fgen.data_models.serialisation

Serialisation of our data models

UnstructuredEnumValue

class UnstructuredEnumValue

Bases: TypedDict

Unstructured enum value type hint

UnstructuredEnumDefinition

class UnstructuredEnumDefinition

Bases: TypedDict

Unstructured enum definition type hint

UnstructuredEnumDefiningModule

class UnstructuredEnumDefiningModule

Bases: TypedDict

Unstructured enum defining module

load_module_definition

load_module_definition(filename)

Read a YAML module definition file

This module definition contains a description of the Fortran module that is being wrapped.

Parameters:

filename (str) – Filename to read

Returns:

fgen.data_models.module.Module – Loaded module definition

load_enum_defining_module

load_enum_defining_module(file)

Read a YAML enum defining module definition file

This enum defining module file contains a description of a Fortran module that exposes an enum.

Parameters:

filename – Filename to read

Returns:

fgen.data_models.module_enum_defining.ModuleEnumDefining – Loaded definition of the enum defining module