summaryrefslogtreecommitdiff
path: root/src/timed_events.py
diff options
context:
space:
mode:
Diffstat (limited to 'src/timed_events.py')
-rw-r--r--src/timed_events.py82
1 files changed, 21 insertions, 61 deletions
diff --git a/src/timed_events.py b/src/timed_events.py
index a922ee03..6160645b 100644
--- a/src/timed_events.py
+++ b/src/timed_events.py
@@ -13,87 +13,47 @@ Once created, they must be added to the list of checked events with
:py:func:`.PluginAPI.add_timed_event` (within a plugin).
"""
+import asyncio
import logging
log = logging.getLogger(__name__)
import datetime
-class TimedEvent(object):
+class DelayedEvent(object):
"""
- An event with a callback that is called when the specified time is passed.
-
- Note that these events can NOT be used for very small delay or a very
- precise date, since the check for events is done once per second, as
- a maximum.
-
- The callback and its arguments should be passed as the lasts arguments.
+ A TimedEvent, but with the date calculated from now + a delay in seconds.
+ Use it if you want an event to happen in, e.g. 6 seconds.
"""
- def __init__(self, date, callback, *args):
+ def __init__(self, delay, callback, *args):
"""
- Create a new timed event.
+ Create a new DelayedEvent.
- :param datetime.datetime date: Time at which the callback must be run.
+ :param int delay: The number of seconds.
:param function callback: The handler that will be executed.
:param \*args: Optional arguments passed to the handler.
"""
- self._callback = callback
+ self.callback = callback
self.args = args
self.repetive = False
- self.next_call_date = date
-
- def __call__(self):
- """
- the call should return False if this event should be remove from
- the events list.
- If it’s true, the date should be updated beforehand to a later date,
- or else it will be called every second
- """
- self._callback(*self.args)
- return self.repetive
+ self.delay = delay
+ # An asyncio handler, as returned by call_later() or call_at()
+ self.handler = None
- def has_timed_out(self, current_date):
- """
- Check if the event has timed out.
-
- :param datetime.datetime current_date: The current date.
- :returns: True if the callback should be called
- :rtype: bool
- """
- if self.next_call_date < current_date:
- return True
- else:
- return False
-
- def change_date(self, date):
- """
- Simply change the date of the event.
-
- :param datetime.datetime date: Next date.
- """
- self.next_call_date = date
-
- def add_delay(self, delay):
- """
- Add a delay (in seconds) to the date.
-
- :param int delay: The delay to add.
- """
- self.next_call_date += datetime.timedelta(seconds=delay)
-
-class DelayedEvent(TimedEvent):
+class TimedEvent(DelayedEvent):
"""
- A TimedEvent, but with the date calculated from now + a delay in seconds.
- Use it if you want an event to happen in, e.g. 6 seconds.
+ An event with a callback that is called when the specified time is passed.
+
+ The callback and its arguments should be passed as the lasts arguments.
"""
- def __init__(self, delay, callback, *args):
+ def __init__(self, date, callback, *args):
"""
- Create a new DelayedEvent.
+ Create a new timed event.
- :param int delay: The number of seconds.
+ :param datetime.datetime date: Time at which the callback must be run.
:param function callback: The handler that will be executed.
:param \*args: Optional arguments passed to the handler.
"""
- date = datetime.datetime.now() + datetime.timedelta(seconds=delay)
- TimedEvent.__init__(self, date, callback, *args)
-
+ delta = date - datetime.datetime.now()
+ delay = delta.total_seconds()
+ DelayedEvent.__init__(self, delay, callback, *args)