Skip to main content

Pidfile featuring stale detection and file-locking, can also be used as context-manager or decorator

Project description

https://travis-ci.org/trbs/pid.svg?branch=master https://coveralls.io/repos/trbs/pid/badge.png Latest PyPI version Number of PyPI downloads

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

with PidFile():
  do_something()

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 determinde 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pid-2.0.0.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

pid-2.0.0-py2.py3-none-any.whl (6.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pid-2.0.0.tar.gz.

File metadata

  • Download URL: pid-2.0.0.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pid-2.0.0.tar.gz
Algorithm Hash digest
SHA256 d966bf7caed3d2eca3e9c4d4816d56a548fb8327e33d5813787c44974d566772
MD5 59a1183275a53fe9bde5ebd271b6a934
BLAKE2b-256 89908001ec1c49da9e5c61d0ebe93fad336b8fd8e14917c48a24b8b643c8ed22

See more details on using hashes here.

File details

Details for the file pid-2.0.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for pid-2.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1c8eb1f1cf4e5054e5b5559c7df89debad13172bdca81e3d01f0cba9a18fcb35
MD5 8d79fe9e865af8f6856b5ae34fb2e77d
BLAKE2b-256 e7582c22cb54bef77525679650eaf061e396260fb4098854627c8f5cbb418c38

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page