TimeloopFE
Loading...
Searching...
No Matches
doc.py File Reference

Namespaces

namespace  timeloopfe
 
namespace  timeloopfe.common
 
namespace  timeloopfe.common.doc
 Provides information on all node subtypes and their attributes.
 

Functions

str timeloopfe.common.doc.get_property_table (Union[Node, type] node=None, int col_len=25, bool trim_cols=False)
 Returns a table of all Node subclasses and their attributes.
 
str timeloopfe.common.doc.get_property_tree (Union[Node, type] node=None, Union[List[str], None] skip=None, n_levels=-1)
 Returns all node subtypes and their attributes in a tree format.
 
str timeloopfe.common.doc._get_property_tree (Union[Node, type] node, Union[Node, type] top, Union[List[str], None] skip=None, n_levels=-1)
 Returns all node subtypes and their attributes in a tree format.
 
 timeloopfe.common.doc.get_property_yaml (Node node, "BaseSpecification" top=None, Union[List[str], None] skip=None)
 Returns all node subtypes and their attributes in a YAML format.
 
 timeloopfe.common.doc._get_property_yaml (Node node, "BaseSpecification" top=None, Union[List[str], None] skip=None)
 Returns a yaml representation of the specification.