cowbird.handlers.impl.catalog
=============================

.. py:module:: cowbird.handlers.impl.catalog


Attributes
----------

.. autoapisummary::

   cowbird.handlers.impl.catalog.LOGGER


Classes
-------

.. autoapisummary::

   cowbird.handlers.impl.catalog.Catalog


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

.. py:data:: LOGGER

.. py:class:: Catalog(settings: cowbird.typedefs.SettingsType, name: str, **kwargs: Any)

   Bases: :py:obj:`cowbird.handlers.handler.Handler`, :py:obj:`cowbird.monitoring.fsmonitor.FSMonitor`


   Keep the catalog index in sync when files are created/deleted/updated.

   Create the catalog instance.

   :param settings: Cowbird settings for convenience
   :param name: Handler name


   .. py:attribute:: required_params
      :type:  List[cowbird.handlers.handler.AnyHandlerParameter]


   .. py:method:: user_created(user_name: str) -> None


   .. py:method:: user_deleted(user_name: str) -> None


   .. py:method:: permission_created(permission: cowbird.permissions_synchronizer.Permission) -> None


   .. py:method:: permission_deleted(permission: cowbird.permissions_synchronizer.Permission) -> None


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


      Return the Catalog singleton instance from the class name used to retrieve the FSMonitor from the DB.



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

      Called when a new path is found.

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



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

      Called when a path is deleted.

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



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

      Called when a path is updated.

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



   .. py:method:: resync() -> None