Config¶

Bases: MutableMapping

Implements a datatype that is used by Butler for configuration.

It is essentially a dict with key/value pairs, including nested dicts (as values). In fact, it can be initialized with a dict. This is explained next:

Config extends the dict api so that hierarchical values may be accessed with delimited notation or as a tuple. If a string is given the delimiter is picked up from the first character in that string. For example, foo.getValue(".a.b.c"), foo["a"]["b"]["c"], foo["a", "b", "c"], foo[".a.b.c"], and foo["/a/b/c"] all achieve the same outcome. If the first character is alphanumeric, no delimiter will be used. foo["a.b.c"] will be a single key a.b.c as will foo[":a.b.c"]. Unicode characters can be used as the delimiter for distinctiveness if required.

If a key in the hierarchy starts with a non-alphanumeric character care should be used to ensure that either the tuple interface is used or a distinct delimiter is always given in string form.

Finally, the delimiter can be escaped if it is part of a key and also has to be used as a delimiter. For example, foo[r".a.b\.c"] results in a two element hierarchy of a and b.c. For hard-coded strings it is always better to use a different delimiter in these cases.

Note that adding a multi-level key implicitly creates any nesting levels that do not exist, but removing multi-level keys does not automatically remove empty nesting levels. As a result:

>>> c = Config()
>>> c[".a.b"] = 1
>>> del c[".a.b"]
>>> c["a"]
Config({'a': {}})

Storage formats supported:

yaml: read and write is supported.
json: read and write is supported but no !include directive.

Parameters:

otherlsst.resources.ResourcePath or Config or dict

Other source of configuration, can be:

(lsst.resources.ResourcePathExpression) Treated as a URI to a config file. Must end with “.yaml”.
(Config) Copies the other Config’s values into this one.
(dict) Copies the values from the dict into this Config.

If None is provided an empty Config will be created.

Attributes Summary

`includeKey`	Key used to indicate that another config should be included at this part of the hierarchy.
`resourcesPackage`	Package to search for default configuration data.

Methods Summary

`asArray`(name)	Get a value as an array.
`clear`()
`copy`()
`dump`([output, format])	Write the config to an output stream.
`dumpToUri`(uri[, updateFile, ...])	Write the config to location pointed to by given URI.
`fromString`(string[, format])	Create a new Config instance from a serialized string.
`fromYaml`(string)	Create a new Config instance from a YAML string.
`get`(k[,d])
`items`()
`keys`()
`merge`(other)	Merge another Config into this one.
`nameTuples`([topLevelOnly])	Get tuples representing the name hierarchies of all keys.
`names`([topLevelOnly, delimiter])	Get a delimited name of all the keys in the hierarchy.
`pop`(k[,d])	If key is not found, d is returned if given, otherwise KeyError is raised.
`popitem`()	as a 2-tuple; but raise KeyError if D is empty.
`ppprint`()	Return config as formatted readable string.
`setdefault`(k[,d])
`toDict`()	Convert a `Config` to a standalone hierarchical `dict`.
`update`(other)	Update config from other `Config` or `dict`.
`updateParameters`(configType, config, full[, ...])	Update specific config parameters.
`values`()

Attributes Documentation

includeKey: ClassVar[str] = 'includeConfigs'¶: Key used to indicate that another config should be included at this part of the hierarchy.

resourcesPackage: str = 'lsst.daf.butler'¶: Package to search for default configuration data. The resources themselves will be within a configs resource hierarchy.

Methods Documentation

asArray(name: str | Sequence[str]) → Sequence[Any]¶

Get a value as an array.

May contain one or more elements.

Parameters:

namestr: Key to use to retrieve value.

Returns:

arraycollections.abc.Sequence: The value corresponding to name, but guaranteed to be returned as a list with at least one element. If the value is a Sequence (and not a str) the value itself will be returned, else the value will be the first element.

clear() → None. Remove all items from D.¶

copy() → Config¶

dump(output: IO | None = None, format: str = 'yaml') → str | None¶

Write the config to an output stream.

Parameters:

outputIO, optional: The stream to use for output. If None the serialized content will be returned.
formatstr, optional: The format to use for the output. Can be “yaml” or “json”.

Returns:

serializedstr or None: If a stream was given the stream will be used and the return value will be None. If the stream was None the serialization will be returned as a string.

dumpToUri(uri: str | ParseResult | ResourcePath | Path, updateFile: bool = True, defaultFileName: str = 'butler.yaml', overwrite: bool = True) → None¶

Write the config to location pointed to by given URI.

Currently supports ‘s3’ and ‘file’ URI schemes.

Parameters:

uri: `lsst.resources.ResourcePathExpression`: URI of location where the Config will be written.
updateFilebool, optional: If True and uri does not end on a filename with extension, will append defaultFileName to the target uri. True by default.
defaultFileNamebool, optional: The file name that will be appended to target uri if updateFile is True and uri does not end on a file with an extension.
overwritebool, optional: If True the configuration will be written even if it already exists at that location.

