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.1.0.tar.gz (9.6 kB view details)

Uploaded Source

Built Distribution

pid-2.1.0-py2.py3-none-any.whl (6.6 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for pid-2.1.0.tar.gz
Algorithm Hash digest
SHA256 37ce56b4a6c022eac5c7a5b5150fe5bd8c14f667e6157ea7b433268fbad2da85
MD5 ed4f604bf259092a44c0fae417cb44ff
BLAKE2b-256 4f5c6a830cf8dd637753cdd4c63ccc98b8d7be7e36fd1b511d8e80cebd614ba7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pid-2.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f5fe06620d70c60e965cd373b75ac38174fa4e698f2b7ca15e3501ecc9c06d15
MD5 78bccdd2d4f6af05d4049c9edd5a2b13
BLAKE2b-256 33aac0cfe62d15254e4ff1899a81840fa39f1a22ccd54d5e1de2788e4ecaa077

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