Skip to main content

Convert numbers between any base (2-62) with human-friendly APIs.

Project description

philiprehberger-base-convert

Tests PyPI version Last updated

Convert numbers between any base (2-62) with human-friendly APIs.

Installation

pip install philiprehberger-base-convert

Usage

Basic Conversion

from philiprehberger_base_convert import to_base, from_base

# Convert to base 16 (hex)
to_base(255, 16)      # "ff"
from_base("ff", 16)   # 255

# Convert to base 62
to_base(999999, 62)   # "4c91"
from_base("4c91", 62) # 999999

Pre-built Codecs

from philiprehberger_base_convert import base16, base36, base58, base62

base62.encode(123456789)       # "8M0kX"
base62.decode("8M0kX")         # 123456789

base58.encode(123456789)       # Bitcoin-style base58
base36.encode(123456789)       # "21i3v9"
base16.encode(255)             # "ff"

Bytes Encoding

Encode arbitrary bytes (UUIDs, hashes, binary data) to compact base-N strings:

from philiprehberger_base_convert import base62

# Encode bytes to base62
data = b"\x00\x01\x02\xff"
encoded = base62.encode_bytes(data)

# Decode back to bytes
decoded = base62.decode_bytes(encoded)
assert decoded == data

# Encode a UUID to a compact string
import uuid
uid = uuid.uuid4().bytes
short_id = base62.encode_bytes(uid)

Custom Alphabet

from philiprehberger_base_convert import to_base, from_base, BaseCodec

# Use a custom alphabet for base 3
to_base(42, 3, alphabet="XYZ")   # "YXZX"
from_base("YXZX", 3, alphabet="XYZ")  # 42

# Reusable codec with custom alphabet
codec = BaseCodec(4, alphabet="ACGT")
codec.encode(42)   # "GCAC"
codec.decode("GCAC")  # 42

Fixed-width output

Pass min_length to left-pad the encoded string with the alphabet's zero character. Useful for fixed-width identifiers:

from philiprehberger_base_convert import to_base, base62

to_base(5, 16, min_length=4)        # "0005"
base62.encode(0, min_length=8)      # "00000000"
base62.encode(123, min_length=6)    # zero-padded base62

API

Function / Class Description
to_base(number, base, *, alphabet="", min_length=0) Convert int to string in given base (2-62); min_length left-pads with zero char
from_base(value, base, *, alphabet="") Convert string in given base back to int
BaseCodec(base, *, alphabet="") Reusable encoder/decoder for a fixed base
BaseCodec.encode(number, *, min_length=0) Encode int to string with optional left-padding
BaseCodec.decode(value) Decode string to int
BaseCodec.encode_bytes(data) Encode bytes to a base-N string (preserves leading zero bytes)
BaseCodec.decode_bytes(value) Decode a base-N string back to bytes
base16 Pre-built codec for base 16
base32 Pre-built codec for base 32
base36 Pre-built codec for base 36
base58 Pre-built codec for base 58 (Bitcoin alphabet)
base62 Pre-built codec for base 62

Development

pip install -e .
python -m pytest tests/ -v

Support

If you find this project useful:

Star the repo

🐛 Report issues

💡 Suggest features

❤️ Sponsor development

🌐 All Open Source Projects

💻 GitHub Profile

🔗 LinkedIn Profile

License

MIT

Project details


Download files

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

Source Distribution

philiprehberger_base_convert-0.3.0.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

philiprehberger_base_convert-0.3.0-py3-none-any.whl (5.9 kB view details)

Uploaded Python 3

File details

Details for the file philiprehberger_base_convert-0.3.0.tar.gz.

File metadata

File hashes

Hashes for philiprehberger_base_convert-0.3.0.tar.gz
Algorithm Hash digest
SHA256 461468189b6eaacfe1631328f34df257d447d3b4070b4e1b364cb68ad41c5ee3
MD5 04de6b57d7ccfee80de8a4177d527952
BLAKE2b-256 5eb06e573ab40c1b1550dce09eb49088dc1be2d3a0eb40364f0531876402b1d7

See more details on using hashes here.

File details

Details for the file philiprehberger_base_convert-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for philiprehberger_base_convert-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f287c159244231627a16177e969b0449fa9b546e4e3b62143b3c11bd920287f6
MD5 d1f875cc37c5d035d0e3897999aadba6
BLAKE2b-256 df51566df8081f18d0d4a810e60cbf7ff57e5e7de356a168aab2afe0413d0dc7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page