/usr/share/pyshared/google/apputils/humanize.py is in python-google-apputils 0.4.0-1.
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 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 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 | #!/usr/bin/env python
# -*- coding: utf-8 -*-
# Copyright 2008 Google Inc. All Rights Reserved.
"""Lightweight routines for producing more friendly output.
Usage examples:
'New messages: %s' % humanize.Commas(star_count)
-> 'New messages: 58,192'
'Found %s.' % humanize.Plural(error_count, 'error')
-> 'Found 2 errors.'
'Found %s.' % humanize.Plural(error_count, 'ox', 'oxen')
-> 'Found 2 oxen.'
'Copied at %s.' % humanize.DecimalPrefix(rate, 'bps', precision=3)
-> 'Copied at 42.6 Mbps.'
'Free RAM: %s' % humanize.BinaryPrefix(bytes_free, 'B')
-> 'Free RAM: 742 MiB'
'Finished all tasks in %s.' % humanize.Duration(elapsed_time)
-> 'Finished all tasks in 34m 5s.'
These libraries are not a substitute for full localization. If you
need localization, then you will have to think about translating
strings, formatting numbers in different ways, and so on. Use
ICU if your application is user-facing. Use these libraries if
your application is an English-only internal tool, and you are
tired of seeing "1 results" or "3450134804 bytes used".
Compare humanize.*Prefix() to C++ utilites HumanReadableNumBytes and
HumanReadableInt in strings/human_readable.h.
"""
import datetime
import math
import re
SIBILANT_ENDINGS = frozenset(['sh', 'ss', 'tch', 'ax', 'ix', 'ex'])
DIGIT_SPLITTER = re.compile(r'\d+|\D+').findall
# These are included because they are common technical terms.
SPECIAL_PLURALS = {
'index': 'indices',
'matrix': 'matrices',
'vertex': 'vertices',
}
VOWELS = frozenset('AEIOUaeiou')
# In Python 2.6, int(float('nan')) intentionally raises a TypeError. This code
# attempts to futureproof us against that eventual upgrade.
try:
_IsNan = math.isnan
except AttributeError:
def _IsNan(x):
return type(x) is float and x != x
def Commas(value):
"""Formats an integer with thousands-separating commas.
Args:
value: An integer.
Returns:
A string.
"""
if value < 0:
sign = '-'
value = -value
else:
sign = ''
result = []
while value >= 1000:
result.append('%03d' % (value % 1000))
value /= 1000
result.append('%d' % value)
return sign + ','.join(reversed(result))
def Plural(quantity, singular, plural=None):
"""Formats an integer and a string into a single pluralized string.
Args:
quantity: An integer.
singular: A string, the singular form of a noun.
plural: A string, the plural form. If not specified, then simple
English rules of regular pluralization will be used.
Returns:
A string.
"""
return '%d %s' % (quantity, PluralWord(quantity, singular, plural))
def PluralWord(quantity, singular, plural=None):
"""Builds the plural of an English word.
Args:
quantity: An integer.
singular: A string, the singular form of a noun.
plural: A string, the plural form. If not specified, then simple
English rules of regular pluralization will be used.
Returns:
the plural form of the word.
"""
if quantity == 1:
return singular
if plural:
return plural
if singular in SPECIAL_PLURALS:
return SPECIAL_PLURALS[singular]
# We need to guess what the English plural might be. Keep this
# function simple! It doesn't need to know about every possiblity;
# only regular rules and the most common special cases.
#
# Reference: http://en.wikipedia.org/wiki/English_plural
for ending in SIBILANT_ENDINGS:
if singular.endswith(ending):
return '%ses' % singular
if singular.endswith('o') and singular[-2:-1] not in VOWELS:
return '%ses' % singular
if singular.endswith('y') and singular[-2:-1] not in VOWELS:
return '%sies' % singular[:-1]
return '%ss' % singular
def WordSeries(words, conjunction='and'):
"""Convert a list of words to an English-language word series.
Args:
words: A list of word strings.
conjunction: A coordinating conjunction.
Returns:
A single string containing all the words in the list separated by commas,
the coordinating conjunction, and a serial comma, as appropriate.
"""
num_words = len(words)
if num_words == 0:
return ''
elif num_words == 1:
return words[0]
elif num_words == 2:
return (' %s ' % conjunction).join(words)
else:
return '%s, %s %s' % (', '.join(words[:-1]), conjunction, words[-1])
def AddIndefiniteArticle(noun):
"""Formats a noun with an appropriate indefinite article.
Args:
noun: A string representing a noun.
Returns:
A string containing noun prefixed with an indefinite article, e.g.,
"a thing" or "an object".
"""
if not noun:
raise ValueError('argument must be a word: {!r}'.format(noun))
if noun[0] in VOWELS:
return 'an ' + noun
else:
return 'a ' + noun
def DecimalPrefix(quantity, unit, precision=1, min_scale=0, max_scale=None):
"""Formats an integer and a unit into a string, using decimal prefixes.
The unit will be prefixed with an appropriate multiplier such that
the formatted integer is less than 1,000 (as long as the raw integer
is less than 10**27). For example:
DecimalPrefix(576012, 'bps') -> '576 kbps'
DecimalPrefix(1574215, 'bps', 2) -> '1.6 Mbps'
Only the SI prefixes which are powers of 10**3 will be used, so
DecimalPrefix(100, 'thread') is '100 thread', not '1 hthread'.
See also:
BinaryPrefix()
Args:
quantity: A number.
unit: A string.
precision: An integer, the minimum number of digits to display.
min_scale: minimum power of 1000 to scale to, (None = unbounded).
max_scale: maximum power of 1000 to scale to, (None = unbounded).
Returns:
A string.
"""
return _Prefix(quantity, unit, precision, DecimalScale, min_scale=min_scale,
max_scale=max_scale)
def BinaryPrefix(quantity, unit, precision=1):
"""Formats an integer and a unit into a string, using binary prefixes.
The unit will be prefixed with an appropriate multiplier such that
the formatted integer is less than 1,024 (as long as the raw integer
is less than 2**90). For example:
BinaryPrefix(576012, 'B') -> '562 KiB'
See also:
DecimalPrefix()
Args:
quantity: A number.
unit: A string.
precision: An integer, the minimum number of digits to display.
Returns:
A string.
"""
return _Prefix(quantity, unit, precision, BinaryScale)
def _Prefix(quantity, unit, precision, scale_callable, **args):
"""Formats an integer and a unit into a string.
Args:
quantity: A number.
unit: A string.
precision: An integer, the minimum number of digits to display.
scale_callable: A callable, scales the number and units.
**args: named arguments passed to scale_callable.
Returns:
A string.
"""
if not quantity:
return '0 %s' % unit
if quantity in [float('inf'), float('-inf')] or _IsNan(quantity):
return '%f %s' % (quantity, unit)
scaled_quantity, scaled_unit = scale_callable(quantity, unit, **args)
print_pattern = '%%.%df %%s' % max(0, (precision - int(
math.log(abs(scaled_quantity), 10)) - 1))
return print_pattern % (scaled_quantity, scaled_unit)
def DecimalScale(quantity, unit, min_scale=0, max_scale=None):
"""Get the scaled value and decimal prefixed unit in a tupple.
DecimalScale(576012, 'bps') -> (576.012, 'kbps')
DecimalScale(1574215, 'bps') -> (1.574215, 'Mbps')
Args:
quantity: A number.
unit: A string.
min_scale: minimum power of 1000 to normalize to (None = unbounded)
max_scale: maximum power of 1000 to normalize to (None = unbounded)
Returns:
A tuple of a scaled quantity (float) and BinaryPrefix for the
units (string).
"""
if min_scale is None or min_scale < 0:
negative_powers = ('m', u'µ', 'n', 'p', 'f', 'a', 'z', 'y')
if min_scale is not None:
negative_powers = tuple(negative_powers[0:-min_scale])
else:
negative_powers = None
if max_scale is None or max_scale > 0:
powers = ('k', 'M', 'G', 'T', 'P', 'E', 'Z', 'Y')
if max_scale is not None:
powers = tuple(powers[0:max_scale])
return _Scale(quantity, unit, 1000, powers, negative_powers)
def BinaryScale(quantity, unit):
"""Get the scaled value and binary prefixed unit in a tupple.
BinaryPrefix(576012, 'B') -> (562.51171875, 'KiB')
Args:
quantity: A number.
unit: A string.
Returns:
A tuple of a scaled quantity (float) and BinaryPrefix for the
units (string).
"""
return _Scale(quantity, unit, 1024,
('Ki', 'Mi', 'Gi', 'Ti', 'Pi', 'Ei', 'Zi', 'Yi'))
def _Scale(quantity, unit, multiplier, prefixes, inverse_prefixes=None):
"""Returns the formatted quantity and unit into a tuple.
Args:
quantity: A number.
unit: A string
multiplier: An integer, the ratio between prefixes.
prefixes: A sequence of strings.
inverse_prefixes: Prefixes to use for negative powers,
If empty or None, no scaling is done for fractions.
Returns:
A tuple containing the raw scaled quantity and the prefixed unit.
"""
if not quantity:
return 0, unit
if quantity in [float('inf'), float('-inf')] or _IsNan(quantity):
return quantity, unit
power = int(math.log(abs(quantity), multiplier))
if abs(quantity) > 1 or not inverse_prefixes:
if power < 1:
return quantity, unit
power = min(power, len(prefixes))
prefix = prefixes[power - 1]
value = float(quantity) / multiplier ** power
else:
power = min(-power + 1, len(inverse_prefixes))
prefix = inverse_prefixes[power - 1]
value = quantity * multiplier ** power
return value, prefix + unit
# Contains the fractions where the full range [1/n ... (n - 1) / n]
# is defined in Unicode.
FRACTIONS = {
3: (None, u'⅓', u'⅔', None),
5: (None, u'⅕', u'⅖', u'⅗', u'⅘', None),
8: (None, u'⅛', u'¼', u'⅜', u'½', u'⅝', u'¾', u'⅞', None),
}
FRACTION_ROUND_DOWN = 1.0 / (max(FRACTIONS.keys()) * 2.0)
FRACTION_ROUND_UP = 1.0 - FRACTION_ROUND_DOWN
def PrettyFraction(number, spacer=''):
"""Convert a number into a string that might include a unicode fraction.
This method returns the integer representation followed by the closest
fraction of a denominator 2, 3, 4, 5 or 8.
For instance, 0.33 will be converted to 1/3.
The resulting representation should be less than 1/16 off.
Args:
number: a python number
spacer: an optional string to insert between the integer and the fraction
default is an empty string.
Returns:
a unicode string representing the number.
"""
# We do not want small negative numbers to display as -0.
if number < -FRACTION_ROUND_DOWN:
return u'-%s' % PrettyFraction(-number)
number = abs(number)
rounded = int(number)
fract = number - rounded
if fract >= FRACTION_ROUND_UP:
return str(rounded + 1)
errors_fractions = []
for denominator, fraction_elements in FRACTIONS.items():
numerator = int(round(denominator * fract))
error = abs(fract - (float(numerator) / float(denominator)))
errors_fractions.append((error, fraction_elements[numerator]))
unused_error, fraction_text = min(errors_fractions)
if rounded and fraction_text:
return u'%d%s%s' % (rounded, spacer, fraction_text)
if rounded:
return str(rounded)
if fraction_text:
return fraction_text
return u'0'
def Duration(duration, separator=' '):
"""Formats a nonnegative number of seconds into a human-readable string.
Args:
duration: A float duration in seconds.
separator: A string separator between days, hours, minutes and seconds.
Returns:
Formatted string like '5d 12h 30m 45s'.
"""
try:
delta = datetime.timedelta(seconds=duration)
except OverflowError:
return '>=' + TimeDelta(datetime.timedelta.max)
return TimeDelta(delta, separator=separator)
def TimeDelta(delta, separator=' '):
"""Format a datetime.timedelta into a human-readable string.
Args:
delta: The datetime.timedelta to format.
separator: A string separator between days, hours, minutes and seconds.
Returns:
Formatted string like '5d 12h 30m 45s'.
"""
parts = []
seconds = delta.seconds
if delta.days:
parts.append('%dd' % delta.days)
if seconds >= 3600:
parts.append('%dh' % (seconds // 3600))
seconds %= 3600
if seconds >= 60:
parts.append('%dm' % (seconds // 60))
seconds %= 60
seconds += delta.microseconds / 1e6
if seconds or not parts:
parts.append('%gs' % seconds)
return separator.join(parts)
def NaturalSortKey(data):
"""Key function for "natural sort" ordering.
This key function results in a lexigraph sort. For example:
- ['1, '3', '20'] (not ['1', '20', '3']).
- ['Model 9', 'Model 70 SE', 'Model 70 SE2']
(not ['Model 70 SE', 'Model 70 SE2', 'Model 9']).
Usage:
new_list = sorted(old_list, key=humanize.NaturalSortKey)
or
list_sort_in_place.sort(key=humanize.NaturalSortKey)
Based on code by Steven Bazyl <sbazyl@google.com>.
Args:
data: str, The key being compared in a sort.
Returns:
A list which is comparable to other lists for the purpose of sorting.
"""
segments = DIGIT_SPLITTER(data)
for i, value in enumerate(segments):
if value.isdigit():
segments[i] = int(value)
return segments
|