replaceRoot

lsst.daf.butler.core.repoRelocation.replaceRoot(configRoot: str, butlerRoot: Union[str, urllib.parse.ParseResult, lsst.resources._resourcePath.ResourcePath, pathlib.Path, None]) → str

Update a configuration root with the butler root location.

No changes are made if the special root string is not found in the configuration entry. The name of the tag is defined in the module variable BUTLER_ROOT_TAG.

Parameters:

configRoot : str

Directory root location as specified in a configuration file.

butlerRoot : lsst.resources.ResourcePathExpression or None

Butler root directory. Absolute path is inserted into the configRoot where the BUTLER_ROOT_TAG string is found. Passing None here is allowed only as a convenient way to raise an exception (ValueError).

Returns:

newRoot : str

New configuration string, with the root tag replaced with the butler root if that tag was present in the supplied configuration root.

Raises:

ValueError

Raised if butlerRoot is not set but a value is required.