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

31 statements  

« prev     ^ index     » next       coverage.py v7.2.7, created at 2023-06-28 10:10 +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/>. 

21 

22from __future__ import annotations 

23 

24from collections.abc import Iterable 

25from types import EllipsisType 

26from typing import Any 

27 

28from astropy.table import Table 

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 """Query dimension records. 

46 

47 Docstring for supported parameters is the same as 

48 `~lsst.daf.butler.Registry.queryDimensionRecords` except for ``no_check``, 

49 which is the inverse of ``check``. 

50 """ 

51 butler = Butler(repo) 

52 

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

54 if datasets: 

55 query_collections = collections if collections else ... 

56 query_results = butler.registry.queryDimensionRecords( 

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

58 ) 

59 

60 if order_by: 

61 query_results = query_results.order_by(*order_by) 

62 if limit > 0: 

63 new_offset = offset if offset > 0 else None 

64 query_results = query_results.limit(limit, new_offset) 

65 

66 records = list(query_results) 

67 

68 if not records: 

69 return None 

70 

71 if not order_by: 

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

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

74 

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

76 

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

78 if isinstance(v, Timespan): 

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

80 elif isinstance(v, bytes): 

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

82 return v 

83 

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