cfinterface 1.10.1__tar.gz → 1.10.2__tar.gz

{cfinterface-1.10.1 → cfinterface-1.10.2}/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.10.2] - 2026-10-14
+
+### Fixed
+
+- Type `SectionFile.read()`, `RegisterFile.read()` and `BlockFile.read()` (and their `read_many()`) as returning the calling subclass instead of the base class, so mypy sees the attributes of files such as `Dadger` or `Caso` read through them
+
 ## [1.10.1] - 2026-04-13
 
 ### Fixed

{cfinterface-1.10.1 → cfinterface-1.10.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: cfinterface
-Version: 1.10.1
+Version: 1.10.2
 Summary: Interface for handling custom formatted files
 Project-URL: Documentation, https://rjmalves.github.io/cfinterface/
 Project-URL: Repository, https://github.com/rjmalves/cfinterface/

{cfinterface-1.10.1 → cfinterface-1.10.2}/cfinterface/__init__.py

@@ -6,7 +6,7 @@ cfi is a Python module for handling custom formatted files
 and provide reading, storing and writing utilities.
 """
 
-__version__ = "1.10.1"
+__version__ = "1.10.2"
 
 from . import components  # noqa
 from . import data  # noqa

{cfinterface-1.10.1 → cfinterface-1.10.2}/cfinterface/files/blockfile.py

@@ -1,5 +1,5 @@
 import warnings
-from typing import IO, TYPE_CHECKING, Any
+from typing import IO, TYPE_CHECKING, Any, TypeVar
 
 from cfinterface.components.block import Block
 from cfinterface.components.defaultblock import DefaultBlock
@@ -12,6 +12,8 @@ from cfinterface.writing.blockwriting import BlockWriting
 if TYPE_CHECKING:
     from cfinterface.versioning import VersionMatchResult
 
+_BlockFileT = TypeVar("_BlockFileT", bound="BlockFile")
+
 
 class BlockFile:
     """
@@ -48,12 +50,12 @@ class BlockFile:
 
     @classmethod
     def read(
-        cls,
+        cls: type[_BlockFileT],
         content: str | bytes,
         *args: Any,
         version: str | None = None,
         **kwargs: Any,
-    ) -> "BlockFile":
+    ) -> _BlockFileT:
         """Read from a file path or buffer. ``version`` selects a component set
         from VERSIONS without mutating the class."""
         components = cls.BLOCKS
@@ -86,11 +88,11 @@ class BlockFile:
 
     @classmethod
     def read_many(
-        cls,
+        cls: type[_BlockFileT],
         paths: list[str],
         *,
         version: str | None = None,
-    ) -> dict[str, "BlockFile"]:
+    ) -> dict[str, _BlockFileT]:
         """Read multiple files and return a dict keyed by file path.
 
         Parameters

{cfinterface-1.10.1 → cfinterface-1.10.2}/cfinterface/files/registerfile.py

@@ -1,5 +1,5 @@
 import warnings
-from typing import IO, TYPE_CHECKING, Any
+from typing import IO, TYPE_CHECKING, Any, TypeVar
 
 from cfinterface.components.defaultregister import DefaultRegister
 from cfinterface.components.register import Register
@@ -12,6 +12,8 @@ from cfinterface.writing.registerwriting import RegisterWriting
 if TYPE_CHECKING:
     from cfinterface.versioning import VersionMatchResult
 
+_RegisterFileT = TypeVar("_RegisterFileT", bound="RegisterFile")
+
 
 class RegisterFile:
     """
@@ -65,12 +67,12 @@ class RegisterFile:
 
     @classmethod
     def read(
-        cls,
+        cls: type[_RegisterFileT],
         content: str | bytes,
         *args: Any,
         version: str | None = None,
         **kwargs: Any,
-    ) -> "RegisterFile":
+    ) -> _RegisterFileT:
         """Read from a file path or buffer. ``version`` selects a component set
         from VERSIONS without mutating the class."""
         components = cls.REGISTERS
@@ -103,11 +105,11 @@ class RegisterFile:
 
     @classmethod
     def read_many(
-        cls,
+        cls: type[_RegisterFileT],
         paths: list[str],
         *,
         version: str | None = None,
-    ) -> dict[str, "RegisterFile"]:
+    ) -> dict[str, _RegisterFileT]:
         """Read multiple files and return a dict keyed by file path.
 
         Parameters

{cfinterface-1.10.1 → cfinterface-1.10.2}/cfinterface/files/sectionfile.py

@@ -1,5 +1,5 @@
 import warnings
-from typing import IO, TYPE_CHECKING, Any
+from typing import IO, TYPE_CHECKING, Any, TypeVar
 
 from cfinterface.components.defaultsection import DefaultSection
 from cfinterface.components.section import Section
@@ -12,6 +12,8 @@ from cfinterface.writing.sectionwriting import SectionWriting
 if TYPE_CHECKING:
     from cfinterface.versioning import VersionMatchResult
 
+_SectionFileT = TypeVar("_SectionFileT", bound="SectionFile")
+
 
 class SectionFile:
     """
@@ -48,12 +50,12 @@ class SectionFile:
 
     @classmethod
     def read(
-        cls,
+        cls: type[_SectionFileT],
         content: str | bytes,
         *args: Any,
         version: str | None = None,
         **kwargs: Any,
-    ) -> "SectionFile":
+    ) -> _SectionFileT:
         """Read from a file path or buffer. ``version`` selects a component set
         from VERSIONS without mutating the class."""
         components = cls.SECTIONS
@@ -86,11 +88,11 @@ class SectionFile:
 
     @classmethod
     def read_many(
-        cls,
+        cls: type[_SectionFileT],
         paths: list[str],
         *,
         version: str | None = None,
-    ) -> dict[str, "SectionFile"]:
+    ) -> dict[str, _SectionFileT]:
         """Read multiple files and return a dict keyed by file path.
 
         Parameters

cfinterface-1.10.2/tests/files/test_read_typing.py

@@ -0,0 +1,38 @@
+from pathlib import Path
+
+import pytest
+from mypy import api
+
+SUBCLASS_READS = """
+from cfinterface.files.blockfile import BlockFile
+from cfinterface.files.registerfile import RegisterFile
+from cfinterface.files.sectionfile import SectionFile
+
+
+class MySectionFile(SectionFile):
+    pass
+
+
+class MyRegisterFile(RegisterFile):
+    pass
+
+
+class MyBlockFile(BlockFile):
+    pass
+
+
+section: MySectionFile = MySectionFile.read("file.txt")
+register: MyRegisterFile = MyRegisterFile.read("file.txt")
+block: MyBlockFile = MyBlockFile.read("file.txt")
+sections: dict[str, MySectionFile] = MySectionFile.read_many(["file.txt"])
+registers: dict[str, MyRegisterFile] = MyRegisterFile.read_many(["file.txt"])
+blocks: dict[str, MyBlockFile] = MyBlockFile.read_many(["file.txt"])
+"""
+
+
+@pytest.mark.slow
+def test_read_is_typed_as_returning_the_subclass(tmp_path: Path):
+    stdout, stderr, status = api.run(
+        ["--cache-dir", str(tmp_path), "-c", SUBCLASS_READS]
+    )
+    assert status == 0, stdout + stderr