Commit 05046152 authored by Serhiy Storchaka's avatar Serhiy Storchaka

Issue #16642: Document kwargs field in sched.Event named tuple.

parent 62688d2a
...@@ -27,6 +27,7 @@ scheduler: ...@@ -27,6 +27,7 @@ scheduler:
.. versionchanged:: 3.3 .. versionchanged:: 3.3
*timefunc* and *delayfunc* parameters are optional. *timefunc* and *delayfunc* parameters are optional.
.. versionchanged:: 3.3 .. versionchanged:: 3.3
:class:`scheduler` class can be safely used in multi-threaded :class:`scheduler` class can be safely used in multi-threaded
environments. environments.
...@@ -129,4 +130,4 @@ Scheduler Objects ...@@ -129,4 +130,4 @@ Scheduler Objects
Read-only attribute returning a list of upcoming events in the order they Read-only attribute returning a list of upcoming events in the order they
will be run. Each event is shown as a :term:`named tuple` with the will be run. Each event is shown as a :term:`named tuple` with the
following fields: time, priority, action, argument. following fields: time, priority, action, argument, kwargs.
...@@ -13,12 +13,12 @@ also be used to integrate scheduling with STDWIN events; the delay ...@@ -13,12 +13,12 @@ also be used to integrate scheduling with STDWIN events; the delay
function is allowed to modify the queue. Time can be expressed as function is allowed to modify the queue. Time can be expressed as
integers or floating point numbers, as long as it is consistent. integers or floating point numbers, as long as it is consistent.
Events are specified by tuples (time, priority, action, argument). Events are specified by tuples (time, priority, action, argument, kwargs).
As in UNIX, lower priority numbers mean higher priority; in this As in UNIX, lower priority numbers mean higher priority; in this
way the queue can be maintained as a priority queue. Execution of the way the queue can be maintained as a priority queue. Execution of the
event means calling the action function, passing it the argument event means calling the action function, passing it the argument
sequence in "argument" (remember that in Python, multiple function sequence in "argument" (remember that in Python, multiple function
arguments are be packed in a sequence). arguments are be packed in a sequence) and keyword parameters in "kwargs".
The action function may be an instance method so it The action function may be an instance method so it
has another way to reference private data (besides global variables). has another way to reference private data (besides global variables).
""" """
...@@ -151,7 +151,7 @@ class scheduler: ...@@ -151,7 +151,7 @@ class scheduler:
"""An ordered list of upcoming events. """An ordered list of upcoming events.
Events are named tuples with fields for: Events are named tuples with fields for:
time, priority, action, arguments time, priority, action, arguments, kwargs
""" """
# Use heapq to sort the queue rather than using 'sorted(self._queue)'. # Use heapq to sort the queue rather than using 'sorted(self._queue)'.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment