voussoir/voussoirkit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add some docstrings.

Browse source
This commit is contained in:
voussoir 2021-11-20 18:48:58 -08:00
parent 6d9300aa9d
commit 8317e7c7b7
No known key found for this signature in database
GPG key ID: 5F7554F8C26DACCB
1 changed files with 10 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
voussoirkit/threadpool.py
View file

@ -60,10 +60,14 @@ class PoolClosed(ThreadPoolException):
pass pass
class PooledThread: class PooledThread:
'''
The PooledThreads are created when the pool is created, and live as long as
the pool does. Each PooledThread will continuously fetch jobs from the pool
and work on them.
'''
def __init__(self, pool): def __init__(self, pool):
self.pool = pool self.pool = pool
self.thread = threading.Thread(target=self.start) self.thread = threading.Thread(target=self.start, daemon=True)
self.thread.daemon = True
self.thread.start() self.thread.start()
def __repr__(self): def __repr__(self):
@ -250,6 +254,10 @@ class ThreadPool:
return these_jobs return these_jobs
def get_next_job(self): def get_next_job(self):
'''
Return the next available Job object, or NO_MORE_JOBS if the pending
queue is empty. This function does not block like a Queue.get would.
'''
with self._job_manager_lock: with self._job_manager_lock:
try: try:
job = next(self._pending_jobs) job = next(self._pending_jobs)