cowbird.monitoring.monitor

Attributes

LOGGER
MonitorKey
MonitorParameters

Exceptions

MonitorException

Error indicating that a Monitor cannot be started because of an invalid path or callback.

Classes

Monitor

Implementation of the watchdog FileSystemEventHandler class Allows to start/stop directory monitoring and

Module Contents

cowbird.monitoring.monitor.LOGGER

cowbird.monitoring.monitor.MonitorKey

cowbird.monitoring.monitor.MonitorParameters

exception cowbird.monitoring.monitor.MonitorException

Bases: Exception

Error indicating that a Monitor cannot be started because of an invalid path or callback.

Initialize self. See help(type(self)) for accurate signature.

class cowbird.monitoring.monitor.Monitor(path: str, recursive: bool, callback: cowbird.monitoring.fsmonitor.FSMonitor | Type[cowbird.monitoring.fsmonitor.FSMonitor] | str)

Bases: watchdog.events.FileSystemEventHandler

Implementation of the watchdog FileSystemEventHandler class Allows to start/stop directory monitoring and send events to FSMonitor callback.

Initialize the path monitoring and ready to be started.

Parameters:

• path – Path to monitor

• recursive – Monitor subdirectory recursively?

• callback – Events are sent to this FSMonitor. Can be an object, a class type implementing FSMonitor or a string containing module and class name. The class type or string is used to instantiate an object using the class method FSMonitor.get_instance()

static get_fsmonitor_instance(callback: cowbird.monitoring.fsmonitor.FSMonitor | Type[cowbird.monitoring.fsmonitor.FSMonitor] | str) → cowbird.monitoring.fsmonitor.FSMonitor

Return a FSMonitor instance from multiple possible forms including the FSMonitor type, the FSMonitor full qualified class name or a direct instance which is returned as is.

static get_qualified_class_name(monitor: cowbird.monitoring.fsmonitor.FSMonitor) → str

Returns the full qualified class name of the FSMonitor object (string of the form module.class_name)

property recursive: bool

property path: str

property callback: str

property callback_instance: cowbird.monitoring.fsmonitor.FSMonitor

property key: MonitorKey

Return a dict that can be used as a unique key to identify this Monitor in a BD.

property is_alive: bool

Returns true if the monitor observer exists and is currently running.

params() → MonitorParameters

Return a dict serializing this object from which a new Monitor can be recreated using the init function.

start() → None

Start the monitoring so that events can be fired.

stop() → None

Stop the monitoring so that events stop to be fired.

on_moved(event: watchdog.events.DirMovedEvent | watchdog.events.FileMovedEvent) → None

Called when a file or a directory is moved or renamed.

Parameters:

event – Event representing file/directory movement.

on_created(event: watchdog.events.DirCreatedEvent | watchdog.events.FileCreatedEvent) → None

Called when a file or directory is created.

Parameters:

event – Event representing file/directory creation.

on_deleted(event: watchdog.events.DirDeletedEvent | watchdog.events.FileDeletedEvent) → None

Called when a file or directory is deleted.

Parameters:

event – Event representing file/directory deletion.

on_modified(event: watchdog.events.DirModifiedEvent | watchdog.events.FileModifiedEvent) → None

Called when a file or directory is modified.

Parameters:

event – Event representing file/directory modification.