Pidfile featuring stale detection and file-locking, can also be used as context-manager or decorator
Project description
PidFile class featuring:
stale detection
pidfile locking (fcntl)
chmod (default is 0o644)
chown
custom exceptions
Context Manager
PidFile can be used as a context manager:
from pid import PidFile
import os
with PidFile('foo') as p:
print(p.pidname) # -> 'foo'
print(p.piddir) # -> '/var/run' But you can modify it when initialize PidFile.
print(os.listdir('/var/run')) # -> ['foo.pid']
# pid file will delete after 'with' literal.
Decorator
PidFile can also be used a a decorator:
from pid.decorator import pidfile @pidfile() def main(): pass if __name__ == "__main__": main()
Exception Order
In default mode PidFile will try to acquire a file lock before anything else. This means that normally you get a PidFileAlreadyLockedError instead of the PidFileAlreadyRunningError when running a program twice.
If you just want to know if a program is already running its easiest to catch just PidFileError since it will capture all possible PidFile exceptions.
Behaviour
Changes in version 2.0.0 and going forward:
pid is now friendly with daemon context managers such as python-daemon where the PidFile context manager is passed as a parameter. The new corrected behaviour will ensure the process environment is determined at the time of acquiring/checking the lock. Prior behaviour would determine the process environment when instancing the class which may result in incorrect determination of the PID in the case of a process forking after instancing PidFile.
Cleanup of pidfile on termination is done using atexit module. The default SIGTERM handler doesn’t cleanly exit and therefore the atexit registered functions will not execute. A custom handler which triggers the atexit registered functions for cleanup will override the default SIGTERM handler. If a prior signal handler has been configured, then it will not be overridden.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file pid-3.0.1.tar.gz.
File metadata
- Download URL: pid-3.0.1.tar.gz
- Upload date:
- Size: 13.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.44.1 CPython/3.7.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a83187f4ca82298ae3b8517d361e1dc6ad61f5c3009ed6f51c57dc6fcfd3f5f6 |
|
| MD5 | 4e092b993558ee1157e0ef4de7163271 |
|
| BLAKE2b-256 | 558777c21ee86728c7db6977ebc608b7cbb686f250102535e726c6e79321d2d2 |
File details
Details for the file pid-3.0.1-py2.py3-none-any.whl.
File metadata
- Download URL: pid-3.0.1-py2.py3-none-any.whl
- Upload date:
- Size: 11.5 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.44.1 CPython/3.7.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c68936d54f38f6c45edcbc83c877cb08973cf972d6ac42a9479b0a82d9fd59c8 |
|
| MD5 | fecb76b5765c79bcc9c7566dfb55ca01 |
|
| BLAKE2b-256 | f89a0928469f5ec2bef9f034751484c8deacc0dc3979ed885444d427bb9145a7 |
