cfinterface 1.9.0__tar.gz → 1.10.0__tar.gz

{cfinterface-1.9.0 → cfinterface-1.10.0}/.gitignore

@@ -134,5 +134,8 @@ dmypy.json
 
 .vscode/
 
+# Implementation plans
+plans/
+
 # Build system
 uv.lock

{cfinterface-1.9.0 → cfinterface-1.10.0}/CHANGELOG.md

@@ -7,6 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.10.0] - 2026-04-13
+
+### Added
+
+- `compact` parameter on `FloatField` (`compact=False` by default) that omits the leading zero for values where `0 < |value| < 1`, matching Fortran fixed-width file conventions and preserving precision in narrow fields
+
+### Fixed
+
+- `RegisterReading.read()` now resets its internal data before each call, preventing register duplication when `RegisterFile.read()` retries with fallback encodings after a mid-file `UnicodeDecodeError`
+
+## [1.9.1] - 2026-03-08
+
+### Fixed
+
+- Translate all documentation and examples from pt-BR to English, matching the project's established language
+- Change Sphinx language setting from `pt_BR` to `en`
+
 ## [1.9.0] - 2026-03-08
 
 ### Added
@@ -67,5 +84,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Null value detection in `Field` write methods now uses `math.isnan()` instead of `pd.isnull()`, eliminating the unnecessary pandas import at module level
 - `RegisterFile._as_df()` now performs a lazy pandas import, only importing the library when the method is actually called
 
-[Unreleased]: https://github.com/rjmalves/cfinterface/compare/v1.9.0...HEAD
+[Unreleased]: https://github.com/rjmalves/cfinterface/compare/v1.9.1...HEAD
+[1.9.1]: https://github.com/rjmalves/cfinterface/compare/v1.9.0...v1.9.1
 [1.9.0]: https://github.com/rjmalves/cfinterface/compare/v1.8.3...v1.9.0

cfinterface-1.10.0/CONTRIBUTING.md

