john/McRogueFace
1
0
Fork 0
Code Issues 41 Pull requests Projects 1 Releases Wiki Activity

Timer refactor: stopwatch-like semantics, mcrfpy.timers collection closes #173

Browse source 
Major Timer API improvements:
- Add `stopped` flag to Timer C++ class for proper state management
- Add `start()` method to restart stopped timers (preserves callback)
- Add `stop()` method that removes from engine but preserves callback
- Make `active` property read-write (True=start/resume, False=pause)
- Add `start=True` init parameter to create timers in stopped state
- Add `mcrfpy.timers` module-level collection (tuple of active timers)
- One-shot timers now set stopped=true instead of clearing callback
- Remove deprecated `setTimer()` and `delTimer()` module functions

Timer callbacks now receive (timer, runtime) instead of just (runtime).
Updated all tests to use new Timer API and callback signature.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
John McCardle 2026-01-03 19:21:37 -05:00
commit 5d41292bf6
16 changed files with 440 additions and 262 deletions
Download patch file Download diff file Expand all files Collapse all files

128
tests/unit/api_timer_test.py
View file

@ -1,70 +1,126 @@
#!/usr/bin/env python3
"""Test for mcrfpy.setTimer() and delTimer() methods"""
"""Test for mcrfpy.Timer class - replaces old setTimer/delTimer tests (#173)"""
import mcrfpy
import sys
def test_timers():
"""Test timer API methods"""
print("Testing mcrfpy timer methods...")
"""Test Timer class API"""
print("Testing mcrfpy.Timer class...")
# Test 1: Create a simple timer
try:
call_count = [0]
def simple_callback(runtime):
def simple_callback(timer, runtime):
call_count[0] += 1
print(f"Timer callback called, count={call_count[0]}, runtime={runtime}")
mcrfpy.setTimer("test_timer", simple_callback, 100)
print("✓ setTimer() called successfully")
timer = mcrfpy.Timer("test_timer", simple_callback, 100)
print("✓ Timer() created successfully")
print(f" Timer repr: {timer}")
except Exception as e:
print(f"✗ setTimer() failed: {e}")
print(f"✗ Timer() failed: {e}")
print("FAIL")
return
# Test 2: Delete the timer
# Test 2: Stop the timer
try:
mcrfpy.delTimer("test_timer")
print("✓ delTimer() called successfully")
timer.stop()
print("✓ timer.stop() called successfully")
assert timer.stopped == True, "Timer should be stopped"
print(f" Timer after stop: {timer}")
except Exception as e:
print(f"✗ delTimer() failed: {e}")
print(f"✗ timer.stop() failed: {e}")
print("FAIL")
return
# Test 3: Delete non-existent timer (should not crash)
# Test 3: Restart the timer
try:
mcrfpy.delTimer("nonexistent_timer")
print("✓ delTimer() accepts non-existent timer names")
timer.start()
print("✓ timer.start() called successfully")
assert timer.stopped == False, "Timer should not be stopped"
assert timer.active == True, "Timer should be active"
timer.stop() # Clean up
except Exception as e:
print(f"✗ delTimer() failed on non-existent timer: {e}")
print(f"✗ timer.start() failed: {e}")
print("FAIL")
return
# Test 4: Create multiple timers
# Test 4: Create timer with start=False
try:
def callback1(rt): pass
def callback2(rt): pass
def callback3(rt): pass
mcrfpy.setTimer("timer1", callback1, 500)
mcrfpy.setTimer("timer2", callback2, 750)
mcrfpy.setTimer("timer3", callback3, 250)
def callback2(timer, runtime): pass
timer2 = mcrfpy.Timer("timer2", callback2, 500, start=False)
assert timer2.stopped == True, "Timer with start=False should be stopped"
print("✓ Timer with start=False created in stopped state")
timer2.start()
assert timer2.active == True, "Timer should be active after start()"
timer2.stop()
except Exception as e:
print(f"✗ Timer with start=False failed: {e}")
print("FAIL")
return
# Test 5: Create multiple timers
try:
def callback3(t, rt): pass
t1 = mcrfpy.Timer("multi1", callback3, 500)
t2 = mcrfpy.Timer("multi2", callback3, 750)
t3 = mcrfpy.Timer("multi3", callback3, 250)
print("✓ Multiple timers created successfully")
# Clean up
mcrfpy.delTimer("timer1")
mcrfpy.delTimer("timer2")
mcrfpy.delTimer("timer3")
print("✓ Multiple timers deleted successfully")
t1.stop()
t2.stop()
t3.stop()
print("✓ Multiple timers stopped successfully")
except Exception as e:
print(f"✗ Multiple timer test failed: {e}")
print("FAIL")
return
print("\nAll timer API tests passed")
# Test 6: mcrfpy.timers collection
try:
# Create a timer that's running
running_timer = mcrfpy.Timer("running_test", callback3, 1000)
timers = mcrfpy.timers
assert isinstance(timers, tuple), "mcrfpy.timers should be a tuple"
print(f"✓ mcrfpy.timers returns tuple with {len(timers)} timer(s)")
# Clean up
running_timer.stop()
except Exception as e:
print(f"✗ mcrfpy.timers test failed: {e}")
print("FAIL")
return
# Test 7: active property is read-write
try:
active_timer = mcrfpy.Timer("active_test", callback3, 1000)
assert active_timer.active == True, "New timer should be active"
active_timer.active = False # Should pause
assert active_timer.paused == True, "Timer should be paused after active=False"
active_timer.active = True # Should resume
assert active_timer.active == True, "Timer should be active after active=True"
active_timer.stop()
active_timer.active = True # Should restart from stopped
assert active_timer.active == True, "Timer should restart from stopped via active=True"
active_timer.stop()
print("✓ active property is read-write")
except Exception as e:
print(f"✗ active property test failed: {e}")
print("FAIL")
return
print("\nAll Timer API tests passed")
print("PASS")
# Run the test
test_timers()
# Exit cleanly
sys.exit(0)
sys.exit(0)