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
|
"""
"""
import copy
import operator
import re
import threading
class _Config:
@property
def lock(self):
return self._lock
@property
def use_unicode(self):
with self.lock:
return copy.copy(self._use_unicode)
@use_unicode.setter
def use_unicode(self, val):
self._use_unicode = bool(val)
def __init__(self):
self._lock = threading.RLock()
self._use_unicode = False
config = _Config()
superscripts = ['⁰', '¹', '²', '³', '⁴', '⁵', '⁶', '⁷', '⁸', '⁹']
def superscript(val):
items = re.split(r'\*{2}([\d]+)(?!\.)', val)
ret = []
while items:
try:
s = items.pop(0)
e = items.pop(0)
ret.append(s+''.join(superscripts[int(i)] for i in e))
except IndexError:
ret.append(s)
return ''.join(ret)
def format_units(udict):
'''
create a string representation of the units contained in a dimensionality
'''
num = []
den = []
keys = [k for k, o in
sorted(
((k, k.format_order) for k in udict),
key=operator.itemgetter(1)
)
]
for key in keys:
d = udict[key]
if config.use_unicode:
u = key.u_symbol
else:
u = key.symbol
if d>0:
if d != 1:
u = u + ('**%s'%d).rstrip('0').rstrip('.')
num.append(u)
elif d<0:
d = -d
if d != 1:
u = u + ('**%s'%d).rstrip('0').rstrip('.')
den.append(u)
res = '*'.join(num)
if len(den):
if not res: res = '1'
fmt = '(%s)' if len(den) > 1 else '%s'
res = res + '/' + fmt%('*'.join(den))
if not res: res = 'dimensionless'
return res
def format_units_unicode(udict):
res = format_units(udict)
res = superscript(res)
res = res.replace('**', '^').replace('*','·')
return res
def format_units_latex(udict,font='mathrm',mult=r'\\cdot',paren=False):
'''
Replace the units string provided with an equivalent latex string.
Division (a/b) will be replaced by \frac{a}{b}.
Exponentiation (m**2) will be replaced with superscripts (m^{2})
The latex is set with the font argument, and the default is the normal,
non-italicized font mathrm. Other useful options include 'mathnormal',
'mathit', 'mathsf', and 'mathtt'.
Multiplication (*) are replaced with the symbol specified by the mult argument.
By default this is the latex \\cdot symbol. Other useful
options may be '' or '*'.
If paren=True, encapsulate the string in '\\left(' and '\\right)'
The result of format_units_latex is encapsulated in $. This allows the result
to be used directly in Latex in normal text mode, or in Matplotlib text via the
MathText feature.
Restrictions:
This routine will not put CompoundUnits into a fractional form.
'''
res = format_units(udict)
if res.startswith('(') and res.endswith(')'):
# Compound Unit
compound = True
else:
# Not a compound unit
compound = False
# Replace division (num/den) with \frac{num}{den}
res = re.sub(r'(?P<num>.+)/(?P<den>.+)',r'\\frac{\g<num>}{\g<den>}',res)
# Replace exponentiation (**exp) with ^{exp}
res = re.sub(r'\*{2,2}(?P<exp>\d+)',r'^{\g<exp>}',res)
# Remove multiplication signs
res = re.sub(r'\*','{'+mult+'}',res)
if paren and not compound:
res = r'\left(%s\right)' % res
res = fr'$\{font}{{{res}}}$'
return res
def format_units_html(udict,font='%s',mult=r'⋅',paren=False):
'''
Replace the units string provided with an equivalent html string.
Exponentiation (m**2) will be replaced with superscripts (m<sup>2</sup>})
No formating is done, change `font` argument to e.g.:
'<span style="color: #0000a0">%s</span>' to have text be colored blue.
Multiplication (*) are replaced with the symbol specified by the mult
argument. By default this is the latex ⋅ symbol. Other useful options
may be '' or '*'.
If paren=True, encapsulate the string in '(' and ')'
'''
res = format_units(udict)
if res.startswith('(') and res.endswith(')'):
# Compound Unit
compound = True
else:
# Not a compound unit
compound = False
# Replace exponentiation (**exp) with ^{exp}
res = re.sub(r'\*{2,2}(?P<exp>\d+)',r'<sup>\g<exp></sup>',res)
# Remove multiplication signs
res = re.sub(r'\*',mult,res)
if paren and not compound:
res = '(%s)' % res
res = font % res
return res
|
