/usr/lib/python2.7/dist-packages/pint/formatting.py is in python-pint 0.7.2-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | # -*- coding: utf-8 -*-
"""
pint.formatter
~~~~~~~~~~~~~~
Format units for pint.
:copyright: 2016 by Pint Authors, see AUTHORS for more details.
:license: BSD, see LICENSE for more details.
"""
from __future__ import division, unicode_literals, print_function, absolute_import
import re
__JOIN_REG_EXP = re.compile("\{\d*\}")
def _join(fmt, iterable):
"""Join an iterable with the format specified in fmt.
The format can be specified in two ways:
- PEP3101 format with two replacement fields (eg. '{0} * {1}')
- The concatenating string (eg. ' * ')
"""
if not iterable:
return ''
if not __JOIN_REG_EXP.search(fmt):
return fmt.join(iterable)
miter = iter(iterable)
first = next(miter)
for val in miter:
ret = fmt.format(first, val)
first = ret
return first
_PRETTY_EXPONENTS = '⁰¹²³⁴⁵⁶⁷⁸⁹'
def _pretty_fmt_exponent(num):
"""Format an number into a pretty printed exponent.
"""
# TODO: Will not work for decimals
ret = '{0:n}'.format(num).replace('-', '⁻')
for n in range(10):
ret = ret.replace(str(n), _PRETTY_EXPONENTS[n])
return ret
#: _FORMATS maps format specifications to the corresponding argument set to
#: formatter().
_FORMATS = {
'P': { # Pretty format.
'as_ratio': True,
'single_denominator': False,
'product_fmt': '·',
'division_fmt': '/',
'power_fmt': '{0}{1}',
'parentheses_fmt': '({0})',
'exp_call': _pretty_fmt_exponent,
},
'L': { # Latex format.
'as_ratio': True,
'single_denominator': True,
'product_fmt': r' \cdot ',
'division_fmt': r'\frac[{0}][{1}]',
'power_fmt': '{0}^[{1}]',
'parentheses_fmt': r'\left({0}\right)',
},
'H': { # HTML format.
'as_ratio': True,
'single_denominator': True,
'product_fmt': r' ',
'division_fmt': r'{0}/{1}',
'power_fmt': '{0}<sup>{1}</sup>',
'parentheses_fmt': r'({0})',
},
'': { # Default format.
'as_ratio': True,
'single_denominator': False,
'product_fmt': ' * ',
'division_fmt': ' / ',
'power_fmt': '{0} ** {1}',
'parentheses_fmt': r'({0})',
},
'C': { # Compact format.
'as_ratio': True,
'single_denominator': False,
'product_fmt': '*', # TODO: Should this just be ''?
'division_fmt': '/',
'power_fmt': '{0}**{1}',
'parentheses_fmt': r'({0})',
},
}
def formatter(items, as_ratio=True, single_denominator=False,
product_fmt=' * ', division_fmt=' / ', power_fmt='{0} ** {1}',
parentheses_fmt='({0})', exp_call=lambda x: '{0:n}'.format(x)):
"""Format a list of (name, exponent) pairs.
:param items: a list of (name, exponent) pairs.
:param as_ratio: True to display as ratio, False as negative powers.
:param single_denominator: all with terms with negative exponents are
collected together.
:param product_fmt: the format used for multiplication.
:param division_fmt: the format used for division.
:param power_fmt: the format used for exponentiation.
:param parentheses_fmt: the format used for parenthesis.
:return: the formula as a string.
"""
if not items:
return ''
if as_ratio:
fun = lambda x: exp_call(abs(x))
else:
fun = exp_call
pos_terms, neg_terms = [], []
for key, value in sorted(items):
if value == 1:
pos_terms.append(key)
elif value > 0:
pos_terms.append(power_fmt.format(key, fun(value)))
elif value == -1 and as_ratio:
neg_terms.append(key)
else:
neg_terms.append(power_fmt.format(key, fun(value)))
if not as_ratio:
# Show as Product: positive * negative terms ** -1
return _join(product_fmt, pos_terms + neg_terms)
# Show as Ratio: positive terms / negative terms
pos_ret = _join(product_fmt, pos_terms) or '1'
if not neg_terms:
return pos_ret
if single_denominator:
neg_ret = _join(product_fmt, neg_terms)
if len(neg_terms) > 1:
neg_ret = parentheses_fmt.format(neg_ret)
else:
neg_ret = _join(division_fmt, neg_terms)
return _join(division_fmt, [pos_ret, neg_ret])
# Extract just the type from the specification mini-langage: see
# http://docs.python.org/2/library/string.html#format-specification-mini-language
# We also add uS for uncertainties.
_BASIC_TYPES = frozenset('bcdeEfFgGnosxX%uS')
_KNOWN_TYPES = frozenset(list(_FORMATS.keys()) + ['~'])
def _parse_spec(spec):
result = ''
for ch in reversed(spec):
if ch == '~' or ch in _BASIC_TYPES:
continue
elif ch in _KNOWN_TYPES:
if result:
raise ValueError("expected ':' after format specifier")
else:
result = ch
elif ch.isalpha():
raise ValueError("Unknown conversion specified " + ch)
else:
break
return result
def format_unit(unit, spec):
if not unit:
return 'dimensionless'
spec = _parse_spec(spec)
fmt = _FORMATS[spec]
result = formatter(unit.items(), **fmt)
if spec == 'L':
result = result.replace('[', '{').replace(']', '}')
return result
def siunitx_format_unit(units):
'''Returns LaTeX code for the unit that can be put into an siunitx command.'''
# NOTE: unit registry is required to identify unit prefixes.
registry = units._REGISTRY
def _tothe(power):
if isinstance(power, int) or (isinstance(power, float) and power.is_integer()):
if power == 1:
return ''
elif power == 2:
return r'\squared'
elif power == 3:
return r'\cubed'
else:
return r'\tothe{{{:d}}}'.format(int(power))
else:
# limit float powers to 3 decimal places
return r'\tothe{{{:.3f}}}'.format(power).rstrip('0')
l = []
# loop through all units in the container
for unit, power in sorted(units._units.items()):
# remove unit prefix if it exists
# siunitx supports \prefix commands
prefix = None
for p in registry._prefixes.values():
p = str(p)
if len(p) > 0 and unit.find(p) == 0:
prefix = p
unit = unit.replace(prefix, '', 1)
if power < 0:
l.append(r'\per')
if prefix is not None:
l.append(r'\{0}'.format(prefix))
l.append(r'\{0}'.format(unit))
l.append(r'{0}'.format(_tothe(abs(power))))
return ''.join(l)
def remove_custom_flags(spec):
for flag in _KNOWN_TYPES:
if flag:
spec = spec.replace(flag, '')
return spec
|