pydoit_nb.config_handling

Tools for working with configuration

insert_path_prefix

insert_path_prefix(config, prefix)

Insert path prefix into config attributes

This adds the prefix prefix to any attributes of config which are Path

Parameters:

• config (typing.TypeVar(AI, bound= attr.AttrsInstance)) – Config to update

• prefix (pathlib.Path) – Prefix to add to paths

Returns:

typing.TypeVar(AI, bound= attr.AttrsInstance) – Updated config

iterable_values_are_updatable

iterable_values_are_updatable(value)

Determine whether an iterable’s values are updatable by insert_path_prefix().

Parameters:

value (collections.abc.Iterable[typing.Any]) – Value to check.

Returns:

bool – True if value’s elements can be updated by update_attr_value(), False otherwise.

update_attr_value

update_attr_value(value, prefix)

Update the attribute value if it is Path to include the prefix

The prefix is taken from the outer scope

Parameters:

• value (typing.Union[attr.AttrsInstance, pathlib.Path, typing.TypeVar(T)]) – Value to update

• prefix (pathlib.Path) – Prefix to insert before paths if value is an instance of Path

Returns:

typing.Union[attr.AttrsInstance, pathlib.Path, typing.TypeVar(T)] – Updated value

get_step_config_ids

get_step_config_ids(step_configs)

Get available config IDs from an iterable of step configurations

Parameters:

step_configs (collections.abc.Iterable[pydoit_nb.typing.NotebookConfigLike]) – Step configurations from which to retrieve the step config IDs

Returns:

list[str] – Step config ID from each step config in step_configs

Raises:

AttributeError – Any object in step_configs is missing a “step_config_id” attribute.

get_config_for_step_id

get_config_for_step_id(config, step, step_config_id)

Get configuration for a specific value of step config ID for a specific step

This will fail if step isn’t a part of config

Parameters:

• config (typing.Any) – Config from which to retrieve the step config

• step (str) – Step in config in which to find a step that has the a step config ID equal to step_config_id

• step_config_id (str) – Value that the retrieved configuration’s step_config_id must match

Returns:

typing.Any – Configuration for step step in config with a step config ID equal to step_config_id

Raises:

• ValueError – No step could be found with ID equal to step_config_id

• AttributeError – config does not have a an attribute equal to the value given in step

load_hydrate_write_config_bundle

load_hydrate_write_config_bundle(configuration_file, load_configuration_file, create_config_bundle, root_dir_output_run, converter)

Load, hydrate and write (to disk) ConfigBundleLike

Parameters:

• configuration_file (pathlib.Path) – File from which to load the configuration

• load_configuration_file (typing.Callable[[pathlib.Path], typing.TypeVar(AI, bound= attr.AttrsInstance)]) – Callable to use to load the configuration from a file

• create_config_bundle (pydoit_nb.typing.ConfigBundleCreator[typing.TypeVar(AI, bound= attr.AttrsInstance), typing.TypeVar(CB, bound= pydoit_nb.typing.ConfigBundleLike[typing.Any])]) – Callable to use to create the ConfigBundleLike from the loaded configuration, the path in which the hydrated config will be written and the run’s output root directory.

• root_dir_output_run (pathlib.Path) – Root directory in which to write output for this run

• converter (pydoit_nb.typing.Converter) – Converter to use to serialise the output ConfigBundleLike to disk

Returns:

typing.TypeVar(CB, bound= pydoit_nb.typing.ConfigBundleLike[typing.Any]) – Loaded ConfigBundleLike