Coverage for python/lsst/daf/butler/script/queryDimensionRecords.py: 16%
36 statements
« prev ^ index » next coverage.py v7.3.2, created at 2023-12-05 11:07 +0000
« prev ^ index » next coverage.py v7.3.2, created at 2023-12-05 11:07 +0000
1# This file is part of daf_butler.
2#
3# Developed for the LSST Data Management System.
4# This product includes software developed by the LSST Project
5# (http://www.lsst.org).
6# See the COPYRIGHT file at the top-level directory of this distribution
7# for details of code ownership.
8#
9# This software is dual licensed under the GNU General Public License and also
10# under a 3-clause BSD license. Recipients may choose which of these licenses
11# to use; please see the files gpl-3.0.txt and/or bsd_license.txt,
12# respectively. If you choose the GPL option then the following text applies
13# (but note that there is still no warranty even if you opt for BSD instead):
14#
15# This program is free software: you can redistribute it and/or modify
16# it under the terms of the GNU General Public License as published by
17# the Free Software Foundation, either version 3 of the License, or
18# (at your option) any later version.
19#
20# This program is distributed in the hope that it will be useful,
21# but WITHOUT ANY WARRANTY; without even the implied warranty of
22# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23# GNU General Public License for more details.
24#
25# You should have received a copy of the GNU General Public License
26# along with this program. If not, see <http://www.gnu.org/licenses/>.
28from __future__ import annotations
30from collections.abc import Iterable
31from types import EllipsisType
32from typing import Any
34from astropy.table import Table
35from lsst.sphgeom import Region
37from .._butler import Butler
38from .._timespan import Timespan
41def queryDimensionRecords(
42 repo: str,
43 element: str,
44 datasets: tuple[str, ...],
45 collections: tuple[str, ...],
46 where: str,
47 no_check: bool,
48 order_by: tuple[str, ...],
49 limit: int,
50 offset: int,
51) -> Table | None:
52 """Query dimension records.
54 Docstring for supported parameters is the same as
55 `~lsst.daf.butler.Registry.queryDimensionRecords` except for ``no_check``,
56 which is the inverse of ``check``.
57 """
58 butler = Butler.from_config(repo, without_datastore=True)
60 query_collections: Iterable[str] | EllipsisType | None = None
61 if datasets:
62 query_collections = collections or ...
63 query_results = butler.registry.queryDimensionRecords(
64 element, datasets=datasets, collections=query_collections, where=where, check=not no_check
65 )
67 if order_by:
68 query_results = query_results.order_by(*order_by)
69 if limit > 0:
70 new_offset = offset if offset > 0 else None
71 query_results = query_results.limit(limit, new_offset)
73 records = list(query_results)
75 if not records:
76 return None
78 if not order_by:
79 # use the dataId to sort the rows if not ordered already
80 records.sort(key=lambda r: r.dataId)
82 # order the columns the same as the record's `field.names`, and add units
83 # to timespans
84 keys = records[0].fields.names
85 headers = ["timespan (TAI)" if name == "timespan" else name for name in records[0].fields.names]
87 def conform(v: Any) -> Any:
88 match v:
89 case Timespan():
90 v = str(v)
91 case bytes():
92 v = "0x" + v.hex()
93 case Region():
94 v = "(elided)"
95 return v
97 return Table([[conform(getattr(record, key, None)) for record in records] for key in keys], names=headers)