A timed, self running, stoppable class for Python

timed_class.py

from threading import Timer
from typing import ClassVar
from typing import Optional


class SelfRunner( object ):
  _timeout: ClassVar[ float ] = 10.0
  _timer: Optional[ Timer ] = None
  _end_called: bool = False

  def __init__ ( self, timeout: float ):
    self._timeout = timeout

  def _run ( self ):
    pass

  def _on_timer ( self ):
    # Stop if already ending
    if self._end_called: return

    self._run()

    # Stop if already ending
    if self._end_called: return

    # Start a new timer
    self._timer = Timer( self._timeout, self._on_timer )
    self._timer.start()

  def start ( self, instant_fire: bool = False ):
    if instant_fire:
      self._on_timer()

    if self._timer is not None:
      self._timer.cancel()
      self._timer = None

    self._timer = Timer( self._timeout, self._on_timer )
    self._timer.start()

  def stop ( self ):
    self._end_called = True
    if self._timer is not None:
      self._timer.cancel()
      self._timer = None