`dissect.target.helpers.docs`#

Module Contents#

Functions#

`get_plugin_class_for_func`	Return pluging class for provided function instance
`get_real_func_obj`	Return a tuple with plugin class and underlying func object for provided function instance
`get_docstring`	Get object's docstring or a placeholder if no docstring found
`get_func_details`	Return a tuple with function's name, output label and docstring
`get_full_func_name`
`get_func_description`
`get_plugin_functions_desc`
`get_plugin_description`
`get_plugin_overview`

Attributes#

`NO_DOCS`
`FUNCTION_OUTPUT_DESCRIPTION`
`INDENT_STEP`
`FUNC_DOC_TEMPLATE`

dissect.target.helpers.docs.NO_DOCS = 'No documentation'#

dissect.target.helpers.docs.FUNCTION_OUTPUT_DESCRIPTION#

dissect.target.helpers.docs.INDENT_STEP#

dissect.target.helpers.docs.get_plugin_class_for_func(func: Callable) → Type#: Return pluging class for provided function instance

dissect.target.helpers.docs.get_real_func_obj(func: Callable) → Tuple[Type, Callable]#: Return a tuple with plugin class and underlying func object for provided function instance

dissect.target.helpers.docs.get_docstring(obj: Any, placeholder=NO_DOCS) → str#: Get object’s docstring or a placeholder if no docstring found

dissect.target.helpers.docs.get_func_details(func: Callable) → Tuple[str, str]#: Return a tuple with function’s name, output label and docstring

dissect.target.helpers.docs.get_full_func_name(plugin_class: Type, func: Callable) → str#

dissect.target.helpers.docs.FUNC_DOC_TEMPLATE = '{func_name} - {short_description} (output: {output_type})'#

dissect.target.helpers.docs.get_func_description(func: Callable, with_docstrings: bool = False) → str#

dissect.target.helpers.docs.get_plugin_functions_desc(plugin_class: Type, with_docstrings: bool = False) → str#

dissect.target.helpers.docs.get_plugin_description(plugin_class: Type) → str#

dissect.target.helpers.docs.get_plugin_overview(plugin_class: Type, with_plugin_desc: bool = False, with_func_docstrings: bool = False) → str#