:py:mod:`dissect.target.tools.utils.report`
===========================================

.. py:module:: dissect.target.tools.utils.report


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

Classes
~~~~~~~

.. autoapisummary::

   dissect.target.tools.utils.report.TargetExecutionReport
   dissect.target.tools.utils.report.ExecutionReport



Functions
~~~~~~~~~

.. autoapisummary::
   :nosignatures:

   dissect.target.tools.utils.report.make_cli_args_overview
   dissect.target.tools.utils.report.make_plugin_import_errors_overview
   dissect.target.tools.utils.report.format_target_report



Attributes
~~~~~~~~~~

.. autoapisummary::

   dissect.target.tools.utils.report.BLOCK_INDENT


.. py:data:: BLOCK_INDENT
   :value: '    '


.. py:class:: TargetExecutionReport

   .. py:attribute:: target
      :type:  dissect.target.target.Target


   .. py:attribute:: incompatible_plugins
      :type:  set[str]


   .. py:attribute:: registered_plugins
      :type:  set[str]


   .. py:attribute:: func_errors
      :type:  dict[str, str]


   .. py:attribute:: func_execs
      :type:  set[str]


   .. py:method:: add_incompatible_plugin(plugin_name: str) -> None


   .. py:method:: add_registered_plugin(plugin_name: str) -> None


   .. py:method:: add_func_error(func: str, stacktrace: str) -> None


   .. py:method:: as_dict() -> dict[str, Any]


.. py:class:: ExecutionReport

   .. py:attribute:: plugin_import_errors
      :type:  dict[str, str]


   .. py:attribute:: target_reports
      :type:  list[TargetExecutionReport]
      :value: []



   .. py:attribute:: cli_args
      :type:  dict[str, Any]


   .. py:method:: set_cli_args(args: argparse.Namespace) -> None


   .. py:method:: set_plugin_stats(plugins: dissect.target.plugin.PluginRegistry) -> None


   .. py:method:: get_formatted_report() -> str


   .. py:method:: add_target_report(target: dissect.target.target.Target) -> TargetExecutionReport


   .. py:method:: get_target_report(target: dissect.target.target.Target, create: bool = False) -> TargetExecutionReport


   .. py:method:: log_incompatible_plugin(target: dissect.target.target.Target, _: dissect.target.target.Event, plugin_cls: type[dissect.target.plugin.Plugin] | None = None, plugin_desc: dissect.target.plugin.FunctionDescriptor | None = None) -> None


   .. py:method:: log_registered_plugin(target: dissect.target.target.Target, _: dissect.target.target.Event, plugin_inst: dissect.target.plugin.Plugin) -> None


   .. py:method:: log_func_error(target: dissect.target.target.Target, _: dissect.target.target.Event, func: str, stacktrace: str) -> None


   .. py:method:: log_func_execution(target: dissect.target.target.Target, _: dissect.target.target.Event, func: str) -> None


   .. py:method:: set_event_callbacks(target_cls: type[dissect.target.target.Target]) -> None


   .. py:method:: as_dict() -> dict[str, Any]


.. py:function:: make_cli_args_overview(report: ExecutionReport) -> str

.. py:function:: make_plugin_import_errors_overview(report: ExecutionReport, short: bool = True) -> str

.. py:function:: format_target_report(target_report: TargetExecutionReport) -> str