pyrevs.core.config

A configuration class to expose limited configuration.

Attributes

T

Classes

MergePolicy	A merge policy for configuration dataclasses.
Config	Lightweight structured access to configuration.

Functions

collect_sections(→ dict[str, Any])	Build a TOML-ready dict from config dataclasses.
merge_config(→ T)	Merge two configuration dataclass objects.
print_config_help(→ None)	Print a help for a pyREVS config dataclass.

Module Contents

T

class MergePolicy

A merge policy for configuration dataclasses.

IMMUTABLE = 'immutable'

REPLACE = 'replace'

class Config(data: collections.abc.Mapping[str, Any])

Lightweight structured access to configuration.

pyREVS input parameters are mostly handled through dataclasses to ensure default values are available and types are enforced: TOML file -> Config -> Typed dataclass.

The typed dataclass are the final object used to instanciate pyREVS objects (Sampler, Database, Trajectories, …)

The Config class provides a simple interface to access configuration parameters in a more structured way. To add a new section to the TOML input file, create a new dataclass with a __section__ class attribute set to the name of the section.

section(name: str) → Config

Return a configuration section.

section_dict(name: str) → dict[str, Any]

Return a section as dict.

require(section: str, key: str) → Any

Get a required parameter.

get(section: str, key: str, default: Any = None) → Any

Get an optional parameter.

as_dict() → dict[str, Any]

Return the config Mapping as a dict.

load(cls: type[T]) → T

Load a dataclass of the provided type from this config section.

collect_sections(*configs: Any) → dict[str, Any]

Build a TOML-ready dict from config dataclasses.

Each dataclass must define __section__.

merge_config(old: T, new: T) → T

Merge two configuration dataclass objects.

print_config_help(cls: type) → None

Print a help for a pyREVS config dataclass.