hexconv 0.3.0__tar.gz → 0.3.1__tar.gz

{hexconv-0.3.0/src/hexconv.egg-info → hexconv-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hexconv
-Version: 0.3.0
+Version: 0.3.1
 Summary: Pythonic conversion toolkit for bytes, hex, integers, arrays, binary strings, base64, and text.
 Author: hexconv contributors
 License-Expression: MIT
@@ -24,7 +24,9 @@ License-File: LICENSE
 Provides-Extra: dev
 Requires-Dist: build; extra == "dev"
 Requires-Dist: hypothesis; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
 Requires-Dist: twine; extra == "dev"
 Dynamic: license-file
 
@@ -320,6 +322,23 @@ Available format specs all work in their simplest bare form:
 - `Bits()`
 - `Auto()`
 
+The short names are ergonomic aliases of the explicit long-form specs — pick
+whichever reads better, they resolve to the same format:
+
+| Short | Long form |
+| --- | --- |
+| `Hex` | `HexString` |
+| `Binary` | `BinaryString` |
+| `Base64` / `Base32` / `Base85` / `Ascii85` | `Base64String` / `Base32String` / `Base85String` / `Ascii85String` |
+| `Escaped` | `EscapedString` |
+| `Hexdump` | `HexDump` |
+| `Struct` | `StructFormat` |
+| `Bits` | `BitArray` |
+| `DecimalInt` / `DecimalIntArray` | `Int` / `IntArray` |
+| `LargeHexNumber` | `HexInt` |
+| `ASCIIText` / `RawString` | `Text` |
+| `Group` (transform) | `Chunk` |
+
 Add options only when you need control over formatting or parsing:
 
 - Display: `Hex(sep=" ", prefix=True, uppercase=True)`, `HexArray(width=2)`.

{hexconv-0.3.0 → hexconv-0.3.1}/README.md

@@ -290,6 +290,23 @@ Available format specs all work in their simplest bare form:
 - `Bits()`
 - `Auto()`
 
+The short names are ergonomic aliases of the explicit long-form specs — pick
+whichever reads better, they resolve to the same format:
+
+| Short | Long form |
+| --- | --- |
+| `Hex` | `HexString` |
+| `Binary` | `BinaryString` |
+| `Base64` / `Base32` / `Base85` / `Ascii85` | `Base64String` / `Base32String` / `Base85String` / `Ascii85String` |
+| `Escaped` | `EscapedString` |
+| `Hexdump` | `HexDump` |
+| `Struct` | `StructFormat` |
+| `Bits` | `BitArray` |
+| `DecimalInt` / `DecimalIntArray` | `Int` / `IntArray` |
+| `LargeHexNumber` | `HexInt` |
+| `ASCIIText` / `RawString` | `Text` |
+| `Group` (transform) | `Chunk` |
+
 Add options only when you need control over formatting or parsing:
 
 - Display: `Hex(sep=" ", prefix=True, uppercase=True)`, `HexArray(width=2)`.

{hexconv-0.3.0 → hexconv-0.3.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "hexconv"
-version = "0.3.0"
+version = "0.3.1"
 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"
@@ -32,7 +32,9 @@ classifiers = [
 dev = [
     "build",
     "hypothesis",
+    "mypy",
     "pytest",
+    "ruff",
     "twine",
 ]
 
@@ -45,3 +47,21 @@ hexconv = ["py.typed"]
 [tool.pytest.ini_options]
 testpaths = ["tests"]
 pythonpath = ["src"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "B", "UP"]
+
+[tool.ruff.lint.per-file-ignores]
+# Public re-exports are grouped by concept rather than sorted alphabetically.
+"src/hexconv/__init__.py" = ["I001"]
+
+[tool.mypy]
+python_version = "3.10"
+no_implicit_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+strict_equality = true

{hexconv-0.3.0 → hexconv-0.3.1}/src/hexconv/__init__.py

@@ -1,52 +1,60 @@
 """Conversion toolkit for bytes, hex, integers, arrays, binary, base64, and text."""
 
 from ._core import (
-    ASCIIText,
-    Auto,
+    # Core types and errors
     AutoResult,
-    Ascii85,
+    Converter,
+    HexConvError,
+    Pipeline,
+    Transform,
+    Value,
+    # Format specifications (explicit long-form names)
     Ascii85String,
-    Base64String,
-    Base64,
-    Base32,
+    Auto,
     Base32String,
-    Base85,
+    Base64String,
     Base85String,
     BinaryString,
-    Binary,
     BitArray,
-    Bits,
     Bytes,
     BytesArray,
     BytesString,
-    Chunk,
-    Converter,
-    DecimalInt,
-    DecimalIntArray,
-    Escaped,
     EscapedString,
-    Group,
-    Hex,
     HexArray,
-    HexConvError,
     HexDump,
-    Hexdump,
     HexInt,
     HexNumbersArray,
     HexString,
     Int,
     IntArray,
+    StructFormat,
+    Text,
+    # Short, ergonomic aliases for the format specifications above
+    ASCIIText,
+    Ascii85,
+    Base32,
+    Base64,
+    Base85,
+    Binary,
+    Bits,
+    DecimalInt,
+    DecimalIntArray,
+    Escaped,
+    Hex,
+    Hexdump,
     LargeHexNumber,
-    Pad,
-    Pipeline,
     RawString,
-    Reverse,
     Struct,
-    StructFormat,
-    Text,
-    Transform,
-    Value,
+    # Pipeline transforms
+    Chunk,
+    Group,
+    Pad,
+    Reverse,
+    # One-shot conversion and pipeline builders
     convert,
+    infer,
+    pipeline,
+    # Source helpers
     from_ascii85,
     from_auto,
     from_base32,
@@ -66,57 +74,63 @@ from ._core import (
     from_int_array,
     from_struct,
     from_text,
-    infer,
-    pipeline,
 )
 
 __all__ = [
-    "ASCIIText",
-    "Auto",
+    # Core types and errors
     "AutoResult",
-    "Ascii85",
+    "Converter",
+    "HexConvError",
+    "Pipeline",
+    "Transform",
+    "Value",
+    # Format specifications (explicit long-form names)
     "Ascii85String",
-    "Base32",
+    "Auto",
     "Base32String",
     "Base64String",
-    "Base64",
-    "Base85",
     "Base85String",
-    "Binary",
     "BinaryString",
     "BitArray",
-    "Bits",
     "Bytes",
     "BytesArray",
     "BytesString",
-    "Chunk",
-    "Converter",
-    "DecimalInt",
-    "DecimalIntArray",
-    "Escaped",
     "EscapedString",
-    "Group",
-    "Hex",
     "HexArray",
-    "HexConvError",
     "HexDump",
-    "Hexdump",
     "HexInt",
     "HexNumbersArray",
     "HexString",
     "Int",
     "IntArray",
+    "StructFormat",
+    "Text",
+    # Short, ergonomic aliases for the format specifications above
+    "ASCIIText",
+    "Ascii85",
+    "Base32",
+    "Base64",
+    "Base85",
+    "Binary",
+    "Bits",
+    "DecimalInt",
+    "DecimalIntArray",
+    "Escaped",
+    "Hex",
+    "Hexdump",
     "LargeHexNumber",
-    "Pad",
-    "Pipeline",
     "RawString",
-    "Reverse",
     "Struct",
-    "StructFormat",
-    "Text",
-    "Transform",
-    "Value",
+    # Pipeline transforms
+    "Chunk",
+    "Group",
+    "Pad",
+    "Reverse",
+    # One-shot conversion and pipeline builders
     "convert",
+    "infer",
+    "pipeline",
+    # Source helpers
     "from_ascii85",
     "from_auto",
     "from_base32",
@@ -136,6 +150,4 @@ __all__ = [
     "from_int_array",
     "from_struct",
     "from_text",
-    "infer",
-    "pipeline",
 ]

{hexconv-0.3.0 → hexconv-0.3.1}/src/hexconv/_core.py

@@ -3,12 +3,13 @@ from __future__ import annotations
 import ast
 import base64
 import binascii
+import builtins
 import codecs
 import re
 import struct
-from collections.abc import Iterable
+from collections.abc import Callable, Iterable
 from dataclasses import dataclass, field
-from typing import Any, Callable, Literal, TypeAlias, overload
+from typing import Any, Literal, TypeAlias, overload
 
 
 class HexConvError(ValueError):
@@ -18,12 +19,12 @@ class HexConvError(ValueError):
 class _Format:
     """Base class for public format marker classes."""
 
-    def __call__(self, value: Any) -> "Value":
+    def __call__(self, value: Any) -> Value:
         """Parse a value using this configured format."""
 
         return _parse(value, self)
 
-    def __rshift__(self, other: Any) -> "Pipeline":
+    def __rshift__(self, other: Any) -> Pipeline:
         """Compose this format with a transform, target format, or pipeline."""
 
         return Pipeline(source=self) >> other
@@ -87,7 +88,7 @@ class HexArray(_Format):
         width: int | None = None,
         prefix: bool = False,
         uppercase: bool = False,
-        endian: "Endian" = "big",
+        endian: Endian = "big",
         pad_odd: bool = True,
     ) -> None:
         self.width = width
@@ -118,7 +119,7 @@ class HexNumbersArray(_Format):
         self,
         *,
         width: int | None = 1,
-        endian: "Endian" = "big",
+        endian: Endian = "big",
         signed: bool = False,
     ) -> None:
         self.width = width
@@ -140,7 +141,7 @@ class HexInt(_Format):
         *,
         min_width: int = 1,
         width: int | None = None,
-        endian: "Endian" = "big",
+        endian: Endian = "big",
         signed: bool = False,
         pad_odd: bool = True,
     ) -> None:
@@ -174,7 +175,7 @@ class Int(_Format):
         *,
         min_width: int = 1,
         width: int | None = None,
-        endian: "Endian" = "big",
+        endian: Endian = "big",
         signed: bool = False,
     ) -> None:
         self.min_width = min_width
@@ -205,7 +206,7 @@ class IntArray(_Format):
         self,
         *,
         width: int | None = None,
-        endian: "Endian" = "big",
+        endian: Endian = "big",
         signed: bool = False,
     ) -> None:
         self.width = width
