fgen_runtime.formatting

Formatting of fgen wrapped objects

get_attribute_str_value

get_attribute_str_value(instance, attribute)

Get the string version of an attribute’s value

Parameters:

• instance (fgen_runtime.base.FinalizableWrapperBase) – Instance from which to get the attribute

• attribute (str) – Attribute for which to get the value

Returns:

str – String version of the attribute’s value, with graceful handling of errors.

to_str

to_str(instance, exposed_attributes)

Convert an instance to its string representation

Parameters:

• instance (fgen_runtime.base.FinalizableWrapperBase) – Instance to convert

• exposed_attributes (collections.abc.Iterable[str]) – Attributes from Fortran that the instance exposes

Returns:

str – String representation of the instance

to_pretty

to_pretty(instance, exposed_attributes, p, cycle, indent=4)

Pretty-print an instance

Parameters:

• instance (fgen_runtime.base.FinalizableWrapperBase) – Instance to convert

• exposed_attributes (collections.abc.Iterable[str]) – Attributes from Fortran that the instance exposes

• p (typing.Any) – Pretty printing object

• cycle (bool) – Whether the pretty printer has detected a cycle or not.

• indent (int) – Indent to apply to the pretty printing group

Return type:

None

add_attribute_row

add_attribute_row(attribute_name, attribute_value, attribute_rows)

Add a row for displaying an attribute’s value to a list of rows

Parameters:

• attribute_name (str) – Attribute’s name

• attribute_value (str) – Attribute’s value

• attribute_rows (list[str]) – Existing attribute rows

Returns:

list[str] – Attribute rows, with the new row appended

to_html

to_html(instance, exposed_attributes)

Convert an instance to its html representation

Parameters:

• instance (fgen_runtime.base.FinalizableWrapperBase) – Instance to convert

• exposed_attributes (collections.abc.Iterable[str]) – Attributes from Fortran that the instance exposes

Returns:

str – HTML representation of the instance