Coverage for python/lsst/daf/butler/script/queryDimensionRecords.py: 16%
36 statements
« prev ^ index » next coverage.py v7.5.0, created at 2024-04-30 02:53 -0700
« prev ^ index » next coverage.py v7.5.0, created at 2024-04-30 02:53 -0700
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 Parameters
55 ----------
56 repo : `str`
57 Butler location.
58 element : `str`
59 Name of relevant dimension record.
60 datasets : `tuple` of `str`
61 Dataset types to restrict query by.
62 collections : `~collections.abc.Iterable` of `str`
63 Collections to search.
64 where : `str`
65 Query string.
66 no_check : `bool`
67 If `True` do not check the query for consistency.
68 order_by : `tuple` of `str`
69 Columns to order results by.
70 limit : `int`
71 Maximum number of results.
72 offset : `int`
73 Offset into the results.
75 Notes
76 -----
77 Docstring for supported parameters is the same as
78 `~lsst.daf.butler.Registry.queryDimensionRecords` except for ``no_check``,
79 which is the inverse of ``check``.
80 """
81 butler = Butler.from_config(repo, without_datastore=True)
83 query_collections: Iterable[str] | EllipsisType | None = None
84 if datasets:
85 query_collections = collections or ...
86 query_results = butler.registry.queryDimensionRecords(
87 element, datasets=datasets, collections=query_collections, where=where, check=not no_check
88 )
90 if order_by:
91 query_results = query_results.order_by(*order_by)
92 if limit > 0:
93 new_offset = offset if offset > 0 else None
94 query_results = query_results.limit(limit, new_offset)
96 records = list(query_results)
98 if not records:
99 return None
101 if not order_by:
102 # use the dataId to sort the rows if not ordered already
103 records.sort(key=lambda r: r.dataId)
105 # order the columns the same as the record's `field.names`, and add units
106 # to timespans
107 keys = records[0].fields.names
108 headers = ["timespan (TAI)" if name == "timespan" else name for name in records[0].fields.names]
110 def conform(v: Any) -> Any:
111 match v:
112 case Timespan():
113 v = str(v)
114 case bytes():
115 v = "0x" + v.hex()
116 case Region():
117 v = "(elided)"
118 return v
120 return Table([[conform(getattr(record, key, None)) for record in records] for key in keys], names=headers)