cosapp.tools.help

Tool to print the description of a CoSApp object.

Functions

display_doc(obj, **kwargs)

Display information for Driver, System or Port in a Jupyter notebook.

Classes

DocDisplay(obj, **kwargs)	Helper class to print nicely information about CoSApp classes.
DocVisitor()	Visitor collecting and reformatting Markdown representations of systems and ports.

class cosapp.tools.help.DocDisplay(obj: type | BasePort | Module, **kwargs)

Bases: object

Helper class to print nicely information about CoSApp classes.

class cosapp.tools.help.DocVisitor

Bases: Visitor

Visitor collecting and reformatting Markdown representations of systems and ports.

add_doc(obj) → None

Add header with obj class name, and docstring (if any).

visit_default(obj) → None

Default formatting of obj Markdown representation

visit_driver(driver) → None

Formatting of driver Markdown representation

visit_port(port) → None

Formatting of port Markdown representation

visit_system(system) → None

Formatting of system Markdown representation

cosapp.tools.help.display_doc(obj: type | BasePort | Module, **kwargs) → DocDisplay

Display information for Driver, System or Port in a Jupyter notebook.

Parameters:

• obj (-) – Object to display.

• **kwargs (-) –

  Additional keyword arguments forwarded to class constructor, if obj is a class.