LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
yaml.py
Go to the documentation of this file.
1 # This file is part of daf_base
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 """This module defines YAML I/O for key lsst.daf.base classes."""
23 
24 # If yaml package is not installed there is no reason to fail everywhere
25 try:
26  import yaml
27 except ImportError:
28  yaml = None
29 
30 from .dateTime import DateTime
31 from .propertyContainer import PropertyList, getPropertyListState, setPropertyListState, \
32  getPropertySetState, setPropertySetState, PropertySet
33 
34 # For YAML >= 5.1 need a different Loader for the constructor
35 loaderList = []
36 if yaml:
37  loaderList = [yaml.Loader, yaml.CLoader]
38  try:
39  loaderList.append(yaml.FullLoader)
40  except AttributeError:
41  pass
42  try:
43  loaderList.append(yaml.UnsafeLoader)
44  except AttributeError:
45  pass
46  try:
47  loaderList.append(yaml.SafeLoader)
48  except AttributeError:
49  pass
50 
51 
52 # YAML representers for key lsst.daf.base classes
53 
54 
55 def dt_representer(dumper, data):
56  """Represent an lsst.daf.base.DateTime (as ISO8601-formatted string in TAI)
57  """
58  return dumper.represent_scalar('lsst.daf.base.DateTime',
59  data.toString(DateTime.TAI))
60 
61 
62 if yaml:
63  yaml.add_representer(DateTime, dt_representer)
64 
65 
66 def pl_representer(dumper, data):
67  """Represent an lsst.daf.base.PropertyList as an ordered sequence of
68  name/type/value/comment lists)
69  """
70  # Turn the tuples into lists for cleaner representation in yaml
71  result = getPropertyListState(data, asLists=True)
72  return dumper.represent_sequence('lsst.daf.base.PropertyList', result,
73  flow_style=None)
74 
75 
76 if yaml:
77  yaml.add_representer(PropertyList, pl_representer)
78 
79 
80 def ps_representer(dumper, data):
81  """Represent an lsst.daf.base.PropertySet as a mapping from names to
82  type/value pairs.
83  """
84  # Turn the tuples into lists for cleaner representation in yaml
85  result = getPropertySetState(data, asLists=True)
86  return dumper.represent_sequence('lsst.daf.base.PropertySet', result,
87  flow_style=None)
88 
89 
90 if yaml:
91  yaml.add_representer(PropertySet, ps_representer)
92 
93 
94 
95 # YAML constructors for key lsst.daf.base classes
96 
97 
98 def dt_constructor(loader, node):
99  """Construct an lsst.daf.base.DateTime from an ISO8601-formatted string in
100  TAI
101  """
102  dt = loader.construct_scalar(node)
103  return DateTime(str(dt), DateTime.TAI)
104 
105 
106 def pl_constructor(loader, node):
107  """Construct an lsst.daf.base.PropertyList from a YAML pickle-like
108  structure.
109  """
110  pl = PropertyList()
111  yield pl
112  state = loader.construct_sequence(node, deep=True)
113  setPropertyListState(pl, state)
114 
115 
116 def ps_constructor(loader, node):
117  """Construct an lsst.daf.base.PropertyList from a YAML pickle-like
118  structure.
119  """
120  ps = PropertySet()
121  yield ps
122  state = loader.construct_sequence(node, deep=True)
123  setPropertySetState(ps, state)
124 
125 
126 if yaml:
127  for loader in loaderList:
128  yaml.add_constructor('lsst.daf.base.PropertyList', pl_constructor, Loader=loader)
129  yaml.add_constructor('lsst.daf.base.PropertySet', ps_constructor, Loader=loader)
130  yaml.add_constructor('lsst.daf.base.DateTime', dt_constructor, Loader=loader)
def dt_representer(dumper, data)
Definition: yaml.py:55
def pl_representer(dumper, data)
Definition: yaml.py:66
def ps_representer(dumper, data)
Definition: yaml.py:80