:py:mod:`dissect.target.plugins.general.plugins`
================================================

.. py:module:: dissect.target.plugins.general.plugins


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

Classes
~~~~~~~

.. autoapisummary::

   dissect.target.plugins.general.plugins.PluginListPlugin



Functions
~~~~~~~~~

.. autoapisummary::
   :nosignatures:

   dissect.target.plugins.general.plugins.categorize_plugins
   dissect.target.plugins.general.plugins.get_exported_plugins
   dissect.target.plugins.general.plugins.dictify_module_recursive
   dissect.target.plugins.general.plugins.update_dict_recursive
   dissect.target.plugins.general.plugins.output_plugin_description_recursive
   dissect.target.plugins.general.plugins.get_plugin_description
   dissect.target.plugins.general.plugins.get_description_dict



.. py:function:: categorize_plugins(plugins_selection: list[dict] = None) -> dict

   Categorize plugins based on the module it's from.


.. py:function:: get_exported_plugins()


.. py:function:: dictify_module_recursive(list_of_items: list, last_value: dissect.target.plugin.Plugin) -> dict

   Create a dict from a list of strings.

   The last element inside the list, will point to `last_value`


.. py:function:: update_dict_recursive(source_dict: dict, updated_dict: dict) -> dict

   Update source dictionary with data in updated_dict.


.. py:function:: output_plugin_description_recursive(structure_dict: Union[Dict, dissect.target.plugin.Plugin], print_docs: bool, indentation_step=0) -> List[str]

   Create plugin overview with identations.


.. py:function:: get_plugin_description(plugin_class: Type[dissect.target.plugin.Plugin], print_docs: bool, indentation_step: int) -> str

   Returns plugin_overview with specific indentation.


.. py:function:: get_description_dict(structure_dict: Dict, print_docs: bool, indentation_step: int) -> List[str]

   Returns a list of indented descriptions.


.. py:class:: PluginListPlugin(target: dissect.target.Target)


   Bases: :py:obj:`dissect.target.plugin.Plugin`

   Base class for plugins.

   Plugins can optionally be namespaced by specifying the ``__namespace__``
   class attribute. Namespacing results in your plugin needing to be prefixed
   with this namespace when being called. For example, if your plugin has
   specified ``test`` as namespace and a function called ``example``, you must
   call your plugin with ``test.example``::

   A ``Plugin`` class has the following private class attributes:

   - ``__namespace__``
   - ``__record_descriptors__``

   With the following three being assigned in :func:`register`:

   - ``__plugin__``
   - ``__functions__``
   - ``__exports__``

   Additionally, the methods and attributes of :class:`Plugin` receive more private attributes
   by using decorators.

   The :func:`export` decorator adds the following private attributes

   - ``__exported__``
   - ``__output__``: Set with the :func:`export` decorator.
   - ``__record__``: Set with the :func:`export` decorator.

   The :func:`internal` decorator and :class:`InternalPlugin` set the ``__internal__`` attribute.
   Finally. :func:`args` decorator sets the ``__args__`` attribute.

   :param target: The :class:`~dissect.target.target.Target` object to load the plugin for.

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

      Perform a compatibility check with the target.

      This function should return ``None`` if the plugin is compatible with
      the current target (``self.target``). For example, check if a certain
      file exists.
      Otherwise it should raise an ``UnsupportedPluginError``.

      :raises UnsupportedPluginError: If the plugin could not be loaded.


   .. py:method:: plugins(plugins: list[dict] = None, print_docs: bool = False) -> None