Coverage for python/lsst/sphgeom/_yaml.py: 63%

42 statements  

« prev     ^ index     » next       coverage.py v6.4.2, created at 2022-07-15 09:47 +0000

1# This file is part of sphgeom. 

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 

22"""Add support for YAML serialization of regions.""" 

23 

24__all__ = () 

25 

26# YAML representers and constructors are only useful if yaml itself can 

27# be imported. If yaml can not be imported then there is no reason to 

28# break the entire module import of sphgeom. 

29try: 

30 import yaml 

31except ImportError: 

32 yaml = None 

33 

34from ._healpixPixelization import HealpixPixelization 

35from ._sphgeom import ( 

36 Box, 

37 Circle, 

38 ConvexPolygon, 

39 Ellipse, 

40 HtmPixelization, 

41 IntersectionRegion, 

42 Mq3cPixelization, 

43 Q3cPixelization, 

44 Region, 

45 UnionRegion, 

46) 

47 

48if yaml: 48 ↛ 63line 48 didn't jump to line 63, because the condition on line 48 was never false

49 try: 

50 # CLoader is not always available 

51 from yaml import CLoader 

52 except ImportError: 

53 CLoader = None 

54 

55 YamlLoaders = (yaml.Loader, yaml.FullLoader, yaml.SafeLoader, yaml.UnsafeLoader) 

56 if CLoader is not None: 56 ↛ 63line 56 didn't jump to line 63, because the condition on line 56 was never false

57 YamlLoaders += (CLoader,) 

58 

59 

60# Regions 

61 

62 

63def region_representer(dumper, data): 

64 """Represent a sphgeom region object in a form suitable for YAML. 

65 

66 Stores the region as a mapping with a single ``encoded`` key 

67 storing the hex encoded byte string. 

68 """ 

69 encoded = data.encode() 

70 return dumper.represent_mapping(f"lsst.sphgeom.{type(data).__name__}", {"encoded": encoded.hex()}) 

71 

72 

73def region_constructor(loader, node): 

74 """Construct a sphgeom region from YAML""" 

75 mapping = loader.construct_mapping(node) 

76 encoded = bytes.fromhex(mapping["encoded"]) 

77 # The generic Region base class can instantiate a region of the 

78 # correct type. 

79 return Region.decode(encoded) 

80 

81 

82# Register all the region classes with the same constructor and representer 

83if yaml: 83 ↛ 94line 83 didn't jump to line 94, because the condition on line 83 was never false

84 for region_class in (ConvexPolygon, Ellipse, Circle, Box, UnionRegion, IntersectionRegion): 

85 yaml.add_representer(region_class, region_representer) 

86 

87 for loader in YamlLoaders: 

88 yaml.add_constructor(f"lsst.sphgeom.{region_class.__name__}", region_constructor, Loader=loader) 

89 

90 

91# Pixelization schemes 

92 

93 

94def pixel_representer(dumper, data): 

95 """Represent a pixelization in YAML 

96 

97 Stored as the pixelization level in a mapping with a single key 

98 ``level``. 

99 """ 

100 return dumper.represent_mapping(f"lsst.sphgeom.{type(data).__name__}", {"level": data.getLevel()}) 

101 

102 

103def pixel_constructor(loader, node): 

104 """Construct a pixelization object from YAML.""" 

105 mapping = loader.construct_mapping(node) 

106 

107 className = node.tag 

108 pixelMap = { 

109 "lsst.sphgeom.Q3cPixelization": Q3cPixelization, 

110 "lsst.sphgeom.Mq3cPixelization": Mq3cPixelization, 

111 "lsst.sphgeom.HtmPixelization": HtmPixelization, 

112 "lsst.sphgeom.HealpixPixelization": HealpixPixelization, 

113 } 

114 

115 if className not in pixelMap: 

116 raise RuntimeError( 

117 f"Encountered unexpected class {className} associated with" 

118 " sphgeom pixelization YAML constructor" 

119 ) 

120 

121 return pixelMap[className](mapping["level"]) 

122 

123 

124# All the pixelization schemes use the same approach with getLevel 

125if yaml: 125 ↛ exitline 125 didn't jump to the function exit

126 for pixelSchemeCls in (HtmPixelization, Q3cPixelization, Mq3cPixelization, HealpixPixelization): 

127 yaml.add_representer(pixelSchemeCls, pixel_representer) 

128 for loader in YamlLoaders: 

129 yaml.add_constructor(f"lsst.sphgeom.{pixelSchemeCls.__name__}", pixel_constructor, Loader=loader)