v1.0

.github/workflows/ci.yml

@@ -9,33 +9,29 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - python-version: "3.9"
-            tox-env: py39
           - python-version: "3.10"
             tox-env: py310
           - python-version: "3.11"
             tox-env: py311
           - python-version: "3.12"
             tox-env: py312
-          - python-version: "3.13.0-rc.1"
+          - python-version: "3.13"
             tox-env: py313
-          - python-version: "pypy-3.9"
-            tox-env: pypy39
           - python-version: "pypy-3.10"
             tox-env: pypy310
-          - python-version: "3.12"
+          - python-version: "3.13"
             tox-env: mypy
-          - python-version: "3.12"
+          - python-version: "3.13"
             tox-env: lint
+          - python-version: "3.13"
+            tox-env: format
     steps:
-    - uses: actions/checkout@v4.1.7
+    - uses: actions/checkout@v4.2.2
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5.2.0
+      uses: actions/setup-python@v5.3.0
       with:
         python-version: ${{ matrix.python-version }}
     - name: Pre-installation requirements
-      run: pip3 install -U pip wheel setuptools
-    - name: Install dependencies
-      run: pip3 install -Ur dev-requirements.txt
+      run: pip3 install -U pip wheel setuptools -r dev-requirements.txt
     - name: Run tests
       run: tox -e ${{ matrix.tox-env }}

.mypy.ini

@@ -0,0 +1,24 @@
+[mypy]
+allow_untyped_globals = false
+allow_redefinition = false
+check_untyped_defs = true
+disallow_any_decorated = false
+disallow_any_generics = true
+disallow_any_unimported = true
+disallow_incomplete_defs = true
+disallow_subclassing_any = true
+disallow_untyped_calls = true
+disallow_untyped_decorators = true
+disallow_untyped_defs = true
+follow_untyped_imports = true
+ignore_missing_imports = false
+implicit_reexport = false
+no_implicit_optional = true
+pretty = true
+show_error_codes = true
+strict_optional = true
+warn_no_return = true
+warn_unreachable = true
+warn_unused_ignores = true
+warn_redundant_casts = true
+warn_return_any = true

.pytest.ini

@@ -0,0 +1,20 @@
+[pytest]
+addopts =
+    -vv
+    --cov=binobj
+    --import-mode importlib
+filterwarnings =
+    always::DeprecationWarning
+
+
+[coverage:run]
+branch = true
+source = binobj
+plugins =
+    coverage_pyver_pragma
+
+[coverage:report]
+show_missing = true
+skip_covered = true
+fail_under = 96.9
+precision = 1

.ruff.toml

@@ -0,0 +1,52 @@
+target-version = "py310"
+
+[lint]
+exclude = ["docs/*"]
+select = ["ALL"]
+extend-ignore = [
+    "ANN401",
+    "COM812",
+    "CPY001",   # Requires copyright notice in every file
+    "D105",
+    "D107",
+    "DTZ",
+    "EM",
+    "ERA001",
+    "FBT",
+    "FIX002",
+    "PLR2004",
+    "TD003",
+    "TRY003",
+]
+
+[lint.pyupgrade]
+keep-runtime-typing = true
+
+[lint.per-file-ignores]
+"__init__.py" = ["F403", "PLC0414"]
+"tests/*" = [
+    "ANN",
+    "D",        # Forces docstrings and such
+    "PLR6301",  # Method could be a function, class method, or static method
+    "S101",
+    "S311",
+]
+"tests/pep526_*.py" = ["N802", "N803", "I002"]
+"tests/full_examples/cpio_test.py" = ["PLR6301"]
+"tests/validators_test.py" = ["PLR6301"]
+
+[lint.isort]
+force-single-line = true
+known-first-party = ["binobj"]
+lines-after-imports = 2
+order-by-type = false
+required-imports = ["from __future__ import annotations"]
+
+[lint.mccabe]
+max-complexity = 9
+
+[lint.flake8-annotations]
+mypy-init-return = true
+
+[lint.pydocstyle]
+convention = "google"

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2017-2024, Diego Argueta
+Copyright (c) 2017-2026, Diego Argueta
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

Makefile

