Coverage for python/lsst/daf/butler/core/composites.py : 29%

Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
# This file is part of daf_butler. # # Developed for the LSST Data Management System. # This product includes software developed by the LSST Project # (http://www.lsst.org). # See the COPYRIGHT file at the top-level directory of this distribution # for details of code ownership. # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>.
# Key to access disassembly information
"""Validate entries have the correct type.""" super().validate() # For now assume flat config with keys mapping to booleans for k, v in self[DISASSEMBLY_KEY].items(): if not isinstance(v, bool): raise ValueError(f"CompositesConfig: Key {k} is not a Boolean")
"""Determine whether a specific datasetType or StorageClass should be disassembled.
Parameters ---------- config : `str`, `ButlerConfig`, or `CompositesConfig` Configuration to control composites disassembly. """
if not isinstance(config, type(self)): config = CompositesConfig(config) assert isinstance(config, CompositesConfig) self.config = config
# Calculate the disassembly lookup table -- no need to process # the values self._lut = processLookupConfigs(self.config[DISASSEMBLY_KEY])
"""Given some choices, indicate whether the entity should be disassembled.
Parameters ---------- entity : `StorageClass` or `DatasetType` or `DatasetRef` Thing to test against the configuration. The ``name`` property is used to determine a match. A `DatasetType` will first check its name, before checking its `StorageClass`. If there are no matches the default will be returned. If the associated `StorageClass` is not a composite, will always return `False`.
Returns ------- disassemble : `bool` Returns `True` if disassembly should occur; `False` otherwise.
Raises ------ ValueError The supplied argument is not understood. """
if not hasattr(entity, "isComposite"): raise ValueError(f"Supplied entity ({entity}) is not understood.")
# If this is not a composite there is nothing to disassemble. if not entity.isComposite(): log.debug("%s will not be disassembled (not a composite)", entity) return False
matchName = "{} (via default)".format(entity) disassemble = self.config["default"]
for key in (entity._lookupNames()): if key is not None and key in self._lut: disassemble = self._lut[key] matchName = key break
log.debug("%s will%s be disassembled", matchName, "" if disassemble else " not") return disassemble |