Latest release 20190923: Remove dependence on cs.obj.
Thread related convenience classes and functions.
Class AdjustableSemaphore
A semaphore whose value may be tuned after instantiation.
Function bg(func, daemon=None, name=None, no_start=False, no_logexc=False, args=None, kwargs=None)
Dispatch the callable func in its own Thread;
return the Thread.
Parameters:
func: a callable for theThreadtarget.daemon: optional argument specifying the.daemonattribute.name: optional argument specifying theThreadname, default: the name offunc.no_start: optional argument, defaultFalse. If true, do not start theThread.no_logexc: if false (defaultFalse), wrapfuncin@logexc.args,kwargs: passed to theThreadconstructor
Class LockableMixin
Trite mixin to control access to an object via its ._lock attribute. Exposes the ._lock as the property .lock. Presents a context manager interface for obtaining an object's lock.
Function locked(func)
A decorator for monitor functions that must run within a lock. Relies upon a ._lock attribute for locking.
Function locked_property(func, lock_name='_lock', prop_name=None, unset_object=None)
A thread safe property whose value is cached. The lock is taken if the value needs to computed.
Class PriorityLock
A priority based mutex.
A priority based mutex which is acquired by and released to waiters in priority order.
The initialiser sets a default priority, itself defaulting to 0.
The acquire() method accepts an optional priority value
which specifies the priority of the acquire request;
lower values have higher priorities.
acquire returns a new PriorityLockSubLock.
Note that internally this allocates a threading.Lock per acquirer.
When acquire is called, if the PriorityLockis taken then the acquirer blocks on their personalLock`.
When release() is called the highest priority Lock is released.
Within a priority level acquires are served in FIFO order.
Used as a context manager, the mutex is obtained at the default priority.
The priority() method offers a context manager
with a specified priority.
Method PriorityLock.__init__(self, default_priority=0, name=None)
Initialise the PriorityLock.
Parameters:
default_priority: the defaultacquirepriority, default0.name: optional identifying name
Function via(cmanager, func, *a, **kw)
Return a callable that calls the supplied func inside a
with statement using the context manager cmanager.
This intended use case is aimed at deferred function calls.
Class WorkerThreadPool
MRO: cs.resources.MultiOpenMixin
A pool of worker threads to run functions.
Method WorkerThreadPool.__init__(self, name=None, max_spare=4)
Initialise the WorkerThreadPool.
Parameters:
name: optional name for the poolmax_spare: maximum size of each idle pool (daemon and non-daemon)
Class WTPoolEntry
MRO: builtins.tuple
WTPoolEntry(thread, queue)
Release Log
Release 20190923: Remove dependence on cs.obj.
Release 20190921: New PriorityLock class for a mutex which releases in (priority,fifo) order.
Release 20190812:
bg: compute default name before wrapping func in @logexc.
Release 20190729:
bg: provide default name, run callable inside Pfx, add optional no_logexc=False param preventing @logec wrapper if true.
Release 20190422:
bg(): new optional no_start=False keyword argument, preventing Thread.start if true
Release 20190102: Drop some unused classes. New LockableMixin, presenting a context manager and a .lock property.
Release 20160828: Use "install_requires" instead of "requires" in DISTINFO.
Release 20160827: Replace bare "excepts" with "except BaseException". Doc updates. Other minor improvements.
Release 20150115: First PyPI release.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file cs.threads-20190923.tar.gz.
File metadata
- Download URL: cs.threads-20190923.tar.gz
- Upload date:
- Size: 7.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e8e52952e582da2380da2937bdfc7ad7a2219e89d7832255ae45ee173f2f28ce
|
|
| MD5 |
38f2968a93c672b2e16f2306ae47756e
|
|
| BLAKE2b-256 |
5fee47f621b1b4cceaf9b402e79ff01802b5e19963bee732f9b4b6b6acdbc028
|
