describe#

skrough.algorithms.meta.describe.describe(processing_element, override_node_name: Optional[str] = None, override_node_meta: Optional[Dict[str, Union[str, bool, int, float]]] = None, override_short_description: Optional[str] = None) → DescriptionNode[source]#

Get a description graph of a given processing_element.

Prepare a description structure for a given processing_element. The function will use processing_element method if available for the given object, i.e., it will use the method to let processing_element self-describe itself. Otherwise, if processing_element is a callable then the function will automatically generate the description structure using available information (using autogenerate_description_node function), e.g., a name attribute stored directly in the element or in its class, or parsing the element’s docstring to obtain textual description. For non-callable elements the function fill produce a dummy description structure filled with None.

Parameters:

  • processing_element – A processing element to be described.

  • override_node_name – If a string value is given then it will override the results’s node_name attribute. Defaults to None.

  • override_node_meta – If a NodeMeta value is given them it will override the results’s node_meta attribute. Defaults to None.

  • override_short_description – If a string value is give then it will override the result’s short_description attribute and it will also set long_description to None. Defaults to None.

Returns:

A description graph structure representing the input processing_element.