Coverage for python/lsst/daf/butler/script/queryDimensionRecords.py: 14%
26 statements
« prev ^ index » next coverage.py v7.2.5, created at 2023-05-03 09:15 +0000
« prev ^ index » next coverage.py v7.2.5, created at 2023-05-03 09:15 +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 program is free software: you can redistribute it and/or modify
10# it under the terms of the GNU General Public License as published by
11# the Free Software Foundation, either version 3 of the License, or
12# (at your option) any later version.
13#
14# This program is distributed in the hope that it will be useful,
15# but WITHOUT ANY WARRANTY; without even the implied warranty of
16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17# GNU General Public License for more details.
18#
19# You should have received a copy of the GNU General Public License
20# along with this program. If not, see <http://www.gnu.org/licenses/>.
22from __future__ import annotations
24from typing import Any
26from astropy.table import Table
28from .._butler import Butler
29from ..core import Timespan
32def queryDimensionRecords(
33 repo: str,
34 element: str,
35 datasets: tuple[str, ...],
36 collections: tuple[str, ...],
37 where: str,
38 no_check: bool,
39 order_by: tuple[str, ...],
40 limit: int,
41 offset: int,
42) -> Table | None:
43 # Docstring for supported parameters is the same as
44 # Registry.queryDimensionRecords except for ``no_check``, which is the
45 # inverse of ``check``.
47 butler = Butler(repo)
49 query_results = butler.registry.queryDimensionRecords(
50 element, datasets=datasets, collections=collections, where=where, check=not no_check
51 )
53 if order_by:
54 query_results = query_results.order_by(*order_by)
55 if limit > 0:
56 new_offset = offset if offset > 0 else None
57 query_results = query_results.limit(limit, new_offset)
59 records = list(query_results)
61 if not records:
62 return None
64 if not order_by:
65 # use the dataId to sort the rows if not ordered already
66 records.sort(key=lambda r: r.dataId)
68 keys = records[0].fields.names # order the columns the same as the record's `field.names`
70 def conform(v: Any) -> Any:
71 if isinstance(v, Timespan):
72 v = (v.begin, v.end)
73 elif isinstance(v, bytes):
74 v = "0x" + v.hex()
75 return v
77 return Table([[conform(getattr(record, key, None)) for record in records] for key in keys], names=keys)