Coverage for python/lsst/daf/butler/_file_descriptor.py: 30%

28 statements  

« prev     ^ index     » next       coverage.py v7.4.0, created at 2024-01-25 10:50 +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/>. 

27from __future__ import annotations 

28 

29__all__ = ("FileDescriptor",) 

30 

31from collections.abc import Mapping 

32from typing import TYPE_CHECKING, Any 

33 

34if TYPE_CHECKING: 

35 from ._location import Location 

36 from ._storage_class import StorageClass 

37 

38 

39class FileDescriptor: 

40 """Describes a particular file. 

41 

42 Parameters 

43 ---------- 

44 location : `Location` 

45 Storage location. 

46 storageClass : `StorageClass` 

47 `StorageClass` associated with this file when it was stored. 

48 readStorageClass : `StorageClass`, optional 

49 Storage class associated with reading the file. Defines the 

50 Python type that the in memory Dataset will have. Will default 

51 to the ``storageClass`` if not specified. 

52 parameters : `dict`, optional 

53 Additional parameters that can be used for reading and writing. 

54 """ 

55 

56 __slots__ = ("location", "storageClass", "_readStorageClass", "parameters") 

57 

58 def __init__( 

59 self, 

60 location: Location, 

61 storageClass: StorageClass, 

62 readStorageClass: StorageClass | None = None, 

63 parameters: Mapping[str, Any] | None = None, 

64 ): 

65 self.location = location 

66 self._readStorageClass = readStorageClass 

67 self.storageClass = storageClass 

68 self.parameters = dict(parameters) if parameters is not None else None 

69 

70 def __repr__(self) -> str: 

71 optionals: dict[str, Any] = {} 

72 if self._readStorageClass is not None: 

73 optionals["readStorageClass"] = self._readStorageClass 

74 if self.parameters: 

75 optionals["parameters"] = self.parameters 

76 

77 # order is preserved in the dict 

78 options = ", ".join(f"{k}={v!r}" for k, v in optionals.items()) 

79 

80 r = f"{self.__class__.__name__}({self.location!r}, {self.storageClass!r}" 

81 if options: 

82 r = r + ", " + options 

83 r = r + ")" 

84 return r 

85 

86 @property 

87 def readStorageClass(self) -> StorageClass: 

88 """Storage class to use when reading. (`StorageClass`). 

89 

90 Will default to ``storageClass`` if none specified. 

91 """ 

92 if self._readStorageClass is None: 

93 return self.storageClass 

94 return self._readStorageClass