file.monitor

class platypush.backend.file.monitor.FileMonitorBackend(paths: Iterable[str | Dict[str, Any] | MonitoredResource], **kwargs)

Bases: Backend

This backend monitors changes to local files and directories using the Watchdog API.

Triggers:

• platypush.message.event.file.FileSystemCreateEvent if a resource is created.

• platypush.message.event.file.FileSystemDeleteEvent if a resource is removed.

• platypush.message.event.file.FileSystemModifyEvent if a resource is modified.

Requires:

• watchdog (pip install watchdog)

class EventHandlerFactory

Bases: object

Create a file system event handler from a string, dictionary or MonitoredResource resource.

__init__(paths: Iterable[str | Dict[str, Any] | MonitoredResource], **kwargs)

Parameters:

paths –

List of paths to monitor. Paths can either be expressed in any of the following ways:

• Simple strings. In this case, paths will be interpreted as absolute references to a file or a directory to monitor. Example:

  backend.file.monitor:
      paths:
          # Monitor changes on the /tmp folder
          - /tmp
          # Monitor changes on /etc/passwd
          - /etc/passwd
  

• Path with monitoring properties expressed as a key-value object. Example showing the supported attributes:

  backend.file.monitor:
      paths:
          # Monitor changes on the /tmp folder and its subfolders
          - path: /tmp
            recursive: True
  

• Path with pattern-based search criteria for the files to monitor and exclude. Example:

  backend.file.monitor:
      paths:
          # Recursively monitor changes on the ~/my-project folder that include all
          # *.py files, excluding those whose name starts with tmp_ and
          # all the files contained in the __pycache__ folders
          - path: ~/my-project
            recursive: True
            patterns:
              - "*.py"
            ignore_patterns:
              - "tmp_*"
            ignore_directories:
              - "__pycache__"
  

• Path with regex-based search criteria for the files to monitor and exclude. Example:

  backend.file.monitor:
      paths:
          # Recursively monitor changes on the ~/my-images folder that include all
          # the files matching a JPEG extension in case-insensitive mode,
          # excluding those whose name starts with tmp_ and
          # all the files contained in the __MACOSX folders
          - path: ~/my-images
            recursive: True
            case_sensitive: False
            regexes:
              - '.*\.jpe?g$'
            ignore_patterns:
              - '^tmp_.*'
            ignore_directories:
              - '__MACOSX'
  

on_stop()

Callback invoked when the process stops

run()

Starts the backend thread. To be implemented in the derived classes if the loop method isn’t defined.