21 from __future__
import annotations
23 __all__ = [
"RepoConverter"]
25 from dataclasses
import dataclass
26 from collections
import defaultdict
27 from abc
import ABC, abstractmethod
44 from lsst.daf.butler
import DataCoordinate, FileDataset, DatasetType
45 from lsst.sphgeom
import RangeSet, Region
46 from .repoWalker
import RepoWalker
49 from ..mapping
import Mapping
as CameraMapperMapping
50 from .convertRepo
import ConvertRepoTask
51 from .scanner
import PathElementHandler
52 from lsst.daf.butler
import StorageClass, Registry, SkyPixDimension, FormatterParameter
53 from .._instrument
import Instrument
58 """A helper class for `ConvertRepoTask` and `RepoConverter` that maintains
59 lists of related data ID values that should be included in the conversion.
64 Instrument name used in Gen3 data IDs.
65 visits : `set` of `int`
66 Visit IDs that define the filter.
69 def __init__(self, instrument: str, visits: Set[int]):
77 """Populate the included tract IDs for the given skymap from those that
78 overlap the visits the `ConversionSubset` was initialized with.
82 registry : `lsst.daf.butler.Registry`
83 Registry that can be queried for visit/tract overlaps.
85 SkyMap name used in Gen3 data IDs.
90 for dataId
in registry.queryDataIds([
"tract"],
91 dataId={
"skymap": name,
94 tracts.add(dataId[
"tract"])
96 def addSkyPix(self, registry: Registry, dimension: SkyPixDimension):
97 """Populate the included skypix IDs for the given dimension from those
98 that overlap the visits the `ConversionSubset` was initialized with.
102 registry : `lsst.daf.butler.Registry`
103 Registry that can be queried for visit regions.
105 SkyMap name used in Gen3 data IDs.
110 dataId = registry.expandDataId(instrument=self.
instrument, visit=visit)
111 self.
regions.append(dataId.region)
114 ranges = ranges.union(dimension.pixelization.envelope(region))
115 self.
skypix[dimension] = ranges
118 """Test whether the given data ID is related to this subset and hence
119 should be included in a repository conversion.
123 dataId : `lsst.daf.butler.DataCoordinate`
129 `True` if this data ID should be included in a repository
134 More formally, this tests that the given data ID is not unrelated;
135 if a data ID does not involve tracts, visits, or skypix dimensions,
136 we always include it.
141 if "visit" in dataId.graph
and dataId[
"visit"]
not in self.
visits:
143 if "tract" in dataId.graph
and dataId[
"tract"]
not in self.
tracts[dataId[
"skymap"]]:
145 for dimension, ranges
in self.
skypix.items():
146 if dimension
in dataId.graph
and not ranges.intersects(dataId[dimension]):
154 """The name of the instrument, as used in Gen3 data IDs (`str`).
158 """The set of visit IDs that should be included in the conversion (`set`
162 regions: Optional[List[Region]]
163 """Regions for all visits (`list` of `lsst.sphgeom.Region`).
165 Set to `None` before it has been initialized. Any code that attempts to
166 use it when it is `None` has a logic bug.
169 tracts: Dict[str, Set[int]]
170 """Tracts that should be included in the conversion, grouped by skymap
171 name (`dict` mapping `str` to `set` of `int`).
174 skypix: Dict[SkyPixDimension, RangeSet]
175 """SkyPix ranges that should be included in the conversion, grouped by
176 dimension (`dict` mapping `SkyPixDimension` to `lsst.sphgeom.RangeSet`).
181 """An abstract base class for objects that help `ConvertRepoTask` convert
182 datasets from a single Gen2 repository.
186 task : `ConvertRepoTask`
187 Task instance that is using this helper object.
189 Root of the Gen2 repo being converted. Will be converted to an
190 absolute path, resolving symbolic links and ``~``, if necessary.
191 instrument : `Instrument`
192 Gen3 instrument class to use for this conversion.
193 collections : `list` of `str`
194 Gen3 collections with which all converted datasets should be
196 subset : `ConversionSubset, optional
197 Helper object that implements a filter that restricts the data IDs that
202 `RepoConverter` defines the only public API users of its subclasses should
203 use (`prep` `ingest`, and `finish`). These delegate to several abstract
204 methods that subclasses must implement. In some cases, subclasses may
205 reimplement the public methods as well, but are expected to delegate to
206 ``super()`` either at the beginning or end of their own implementation.
209 def __init__(self, *, task: ConvertRepoTask, root: str, instrument: Instrument, run: Optional[str],
210 subset: Optional[ConversionSubset] =
None):
212 self.
root = os.path.realpath(os.path.expanduser(root))
217 self._fileDatasets: Mapping[DatasetType, Mapping[Optional[str], List[FileDataset]]] \
218 = defaultdict(
lambda: defaultdict(list))
222 """Test whether the given dataset is handled specially by this
223 converter and hence should be ignored by generic base-class logic that
224 searches for dataset types to convert.
228 datasetTypeName : `str`
229 Name of the dataset type to test.
234 `True` if the dataset type is special.
236 raise NotImplementedError()
240 """Iterate over all `CameraMapper` `Mapping` objects that should be
241 considered for conversion by this repository.
243 This this should include any datasets that may appear in the
244 repository, including those that are special (see
245 `isDatasetTypeSpecial`) and those that are being ignored (see
246 `ConvertRepoTask.isDatasetTypeIncluded`); this allows the converter
247 to identify and hence skip these datasets quietly instead of warning
248 about them as unrecognized.
252 datasetTypeName: `str`
253 Name of the dataset type.
254 mapping : `lsst.obs.base.mapping.Mapping`
255 Mapping object used by the Gen2 `CameraMapper` to describe the
258 raise NotImplementedError()
262 storageClass: StorageClass,
263 formatter: FormatterParameter =
None,
264 targetHandler: Optional[PathElementHandler] =
None,
265 ) -> RepoWalker.Target:
266 """Make a struct that identifies a dataset type to be extracted by
267 walking the repo directory structure.
271 datasetTypeName : `str`
272 Name of the dataset type (the same in both Gen2 and Gen3).
274 The full Gen2 filename template.
275 keys : `dict` [`str`, `type`]
276 A dictionary mapping Gen2 data ID key to the type of its value.
277 storageClass : `lsst.daf.butler.StorageClass`
278 Gen3 storage class for this dataset type.
279 formatter : `lsst.daf.butler.Formatter` or `str`, optional
280 A Gen 3 formatter class or fully-qualified name.
281 targetHandler : `PathElementHandler`, optional
282 Specialist target handler to use for this dataset type.
286 target : `RepoWalker.Target`
287 A struct containing information about the target dataset (much of
288 it simplify forwarded from the arguments).
290 raise NotImplementedError()
293 """Return a list of directory paths that should not be searched for
296 These may be directories that simply do not contain datasets (or
297 contain datasets in another repository), or directories whose datasets
298 are handled specially by a subclass.
302 directories : `list` [`str`]
303 The full paths of directories to skip, relative to the repository
309 """Perform preparatory work associated with the dataset types to be
310 converted from this repository (but not the datasets themselves).
314 This should be a relatively fast operation that should not depend on
315 the size of the repository.
317 Subclasses may override this method, but must delegate to the base
318 class implementation at some point in their own logic.
319 More often, subclasses will specialize the behavior of `prep` by
320 overriding other methods to which the base class implementation
321 delegates. These include:
323 - `isDatasetTypeSpecial`
324 - `getSpecialDirectories`
325 - `makeRepoWalkerTarget`
327 This should not perform any write operations to the Gen3 repository.
328 It is guaranteed to be called before `ingest`.
330 self.
task.log.info(f
"Preparing other dataset types from root {self.root}.")
331 walkerInputs: List[Union[RepoWalker.Target, RepoWalker.Skip]] = []
334 template = mapping.template
343 if (
not self.
task.isDatasetTypeIncluded(datasetTypeName)
350 if storageClass
is None:
355 message = f
"no storage class found for {datasetTypeName}"
358 if template.endswith(
".fits"):
359 extensions.extend((
".gz",
".fz"))
360 for extension
in extensions:
362 walkerInput = RepoWalker.Skip(
363 template=template+extension,
367 self.
task.log.debug(
"Skipping template in walker: %s", template)
369 assert message
is None
370 targetHandler = self.
task.config.targetHandlerClasses.get(datasetTypeName)
371 if targetHandler
is not None:
372 targetHandler = doImport(targetHandler)
374 datasetTypeName=datasetTypeName,
375 template=template+extension,
377 storageClass=storageClass,
378 formatter=self.
task.config.formatterClasses.get(datasetTypeName),
379 targetHandler=targetHandler,
381 self.
task.log.debug(
"Adding template to walker: %s + %s, for %s", template, extension,
382 walkerInput.datasetType)
383 walkerInputs.append(walkerInput)
394 fileIgnoreRegExTerms = []
395 for pattern
in self.
task.config.fileIgnorePatterns:
396 fileIgnoreRegExTerms.append(fnmatch.translate(pattern))
397 if fileIgnoreRegExTerms:
398 fileIgnoreRegEx = re.compile(
"|".join(fileIgnoreRegExTerms))
400 fileIgnoreRegEx =
None
402 log=self.
task.log.getChild(
"repoWalker"))
405 """Iterate over datasets in the repository that should be ingested into
408 The base class implementation yields nothing; the datasets handled by
409 the `RepoConverter` base class itself are read directly in
412 Subclasses should override this method if they support additional
413 datasets that are handled some other way.
417 dataset : `FileDataset`
418 Structures representing datasets to be ingested. Paths should be
424 assert self.
_repoWalker,
"prep() must be called before findDatasets."
425 self.
task.log.info(
"Adding special datasets in repo %s.", self.
root)
427 assert len(dataset.refs) == 1
430 self._fileDatasets[dataset.refs[0].datasetType][
None].append(dataset)
431 self.
task.log.info(
"Finding datasets from files in repo %s.", self.
root)
432 datasetsByTypeAndCalibDate = self.
_repoWalker.walk(
434 predicate=(self.
subset.isRelated
if self.
subset is not None else None)
436 for datasetType, datasetsByCalibDate
in datasetsByTypeAndCalibDate.items():
437 for calibDate, datasets
in datasetsByCalibDate.items():
438 self._fileDatasets[datasetType][calibDate].extend(datasets)
441 """Expand the data IDs for all datasets to be inserted.
443 Subclasses may override this method, but must delegate to the base
444 class implementation if they do.
446 This involves queries to the registry, but not writes. It is
447 guaranteed to be called between `findDatasets` and `ingest`.
450 for datasetType, datasetsByCalibDate
in self._fileDatasets.items():
451 for calibDate, datasetsForCalibDate
in datasetsByCalibDate.items():
452 self.
task.log.info(
"Expanding data IDs for %s %s datasets.", len(datasetsByCalibDate),
455 for dataset
in datasetsForCalibDate:
456 for i, ref
in enumerate(dataset.refs):
458 dataId = self.
task.registry.expandDataId(ref.dataId)
459 dataset.refs[i] = ref.expanded(dataId)
460 except LookupError
as err:
461 self.
task.log.warn(
"Skipping ingestion for '%s': %s", dataset.path, err)
463 dataset.refs[i] =
None
464 dataset.refs[:] = itertools.filterfalse(
lambda x: x
is None, dataset.refs)
466 expanded.append(dataset)
467 datasetsForCalibDate[:] = expanded
470 """Insert converted datasets into the Gen3 repository.
472 Subclasses may override this method, but must delegate to the base
473 class implementation at some point in their own logic.
475 This method is guaranteed to be called after `expandDataIds`.
477 for datasetType, datasetsByCalibDate
in self._fileDatasets.items():
478 self.
task.registry.registerDatasetType(datasetType)
479 for calibDate, datasetsForCalibDate
in datasetsByCalibDate.items():
481 run = self.
getRun(datasetType.name, calibDate)
483 self.
task.log.warn(f
"No run configured for dataset type {datasetType.name}.")
485 self.
task.log.info(
"Ingesting %s %s datasets into run %s.", len(datasetsForCalibDate),
486 datasetType.name, run)
488 self.
task.registry.registerRun(run)
489 self.
task.butler3.ingest(*datasetsForCalibDate, transfer=self.
task.config.transfer,
491 except LookupError
as err:
493 f
"Error expanding data ID for dataset type {datasetType.name}."
498 self.
_finish(self._fileDatasets)
500 def _finish(self, datasets: Mapping[DatasetType, Mapping[Optional[str], List[FileDataset]]]) ->
None:
504 def getRun(self, datasetTypeName: str, calibDate: Optional[str] =
None) -> str:
505 """Return the name of the run to insert instances of the given dataset
506 type into in this collection.
510 datasetTypeName : `str`
511 Name of the dataset type.
512 calibDate : `str`, optional
513 If not `None`, the "CALIBDATE" associated with this (calibration)
514 dataset in the Gen2 data repository.
519 Name of the `~lsst.daf.butler.CollectionType.RUN` collection.
521 assert self.
_run is not None,
"Method must be overridden if self._run is allowed to be None"
522 assert calibDate
is None,
"Method must be overridden if calibDate is allowed to be not None"
525 def _guessStorageClass(self, datasetTypeName: str, mapping: CameraMapperMapping
526 ) -> Optional[StorageClass]:
527 """Infer the Gen3 `StorageClass` from a dataset from a combination of
528 configuration and Gen2 dataset type information.
530 datasetTypeName: `str`
531 Name of the dataset type.
532 mapping : `lsst.obs.base.mapping.Mapping`
533 Mapping object used by the Gen2 `CameraMapper` to describe the
536 storageClassName = self.
task.config.storageClasses.get(datasetTypeName)
537 if storageClassName
is None and mapping.python
is not None:
538 storageClassName = self.
task.config.storageClasses.get(mapping.python,
None)
539 if storageClassName
is None and mapping.persistable
is not None:
540 storageClassName = self.
task.config.storageClasses.get(mapping.persistable,
None)
541 if storageClassName
is None and mapping.python
is not None:
542 unqualified = mapping.python.split(
".")[-1]
543 storageClassName = self.
task.config.storageClasses.get(unqualified,
None)
544 if storageClassName
is not None:
545 storageClass = self.
task.butler3.storageClasses.getStorageClass(storageClassName)
548 storageClass = self.
task.butler3.storageClasses.getStorageClass(mapping.persistable)
551 if storageClass
is None and mapping.python
is not None:
553 storageClass = self.
task.butler3.storageClasses.getStorageClass(unqualified)
556 if storageClass
is None:
557 self.
task.log.debug(
"No StorageClass found for %s; skipping.", datasetTypeName)
559 self.
task.log.debug(
"Using StorageClass %s for %s.", storageClass.name, datasetTypeName)
565 task: ConvertRepoTask
566 """The parent task that constructed and uses this converter
571 """Root path to the Gen2 repository this converter manages (`str`).
573 This is a complete path, not relative to some other repository root.
576 subset: Optional[ConversionSubset]
577 """An object that represents a filter to be applied to the datasets that
578 are converted (`ConversionSubset` or `None`).