Skip to main content

A platform independent file lock.

Project description

# Py-FileLock
This package contains a single module [filelock](filelock.py), which implements
a platform independent file locking mechanism for Python.


## Examples
```Python
import filelock

lock = filelock.FileLock("my_lock_file")

# This is the easiest way to use the file lock. Note, that the FileLock object
# blocks until the lock can be acquired.
with lock:
print("Doing awesome stuff")

# If you don't want to wait an undefined time for the file lock, you can use
# the *acquire* method to provide a *timeout* paramter:
try:
with lock.acquire(timeout=10):
print("Doing more awesome stuff!")
except filelock.Timeout as err:
print("Could not acquire the file lock. Leaving here!")
exit(1)

# When you're using Python 3.3+, *filelock.Timeout* is a subclass of
# *TimeoutError* else OSError. So you can do this too:
try:
with lock.acquire(timeout=10):
print("Doing more awesome stuff!")
except TimeoutError as err:
print("Could not acquire the file lock. Leaving here!")
exit(1)

# If you don't want to use or if you can't use the *with-statement*, the
# example above is equal to this one:
try:
lock.acquire(timeout=10)
except filelock.Timeout as err:
print("Could not acquire the file lock. Leaving here!")
exit(1)
else:
print("Doing more awesome stuff!")
finally:
lock.release()
```


## License
This package is [public domain](LICENSE.md).

Project details


Release history Release notifications | RSS feed

This version

0.2.0

Download files

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

Source Distribution

filelock-0.2.0.zip (7.1 kB view details)

Uploaded Source

File details

Details for the file filelock-0.2.0.zip.

File metadata

  • Download URL: filelock-0.2.0.zip
  • Upload date:
  • Size: 7.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for filelock-0.2.0.zip
Algorithm Hash digest
SHA256 01df3f204f1e02a81550daf07a6b29a5c08b9a46dc61ed0e644b334ca9b448fb
MD5 8e3a513b9ec91e5f770bf21879e3b7bb
BLAKE2b-256 5db7979e97be7d422ce8f203e2305f8f26d2a4baed7267e16324593bd27f2701

See more details on using hashes here.

Provenance

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