gemseo.formulations.base_factory module#

A factory of formulations.

class BaseFormulationFactory[source]#

Bases: BaseFactory[BaseFormulation]

A factory of BaseFormulation.

Return type:

Any

get_default_option_values(name)[source]#

Return the default values for the keyword arguments of a class.

Parameters:

name (str) -- The name of the class.

Returns:

The mapping from the keyword argument names to their default values.

Return type:

StrKeyMapping

get_default_sub_option_values(name, **options)[source]#

Return the default values of the sub options of a class.

Parameters:

  • name (str) -- The name of the class.

  • **options (str) -- The options to be passed to the class required to deduce the sub options.

Returns:

The JSON grammar.

Return type:

StrKeyMapping

get_options_doc(name)[source]#

Return the documentation for the arguments of a class.

Parameters:

name (str) -- The name of the class.

Returns:

The mapping from the argument names to their documentation.

Return type:

dict[str, str]

get_sub_options_grammar(name, **options)[source]#

Return the JSONGrammar of the sub options of a class.

Parameters:

  • name (str) -- The name of the class.

  • **options (str) -- The options to be passed to the class required to deduce the sub options.

Returns:

The JSON grammar.

Return type:

JSONGrammar

failed_imports: dict[str, str]#

The class names bound to the import errors.