@@ -0,0 +1,36 @@
+# Contributing
+
+Thank you for your interest in contributing to **cfinterface**! This page
+summarises the essential steps. For detailed instructions, see the
+[full contribution documentation](https://rjmalves.github.io/cfinterface/getting_started/contributing.html).
+
+## Reporting Bugs
+
+Found unexpected behavior? Open an
+[issue on GitHub](https://github.com/rjmalves/cfinterface/issues) describing
+the problem. Include the Python version, the operating system, and a code
+snippet that allows the error to be reproduced.
+
+## Submitting Pull Requests
+
+Fixes and improvements are welcome via
+[pull request](https://github.com/rjmalves/cfinterface/pulls). Before
+submitting, read the full documentation to ensure that the code follows the
+project conventions and that all tests and quality checks pass.
+
+## Quick Setup
+
+```bash
+git clone https://github.com/rjmalves/cfinterface.git
+cd cfinterface
+uv sync --extra dev
+uv run pre-commit install
+```
+
+## Full Documentation
+
+See the contribution page in the project documentation for details on
+pre-commit hooks, code conventions, running tests, and building the
+documentation:
+
+<https://rjmalves.github.io/cfinterface/getting_started/contributing.html>

{cfinterface-1.9.0 → cfinterface-1.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cfinterface
-Version: 1.9.0
+Version: 1.10.0
 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.9.0 → cfinterface-1.10.0}/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.9.0"
+__version__ = "1.10.0"
 
 from . import components  # noqa
 from . import data  # noqa

{cfinterface-1.9.0 → cfinterface-1.10.0}/cfinterface/components/floatfield.py

@@ -13,7 +13,7 @@ class FloatField(Field):
     by 'F' for fixed point notation and 'E' or 'D' for scientific notation.
     """
 
-    __slots__ = ["__decimal_digits", "__format", "__sep", "__type"]
+    __slots__ = ["__compact", "__decimal_digits", "__format", "__sep", "__type"]
 
     TYPES = {
         2: np.float16,
@@ -29,12 +29,14 @@ class FloatField(Field):
         format: str = "F",
         sep: str = ".",
         value: float | None = None,
+        compact: bool = False,
     ) -> None:
         super().__init__(
             size,
             starting_position,
             value,
         )
+        self.__compact = compact
         self.__decimal_digits = decimal_digits
         self.__format = format
         self.__sep = sep
@@ -63,6 +65,14 @@ class FloatField(Field):
         else:
             return np.array([self._value], dtype=self.__type).tobytes()
 
+    def _apply_compact(self, value: str) -> str:
+        if self.__compact and 0 < abs(self._value) < 1:
+            if value.startswith("0."):
+                return value[1:]
+            if value.startswith("-0."):
+                return "-" + value[2:]
+        return value
+
     def _textual_write(self) -> str:
         value = ""
         if self.value is not None and not _is_null(self.value):
@@ -97,6 +107,7 @@ class FloatField(Field):
                     d=self.__decimal_digits,
                     format=formatting_format,
                 ).replace("E", self.__format)
+                value = self._apply_compact(value)
                 if len(value) > self._size:
                     excess = len(value) - self._size
                     new_d = self.__decimal_digits - excess
@@ -107,6 +118,7 @@ class FloatField(Field):
                         d=new_d,
                         format=formatting_format,
                     ).replace("E", self.__format)
+                    value = self._apply_compact(value)
                     if len(value) > self._size:
                         new_d = max(0, new_d - 1)
                         value = "{:.{d}{format}}".format(
@@ -114,6 +126,7 @@ class FloatField(Field):
                             d=new_d,
                             format=formatting_format,
                         ).replace("E", self.__format)
+                        value = self._apply_compact(value)
         return value.rjust(self.size)
 
     @property

{cfinterface-1.9.0 → cfinterface-1.10.0}/cfinterface/reading/registerreading.py

@@ -82,6 +82,7 @@ class RegisterReading:
         :return: The data from the registers found in the file
         :rtype: RegisterData
         """
+        self.__data = RegisterData(DefaultRegister(data=""))
         self.__repository = factory(self.__storage)(
             content, not isfile(content), encoding
         )

{cfinterface-1.9.0 → cfinterface-1.10.0}/docs/source/conf.py

@@ -58,7 +58,7 @@ templates_path = ["_templates"]
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = "pt_BR"
+language = "en"
 
 # The suffix of source filenames.
 source_suffix = ".rst"

cfinterface-1.10.0/docs/source/getting_started/contributing.rst

@@ -0,0 +1,103 @@
+Contributing
+============
+
+To report unexpected behavior, open an
+`issue <https://github.com/rjmalves/cfinterface/issues>`_ in the repository.
+When doing so, it is recommended to provide basic information (Python version,
+operating system) along with a code snippet that allows the problem to be
+reproduced. If you have found a possible fix for an existing issue,
+`pull requests <https://github.com/rjmalves/cfinterface/pulls>`_
+are welcome. In that case, please review the content of this page before
+submitting your contribution.
+
+
+Development Environment Setup
+-------------------------------
+
+To install the development dependencies, run the commands below:
+
+.. code-block:: bash
+
+    git clone https://github.com/rjmalves/cfinterface.git
+    cd cfinterface
+    uv sync --extra dev
+    uv run pre-commit install
+
+
+Pre-commit Hooks
+-----------------
+
+The project uses `pre-commit <https://pre-commit.com/>`_ to automatically
+enforce code quality before each commit. Three hooks are configured:
+
+- **ruff** (v0.9.10): linter with automatic fixes (``--fix``)
+- **ruff-format** (v0.9.10): code formatting
+- **mypy** (v1.19.1): static type checking, applied only to the
+  ``cfinterface/`` directory
+
+To run all hooks manually against all files:
+
+.. code-block:: bash
+
+    uv run pre-commit run --all-files
+
+
+Code Conventions
+-----------------
+
+The project uses ``ruff`` for linting and formatting, and ``mypy`` for static
+typing. To run the checks manually:
+
+.. code-block:: bash
+
+    uv run ruff check ./cfinterface
+    uv run ruff format --check ./cfinterface
+    uv run mypy ./cfinterface
+
+These same checks are run in the CI workflows. For a version to be published
+successfully, all requirements must be met.
+
+
+Tests
+------
+
+The adopted testing framework is `pytest <https://docs.pytest.org/en/stable/>`_.
+
+To run all tests:
+
+.. code-block:: bash
+
+    uv run pytest ./tests
+
+To run only the performance tests with
+`pytest-benchmark <https://pytest-benchmark.readthedocs.io/>`_:
+
+.. code-block:: bash
+
+    uv run pytest ./tests --benchmark-only
+
+To check test coverage with
+`pytest-cov <https://pytest-cov.readthedocs.io/>`_:
+
+.. code-block:: bash
+
+    uv run pytest ./tests --cov=cfinterface
+
+
+Documentation
+--------------
+
+The documentation is built with `Sphinx <https://www.sphinx-doc.org/>`_ and the
+`Furo <https://pradyunsg.me/furo/>`_ theme. To generate the documentation
+locally:
+
+.. code-block:: bash
+
+    uv run sphinx-build -W -b html docs/source docs/build/html
+
+.. note::
+
+    The content generated by the build **must not be committed** to the
+    repository. Artifacts are built and published automatically by the
+    `GitHub Actions <https://github.com/features/actions>`_ workflows on
+    every change to the ``main`` branch.