Source code for tolkein.lib.tobin

#!/usr/bin/env python3

"""Binning functions."""

import math


def readable_bin(value, *, start_digits=None):
    """
    Place values in human readable bins.

    Args:
        value (float): Number to bin.
        start_digits (list, optional): List of threshold values between 1 and 10.
            Defaults to `[1, 2, 3, 5]`

    .. testsetup::

       from tolkein.lib.tobin import readable_bin

    .. doctest::

        >>> readable_bin(123456789)
        '200M'

        >>> readable_bin(56789012234)
        '100G'

        >>> readable_bin(567.89)
        '1k'

        >>> readable_bin(21, start_digits=[1, 2, 4, 8])
        '40'

        >>> readable_bin(-1234567)
        '-2M'
    """
    if start_digits is None:
        start_digits = [1, 2, 3, 5, 10]
    else:
        start_digits.append(start_digits[0] * 10)
    thousands = ["", "k", "M", "G", "T", "P", "E", "Z"]
    start_digits.append(10)
    # Check sign
    sign = 1
    if value < 0:
        value = abs(value)
        sign = -1
    # Check order of magnitude
    order = int(math.floor(math.log10(abs(value))))
    # Get first digit
    first = value / pow(10, order)
    # Find bin
    for digit in start_digits:
        if first < digit:
            initial = digit
            if initial == 10:
                order += 1
                initial = 1
            break
    # Count thousands
    mag = order // 3
    # Count additional orders of magnitude
    order %= 3
    # Set return value
    value = sign * initial * pow(10, order)
    return "%d%s" % (value, thousands[mag])


if __name__ == "__main__":
    # Run inline tests
    import doctest

    doctest.testmod()