hexconv 0.2.3__tar.gz → 0.2.4__tar.gz

{hexconv-0.2.3/src/hexconv.egg-info → hexconv-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hexconv
-Version: 0.2.3
+Version: 0.2.4
 Summary: Pythonic conversion toolkit for bytes, hex, integers, arrays, binary strings, base64, and text.
 Author: hexconv contributors
 License-Expression: MIT
@@ -41,33 +41,67 @@ It is built around ergonomic one-liners and composable format objects.
 pip install hexconv
 ```
 
-## Quick tour
+## Fast compose
 
-Use direct helpers when you want one obvious conversion:
+The intended interface is small pieces snapped together:
+`source format >> optional transforms >> target format`.
 
 ```python
 import hexconv as hx
 
-hx.from_hex("dead beef").to_bytes()
+to_bytes = hx.Hex() >> hx.Bytes()
+to_bytes("de ad be ef")
 # b'\xde\xad\xbe\xef'
 
-hx.from_hex("dead beef").bytes
-# b'\xde\xad\xbe\xef'
+spaced_hex = hx.Bytes() >> hx.Hex(sep=" ")
+spaced_hex(b"\xde\xad\xbe\xef")
+# 'de ad be ef'
 
-hx.from_bytes_array([0xde, 0xad, 0xbe, 0xef]).to_hex()
-# 'deadbeef'
+words = hx.Hex(sep=" ") >> hx.Chunk(2) >> hx.IntArray(width=2)
+words("12 34 56 78")
+# [4660, 22136]
 
-hx.from_bytes_array([0xde, 0xad, 0xbe, 0xef]).hex
-# 'deadbeef'
+text_to_urlsafe = hx.Text() >> hx.Base64(urlsafe=True, padding=False)
+text_to_urlsafe("data")
+# 'ZGF0YQ'
+```
+
+Hex input accepts common separators, so spaced or copied hex usually does not
+need manual cleanup before conversion. `Hex(sep=" ")` is also how you emit
+space-separated hex.
+
+## Quick tour
+
+Use direct helpers when you want one obvious conversion across many
+representations:
+
+```python
+hx.from_hex("de ad be ef").bytes
+# b'\xde\xad\xbe\xef'
 
 hx.from_text("data").to_hex_array(prefix=True)
 # ['0x64', '0x61', '0x74', '0x61']
 
-hx.from_int(0xdeadbeef).to_bytes()
+hx.from_int(0xdeadbeef).bytes
 # b'\xde\xad\xbe\xef'
 
 hx.from_int_array([0x1234, 0x5678], width=2).to_hex_array(width=2)
 # ['1234', '5678']
+
+hx.from_binary("01100100 01100001 01110100 01100001").text
+# 'data'
+
+hx.from_base64("ZGF0YQ==").text
+# 'data'
+
+hx.from_escaped(r"\xde\xad").hex
+# 'dead'
+
+hx.from_struct((0x1234, 0x5678), fmt=">HH").hex
+# '12345678'
+
+hx.from_bits("101", pad=True).hex
+# '05'
 ```
 
 Use `from_auto` when you want a quick best-effort parse:
@@ -88,7 +122,7 @@ hx.from_auto([0xde, 0xad, 0xbe, 0xef]).to(hx.Hex(prefix=True))
 `hexconv` is built around small format objects. A format can parse directly:
 
 ```python
-hx.Hex()("dead beef").bytes
+hx.Hex()("de ad be ef").bytes
 # b'\xde\xad\xbe\xef'
 
 hx.Text()("data").hex
@@ -98,7 +132,7 @@ hx.Int(width=4, endian="little")(0x12345678).hex
 # '78563412'
 ```
 
-Formats compose with `>>`:
+Formats compose with `>>`, so reusable converters are normal Python objects:
 
 ```python
 to_text = hx.HexArray() >> hx.Text()
@@ -148,6 +182,9 @@ Use `convert` when you want an explicit source and target in one expression:
 hx.convert("de ad be ef", hx.Hex(sep=" "), hx.Bytes())
 # b'\xde\xad\xbe\xef'
 
+hx.convert(b"\xde\xad\xbe\xef", hx.Bytes(), hx.Hex(sep=" "))
+# 'de ad be ef'
+
 hx.convert("data", hx.Text(), hx.Hex(prefix=True))
 # '0x64617461'
 

{hexconv-0.2.3 → hexconv-0.2.4}/README.md

@@ -12,33 +12,67 @@ It is built around ergonomic one-liners and composable format objects.
 pip install hexconv
 ```
 
-## Quick tour
+## Fast compose
 
-Use direct helpers when you want one obvious conversion:
+The intended interface is small pieces snapped together:
+`source format >> optional transforms >> target format`.
 
 ```python
 import hexconv as hx
 
-hx.from_hex("dead beef").to_bytes()
+to_bytes = hx.Hex() >> hx.Bytes()
+to_bytes("de ad be ef")
 # b'\xde\xad\xbe\xef'
 
-hx.from_hex("dead beef").bytes
-# b'\xde\xad\xbe\xef'
+spaced_hex = hx.Bytes() >> hx.Hex(sep=" ")
+spaced_hex(b"\xde\xad\xbe\xef")
+# 'de ad be ef'
 
-hx.from_bytes_array([0xde, 0xad, 0xbe, 0xef]).to_hex()
-# 'deadbeef'
+words = hx.Hex(sep=" ") >> hx.Chunk(2) >> hx.IntArray(width=2)
+words("12 34 56 78")
+# [4660, 22136]
 
-hx.from_bytes_array([0xde, 0xad, 0xbe, 0xef]).hex
-# 'deadbeef'
+text_to_urlsafe = hx.Text() >> hx.Base64(urlsafe=True, padding=False)
+text_to_urlsafe("data")
+# 'ZGF0YQ'
+```
+
+Hex input accepts common separators, so spaced or copied hex usually does not
+need manual cleanup before conversion. `Hex(sep=" ")` is also how you emit
+space-separated hex.
+
+## Quick tour
+
+Use direct helpers when you want one obvious conversion across many
+representations:
+
+```python
+hx.from_hex("de ad be ef").bytes
+# b'\xde\xad\xbe\xef'
 
 hx.from_text("data").to_hex_array(prefix=True)
 # ['0x64', '0x61', '0x74', '0x61']
 
-hx.from_int(0xdeadbeef).to_bytes()
+hx.from_int(0xdeadbeef).bytes
 # b'\xde\xad\xbe\xef'
 
 hx.from_int_array([0x1234, 0x5678], width=2).to_hex_array(width=2)
 # ['1234', '5678']
+
+hx.from_binary("01100100 01100001 01110100 01100001").text
+# 'data'
+
+hx.from_base64("ZGF0YQ==").text
+# 'data'
+
+hx.from_escaped(r"\xde\xad").hex
+# 'dead'
+
+hx.from_struct((0x1234, 0x5678), fmt=">HH").hex
+# '12345678'
+
+hx.from_bits("101", pad=True).hex
+# '05'
 ```
 
 Use `from_auto` when you want a quick best-effort parse:
@@ -59,7 +93,7 @@ hx.from_auto([0xde, 0xad, 0xbe, 0xef]).to(hx.Hex(prefix=True))
 `hexconv` is built around small format objects. A format can parse directly:
 
 ```python
-hx.Hex()("dead beef").bytes
+hx.Hex()("de ad be ef").bytes
 # b'\xde\xad\xbe\xef'
 
 hx.Text()("data").hex
@@ -69,7 +103,7 @@ hx.Int(width=4, endian="little")(0x12345678).hex
 # '78563412'
 ```
 
-Formats compose with `>>`:
+Formats compose with `>>`, so reusable converters are normal Python objects:
 
 ```python
 to_text = hx.HexArray() >> hx.Text()
@@ -119,6 +153,9 @@ Use `convert` when you want an explicit source and target in one expression:
 hx.convert("de ad be ef", hx.Hex(sep=" "), hx.Bytes())
 # b'\xde\xad\xbe\xef'
 
+hx.convert(b"\xde\xad\xbe\xef", hx.Bytes(), hx.Hex(sep=" "))
+# 'de ad be ef'
+
 hx.convert("data", hx.Text(), hx.Hex(prefix=True))
 # '0x64617461'
 

{hexconv-0.2.3 → hexconv-0.2.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "hexconv"
-version = "0.2.3"
+version = "0.2.4"
 description = "Pythonic conversion toolkit for bytes, hex, integers, arrays, binary strings, base64, and text."
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.10"

{hexconv-0.2.3 → hexconv-0.2.4/src/hexconv.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hexconv
-Version: 0.2.3
+Version: 0.2.4
 Summary: Pythonic conversion toolkit for bytes, hex, integers, arrays, binary strings, base64, and text.
 Author: hexconv contributors
 License-Expression: MIT
@@ -41,33 +41,67 @@ It is built around ergonomic one-liners and composable format objects.
 pip install hexconv
 ```
 
-## Quick tour
+## Fast compose
 
-Use direct helpers when you want one obvious conversion:
+The intended interface is small pieces snapped together:
+`source format >> optional transforms >> target format`.
 
 ```python
 import hexconv as hx
 
-hx.from_hex("dead beef").to_bytes()
+to_bytes = hx.Hex() >> hx.Bytes()
+to_bytes("de ad be ef")
 # b'\xde\xad\xbe\xef'
 
-hx.from_hex("dead beef").bytes
-# b'\xde\xad\xbe\xef'
+spaced_hex = hx.Bytes() >> hx.Hex(sep=" ")
+spaced_hex(b"\xde\xad\xbe\xef")
+# 'de ad be ef'
 
-hx.from_bytes_array([0xde, 0xad, 0xbe, 0xef]).to_hex()
-# 'deadbeef'
+words = hx.Hex(sep=" ") >> hx.Chunk(2) >> hx.IntArray(width=2)
+words("12 34 56 78")
+# [4660, 22136]
 
-hx.from_bytes_array([0xde, 0xad, 0xbe, 0xef]).hex
-# 'deadbeef'
+text_to_urlsafe = hx.Text() >> hx.Base64(urlsafe=True, padding=False)
+text_to_urlsafe("data")
+# 'ZGF0YQ'
+```
+
+Hex input accepts common separators, so spaced or copied hex usually does not
+need manual cleanup before conversion. `Hex(sep=" ")` is also how you emit
+space-separated hex.
+
+## Quick tour
+
+Use direct helpers when you want one obvious conversion across many
+representations:
+
+```python
+hx.from_hex("de ad be ef").bytes
+# b'\xde\xad\xbe\xef'
 
 hx.from_text("data").to_hex_array(prefix=True)
 # ['0x64', '0x61', '0x74', '0x61']
 
-hx.from_int(0xdeadbeef).to_bytes()
+hx.from_int(0xdeadbeef).bytes
 # b'\xde\xad\xbe\xef'
 
 hx.from_int_array([0x1234, 0x5678], width=2).to_hex_array(width=2)
 # ['1234', '5678']
+
+hx.from_binary("01100100 01100001 01110100 01100001").text
+# 'data'
+
+hx.from_base64("ZGF0YQ==").text
+# 'data'
+
+hx.from_escaped(r"\xde\xad").hex
+# 'dead'
+
+hx.from_struct((0x1234, 0x5678), fmt=">HH").hex
+# '12345678'
+
+hx.from_bits("101", pad=True).hex
+# '05'
 ```
 
 Use `from_auto` when you want a quick best-effort parse:
@@ -88,7 +122,7 @@ hx.from_auto([0xde, 0xad, 0xbe, 0xef]).to(hx.Hex(prefix=True))
 `hexconv` is built around small format objects. A format can parse directly:
 
 ```python
-hx.Hex()("dead beef").bytes
+hx.Hex()("de ad be ef").bytes
 # b'\xde\xad\xbe\xef'
 
 hx.Text()("data").hex
@@ -98,7 +132,7 @@ hx.Int(width=4, endian="little")(0x12345678).hex
 # '78563412'
 ```
 
-Formats compose with `>>`:
+Formats compose with `>>`, so reusable converters are normal Python objects:
 
 ```python
 to_text = hx.HexArray() >> hx.Text()
@@ -148,6 +182,9 @@ Use `convert` when you want an explicit source and target in one expression:
 hx.convert("de ad be ef", hx.Hex(sep=" "), hx.Bytes())
 # b'\xde\xad\xbe\xef'
 
+hx.convert(b"\xde\xad\xbe\xef", hx.Bytes(), hx.Hex(sep=" "))
+# 'de ad be ef'
+
 hx.convert("data", hx.Text(), hx.Hex(prefix=True))
 # '0x64617461'
 

{hexconv-0.2.3 → hexconv-0.2.4}/tests/test_hexconv.py

@@ -46,6 +46,7 @@ def test_converter_class_matches_proposed_usage():
 def test_convert_one_shot():
     assert hx.convert("data", from_=hx.Text, to=hx.HexString) == "64617461"
     assert hx.convert("de ad be ef", hx.Hex(sep=" "), hx.Bytes()) == b"\xde\xad\xbe\xef"
+    assert hx.convert(b"\xde\xad\xbe\xef", hx.Bytes(), hx.Hex(sep=" ")) == "de ad be ef"
     assert hx.convert("data", hx.Text(), hx.Hex(prefix=True)) == "0x64617461"