Skip to main content

Introduction

The JustPidFile libraray is a very simple, yet functional, pid file implementation.

This way the first process accessing the pid file, is able to write there its PID (Process ID). The next one will check the file, the pid inside, and will check if the process with the PID exists. If it exists, then an exception is thrown.

If the pid file doesn’t exist, or contains garbage data, or an integer with a PID of a not running process, then the directory can be “locked”.

“Locking” a directory is done by creating a “.pid” file in the directory with the locking process ID inside.

Gotchas

Locking a directory with a simple file works as long as everybody uses the same mechanism. There is nothing that forbids any other process to change files in the “locked” directory. The purpose of this library is to avoid having two processes writing to the same files at the same time.

Example

Lock a directory using the simple functional API

import justpid as jp
directory = "abc"

try:
    jp.lock(directory)
    # some logic
    jp.unlock(directory)
except jp.LockException:
    print("Cannot lock a directory")

Use a context manager to automatically unlock the directory at the end

import justpid as jp

with jp.Lock(directory):
    # do something here
    # the directory is exlusively locked
# and here is unlocked

Implementation Details

There are some hardcoded things like:

  • The pid file is in side the locked directory and is named .pid

  • The main api is made of functions.

  • There is also a context manager, just to make life a little bit simpler.

Do You Need this?

Maybe? Who knows. I need.

Metadata

Release files for justpid 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for justpid 1.1.0
File Size Uploaded
justpid-1.1.0.tar.gz 5.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for justpid 1.1.0
File Interpreter ABI Platform
justpid-1.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 11.2 kB

Release files / justpid-1.1.0.tar.gz

Download URL justpid-1.1.0.tar.gz
Size 5.5 kB
Tags Source
SHA-256 checksum
How to use checksums
d617594f273453b71eda3f40cfc4816ae62de68e79155875cbfcd210291ee9a9
BLAKE2b-256 checksum
How to use checksums
c64d9c74e601501874f6eb4ae14bc24b17c3ad32672ae8dd15804c2d69700867
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.5.0 importlib_metadata/4.2.0 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.6.12

Release files / justpid-1.1.0-py3-none-any.whl

Download URL justpid-1.1.0-py3-none-any.whl
Size 5.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d5d512aa03b6b3f5a50a8ed40dec97bdcd6f34e1db1c832e1d4ca2c04ec40358
BLAKE2b-256 checksum
How to use checksums
de1aac3c289e34d21dab5fa0c543d3287a2e134c3d4165f3a65c95251d5d2873
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.5.0 importlib_metadata/4.2.0 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.6.12

Release history Release notifications | RSS feed

This release

1.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page