classmethod fromString(string: str, format: str = 'yaml') → Config¶

Create a new Config instance from a serialized string.

Parameters:

stringstr: String containing content in specified format
formatstr, optional: Format of the supplied string. Can be json or yaml.

Returns:

cConfig: Newly-constructed Config.

classmethod fromYaml(string: str) → Config¶

Create a new Config instance from a YAML string.

Parameters:

stringstr: String containing content in YAML format

Returns:

cConfig: Newly-constructed Config.

get(k[, d]) → D[k] if k in D, else d. d defaults to None.¶

items() → a set-like object providing a view on D's items¶

keys() → a set-like object providing a view on D's keys¶

merge(other: Mapping) → None¶

Merge another Config into this one.

Like Config.update(), but will add keys & values from other that DO NOT EXIST in self.

Keys and values that already exist in self will NOT be overwritten.

Parameters:

otherdict or Config: Source of configuration:

nameTuples(topLevelOnly: bool = False) → list[tuple[str, ...]]¶

Get tuples representing the name hierarchies of all keys.

The tuples returned from this method are guaranteed to be usable to access items in the configuration object.

Parameters:

topLevelOnlybool, optional: If False, the default, a full hierarchy of names is returned. If True, only the top level are returned.

Returns:

nameslist of tuple of str: List of all names present in the Config where each element in the list is a tuple of strings representing the hierarchy.

names(topLevelOnly: bool = False, delimiter: str | None = None) → list[str]¶

Get a delimited name of all the keys in the hierarchy.

The values returned from this method are guaranteed to be usable to access items in the configuration object.

Parameters:

topLevelOnlybool, optional: If False, the default, a full hierarchy of names is returned. If True, only the top level are returned.
delimiterstr, optional: Delimiter to use when forming the keys. If the delimiter is present in any of the keys, it will be escaped in the returned names. If None given a delimiter will be automatically provided. The delimiter can not be alphanumeric.

Returns:

nameslist of str: List of all names present in the Config.

Raises:

ValueError:: The supplied delimiter is alphanumeric.

Notes

This is different than the built-in method dict.keys, which will return only the first level keys.

pop(k[, d]) → v, remove specified key and return the corresponding value.¶: If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() → (k, v), remove and return some (key, value) pair¶: as a 2-tuple; but raise KeyError if D is empty.

ppprint() → str¶

Return config as formatted readable string.

Returns:

sstr: A prettyprint formatted string representing the config

Examples

use: pdb> print(myConfigObject.ppprint())

setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D¶

toDict() → dict[str, Any]¶

Convert a Config to a standalone hierarchical dict.

Returns:

ddict: The standalone hierarchical dict with any Config classes in the hierarchy converted to dict.

Notes

This can be useful when passing a Config to some code that expects native Python types.

update(other: Mapping[str, Any]) → None¶

Update config from other Config or dict.

Like dict.update(), but will add or modify keys in nested dicts, instead of overwriting the nested dict entirely.

Parameters:

otherdict or Config: Source of configuration:

Examples

>>> c = Config({"a": {"b": 1}})
>>> c.update({"a": {"c": 2}})
>>> print(c)
{'a': {'b': 1, 'c': 2}}

>>> foo = {"a": {"b": 1}}
>>> foo.update({"a": {"c": 2}})
>>> print(foo)
{'a': {'c': 2}}

static updateParameters(configType: type[lsst.daf.butler.core.config.ConfigSubset], config: Config, full: Config, toUpdate: dict[str, Any] | None = None, toCopy: Sequence[str | Sequence[str]] | None = None, overwrite: bool = True, toMerge: Sequence[str | Sequence[str]] | None = None) → None¶

Update specific config parameters.

Allows for named parameters to be set to new values in bulk, and for other values to be set by copying from a reference config.

Assumes that the supplied config is compatible with configType and will attach the updated values to the supplied config by looking for the related component key. It is assumed that config and full are from the same part of the configuration hierarchy.

Parameters:

configTypeConfigSubset

Config type to use to extract relevant items from config.

configConfig

A Config to update. Only the subset understood by the supplied ConfigSubset will be modified. Default values will not be inserted and the content will not be validated since mandatory keys are allowed to be missing until populated later by merging.

fullConfig

A complete config with all defaults expanded that can be converted to a configType. Read-only and will not be modified by this method. Values are read from here if toCopy is defined.

Repository-specific options that should not be obtained from defaults when Butler instances are constructed should be copied from full to config.

toUpdatedict, optional

A dict defining the keys to update and the new value to use. The keys and values can be any supported by Config assignment.

toCopytuple, optional

tuple of keys whose values should be copied from full into config.

overwritebool, optional

If False, do not modify a value in config if the key already exists. Default is always to overwrite.

toMergetuple, optional

Keys to merge content from full to config without overwriting pre-existing values. Only works if the key refers to a hierarchy. The overwrite flag is ignored.

Raises:

ValueError: Neither toUpdate, toCopy nor toMerge were defined.

values() → an object providing a view on D's values¶

Navigation

Config¶