Typing stubs for filelock

3.2.7 · active · verified Tue Apr 14

This package provides static type checking stubs for the `filelock` library, enabling tools like MyPy to verify type correctness. It is part of the Python typeshed project, which maintains high-quality stubs generally kept up-to-date with the latest versions of their respective runtime libraries. Releases follow typeshed's continuous integration and release cycle, reflecting updates to the underlying `filelock` library.

Warnings

gotcha Installing `types-filelock` does NOT install the `filelock` runtime library. You must install `filelock` separately (e.g., `pip install filelock`) for your code to function.
Fix: Ensure `filelock` is listed in your project's dependencies and installed alongside `types-filelock`.
gotcha Do not attempt to import symbols directly from `types_filelock` (or any variation of the stub package name). The purpose of `types-filelock` is to provide type information for imports from the original `filelock` library.
Fix: Always import symbols directly from the `filelock` package, e.g., `from filelock import FileLock`.
gotcha Type stubs are maintained by the typeshed project and may occasionally lag behind the absolute latest releases of the `filelock` library. This can lead to `mypy` errors if `filelock` introduces new features or changes its API before corresponding stubs are updated.
Fix: If encountering type errors due to new `filelock` features, consider pinning `filelock` to an older version until stubs are updated, or temporarily ignoring specific `mypy` errors.

Install

pip install types-filelock Install typing stubs

Imports

FileLock
```
from filelock import FileLock
```
Typing stubs are not meant for direct import; they provide type information for the original library's imports.

Quickstart

This quickstart demonstrates the usage of the `filelock` library, for which `types-filelock` provides type hints. To run this code with type checking, ensure both `filelock` and `types-filelock` are installed. The `FileLock` context manager ensures that the enclosed code block is executed exclusively, preventing race conditions across processes.

import os
import time
from filelock import FileLock

# Define a lock file path
lock_file_path = "/tmp/my_app.lock"

try:
    # Acquire the lock. If another process holds it, this will block until it's released.
    # The timeout parameter ensures it doesn't wait indefinitely.
    with FileLock(lock_file_path, timeout=5):
        print("Lock acquired. Performing exclusive operation...")
        # Simulate work
        time.sleep(2)
        print("Exclusive operation completed. Releasing lock.")
except Exception as e:
    print(f"Could not acquire lock or an error occurred: {e}")

view raw JSON →