philiprehberger-file-watcher 0.1.8

Filesystem event watcher with decorator-based callbacks

philiprehberger-file-watcher

Filesystem event watcher with decorator-based callbacks.

Installation

pip install philiprehberger-file-watcher

Usage

from philiprehberger_file_watcher import Watcher

watcher = Watcher("./src")

@watcher.on("created", pattern="*.py")
def on_new_python_file(event):
    print(f"New file: {event.path}")

@watcher.on("modified", pattern="*.css")
def on_css_change(event):
    print(f"CSS changed: {event.path}")

@watcher.on("any")
def on_anything(event):
    print(f"{event.type}: {event.path}")

# Blocking
watcher.start()

# Or background mode
watcher.start(background=True)
# ... do other work ...
watcher.stop()

Event Types

"created", "modified", "deleted", "moved", "any"

Options

Option	Default	Description
recursive	True	Watch subdirectories
debounce	0.5	Debounce interval in seconds

API

Function / Class	Description
Watcher(path, recursive, debounce)	Watch a directory for filesystem changes with decorator-based event handlers
FileEvent	A filesystem event with type, path, is_directory, and dest_path fields

Development

pip install -e .
python -m pytest tests/ -v

License

MIT