Skip to content

Latest commit

 

History

History
63 lines (43 loc) · 2.77 KB

supported_tags.rst

File metadata and controls

63 lines (43 loc) · 2.77 KB
Raw

Supported YAML Tags

YAML allows defining custom so-called tags which can be distinguished during loading and serialization of objects. :pyparamspace makes heavy use of this possibility, as it greatly simplifies the definition and usage of configuration files.

:pyparamspace-related tags

The :pyparamspace.yaml module implements constructors and representers for the following classes:

  • !pspace constructs a :py~paramspace.paramspace.ParamSpace
  • !pdim constructs a :py~paramspace.paramdim.ParamDim
  • !coupled-pdim constructs a :py~paramspace.paramdim.CoupledParamDim

This is a very convenient way of defining these objects.

Hint

For the :py~paramspace.paramdim.ParamDim and derived classes, there additionally are the !pdim-default and !coupled-pdim-default tags. These do not create a :py~paramspace.paramdim.ParamDim objects but directly return the default value. By adding the -default in the end, they can be quickly deactivated inside the configuration file (as an alternative to commenting them out).

Python builtins and basic operators

:pyparamspace.yaml adds YAML constructors for a number of frequently used Python built-in functions and operators. Having these available while specifying configurations can make the definition of configurations files more versatile.

Warning

The YAML tags provided here are only meant to allow basic operations, i.e. summing two parameters to create a third. Don't overdo it. Configuration files should remain easy to read.

The tags shown below call the equivalent Python builtin or the operators defined in the operator Python module. Example:

../../tests/test_yaml.py

Recursively updating maps

While YAML already provides the << operator to update a mapping, this operator does not work recursively. The !rec-update YAML tag supplies exactly that functionality using the :py~paramspace.tools.recursive_update function.

../../tests/test_yaml.py

Warning

Always include via <<: *my_ref!

If supplying references to mappings (as shown in the example), the references have to be included using <<: *my_ref!

Otherwise, if using the simple *my_ref as argument, the YAML parser does not properly resolve the reference to the anchor but only returns an empty mapping.