hexconv 0.2.1

Pythonic conversion toolkit for bytes, hex, integers, arrays, binary strings, base64, and text.

hexconv

hexconv is a small, dependency-free Python toolkit for converting between bytes, hex, integers, arrays, binary strings, base encodings, escaped strings, hexdumps, and text.

It is designed around a simple idea: build the conversion you mean, then call it.

import hexconv as hx

decode = hx.HexArray() >> hx.Text()

decode([0x3C, 0x4D, 0x41, 0x47])
# '<MAG'

Install

pip install hexconv

The intended interface

Use format objects for direct parsing:

hx.Hex()("dead beef").bytes
# b'\xde\xad\xbe\xef'

hx.Text()("data").hex
# '64617461'

hx.Int(width=4, endian="little")(0x12345678).hex
# '78563412'

Use from_auto when you want a quick best-effort parse:

hx.from_auto("0xdeadbeef").bytes
# b'\xde\xad\xbe\xef'

hx.from_auto(b"\xde\xad").hex
# 'dead'

hx.from_auto([0xde, 0xad, 0xbe, 0xef]).to(hx.Hex(prefix=True))
# '0xdeadbeef'

Use >> to compose reusable converters:

to_text = hx.HexArray() >> hx.Text()
to_text([0x3C, 0x4D, 0x41, 0x47])
# '<MAG'

to_hex = hx.Text() >> hx.Hex(prefix=True)
to_hex("data")
# '0x64617461'

Use transforms between formats when the data needs shaping:

words = hx.Hex() >> hx.Chunk(2) >> hx.IntArray(width=2)
words("12345678")
# [4660, 22136]

reverse_hex = hx.Hex() >> hx.Reverse() >> hx.Hex()
reverse_hex("deadbeef")
# 'efbeadde'

pad_hex = hx.Hex() >> hx.Pad.left(width=4) >> hx.Hex()
pad_hex("dead")
# '0000dead'

Use the builder form when readability matters more than compactness:

conv = (
    hx.pipeline()
    .from_(hx.Hex())
    .chunk(2)
    .to(hx.HexArray(prefix=True))
)

conv("12345678")
# ['0x1234', '0x5678']

Common conversions

Text, bytes, and hex:

hx.Text()("hello").bytes
# b'hello'

hx.Hex()("68656c6c6f").text
# 'hello'

hx.BytesArray()([0x68, 0x69]).to(hx.Text())
# 'hi'

Integer packing:

hx.Int(width=2)(0x1234).hex
# '1234'

hx.Int(width=2, endian="little")(0x1234).hex
# '3412'

(hx.Hex() >> hx.Chunk(2) >> hx.IntArray(width=2))("12345678")
# [4660, 22136]

Base encodings:

hx.Text()("data").to(hx.Base64())
# 'ZGF0YQ=='

hx.Text()("data").to(hx.Base32(padding=False))
# 'MRQXIYI'

hx.Base64(urlsafe=True, padding=False)("-_8").hex
# 'fbff'

Escaped strings, hexdumps, structs, and bits:

hx.Escaped()(r"\xde\xad").hex
# 'dead'

dump = hx.Hex()("deadbeef").to(hx.Hexdump(width=2))
hx.Hexdump()(dump).hex
# 'deadbeef'

hx.Struct(">HH")((0x1234, 0x5678)).hex
# '12345678'

hx.Hex()("12345678").to(hx.Struct(">HH"))
# (4660, 22136)

hx.Bits()([1, 0, 1]).hex
# '05'

Why explicit formats?

Some values are genuinely ambiguous:

"face"

That can mean raw text:

hx.Text()("face").hex
# '66616365'

or hex bytes:

hx.Hex()("face").bytes
# b'\xfa\xce'

hexconv keeps the recommended path explicit so conversions are predictable. If you want convenience heuristics, use from_auto:

hx.from_auto("0xdead").hex
# 'dead'

If you want to see what from_auto would infer, use infer:

result = hx.infer("0xdead")

result.value.hex
# 'dead'

result.reason
# '0x-prefixed hex string'

from_auto(..., explain=True) returns the same explanation object:

result = hx.from_auto("0b101", explain=True)

result.value.hex
# '05'

Format objects

Format objects are both parsers and pipeline endpoints.

value = hx.Hex()("deadbeef")
value.to(hx.Int())
# 3735928559

conv = hx.Hex() >> hx.Int()
conv("deadbeef")
# 3735928559

Available format specs:

• Bytes()
• BytesArray()
• BytesString()
• Hex()
• HexArray()
• HexInt() / LargeHexNumber()
• Int()
• IntArray()
• Text()
• Binary()
• Base64()
• Base32()
• Base85()
• Ascii85()
• Escaped()
• Hexdump()
• Struct(fmt)
• Bits()

Transforms

Transforms are byte-to-byte steps that sit between input and output formats.

hx.Hex() >> hx.Chunk(2) >> hx.HexArray()
hx.Hex() >> hx.Group(2) >> hx.IntArray(width=2)
hx.Hex() >> hx.Pad.left(width=8) >> hx.Hex()
hx.Hex() >> hx.Pad.right(block_size=8, byte=0xFF) >> hx.Hex()
hx.Hex() >> hx.Reverse() >> hx.Hex()

Current transforms:

• Chunk(width, strict=True) — set downstream grouping width.
• Group(width, strict=True) — alias for Chunk.
• Pad.left(width=..., block_size=..., byte=0) — left-pad bytes.
• Pad.right(width=..., block_size=..., byte=0) — right-pad bytes.
• Reverse() — reverse byte order.

Classic helper API

The original helper style is still supported:

hx.from_hex("dead beef").bytes
# b'\xde\xad\xbe\xef'

hx.from_text("data").hex
# '64617461'

hx.convert("data", from_=hx.Text, to=hx.HexString)
# '64617461'

Source helpers:

• from_bytes(value)
• from_bytes_array(values)
• from_bytes_string(value)
• from_hex(value)
• from_hex_array(values)
• from_hex_int(value)
• from_int(value)
• from_int_array(values, width=...)
• from_text(value)
• from_binary(value)
• from_base64(value)
• from_base32(value)
• from_base85(value)
• from_ascii85(value)
• from_escaped(value)
• from_hexdump(value)
• from_struct(value, fmt=...)
• from_bits(value)
• from_auto(value)
• infer(value)

Common Value outputs:

• to_bytes()
• to_bytearray()
• to_bytes_array()
• to_bytes_string()
• to_hex(sep="", prefix=False, uppercase=False)
• to_hex_array(width=1, prefix=False, uppercase=False)
• to_hex_numbers(width=1)
• to_int(endian="big", signed=False)
• to_int_array(width=1, endian="big", signed=False)
• to_text(encoding="ascii", errors="strict")
• to_binary(sep="")
• to_base64()
• to_base32()
• to_base85()
• to_ascii85()
• to_escaped()
• to_hexdump()
• to_struct(fmt)
• to_bits()
• to(format_spec)