@@ -258,7 +259,7 @@ class BinaryString(_Format):
         sep: str = "",
         prefix: bool = False,
         pad_odd: bool = True,
-        bit_order: "BitOrder" = "msb",
+        bit_order: BitOrder = "msb",
     ) -> None:
         self.sep = sep
         self.prefix = prefix
@@ -414,9 +415,9 @@ class BitArray(_Format):
     def __init__(
         self,
         *,
-        bit_order: "BitOrder" = "msb",
+        bit_order: BitOrder = "msb",
         pad: bool = True,
-        pad_side: "PadSide" = "left",
+        pad_side: PadSide = "left",
     ) -> None:
         self.bit_order = bit_order
         self.pad = pad
@@ -468,12 +469,12 @@ class Value:
     source: str | None = None
     meta: dict[str, Any] = field(default_factory=dict)
 
-    def with_data(self, data: bytes, *, source: str | None = None) -> "Value":
+    def with_data(self, data: bytes, *, source: str | None = None) -> Value:
         """Return a copy with different bytes and preserved metadata."""
 
         return Value(bytes(data), source=source or self.source, meta=dict(self.meta))
 
-    def with_meta(self, **meta: Any) -> "Value":
+    def with_meta(self, **meta: Any) -> Value:
         """Return a copy with additional metadata used by composable transforms."""
 
         merged = dict(self.meta)
