The ast_tree.py module

Summary

Classes

NameMap
Element	Provides the base element.
ItemizedList	Provides the itemized list element.
SimpleList	Provides the simple itemized list element.
Member	Provides the member element for a simple itemized list.
OrderedList	Provides the ordered list element.
ListItem	Provides the list item element.
FileName	Provides the filename element.
OLink	Provides the external link element.
Paragraph	Provides the paragraph element.
Phrase	Provides the phrase element.
Structname	Provides the structure name element.
Title	Provides the title element.
Emphasis	Provides the emphasis element.
Example	Provides the example element.
InformalExample	Provides the informal example element.
GuiMenu	Provides the GUI menu element.
Replaceable	Provides the replaceable element.
ProgramListing	Provides the program listing element.
Variablelist	Provides the variable list.
RefSection	Provides the reference section element.
VarlistEntry	Provides the variable list entry element.
Term	Provides the term element.
GuiLabel	Provides the GUI label element.
GuiMenuItem	Provides the GUI menu item element.
SuperScript	Provides the superscript element.
Code	Provides the code element.
Math	Provides the math element.
InlineEquation	Provides the inline equation element.
SubScript	Provides the subscript element.
InlineGraphic	Provides the inline graphic element.
Quote	Provides the quote element.
Link	Provides the link element.
XRef	Provides the cross reference element.
UserInput	Provides the user input element.
Screen	Provides the screen element.
Literal	Provides the literal output element.
Caution	Provides the caution element.
Graphic	Provides the graphic element.
Function	Provides the function element.
Note	Provides the note element.
BlockQuote	Provides the block quote element.
RefMeta	Provides the reference metadata element.
IndexTerm	Provides the index term element.
Primary	Provides the primary element.
TGroup	Provides the tgroup element, which contains the header and body rows of a table.
Table	Provides the table element
Refentrytitle	Provides the title of the reference entry.
Refnamediv	Provides the refnamediv element, which contains the name,
Refname	Provides the refname element which contains
Refpurpose	Provides the refpurpose element, which contains
Refclass	Provides the base element.
Application	Provides the base element.
Refsect1	Provides the base element.
Command	Provides the command element.
ComputerOutput	Provides the computer output element.
Figure	Provides the figure element.
Footnote	Provides the base element.
Footnoteref	Provides the base element.
Formalpara	Provides the base element.
Glossterm	Provides the base element.
GuiButton	Provides the base element.
GuiIcon	Provides the base element.
Highlights	Provides the base element.
Important	Provides the base element.
InformalEquation	Provides the math element.
Interface	Provides the base element.
Markup	Provides the base element.
Mediaobject	Provides the base element.
Option	Provides the base element.
Refsect3	Provides the base element.
Refsynopsisdiv	Provides the base element.
Sidebar	Provides the base element.
XMLType	Provides the base element.
XMLWarning	XML Warning element are handled the same as Caution elements.
ClassName	Provides the base element.
Imageobject	Provides the base element.
InformalFigure	Provides the base element.
Envar	Provides the base element.
ImageData	Provides the base element.
ColSpec	Provides the base element.
TBody	Provides the tbody element.
Entry	Provides the entry element.
Row	Provides the row element.
THead	Provides the thead element.
Remark	Provides the base element.
LiteralLayout	Provides the base element.
CiteTitle	Provides the base element.
ULink	Provides the base element.
SegTitle	Provides the base element.
Chapter	Provides the chapter element.
Section1	Provides the base element.
ProductName	Provides the base element.
Argument	Argument object.
ArgumentList
XMLCommand	Provides the XML command from the documentation.
InformalTable	Provides the informal table element.
BridgeHead	Provides the bridgehead element.
OxygenXmlTree	Provides for loading an XML file as an AST (abstract syntax tree).

Functions

to_py_name	Return a Python-compatible name for a command using the global name map.
get_iter_values	Get the values of an iterator.
get_quant_iter_pos	Get the values of a quantity iterator.
to_py_arg_name	Return a Python-compatible name for an argument.
get_complete_args_from_initial_arg	Get the complete argument list from a list with elipsis.
is_elipsis	Check if a name is an elipsis.
str_types	String representation of the parameter types.
to_py_signature	Return the Python signature of the argument.
resize_length	Resize the length of a text.
get_fragment_code	Split the text around a pattern.
replace_asterisks_without_code
replace_asterisks
replace_terms	Replace terms with their definitions.
ponctuation_whitespace
resize_element_list
parse_element	Parse a single element.
parse_children	Parse the children of an element.
get_parser

Attributes

logger
superlatif
parsers
item_needing_links_base_url
item_needing_fcache
item_needing_all

Constants

CONV_EQN
XML_CLEANUP
CLEANUP
PY_ARG_CLEANUP
FORBIDDEN_ARGUMENT_NAMES
NAME_MAP_GLOB
NO_RESIZE_LIST
MISSING_ARGUMENT_DESCRIPTION
ADDITIONAL_ARGUMENT_DESCRIPTION

Module detail

ast_tree.to_py_name(name, name_map=None)

