pycolib/prettysize.py
author Radek Brich <brich.radek@ifortuna.cz>
Mon, 14 Apr 2014 22:29:07 +0200
changeset 11 d1f08fc9de31
parent 1 ee31f1bf17c1
permissions -rw-r--r--
Update prettysize: Add parameter to enable trailing zeros.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
     1
# -*- coding: utf-8 -*-
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
     2
#
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
     3
# prettysize - print data sizes in format easily readable by humans
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
     4
#
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
     5
# Copyright (c) 2011  Radek Brich <radek.brich@devl.cz>
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
     6
#
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
     7
# Permission is hereby granted, free of charge, to any person obtaining a copy
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
     8
# of this software and associated documentation files (the "Software"), to deal
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
     9
# in the Software without restriction, including without limitation the rights
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    10
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    11
# copies of the Software, and to permit persons to whom the Software is
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    12
# furnished to do so, subject to the following conditions:
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    13
#
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    14
# The above copyright notice and this permission notice shall be included in
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    15
# all copies or substantial portions of the Software.
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    16
#
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    17
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    18
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    19
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    20
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    21
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    22
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    23
# THE SOFTWARE.
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    24
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    25
iec_prefixes = ('Ki', 'Mi', 'Gi', 'Ti', 'Pi', 'Ei', 'Zi', 'Yi')
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    26
si_prefixes = 'kMGTPEZY'
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    27
big_prefixes = 'KMGTPEZY'
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    28
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    29
11
d1f08fc9de31 Update prettysize: Add parameter to enable trailing zeros.
Radek Brich <brich.radek@ifortuna.cz>
parents: 1
diff changeset
    30
def prettysize(num, base=1024, prefixes=si_prefixes, unit='B', sep=' ', trailing_zeros=False):
1
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    31
    '''Convert data size in bytes to human readable aproximation.
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    32
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    33
    Beware that default output is invalid by recent standardization.
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    34
    Still, this form was in use for ages.
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    35
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    36
    For standardized output, see prettysize_si and prettysize_iec.
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    37
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    38
    '''
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    39
    prefixes = list(prefixes)
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    40
    prefix = ''
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    41
    num = float(num)
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    42
    while True:
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    43
        if num < base:
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    44
            # format number
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    45
            out = '{:.2f}'.format(num)
11
d1f08fc9de31 Update prettysize: Add parameter to enable trailing zeros.
Radek Brich <brich.radek@ifortuna.cz>
parents: 1
diff changeset
    46
            if not trailing_zeros:
d1f08fc9de31 Update prettysize: Add parameter to enable trailing zeros.
Radek Brich <brich.radek@ifortuna.cz>
parents: 1
diff changeset
    47
                # cut off trailing zeros
d1f08fc9de31 Update prettysize: Add parameter to enable trailing zeros.
Radek Brich <brich.radek@ifortuna.cz>
parents: 1
diff changeset
    48
                out = out.rstrip('0')
d1f08fc9de31 Update prettysize: Add parameter to enable trailing zeros.
Radek Brich <brich.radek@ifortuna.cz>
parents: 1
diff changeset
    49
                if out.endswith('.'):
d1f08fc9de31 Update prettysize: Add parameter to enable trailing zeros.
Radek Brich <brich.radek@ifortuna.cz>
parents: 1
diff changeset
    50
                    out = out[:-1]
1
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    51
            return out + sep + prefix + unit
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    52
        num /= base
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    53
        prefix = prefixes.pop(0)
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    54
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    55
    raise OverflowError('Number is too large.')
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    56
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    57
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    58
def prettysize_si(num, **kw):
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    59
    return prettysize(num, base=1000, **kw)
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    60
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    61
11
d1f08fc9de31 Update prettysize: Add parameter to enable trailing zeros.
Radek Brich <brich.radek@ifortuna.cz>
parents: 1
diff changeset
    62
def prettysize_short(num, **kw):
d1f08fc9de31 Update prettysize: Add parameter to enable trailing zeros.
Radek Brich <brich.radek@ifortuna.cz>
parents: 1
diff changeset
    63
    return prettysize(num, unit='', sep='', prefixes=big_prefixes, **kw)
1
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    64
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    65
11
d1f08fc9de31 Update prettysize: Add parameter to enable trailing zeros.
Radek Brich <brich.radek@ifortuna.cz>
parents: 1
diff changeset
    66
def prettysize_iec(num, **kw):
d1f08fc9de31 Update prettysize: Add parameter to enable trailing zeros.
Radek Brich <brich.radek@ifortuna.cz>
parents: 1
diff changeset
    67
    return prettysize(num, prefixes=iec_prefixes, **kw)
1
ee31f1bf17c1 Add ansicolor, prettysize, makeurl and README.
Radek Brich <radek.brich@devl.cz>
parents:
diff changeset
    68