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

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

Uploaded Source

Built Distribution

pid-2.2.5-py2.py3-none-any.whl (9.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: pid-2.2.5.tar.gz
  • Upload date:
  • Size: 12.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.4

File hashes

Hashes for pid-2.2.5.tar.gz
Algorithm Hash digest
SHA256 96eb7dba326b88f5164bc1afdc986c7793e0d32d7f62366256a3903c7b0614ef
MD5 ad352ee1dc28b9746a15451c0c53e9d7
BLAKE2b-256 125c1d479a2698ea6fb9bc946513b28c1c46965c9e809823743f3d72b3273084

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pid-2.2.5-py2.py3-none-any.whl
  • Upload date:
  • Size: 9.3 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.4

File hashes

Hashes for pid-2.2.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 fe1ac2fd0617b091e7afd7b90f7af65ffb2339b57586215500e965462bb3cf0b
MD5 c1e8194af21375a412b37dc625ec9acc
BLAKE2b-256 82bc3633e94577c0f64864684be5a73251f194fd8673fb7c1f095597ef34dbc2

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