cowbird.monitoring.fsmonitor
============================

.. py:module:: cowbird.monitoring.fsmonitor


Classes
-------

.. autoapisummary::

   cowbird.monitoring.fsmonitor.FSMonitor


Module Contents
---------------

.. py:class:: FSMonitor

   Bases: :py:obj:`abc.ABC`


   Interface being called when something changes on the filesystem.


   .. py:method:: get_instance() -> Optional[FSMonitor]
      :staticmethod:

      :abstractmethod:


      Must return an instance of the class implementing FSMonitor.



   .. py:method:: on_created(path: str) -> None
      :abstractmethod:


      Called when a new path is found.

      :param path: Absolute path of a new file/directory



   .. py:method:: on_deleted(path: str) -> None
      :abstractmethod:


      Called when a path is deleted.

      :param path: Absolute path of a new file/directory



   .. py:method:: on_modified(path: str) -> None
      :abstractmethod:


      Called when a path is updated.

      :param path: Absolute path of a new file/directory