Added docstrings to Pool methods that didn't have them.
This commit is contained in:
@@ -28,9 +28,12 @@ class Pool(object):
|
|||||||
|
|
||||||
@property
|
@property
|
||||||
def current_size(self):
|
def current_size(self):
|
||||||
|
""" The number of coroutines that are currently executing jobs. """
|
||||||
return len(self.procs)
|
return len(self.procs)
|
||||||
|
|
||||||
def free(self):
|
def free(self):
|
||||||
|
""" Returns the number of coroutines that are available for doing
|
||||||
|
work."""
|
||||||
return self.sem.counter
|
return self.sem.counter
|
||||||
|
|
||||||
def execute(self, func, *args, **kwargs):
|
def execute(self, func, *args, **kwargs):
|
||||||
@@ -70,6 +73,8 @@ class Pool(object):
|
|||||||
return p
|
return p
|
||||||
|
|
||||||
def waitall(self):
|
def waitall(self):
|
||||||
|
""" Calling this function blocks until every coroutine
|
||||||
|
completes its work (i.e. there are 0 running coroutines)."""
|
||||||
return self.procs.waitall()
|
return self.procs.waitall()
|
||||||
|
|
||||||
wait_all = waitall
|
wait_all = waitall
|
||||||
@@ -80,6 +85,7 @@ class Pool(object):
|
|||||||
return self.results.wait()
|
return self.results.wait()
|
||||||
|
|
||||||
def killall(self):
|
def killall(self):
|
||||||
|
""" Kill every running coroutine as immediately as possible."""
|
||||||
return self.procs.killall()
|
return self.procs.killall()
|
||||||
|
|
||||||
def launch_all(self, function, iterable):
|
def launch_all(self, function, iterable):
|
||||||
|
Reference in New Issue
Block a user