cosapp.tools.help

Tool to print the description of a CoSApp object.

Functions

display_doc(obj)

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

Classes

DocDisplay(obj, cosapp.ports.port.BasePort, …)

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: Union[type, cosapp.ports.port.BasePort, cosapp.core.module.Module])[source]

Bases: object

Helper class to print nicely information about CoSApp classes.

classmethod display_doc(obj: Union[type, cosapp.ports.port.BasePort, cosapp.core.module.Module]) → cosapp.tools.help.DocDisplay[source]

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

Parameters

obj (Any) – Object of interest

class cosapp.tools.help.DocVisitor[source]

Bases: cosapp.patterns.visitor.Visitor

Visitor collecting and reformatting Markdown representations of systems and ports.

add_doc(obj) → None[source]

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

visit_default(obj) → None[source]

Default formatting of obj Markdown representation

visit_driver(driver) → None[source]

Formatting of driver Markdown representation

visit_port(port) → None[source]

Formatting of port Markdown representation

visit_system(system) → None[source]

Formatting of system Markdown representation

cosapp.tools.help.display_doc(obj: Union[type, cosapp.ports.port.BasePort, cosapp.core.module.Module]) → cosapp.tools.help.DocDisplay

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

Parameters

obj (Any) – Object of interest