hexconv 0.1.1

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

hexconv

hexconv is a small, dependency-free Python conversion toolkit for working with bytes, byte arrays, hex strings, hex arrays, integers, integer arrays, bytes literals, binary strings, base64, and raw text.

The main idea is: explicitly state what you have, then ask for what you want.

import hexconv as hx

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

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

hx.from_bytes_array([0xde, 0xad, 0xbe, 0xef]).to_hex()
# 'deadbeef'

hx.from_bytes_array([0xde, 0xad, 0xbe, 0xef]).hex
# 'deadbeef'

hx.from_text("data").to_hex_array(prefix=True)
# ['0x64', '0x61', '0x74', '0x61']

hx.from_int(0xdeadbeef).to_bytes()
# b'\xde\xad\xbe\xef'

hx.from_int_array([0x1234, 0x5678], width=2).to_hex_array(width=2)
# ['1234', '5678']

Why explicit source helpers?

Some inputs are impossible to infer safely:

"face"

That could be ASCII text (66 61 63 65) or hex bytes (fa ce). So hexconv keeps the safe path explicit:

hx.from_text("face").to_hex()
# '66616365'

hx.from_hex("face").to_bytes()
# b'\xfa\xce'

If you do want convenience heuristics, use from_auto:

hx.from_auto("0xdeadbeef").to_int()
# 3735928559

Converter API

If you prefer a reusable converter object, use marker classes:

conv = hx.Converter(hx.BytesArray, hx.HexArray)
conv([0xde, 0xad, 0xbe, 0xef])
# ['de', 'ad', 'be', 'ef']

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

For conversions with options, pass input and output option dictionaries:

conv = hx.Converter(
    hx.DecimalIntArray,
    hx.HexArray,
    input_options={"width": 2},
    output_options={"width": 2, "prefix": True},
)

conv([4660, 22136])
# ['0x1234', '0x5678']

Supported source helpers

• from_bytes(value)
• from_bytes_array(values)
• from_bytes_string(value) for strings like "b'\\xde\\xad'"
• 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_auto(value)

Common output methods

• 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(format_marker, **options)