@@ -10,7 +10,8 @@ PIP := python3 -m pip
 
 
 poetry.lock: pyproject.toml
-	poetry lock --no-update
+	# Poetry 2.0 removed --no-update
+	poetry lock --no-update || poetry lock
 	touch $@
 
 # Coverage file gets changed on every test run so we can use it to see when the
@@ -32,6 +33,11 @@ setup:
 lint: $(SOURCEFILES)
 	tox -e lint
 
+.PHONY: format
+format:
+	poetry run ruff check --select I --fix binobj tests
+	poetry run ruff format binobj tests
+
 .PHONY: clean
 clean:
 	-$(MAKE) -C $(DOCSDIR) clean

README.rst

@@ -6,7 +6,7 @@ binobj
 .. |build-status| image:: https://github.com/dargueta/binobj/actions/workflows/ci.yml/badge.svg
    :alt: Build status
 
-.. |python-versions| image:: https://img.shields.io/badge/python-3.9,%203.10,%203.11,%203.12,%203.13-blue.svg
+.. |python-versions| image:: https://img.shields.io/badge/python-3.10,%203.11,%203.12,%203.13-blue.svg
    :alt: Python versions
 
 .. |installs-month| image:: https://pepy.tech/badge/binobj/month
@@ -50,7 +50,7 @@ The same example rewritten using ``binobj``:
 
         magic: Bytes = b"BM"
         file_size: UInt32
-        _reserved: binobj.Bytes(const=b"\0\0\0\0", discard=True)
+        _reserved: binobj.Bytes(const=True, default=b"\0\0\0\0", discard=True)
         pixels_offset: UInt32
 
         # Legacy DIB header
@@ -81,7 +81,7 @@ System Requirements
 
 - This package will *not* work on a `mixed-endian`_ system. Those are pretty rare
   nowadays so chances are you won't have a problem.
-- This has been tested on CPython 3.9-3.13, PyPy 3.9-3.10.
+- This has been tested on CPython 3.10-3.13, and PyPy 3.10.
 
 .. _mixed-endian: https://en.wikipedia.org/wiki/Endianness#Mixed
 

binobj/__init__.py

@@ -4,7 +4,6 @@
 
 import importlib.metadata
 from typing import NamedTuple
-from typing import Optional
 
 from .errors import *
 from .fields import *
@@ -18,7 +17,7 @@ class VersionInfo(NamedTuple):
     major: int
     minor: int
     patch: int
-    suffix: Optional[str]
+    suffix: str | None
 
     @classmethod
     def from_string(cls, version: str) -> VersionInfo:
@@ -29,11 +28,12 @@ def from_string(cls, version: str) -> VersionInfo:
         return cls(int(major), int(minor), int(patch), suffix or None)
 
     def __str__(self) -> str:
+        version = f"{self.major}.{self.minor}.{self.patch}"
         # Having a version suffix is rare for this library, so we'll tell pycoverage to
         # ignore this branch.
         if self.suffix:  # pragma: no cover
-            return "%d.%d.%d-%s" % (self.major, self.minor, self.patch, self.suffix)
-        return "%d.%d.%d" % (self.major, self.minor, self.patch)
+            return version + f"-{self.suffix}"
+        return version
 
 
 __version__ = importlib.metadata.version("binobj")

binobj/decorators.py

@@ -3,13 +3,11 @@
 from __future__ import annotations
 
 import functools
-from typing import Callable
-from typing import Optional
 from typing import TYPE_CHECKING
-from typing import Union
 
 
 if TYPE_CHECKING:  # pragma: no cover
+    from collections.abc import Callable
     from collections.abc import Iterable
     from typing import Any
 
@@ -29,13 +27,13 @@ class ValidatorMethodWrapper:
     """
 
     def __init__(
-        self, func: Union[FieldValidator, StructValidator], field_names: Iterable[str]
+        self, func: FieldValidator | StructValidator, field_names: Iterable[str]
     ):
         self.func = func
         self.field_names = tuple(field_names or ())
         functools.wraps(func)(self)
 
-    def __call__(self, *args: Any) -> Optional[bool]:
+    def __call__(self, *args: Any) -> bool | None:
         """Execute the wrapped function."""
         return self.func(*args)