@@ -773,17 +774,18 @@ class Value:
             raise HexConvError("chunk width cannot be None")
         return chunk_width
 
-    # `int`/`integer` shadow the builtin, so they are defined after every method
-    # whose annotations reference the builtin `int` (integer before int keeps
-    # both of these return annotations resolving to the builtin too).
+    # ``int``/``integer`` are convenience shortcuts whose names shadow the builtin
+    # ``int``. They are declared after every method above so those methods keep
+    # annotating with the builtin, and they spell their own return type as
+    # ``builtins.int`` so their order here does not matter.
     @property
-    def integer(self) -> int:
+    def int(self) -> builtins.int:
         """Shortcut for to_int()."""
 
         return self.to_int()
 
     @property
-    def int(self) -> int:
+    def integer(self) -> builtins.int:
         """Shortcut for to_int()."""
 
         return self.to_int()
@@ -805,7 +807,7 @@ class Transform:
     def __call__(self, value: Any) -> Value:
         return self.apply(_ensure_value(value))
 
-    def __rshift__(self, other: Any) -> "Pipeline":
+    def __rshift__(self, other: Any) -> Pipeline:
         return Pipeline(transforms=[self]) >> other
 
     def apply(self, value: Value) -> Value:
@@ -861,7 +863,7 @@ class Pad(Transform):
         width: int | None = None,
         block_size: int | None = None,
         byte: int = 0,
-    ) -> "Pad":
+    ) -> Pad:
         return cls(width=width, block_size=block_size, byte=byte, side="left")
 
     @classmethod
@@ -871,7 +873,7 @@ class Pad(Transform):
         width: int | None = None,
         block_size: int | None = None,
         byte: int = 0,
-    ) -> "Pad":
+    ) -> Pad:
         return cls(width=width, block_size=block_size, byte=byte, side="right")
 
     def apply(self, value: Value) -> Value:
@@ -908,23 +910,23 @@ class Pipeline:
         self.transforms = list(transforms or [])
         self.target = target
 