Return a Python-compatible name for a command using the global name map.

Parameters:

namestr

Name of the command.

name_mapdict

Dictionary containing the name map.

Returns:

str

Python-compatible command name.

ast_tree.get_iter_values(name: str)

Get the values of an iterator.

Parameters:

namestr

Name of the parameter containing the iterator.

Returns:

tuple(str, int)

Tuple containing the name of the iterator and the iteration value.

ast_tree.get_quant_iter_pos(name: str) → tuple

Get the values of a quantity iterator.

Parameters:

name: str

Name of the parameter containing the iterator.

Returns:

tuple

Tuple containing the iteration value and the position of the iterator.

ast_tree.to_py_arg_name(name: str) → str

Return a Python-compatible name for an argument.

Parameters:

namestr

Name of the argument.

Returns:

str

Python-compatible argument name.

ast_tree.get_complete_args_from_initial_arg(initial_args: List[str], elipsis_args: List[str]) → List[str]

Get the complete argument list from a list with elipsis.

Parameters:

initial_argslist

List of initial arguments.

elipsis_argslist

List of containing the elipsed arguments.

Returns:

list

List of complete pythonnic arguments.

Examples

>>> initial_args = ['energytype', 'cname1', 'cname2', 'cname3', 'cname4', 'cname5', 'cname6']
>>> elipsis_args = ['Cname1', ' Cname2',' …']
>>> get_complete_args_from_initial_arg(initial_args, elipsis_args)
['cname1', 'cname2', 'cname3', 'cname4', 'cname5', 'cname6']

ast_tree.is_elipsis(name: str) → bool

Check if a name is an elipsis.

Returns:

bool

True if the argument is an elipsis, False otherwise.

ast_tree.str_types(types, join_str: str) → str

String representation of the parameter types.

Parameters:

typeslist

List of types.

join_strstr

String to join the types.

Returns:

str

String representation of the parameter types.

Examples

>>> types = [str, int, float]
>>> str_types(types, " | ")
'str | int | float'

>>> types = [str, int]
>>> str_types(types, " or ")
'str or int'

ast_tree.to_py_signature(py_arg_name, types) → str

Return the Python signature of the argument.

Parameters:

py_arg_namestr

Python-compatible argument name.

typeslist

List of types.

Returns:

str

Python signature of the argument.

Examples

>>> py_arg_name = 'energytype'
>>> types = [str, int, float]
>>> to_py_signature(py_arg_name, types)
'energytype: str | int | float = ""'

ast_tree.resize_length(text, max_length=100, initial_indent='', subsequent_indent='', list=False)

Resize the length of a text.

Parameters:

textstr

Text to resize.

max_lengthint

Maximum length of the text to be resized.

initial_indentstr

Initial indentation of the text.

subsequent_indentstr

Subsequent indentation of the text.

return_listbool

If set to True, the function returns a list of strings. Default is False.

Returns:

str or list

Resized text.

ast_tree.get_fragment_code(initial_text, pattern)

Split the text around a pattern.

Parameters:

initial_textstr

Initial text to split.

patternstr

Pattern to split the text.

Returns:

list

List of fragments.

ast_tree.replace_asterisks_without_code(initial_text)

ast_tree.replace_asterisks(initial_text)

ast_tree.replace_terms(text, terms)

Replace terms with their definitions.

Parameters:

textstr

Text to replace terms.

termsdict

Dictionary containing the terms and their definitions.

Returns:

str

Text with the terms replaced.

ast_tree.ponctuation_whitespace(text, ponctuation)

ast_tree.resize_element_list(text, max_length=100, initial_indent='', subsequent_indent='')

ast_tree.parse_element(element)

Parse a single element.

ast_tree.parse_children(element)

Parse the children of an element.

Returns:

list

List of the children of the element.

ast_tree.get_parser()

ast_tree.CONV_EQN = False

ast_tree.XML_CLEANUP

ast_tree.CLEANUP

ast_tree.PY_ARG_CLEANUP

ast_tree.FORBIDDEN_ARGUMENT_NAMES = ['abs', 'char', 'class', 'dir', 'eval', 'format', 'id', 'int', 'iter', 'list', 'min', 'max',...

ast_tree.NAME_MAP_GLOB

ast_tree.NO_RESIZE_LIST = ['Variablelist', 'ItemizedList', 'SimpleList', 'Caution', 'XMLWarning', 'ProgramListing', 'Example']

ast_tree.MISSING_ARGUMENT_DESCRIPTION = Multiline-String

Show Value

"""The description of the argument is missing in the Python function.
Please, refer to the `command documentation `_ for further information."""

ast_tree.ADDITIONAL_ARGUMENT_DESCRIPTION = Multiline-String

Show Value

"""Additional arguments can be passed to the initial command.
Please, refer to the `command documentation `_ for further information."""

ast_tree.logger

ast_tree.superlatif = ['st', 'nd', 'rd', 'th']

ast_tree.parsers

ast_tree.item_needing_links_base_url

ast_tree.item_needing_fcache

ast_tree.item_needing_all