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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
|
from __future__ import annotations
import numbers
import typing as ty
from dataclasses import dataclass
from functools import cached_property
from typing import Callable
from flexparser import flexparser as fp
from . import common, errors
from .pintimports import Converter, UnitsContainer
@dataclass(frozen=True)
class PrefixDefinition(fp.ParsedStatement):
"""Definition of a prefix::
<prefix>- = <value> [= <symbol>] [= <alias>] [ = <alias> ] [...]
Example::
deca- = 1e+1 = da- = deka-
"""
name: str
value: numbers.Number
defined_symbol: str | None
aliases: ty.Tuple[str, ...]
@classmethod
def from_string_and_config(
cls, s: str, config: common.Config
) -> fp.NullableParsedResult[PrefixDefinition]:
if "=" not in s:
return None
name, value, *aliases = s.split("=")
name = name.strip()
if not name.endswith("-"):
return None
aliases = tuple(alias.strip().rstrip("-") for alias in aliases)
if aliases and aliases[0].strip() != "_":
defined_symbol, *aliases = aliases
else:
defined_symbol = None
try:
value = config.to_number(value)
except common.NotNumeric as ex:
return errors.DefinitionSyntaxError(
f"Prefix definition ('{name}') must contain only numbers, not {ex.value}"
)
return cls(name, value, defined_symbol, aliases)
@property
def symbol(self) -> str:
return self.defined_symbol or self.name
@property
def has_symbol(self) -> bool:
return bool(self.defined_symbol)
@cached_property
def converter(self):
return Converter.from_arguments(scale=self.value)
@dataclass(frozen=True)
class UnitDefinition(fp.ParsedStatement):
"""Definition of a unit::
<canonical name> = <relation to another unit or dimension> [= <symbol>] [= <alias>] [ = <alias> ] [...]
Example::
millennium = 1e3 * year = _ = millennia
Parameters
----------
reference : UnitsContainer
Reference units.
is_base : bool
Indicates if it is a base unit.
"""
name: str
defined_symbol: ty.Optional[str]
aliases: ty.Tuple[str, ...]
converter: ty.Optional[ty.Union[Callable, Converter]]
reference: ty.Optional[UnitsContainer]
is_base: bool
@classmethod
def from_string_and_config(
cls, s: str, config: common.Config
) -> fp.NullableParsedResult[UnitDefinition]:
if "=" not in s:
return None
name, value, *aliases = (p.strip() for p in s.split("="))
if aliases and aliases[0].strip() == "_":
defined_symbol, *aliases = aliases
else:
defined_symbol = None
if ";" in value:
[converter, modifiers] = value.split(";", 1)
try:
modifiers = {
key.strip(): config.to_number(value)
for key, value in (part.split(":") for part in modifiers.split(";"))
}
except common.NotNumeric as ex:
return errors.DefinitionSyntaxError(
f"Unit definition ('{name}') must contain only numbers in modifier, not {ex.value}"
)
else:
converter = value
modifiers = {}
converter = config.to_scaled_units_container(converter)
if not any(common.is_dim(key) for key in converter.keys()):
is_base = False
elif all(common.is_dim(key) for key in converter.keys()):
is_base = True
if converter.scale != 1:
return errors.DefinitionSyntaxError(
"Base unit definitions cannot have a scale different to 1. "
f"(`{converter.scale}` found)"
)
else:
return errors.DefinitionSyntaxError(
"Cannot mix dimensions and units in the same definition. "
"Base units must be referenced only to dimensions. "
"Derived units must be referenced only to units."
)
try:
from pint.util import UnitsContainer
reference = UnitsContainer(converter)
# reference = converter.to_units_container()
except errors.DefinitionSyntaxError as ex:
return errors.DefinitionSyntaxError(f"While defining {name}", ex)
try:
converter = Converter.from_arguments(scale=converter.scale, **modifiers)
except Exception as ex:
return errors.DefinitionSyntaxError(
"Unable to assign a converter to the unit", ex
)
return cls(
name,
defined_symbol,
aliases,
converter,
reference,
is_base,
)
@property
def is_multiplicative(self) -> bool:
return self.converter.is_multiplicative
@property
def is_logarithmic(self) -> bool:
return self.converter.is_logarithmic
@property
def symbol(self) -> str:
return self.defined_symbol or self.name
@property
def has_symbol(self) -> bool:
return bool(self.defined_symbol)
@dataclass(frozen=True)
class DimensionDefinition(fp.ParsedStatement):
"""Definition of a root dimension::
[dimension name]
Example::
[volume]
"""
name: str
@property
def is_base(self):
return False
@classmethod
def from_string(cls, s: str) -> fp.NullableParsedResult[DimensionDefinition]:
s = s.strip()
if not (s.startswith("[") and "=" not in s):
return None
try:
s = common.check_dim(s)
except errors.DefinitionSyntaxError as ex:
return ex
return cls(s)
@dataclass(frozen=True)
class DerivedDimensionDefinition(fp.ParsedStatement):
"""Definition of a derived dimension::
[dimension name] = <relation to other dimensions>
Example::
[density] = [mass] / [volume]
"""
name: str
reference: UnitsContainer
@property
def is_base(self):
return False
@classmethod
def from_string_and_config(
cls, s: str, config: common.Config
) -> fp.NullableParsedResult[DerivedDimensionDefinition]:
if not (s.startswith("[") and "=" in s):
return None
name, value, *aliases = s.split("=")
if not (s.startswith("[") and "=" not in s):
return None
try:
name = common.check_dim(name)
except errors.DefinitionSyntaxError as ex:
return ex
if aliases:
return errors.DefinitionSyntaxError(
"Derived dimensions cannot have aliases."
)
try:
reference = config.to_dimension_container(value)
except errors.DefinitionSyntaxError as ex:
return errors.DefinitionSyntaxError(
f"In {name} derived dimensions must only be referenced "
"to dimensions.",
ex,
)
return cls(name.strip(), reference)
@dataclass(frozen=True)
class AliasDefinition(fp.ParsedStatement):
"""Additional alias(es) for an already existing unit::
@alias <canonical name or previous alias> = <alias> [ = <alias> ] [...]
Example::
@alias meter = my_meter
"""
name: str
aliases: ty.Tuple[str, ...]
@classmethod
def from_string(cls, s: str) -> fp.NullableParsedResult[AliasDefinition]:
if not s.startswith("@alias "):
return None
name, *aliases = s[len("@alias ") :].split("=")
name = name.strip()
if name.startswith("["):
return errors.DefinitionSyntaxError(
"Derived dimensions cannot have aliases."
)
if name.endswith("-"):
return errors.DefinitionSyntaxError(
"Prefixes aliases cannot be added after initial definition."
)
return cls(name.strip(), tuple(alias.strip() for alias in aliases))
|
