Coverage for python/lsst/daf/butler/script/queryDimensionRecords.py: 16%

31 statements  

« prev     ^ index     » next       coverage.py v7.2.5, created at 2023-05-17 02:31 -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 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/>. 

21 

22from __future__ import annotations 

23 

24from collections.abc import Iterable 

25from typing import Any 

26 

27from astropy.table import Table 

28from lsst.utils.ellipsis import Ellipsis, EllipsisType 

29 

30from .._butler import Butler 

31from ..core import Timespan 

32 

33 

34def queryDimensionRecords( 

35 repo: str, 

36 element: str, 

37 datasets: tuple[str, ...], 

38 collections: tuple[str, ...], 

39 where: str, 

40 no_check: bool, 

41 order_by: tuple[str, ...], 

42 limit: int, 

43 offset: int, 

44) -> Table | None: 

45 # Docstring for supported parameters is the same as 

46 # Registry.queryDimensionRecords except for ``no_check``, which is the 

47 # inverse of ``check``. 

48 

49 butler = Butler(repo) 

50 

51 query_collections: Iterable[str] | EllipsisType | None = None 

52 if datasets: 

53 query_collections = collections if collections else Ellipsis 

54 query_results = butler.registry.queryDimensionRecords( 

55 element, datasets=datasets, collections=query_collections, where=where, check=not no_check 

56 ) 

57 

58 if order_by: 

59 query_results = query_results.order_by(*order_by) 

60 if limit > 0: 

61 new_offset = offset if offset > 0 else None 

62 query_results = query_results.limit(limit, new_offset) 

63 

64 records = list(query_results) 

65 

66 if not records: 

67 return None 

68 

69 if not order_by: 

70 # use the dataId to sort the rows if not ordered already 

71 records.sort(key=lambda r: r.dataId) 

72 

73 keys = records[0].fields.names # order the columns the same as the record's `field.names` 

74 

75 def conform(v: Any) -> Any: 

76 if isinstance(v, Timespan): 

77 v = (v.begin, v.end) 

78 elif isinstance(v, bytes): 

79 v = "0x" + v.hex() 

80 return v 

81 

82 return Table([[conform(getattr(record, key, None)) for record in records] for key in keys], names=keys)