Mikaela/Limnoria
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria.git synced 2024-12-25 04:02:46 +01:00
Code Issues Projects Releases Wiki Activity

Added docstrings.

Browse Source
This commit is contained in:
Jeremy Fincher 2003-10-04 12:45:44 +00:00
parent d079777f27
commit 6bd138c4eb
1 changed files with 15 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
src/schedule.py
View File

@ -29,6 +29,11 @@
# POSSIBILITY OF SUCH DAMAGE. # POSSIBILITY OF SUCH DAMAGE.
### ###
"""
Schedule plugin with a subclass of drivers.IrcDriver in order to be run as a
Supybot driver.
"""
from fix import * from fix import *
import time import time
@ -36,18 +41,6 @@ import heapq
import drivers import drivers
## class RTuple(tuple):
## def __lt__(self, other):
## return not tuple.__lt__(self, other)
## def __gt__(self, other):
## return not tuple.__gt__(self, other)
## def __ge__(self, other):
## return not tuple.__ge__(self, other)
## def __le__(self, other):
## return not tuple.__le__(self, other)
## def __cmp__(self, other):
## return -1*tuple.__cmp__(self, other)
class mytuple(tuple): class mytuple(tuple):
def __cmp__(self, other): def __cmp__(self, other):
return cmp(self[0], other[0]) return cmp(self[0], other[0])
@ -61,6 +54,10 @@ class mytuple(tuple):
return self[0] >= other[0] return self[0] >= other[0]
class Schedule(drivers.IrcDriver): class Schedule(drivers.IrcDriver):
"""An IrcDriver to handling scheduling of events.
Events, in this case, are functions accepting no arguments.
"""
def __init__(self): def __init__(self):
drivers.IrcDriver.__init__(self) drivers.IrcDriver.__init__(self)
self.schedule = [] self.schedule = []
@ -68,6 +65,10 @@ class Schedule(drivers.IrcDriver):
self.counter = 0 self.counter = 0
def addEvent(self, f, t, name=None): def addEvent(self, f, t, name=None):
"""Schedules an event f to run at time t.
name must be hashable and not an int.
"""
if name is None: if name is None:
name = self.counter name = self.counter
self.counter += 1 self.counter += 1
@ -79,11 +80,13 @@ class Schedule(drivers.IrcDriver):
heapq.heappush(self.schedule, mytuple((t, name))) heapq.heappush(self.schedule, mytuple((t, name)))
def removeEvent(self, name): def removeEvent(self, name):
"""Removes the event with the given name from the schedule."""
del self.events[name] del self.events[name]
heapq.heappop(self.schedule) heapq.heappop(self.schedule)
self.schedule = [(t, n) for (t, n) in self.schedule if n != name] self.schedule = [(t, n) for (t, n) in self.schedule if n != name]
def addPeriodicEvent(self, f, t, name=None): def addPeriodicEvent(self, f, t, name=None):
"""Adds a periodic event that is called every t seconds."""
def wrapper(): def wrapper():
f() f()
self.addEvent(wrapper, time.time() + t, name) self.addEvent(wrapper, time.time() + t, name)