abqpy.decorators

Module Contents

Functions

class_or_module_link(→ Tuple[str, str])	Generate a link to the Abaqus class documentation.
method_or_function_link(→ Tuple[str, str])	Generate a link to the Abaqus function documentation.
add_link_in_class_or_module_docstring(→ str)	Add a link to the Abaqus documentation to the docstring for classes or modules.
add_link_in_method_or_function_docstring(→ str)	Add a link to the Abaqus documentation to the docstring for methods or functions.
abaqus_function_doc(func)	Add a link to the Abaqus documentation to the docstring of the function.
_process_class_name(→ str)	Process the class name.
abaqus_method_doc(method)	Add a link to the Abaqus documentation to the docstring of the method.
abaqus_class_doc(cls)	Add a link to the Abaqus documentation to the docstring of the class.

Attributes

add_link_in_class_docstring
add_link_in_module_docstring
add_link_in_method_docstring
add_link_in_function_docstring
class_suffix

class_or_module_link(type: str, class_or_module_name: str, prefix='', suffix='', label=None) → Tuple[str, str]

Generate a link to the Abaqus class documentation.

Parameters:

• type (str) – Type of the object, ‘class’ or ‘module’.

• class_or_module_name (str) – The name of the class or module.

• prefix (str) – The prefix to the class or module name.

• suffix (str) – The suffix to the class name.

• label (str) – The label to use for the link.

Returns:

• str – The link to the documentation.

• str – The link with label.

method_or_function_link(type: str, class_or_module_name: str, method_or_function_name: str, prefix='', suffix='', label=None) → Tuple[str, str]

Generate a link to the Abaqus function documentation.

Parameters:

• type (str) – Type of the object, ‘method’ or ‘function’.

• class_or_module_name (str) – The name of the module.

• method_or_function_name (str) – The name of the function.

• prefix (str) – The prefix to the class or module name.

• suffix (str) – The suffix to the class name.

• label (str) – The label to use for the link.

Returns:

• str – The link to the documentation.

• str – The link with label.

add_link_in_class_or_module_docstring(type: str, class_or_module_name: str, docstring: str, prefix='', suffix='', label=None) → str

Add a link to the Abaqus documentation to the docstring for classes or modules.

Parameters:

• type (str) – Type of the object, ‘class’ or ‘module’.

• class_or_module_name (str) – The name of the class or module.

• docstring (str) – The docstring.

• prefix (str) – The prefix to the class or module name.

• suffix (str) – The suffix to the class name.

• label (str) – The label to use for the link.

Returns:

The docstring with the link to the Abaqus documentation.

Return type:

str

add_link_in_class_docstring

add_link_in_module_docstring

add_link_in_method_or_function_docstring(type: str, class_or_module_name: str, method_or_function_name: str, docstring: str, prefix='', suffix='', label=None) → str

Add a link to the Abaqus documentation to the docstring for methods or functions.

Parameters:

• type (str) – Type of the object, ‘method’ or ‘function’.

• class_or_module_name (str) – The name of the module.

• method_or_function_name (str) – The name of the function.

• docstring (str) – The docstring.

• prefix (str) – The prefix to the class or module name.

• suffix (str) – The suffix to the class name.

• label (str) – The label to use for the link.

Returns:

The docstring with the link to the Abaqus documentation.

Return type:

str

add_link_in_method_docstring

add_link_in_function_docstring

abaqus_function_doc(func)

Add a link to the Abaqus documentation to the docstring of the function.

_process_class_name(class_name: str) → str

Process the class name.

class_suffix

abaqus_method_doc(method)

Add a link to the Abaqus documentation to the docstring of the method.

abaqus_class_doc(cls)

Add a link to the Abaqus documentation to the docstring of the class.