PyR3.factory package

Subpackages

• PyR3.factory.fields package
  • Submodules
  • PyR3.factory.fields.Field module
    • Field
      • Field.clean_value()
      • Field.digest()
      • Field.get_default()
  • PyR3.factory.fields.Number module
    • Boolean
      • Boolean.clean_value()
    • Float
      • Float.check_if_in_range()
      • Float.clean_value()
    • Integer
      • Integer.check_if_in_range()
      • Integer.clean_value()
  • PyR3.factory.fields.Select module
    • Select
      • Select.clean_value()
      • Select.digest()
  • PyR3.factory.fields.String module
    • Regex
    • String
      • String.clean_value()
      • String.digest()
  • PyR3.factory.fields.Struct module
    • Struct
      • Struct.clean_value()
      • Struct.get_default()
    • StructNamespace
      • StructNamespace.dict()
  • PyR3.factory.fields.Unit module
    • Angle
      • Angle.parser
    • Length
      • Length.clean_value()
      • Length.digest()
      • Length.parser
  • Module contents

Submodules

PyR3.factory.MeshFactory module

class PyR3.factory.MeshFactory.MeshFactory(**MF_params)

Bases: object

Base class for a mesh factory object.

Mesh factory requires __doc__, __author__ and __version__ to be defined in mesh factory subclass, otherwise class instantiation will fail. Mesh factory can (and should) make use of Fields (subclasses of Field class) to specify mesh factory customization params. See PyR3.factory.fields modules for first-party fields. To specify field just set class attribute to instance of Field subclass. See MeshFactory usage.

static build_external(class_: str | MeshFactory, **params) → Objects

static build_external_direct_map(class_: str | MeshFactory, param_source: Mapping) → Objects

prevent_autoselect()

render(**kwargs)

PyR3.factory.MeshFactory.getfields(mesh_factory: MeshFactory) → Dict[str, Field]

Returns fields specified for given MeshFactory.

Parameters

mesh_factory (MeshFactory) – Object to fetch fields from.

Returns

dictionary of factory fields.

Return type

dict

PyR3.factory.MeshFactory.import_factory(class_: str)

Imports factory class from module.

Parameters

class (str) – python import name in form <python_module_import_path>.class

Raises

TypeError – Raised if requested class is not descendant of MeshFactory.

Module contents

PyR3.factory.build_and_save(generator_type: str, class_: str | MeshFactory, params: dict, save_path: Path)

PyR3.factory.build_from_file(src_file: Path, save_path: Path)

Build mesh using configuration from file. Later mesh is saved to save_path.

Parameters

• src_file (Path) – source configuration file.

• save_path (Path) – destination save path.

PyR3.factory.build_python(class_: str | MeshFactory, params: dict)