unit suffixes for nonnegative integers; parsing and transcription

## Project description

Functions for decomposing nonnegative integers according to various unit scales.

Presupplied scales:

`BINARY_BYTES_SCALE`

: Binary units of (B)ytes, KiB, MiB, GiB etc.`DECIMAL_BYTES_SCALE`

: Decimal units of (B)ytes, KB, MB, GB etc.`DECIMAL_SCALE`

: Unit suffixes K, M, G etc.`TIME_SCALE`

: Units of (s)econds, (m)inutes, (h)ours, (d)ays and (w)eeks.

## Function `combine(components, scale)`

Combine a sequence of value components as from `human()`

into an integer.

## Function `geek_bytes(n)`

Decompose a nonnegative integer `n`

into counts by unit
from `BINARY_BYTES_SCALE`

.

## Function `human(n, scale)`

Decompose a nonnegative integer `n`

into counts by unit from `scale`

.

Parameters:

`n`

: a nonnegative integer.`scale`

: a sequence of`(factor,unit)`

where factor is the size factor to the follow scale and`unit`

is the designator of the unit.

## Function `human_bytes(n)`

Decompose a nonnegative integer `n`

into counts by unit
from `DECIMAL_BYTES_SCALE`

.

## Function `human_time(n, scale=None)`

Decompose a nonnegative integer `n`

into counts by unit
from `TIME_SCALE`

.

## Function `multiparse(s, scales, offset=0)`

Parse an integer followed by an optional scale and return computed value. Returns the parsed value and the new offset.

Parameters:

`s`

: the string to parse.`scales`

: an iterable of scale arrays of (factor, unit_name).`offset`

: starting position for parse.

## Function `parse(s, scale, offset=0)`

Parse an integer followed by an optional scale and return computed value. Returns the parsed value and the new offset.

Parameters:

`s`

: the string to parse.`scale`

: a scale array of (factor, unit_name).`offset`

: starting position for parse.

## Function `transcribe(n, scale, max_parts=None, skip_zero=False, sep='')`

Transcribe a nonnegative integer `n`

against `scale`

.

Parameters:

`n`

: a nonnegative integer.`scale`

: a sequence of (factor, unit) where factor is the size factor to the follow scale and`unit`

is the designator of the unit.`max_parts`

: the maximum number of components to transcribe.`skip_zero`

: omit components of value 0.`sep`

: separator between words, default:`''`

.

## Function `transcribe_bytes_geek(n, max_parts=1, **kw)`

Transcribe a nonnegative integer `n`

against `BINARY_BYTES_SCALE`

.

## Function `transcribe_bytes_human(n, max_parts=1, **kw)`

Transcribe a nonnegative integer `n`

against `DECIMAL_BYTES_SCALE`

.

## Function `transcribe_time(n, max_parts=3, **kw)`

Transcribe a nonnegative integer `n`

against `TIME_SCALE`

.

## Project details

## Release history Release notifications

## Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help | File type | Python version | Upload date |
---|---|---|---|

cs.units-20190220.tar.gz (3.4 kB) Copy SHA256 hash SHA256 | Source | None |