-    def from_(self, source: FormatLike) -> "Pipeline":
+    def from_(self, source: FormatLike) -> Pipeline:
         return Pipeline(source=source, transforms=self.transforms, target=self.target)
 
-    def to(self, target: FormatLike) -> "Pipeline":
+    def to(self, target: FormatLike) -> Pipeline:
         return Pipeline(source=self.source, transforms=self.transforms, target=target)
 
-    def then(self, transform: Transform) -> "Pipeline":
+    def then(self, transform: Transform) -> Pipeline:
         return Pipeline(
             source=self.source,
             transforms=[*self.transforms, transform],
             target=self.target,
         )
 
-    def chunk(self, width: int, *, strict: bool = True) -> "Pipeline":
+    def chunk(self, width: int, *, strict: bool = True) -> Pipeline:
         return self.then(Chunk(width, strict=strict))
 
-    def group(self, width: int, *, strict: bool = True) -> "Pipeline":
+    def group(self, width: int, *, strict: bool = True) -> Pipeline:
         return self.then(Group(width, strict=strict))
 
     def pad(
@@ -934,13 +936,13 @@ class Pipeline:
         block_size: int | None = None,
         byte: int = 0,
         side: PadSide = "left",
-    ) -> "Pipeline":
+    ) -> Pipeline:
         return self.then(Pad(width=width, block_size=block_size, byte=byte, side=side))
 
-    def reverse(self) -> "Pipeline":
+    def reverse(self) -> Pipeline:
         return self.then(Reverse())
 
-    def __rshift__(self, other: Any) -> "Pipeline":
+    def __rshift__(self, other: Any) -> Pipeline:
         if isinstance(other, Pipeline):
             source = self.source if self.source is not None else other.source
             return Pipeline(
@@ -1657,10 +1659,7 @@ def _format_options(format_: FormatLike, direction: str) -> dict[str, Any]:
 def _ensure_value(value: Any) -> Value:
     if isinstance(value, Value):
         return value
-    parsed = from_auto(value)
-    if isinstance(parsed, AutoResult):
-        return parsed.value
-    return parsed
+    return from_auto(value)
 
 
 def _validate_endian(endian: Endian) -> None:
@@ -1850,6 +1849,8 @@ def _int_to_bytes(
 
 
 def _signed_int_to_minimal_bytes(value: int, *, min_width: int, endian: Endian) -> bytes:
+    # Two's complement needs a bit beyond the magnitude for the sign, so start
+    # one byte wider than the magnitude and widen further until the value fits.
     candidate = max(min_width, 1, (abs(value).bit_length() + 8) // 8)
     for width in range(candidate, candidate + 2):
         try:

{hexconv-0.3.0 → hexconv-0.3.1/src/hexconv.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hexconv
-Version: 0.3.0
+Version: 0.3.1
 Summary: Pythonic conversion toolkit for bytes, hex, integers, arrays, binary strings, base64, and text.
 Author: hexconv contributors
 License-Expression: MIT
@@ -24,7 +24,9 @@ License-File: LICENSE
 Provides-Extra: dev
 Requires-Dist: build; extra == "dev"
 Requires-Dist: hypothesis; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
 Requires-Dist: twine; extra == "dev"
 Dynamic: license-file
 
@@ -320,6 +322,23 @@ Available format specs all work in their simplest bare form:
 - `Bits()`
 - `Auto()`
 
+The short names are ergonomic aliases of the explicit long-form specs — pick
+whichever reads better, they resolve to the same format:
+
+| Short | Long form |
+| --- | --- |
+| `Hex` | `HexString` |
+| `Binary` | `BinaryString` |
+| `Base64` / `Base32` / `Base85` / `Ascii85` | `Base64String` / `Base32String` / `Base85String` / `Ascii85String` |
+| `Escaped` | `EscapedString` |
+| `Hexdump` | `HexDump` |
+| `Struct` | `StructFormat` |
+| `Bits` | `BitArray` |
+| `DecimalInt` / `DecimalIntArray` | `Int` / `IntArray` |
+| `LargeHexNumber` | `HexInt` |
+| `ASCIIText` / `RawString` | `Text` |
+| `Group` (transform) | `Chunk` |
+
 Add options only when you need control over formatting or parsing:
 
 - Display: `Hex(sep=" ", prefix=True, uppercase=True)`, `HexArray(width=2)`.

{hexconv-0.3.0 → hexconv-0.3.1}/src/hexconv.egg-info/requires.txt

@@ -2,5 +2,7 @@
 [dev]
 build
 hypothesis
+mypy
 pytest
+ruff
 twine