replaceRoot¶
-
lsst.daf.butler.core.repoRelocation.
replaceRoot
(configRoot: str, butlerRoot: Union[lsst.daf.butler.core._butlerUri._butlerUri.ButlerURI, str, 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 :
str
,ButlerURI
orNone
Butler root directory. Absolute path is inserted into the
configRoot
where theBUTLER_ROOT_TAG
string is found. PassingNone
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.
- configRoot :