Coverage for python/lsst/daf/butler/script/queryDimensionRecords.py: 16%
31 statements
« prev ^ index » next coverage.py v7.3.1, created at 2023-10-02 08:00 +0000
« prev ^ index » next coverage.py v7.3.1, created at 2023-10-02 08:00 +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
36from .._butler import Butler
37from ..core import Timespan
40def queryDimensionRecords(
41 repo: str,
42 element: str,
43 datasets: tuple[str, ...],
44 collections: tuple[str, ...],
45 where: str,
46 no_check: bool,
47 order_by: tuple[str, ...],
48 limit: int,
49 offset: int,
50) -> Table | None:
51 """Query dimension records.
53 Docstring for supported parameters is the same as
54 `~lsst.daf.butler.Registry.queryDimensionRecords` except for ``no_check``,
55 which is the inverse of ``check``.
56 """
57 butler = Butler(repo, without_datastore=True)
59 query_collections: Iterable[str] | EllipsisType | None = None
60 if datasets:
61 query_collections = collections or ...
62 query_results = butler.registry.queryDimensionRecords(
63 element, datasets=datasets, collections=query_collections, where=where, check=not no_check
64 )
66 if order_by:
67 query_results = query_results.order_by(*order_by)
68 if limit > 0:
69 new_offset = offset if offset > 0 else None
70 query_results = query_results.limit(limit, new_offset)
72 records = list(query_results)
74 if not records:
75 return None
77 if not order_by:
78 # use the dataId to sort the rows if not ordered already
79 records.sort(key=lambda r: r.dataId)
81 keys = records[0].fields.names # order the columns the same as the record's `field.names`
83 def conform(v: Any) -> Any:
84 if isinstance(v, Timespan):
85 v = (v.begin, v.end)
86 elif isinstance(v, bytes):
87 v = "0x" + v.hex()
88 return v
90 return Table([[conform(getattr(record, key, None)) for record in records] for key in keys], names=keys)