openstack/deb-python-taskflow
Code Issues Proposed changes

Merge "Move from generator to iterator for iterjobs"

Browse Source
This commit is contained in:
Jenkins
2014-05-07 21:12:53 +00:00
committed by Gerrit Code Review
parent ee1e96d87d 479b3c8430
commit 84d65efbf2
3 changed files with 91 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
taskflow/jobs/jobboard.py
View File

@@ -36,14 +36,19 @@ class JobBoard(object):
@abc.abstractmethod
def iterjobs(self, only_unclaimed=False, ensure_fresh=False):
"""Yields back jobs that are currently on this jobboard (claimed
or not claimed).
"""Returns an iterator that will provide back jobs that are currently
on this jobboard.
NOTE(harlowja): the ordering of this iteration should be by posting
order (oldest to newest) if possible, but it is left up to the backing
implementation to provide the order that best suits it (so don't depend
on it always being oldest to newest).
NOTE(harlowja): the iterator that is returned may support other
attributes which can be used to further customize how iteration can
be accomplished; check with the backends iterator object to determine
what other attributes are supported.
:param only_unclaimed: boolean that indicates whether to only iteration
over unclaimed jobs.
:param ensure_fresh: boolean that requests to only iterate over the
@@ -55,7 +60,9 @@ class JobBoard(object):
@abc.abstractproperty
def job_count(self):
"""Returns how many jobs are on this jobboard."""
"""Returns how many jobs are on this jobboard (this count may change as
new jobs appear or are removed).
"""
@abc.abstractmethod
def find_owner(self, job):