1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27 """
28 Definitions of type strings found in LIGO Light Weight XML files.
29
30 Notes. To guarantee that a double-precision floating-point number can be
31 reconstructed exactly from its representation as a decimal number, one must
32 use 17 decimal digits; for single-precision, the number is 9. Python uses
33 only double-precision numbers, but LIGO Light Weight XML allows for
34 single-precision values, so I provide distinct format specifiers for those
35 cases here. In both cases, I have elected to use 1 fewer digits than are
36 required to uniquely reconstruct the number: the XML written by this
37 library is lossy. I made this choice to reduce the file size, for example
38
39 >>> "%.17g" % 0.1
40 '0.10000000000000001'
41
42 while
43
44 >>> "%.16g" % 0.1
45 '0.1'
46
47 In this worst case, storing full precision increases the size of the XML by
48 more than an order of magnitude. If you wish to make a different choice
49 for your files, for example if you wish your XML files to be lossless,
50 simply include the lines
51
52 glue.ligolw.types.FormatFunc.update({
53 "real_4": u"%.9g".__mod__,
54 "real_8": u"%.17g".__mod__,
55 "float": u"%.9g".__mod__,
56 "double": u"%.17g".__mod__,
57 u"complex_8": glue.ligolw.types.mk_complex_format_func(u"%.9g"),
58 u"complex_16": glue.ligolw.types.mk_complex_format_func(u"%.17g")
59 })
60
61 anywhere in your code, but before you write the document to a file.
62
63 References:
64
65 - http://docs.sun.com/source/806-3568/ncg_goldberg.html
66 """
67
68
69 import base64
70
71
72 from glue import git_version
73 from . import ilwd
74 import six
75
76
77 try:
78 long
79 except NameError:
80 long = int
81
82
83 __author__ = "Kipp Cannon <kipp.cannon@ligo.org>"
84 __version__ = "git id %s" % git_version.id
85 __date__ = git_version.date
86
87
88
89
90
91
92
93
94
95
96
97 IDTypes = set([u"ilwd:char", u"ilwd:char_u"])
98 """LIGO Light-Weight XML type strings for ID-like data."""
99
100 BlobTypes = set([u"blob", u"ilwd:char_u"])
101 """LIGO Light-Weight XML type strings for binary blob-like data."""
102
103 StringTypes = set([u"char_s", u"char_v", u"lstring", u"string", u"ilwd:char"])
104 """LIGO Light-Weight XML type strings for string-like data."""
105
106 IntTypes = set([u"int_2s", u"int_2u", u"int_4s", u"int_4u", u"int_8s", u"int_8u", u"int"])
107 """LIGO Light-Weight XML type strings for integer-like data."""
108
109 FloatTypes = set([u"real_4", u"real_8", u"float", u"double"])
110 """LIGO Light-Weight XML type strings for floating-point-like data."""
111
112 ComplexTypes = set([u"complex_8", u"complex_16"])
113 """LIGO Light-Weight XML type strings for complex-like data."""
114
115 NumericTypes = IntTypes | FloatTypes | ComplexTypes
116 """LIGO Light-Weight XML type strings for number-like data."""
117
118 TimeTypes = set([u"GPS", u"Unix", u"ISO-8601"])
119 """LIGO Light-Weight XML type strings for time-like data."""
120
121 Types = BlobTypes | StringTypes | NumericTypes | TimeTypes
122 """All valid LIGO Light-Weight XML type strings."""
123
124
125
126
127
128
129
130
131
132
133
141
142
149
150
159 return complex_format_func
160
161
162 FormatFunc = {
163 u"char_s": string_format_func,
164 u"char_v": string_format_func,
165 u"ilwd:char": u"\"%s\"".__mod__,
166 u"ilwd:char_u": blob_format_func,
167 u"blob": blob_format_func,
168 u"lstring": string_format_func,
169 u"string": string_format_func,
170 u"int_2s": u"%d".__mod__,
171 u"int_2u": u"%u".__mod__,
172 u"int_4s": u"%d".__mod__,
173 u"int_4u": u"%u".__mod__,
174 u"int_8s": u"%d".__mod__,
175 u"int_8u": u"%u".__mod__,
176 u"int": u"%d".__mod__,
177 u"real_4": u"%.8g".__mod__,
178 u"real_8": u"%.16g".__mod__,
179 u"float": u"%.8g".__mod__,
180 u"double": u"%.16g".__mod__,
181 u"complex_8": mk_complex_format_func(u"%.8g"),
182 u"complex_16": mk_complex_format_func(u"%.16g")
183 }
184 """
185 Look-up table mapping LIGO Light-Weight XML data type strings to functions
186 for formating Python data for output. This table is used universally by
187 glue.ligolw XML writing codes.
188 """
189
190
191
192
193
194
195
196
197
198
199
200 ToPyType = {
201 u"char_s": six.text_type,
202 u"char_v": six.text_type,
203 u"ilwd:char": ilwd.ilwdchar,
204 u"ilwd:char_u": lambda s: memoryview(base64.b64decode(s)),
205 u"blob": lambda s: memoryview(base64.b64decode(s)),
206 u"lstring": six.text_type,
207 u"string": six.text_type,
208 u"int_2s": int,
209 u"int_2u": int,
210 u"int_4s": int,
211 u"int_4u": int,
212 u"int_8s": int,
213 u"int_8u": int,
214 u"int": int,
215 u"real_4": float,
216 u"real_8": float,
217 u"float": float,
218 u"double": float,
219 u"complex_8": lambda s: complex(*map(float, s.split(u"+i"))),
220 u"complex_16": lambda s: complex(*map(float, s.split(u"+i")))
221 }
222 """
223 Look-up table mapping LIGO Light-Weight XML data type strings to functions
224 for parsing Python data from input. This table is used universally by
225 glue.ligolw XML parsing codes.
226 """
227
228
231 try:
232 return super(FromPyTypeCls, self).__getitem__(key)
233 except KeyError:
234 for test_key, val in six.iteritems(self):
235 if issubclass(key, test_key):
236 return val
237 raise