cfinterface 1.8.3__tar.gz → 1.9.1__tar.gz

cfinterface-1.9.1/.github/workflows/benchmark.yml

@@ -0,0 +1,34 @@
+name: benchmarks
+
+on:
+  workflow_dispatch:
+    inputs:
+      benchmark-min-rounds:
+        description: "Minimum rounds per benchmark"
+        required: false
+        default: "5"
+        type: string
+
+jobs:
+  benchmark:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - name: Set up Python 3.12
+        run: uv python install 3.12
+      - name: Install the project
+        run: |
+          uv sync --all-extras --dev
+      - name: Run benchmarks
+        run: |
+          uv run pytest -m benchmark --benchmark-only \
+            --benchmark-min-rounds=${{ inputs.benchmark-min-rounds }} \
+            --benchmark-json=benchmark-results.json
+      - name: Upload benchmark results
+        uses: actions/upload-artifact@v4
+        with:
+          name: benchmark-results
+          path: benchmark-results.json
+          retention-days: 30

cfinterface-1.9.1/.github/workflows/docs.yml

@@ -0,0 +1,45 @@
+name: Docs
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - name: Set up Python
+        run: uv python install 3.12
+      - name: Install the project
+        run: uv sync --all-extras --dev
+      - name: Sphinx build
+        run: uv run python -m sphinx -M html docs/source docs/build -W
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/build/html
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

cfinterface-1.9.1/.github/workflows/main.yml

@@ -0,0 +1,77 @@
+name: tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: ubuntu-latest
+            python-version: "3.10"
+          - os: ubuntu-latest
+            python-version: "3.11"
+          - os: ubuntu-latest
+            python-version: "3.12"
+          - os: ubuntu-latest
+            python-version: "3.13"
+          - os: ubuntu-latest
+            python-version: "3.14"
+          - os: windows-latest
+            python-version: "3.12"
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+      - name: Install the project
+        run: |
+          uv sync --all-extras --dev
+      - name: Run tests
+        run: |
+          uv run pytest -m "not benchmark" --cov-report=xml --cov=cfinterface ./tests
+      - name: Upload coverage
+        if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.12'
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage.xml
+          flags: unittests
+          env_vars: OS,PYTHON
+          name: codecov-cfinterface
+          fail_ci_if_error: true
+          verbose: true
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - name: Set up Python 3.12
+        run: uv python install 3.12
+      - name: Install the project
+        run: |
+          uv sync --all-extras --dev
+      - name: Mypy
+        run: |
+          uv run mypy ./cfinterface
+      - name: Ruff
+        run: |
+          uv run ruff check ./cfinterface
+      - name: Ty (informational)
+        continue-on-error: true
+        run: |
+          uvx ty check ./cfinterface
+      - name: Sphinx
+        run: |
+          uv run python -m sphinx -M html docs/source docs/build -W

cfinterface-1.9.1/.github/workflows/publish.yml

@@ -0,0 +1,33 @@
+name: deploy
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/cfinterface/
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - name: Set up Python
+        run: uv python install 3.12
+      - name: Install the project
+        run: |
+          uv sync --all-extras --dev
+      - name: Run tests
+        run: |
+          uv run pytest -m "not benchmark" ./tests
+      - name: Build package
+        if: startsWith(github.ref, 'refs/tags')
+        run: |
+          uv build
+      - name: PyPI publish
+        if: startsWith(github.ref, 'refs/tags')
+        uses: pypa/gh-action-pypi-publish@release/v1

{cfinterface-1.8.3 → cfinterface-1.9.1}/.gitignore

@@ -70,6 +70,10 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/build/
+docs/source/examples/
+docs/source/gen_modules/
+docs/source/sg_execution_times.rst
 
 # PyBuilder
 target/

cfinterface-1.9.1/.pre-commit-config.yaml

@@ -0,0 +1,16 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.10
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.19.1
+    hooks:
+      - id: mypy
+        files: ^cfinterface/
+        args: [--config-file=pyproject.toml]
+        additional_dependencies:
+          - numpy>=2.0.0
+          - types-setuptools

cfinterface-1.9.1/CHANGELOG.md

@@ -0,0 +1,79 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [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
+
+- `StorageType` enum (`cfinterface/storage.py`) for type-safe `TEXT`/`BINARY` dispatch, replacing bare string literals
+- `TabularParser` class (`cfinterface/components/tabular.py`) for generic, schema-driven tabular file parsing
+- `TabularSection` convenience base class for sections backed by a tabular data block
+- `ColumnDef` named tuple for declaring column schemas (name, width, dtype, default) in `TabularParser`
+- Delimited tabular parsing support (CSV-style, semicolon-separated, and custom delimiters) in `TabularParser`
+- `SchemaVersion` descriptor (`cfinterface/versioning.py`) for declarative version binding on file classes
+- `resolve_version()` utility function for resolving the active schema version at read/write time
+- `VersionMatchResult` named tuple for structured version comparison results
+- `validate_version()` function for detecting version mismatches between file schema and actual content
+- `read_many()` batch read API on `RegisterFile`, `BlockFile`, and `SectionFile` for reading multiple files in one call
+- `validate()` method on file classes for programmatic version mismatch detection
+- `py.typed` marker file for PEP 561 compliance, enabling downstream type checking of cfinterface
+- Hypothesis property-based tests for `Field` round-trip correctness (`tests/components/test_field_hypothesis.py`)
+- Hypothesis property-based tests for `TabularParser` parsing invariants (`tests/components/test_tabular_hypothesis.py`)
+- pytest-benchmark integration for performance regression testing (`tests/components/test_floatfield_benchmark.py`)
+- Sphinx reference documentation for `TabularParser`, versioning module, `StorageType`, and adapter classes
+- CI test matrix covering Python 3.10, 3.11, 3.12, 3.13, and 3.14 on Linux, plus Python 3.12 on Windows
+- Separated lint/quality CI job running mypy, ruff, ty (informational), and `sphinx-build -W`
+- Manual-dispatch benchmark CI workflow (`.github/workflows/benchmark.yml`) for on-demand performance profiling
+- Pre-commit configuration with ruff (lint + format) and mypy hooks (`.pre-commit-config.yaml`)
+- Sphinx gallery examples for `BlockFile` and `SectionFile` usage (`examples/plot_block_file.py`, `examples/plot_section_file.py`)
+- Documentation pages in pt-BR: architecture overview, FAQ, migration guide (v1.8→v1.9), and performance tips
+- Root-level `CONTRIBUTING.md` in pt-BR with links to full Sphinx contributing page
+
+### Changed
+
+- pandas moved from required to optional dependency; install via `pip install cfinterface[pandas]`
+- Only `numpy>=2.0.0` remains as a hard runtime dependency
+- Regex patterns in the adapter layer are now compiled and cached at first use via `_pattern_cache`, eliminating per-call recompilation
+- `FloatField._textual_write()` optimized from an O(decimal_digits) trial loop to at most 3 format attempts
+- `RegisterData`, `BlockData`, and `SectionData` migrated from linked-list structures to array-backed (`list`) containers with O(1) `len()` and type-indexed lookups
+- `Register.previous`/`next`, `Block.previous`/`next`, and `Section.previous`/`next` are now computed properties derived from container position instead of stored linked-list pointers
+- `Field.read()` and `Field.write()` use `@overload` signatures for type-safe `str`/`bytes` dispatch
+- All four adapter `factory()` functions accept `StorageType` enum values in addition to legacy string values
+- `RegisterFile`, `BlockFile`, and `SectionFile` `STORAGE` class attribute defaults changed to `StorageType.TEXT`
+- pyproject.toml expanded with `[tool.mypy]`, `[tool.pytest.ini_options]`, `[tool.coverage]`, and an expanded `[tool.ruff.lint]` section
+- Python classifiers updated to include 3.10, 3.11, 3.12, 3.13, and 3.14
+- `docs.yml` and `publish.yml` GitHub Actions workflows modernized to use `uv` and consistent job patterns
+- All GitHub Actions upgraded to latest versions (`setup-uv@v6`, `codecov-action@v5`)
+- Docs deployment migrated from `peaceiris/actions-gh-pages` to official `actions/deploy-pages`
+- Sphinx theme migrated from `sphinx-rtd-theme` to Furo (dark mode, mobile-responsive)
+- Sphinx language setting changed from `en_US` to `pt_BR`
+- Intersphinx pandas URL updated from HTTP to HTTPS
+- `docs/source/getting_started/contributing.rst` rewritten in pt-BR with correct repository URL and uv-based workflow
+- `docs/source/index.rst` restructured with Guias and Recursos toctree sections
+
+### Deprecated
+
+- Passing `"TEXT"` or `"BINARY"` as plain strings to the file class `STORAGE` attribute; use `StorageType.TEXT` or `StorageType.BINARY` instead (a deprecation warning is emitted at file class instantiation time)
+- `set_version()` method on file classes; pass the `version=` keyword argument to `read()` instead
+
+### Fixed
+
+- 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.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.9.1/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.1/PKG-INFO

@@ -0,0 +1,153 @@
+Metadata-Version: 2.4
+Name: cfinterface
+Version: 1.9.1
+Summary: Interface for handling custom formatted files
+Project-URL: Documentation, https://rjmalves.github.io/cfinterface/
+Project-URL: Repository, https://github.com/rjmalves/cfinterface/
+Author-email: Rogerio Alves <rogerioalves.ee@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2022 Rogerio Alves
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: numpy>=2.0.0
+Provides-Extra: dev
+Requires-Dist: furo; extra == 'dev'
+Requires-Dist: hypothesis; extra == 'dev'
+Requires-Dist: matplotlib; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: numpydoc; extra == 'dev'
+Requires-Dist: pandas-stubs; extra == 'dev'
+Requires-Dist: pandas>=2.2.3; extra == 'dev'
+Requires-Dist: plotly; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-benchmark; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: sphinx; extra == 'dev'
+Requires-Dist: sphinx-gallery; extra == 'dev'
+Provides-Extra: pandas
+Requires-Dist: pandas>=2.2.3; extra == 'pandas'
+Description-Content-Type: text/markdown
+
+# cfinterface
+
+[![tests](https://github.com/rjmalves/cfinterface/workflows/tests/badge.svg)](https://github.com/rjmalves/cfinterface/actions)
+[![codecov](https://codecov.io/gh/rjmalves/cfinterface/branch/main/graph/badge.svg?token=86ZXJGB854)](https://codecov.io/gh/rjmalves/cfinterface)
+[![PyPI version](https://img.shields.io/pypi/v/cfinterface.svg)](https://pypi.org/project/cfinterface/)
+[![Python versions](https://img.shields.io/pypi/pyversions/cfinterface.svg)](https://pypi.org/project/cfinterface/)
+
+Python framework for modeling custom file formats with declarative reading, formatting, and writing.
+
+## Key Features
+
+- **Fields** — typed value containers (`LiteralField`, `IntegerField`, `FloatField`, `DatetimeField`) with positional formatting for both text and binary files
+- **Line** — ordered collection of fields that models a single line or record
+- **Register / RegisterFile** — single-line blocks identified by a beginning pattern, ideal for files with many line types
+- **Block / BlockFile** — multi-line blocks with beginning/ending patterns, for complex structured files
+- **Section / SectionFile** — ordered, non-overlapping divisions of file content
+- **TabularParser** — schema-driven tabular parsing with fixed-width or delimiter-separated layouts
+- **Versioning** — `VERSIONS` dict with `resolve_version()` and `validate_version()` for files that evolve over time
+- **Binary support** — `StorageType.TEXT` / `StorageType.BINARY` for seamless text or binary I/O
+- **Batch reading** — `read_many()` for reading multiple files in one call
+
+## Install
+
+`cfinterface` requires Python >= 3.10:
+
+```
+pip install cfinterface
+```
+
+### Optional Dependencies
+
+For pandas DataFrame integration (`TabularParser.to_dataframe()`):
+
+```
+pip install cfinterface[pandas]
+```
+
+## Quick Start
+
+Model a line-based file with `Register` and `RegisterFile`:
+
+```python
+from datetime import datetime
+from cfinterface import (
+    DatetimeField, FloatField, LiteralField, Line, Register, RegisterFile,
+)
+
+class DataHigh(Register):
+    IDENTIFIER = "DATA_HIGH"
+    IDENTIFIER_DIGITS = 9
+    LINE = Line(
+        [
+            LiteralField(size=6, starting_position=11),
+            LiteralField(size=9, starting_position=19),
+            DatetimeField(size=10, starting_position=30, format="%m/%d/%Y"),
+            FloatField(size=6, starting_position=42, decimal_digits=2),
+        ]
+    )
+
+class MyFile(RegisterFile):
+    REGISTERS = [DataHigh]
+
+file = MyFile.read("data.txt")
+for reg in file.data.get_registers_of_type(DataHigh):
+    print(reg.data)
+```
+
+Parse tabular data with `TabularParser`:
+
+```python
+from cfinterface import IntegerField, FloatField, LiteralField
+from cfinterface.components.tabular import ColumnDef, TabularParser
+
+columns = [
+    ColumnDef(name="City", field=LiteralField(size=12, starting_position=0)),
+    ColumnDef(name="Pop", field=IntegerField(size=10, starting_position=12)),
+    ColumnDef(name="Area", field=FloatField(size=8, starting_position=22, decimal_digits=1)),
+]
+
+parser = TabularParser(columns)
+data = parser.parse_lines(["Springfield  1200000    115.4\n"])
+# {"City": ["Springfield"], "Pop": [1200000], "Area": [115.4]}
+```
+
+## Documentation
+
+Guides, tutorials, and API reference: https://rjmalves.github.io/cfinterface
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for release history.

cfinterface-1.9.1/README.md

@@ -0,0 +1,91 @@
+# cfinterface
+
+[![tests](https://github.com/rjmalves/cfinterface/workflows/tests/badge.svg)](https://github.com/rjmalves/cfinterface/actions)
+[![codecov](https://codecov.io/gh/rjmalves/cfinterface/branch/main/graph/badge.svg?token=86ZXJGB854)](https://codecov.io/gh/rjmalves/cfinterface)
+[![PyPI version](https://img.shields.io/pypi/v/cfinterface.svg)](https://pypi.org/project/cfinterface/)
+[![Python versions](https://img.shields.io/pypi/pyversions/cfinterface.svg)](https://pypi.org/project/cfinterface/)
+
+Python framework for modeling custom file formats with declarative reading, formatting, and writing.
+
+## Key Features
+
+- **Fields** — typed value containers (`LiteralField`, `IntegerField`, `FloatField`, `DatetimeField`) with positional formatting for both text and binary files
+- **Line** — ordered collection of fields that models a single line or record
+- **Register / RegisterFile** — single-line blocks identified by a beginning pattern, ideal for files with many line types
+- **Block / BlockFile** — multi-line blocks with beginning/ending patterns, for complex structured files
+- **Section / SectionFile** — ordered, non-overlapping divisions of file content
+- **TabularParser** — schema-driven tabular parsing with fixed-width or delimiter-separated layouts
+- **Versioning** — `VERSIONS` dict with `resolve_version()` and `validate_version()` for files that evolve over time
+- **Binary support** — `StorageType.TEXT` / `StorageType.BINARY` for seamless text or binary I/O
+- **Batch reading** — `read_many()` for reading multiple files in one call
+
+## Install
+
+`cfinterface` requires Python >= 3.10:
+
+```
+pip install cfinterface
+```
+
+### Optional Dependencies
+
+For pandas DataFrame integration (`TabularParser.to_dataframe()`):
+
+```
+pip install cfinterface[pandas]
+```
+
+## Quick Start
+
+Model a line-based file with `Register` and `RegisterFile`:
+
+```python
+from datetime import datetime
+from cfinterface import (
+    DatetimeField, FloatField, LiteralField, Line, Register, RegisterFile,
+)
+
+class DataHigh(Register):
+    IDENTIFIER = "DATA_HIGH"
+    IDENTIFIER_DIGITS = 9
+    LINE = Line(
+        [
+            LiteralField(size=6, starting_position=11),
+            LiteralField(size=9, starting_position=19),
+            DatetimeField(size=10, starting_position=30, format="%m/%d/%Y"),
+            FloatField(size=6, starting_position=42, decimal_digits=2),
+        ]
+    )
+
+class MyFile(RegisterFile):
+    REGISTERS = [DataHigh]
+
+file = MyFile.read("data.txt")
+for reg in file.data.get_registers_of_type(DataHigh):
+    print(reg.data)
+```
+
+Parse tabular data with `TabularParser`:
+
+```python
+from cfinterface import IntegerField, FloatField, LiteralField
+from cfinterface.components.tabular import ColumnDef, TabularParser
+
+columns = [
+    ColumnDef(name="City", field=LiteralField(size=12, starting_position=0)),
+    ColumnDef(name="Pop", field=IntegerField(size=10, starting_position=12)),
+    ColumnDef(name="Area", field=FloatField(size=8, starting_position=22, decimal_digits=1)),
+]
+
+parser = TabularParser(columns)
+data = parser.parse_lines(["Springfield  1200000    115.4\n"])
+# {"City": ["Springfield"], "Pop": [1200000], "Area": [115.4]}
+```
+
+## Documentation
+
+Guides, tutorials, and API reference: https://rjmalves.github.io/cfinterface
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for release history.

cfinterface-1.9.1/benchmarks/bench_floatfield_write.py

@@ -0,0 +1,82 @@
+"""Benchmark FloatField._textual_write() across format types and scenarios."""
+
+import timeit
+
+from cfinterface.components.floatfield import FloatField
+
+N_WRITES = 100_000
+N_REPEATS = 5
+
+
+def _make_fields(size, dec, fmt, values):
+    return [FloatField(size, 0, dec, format=fmt, value=v) for v in values]
+
+
+def _bench_scenario(name, fields, n_writes, n_repeats):
+    n_fields = len(fields)
+    loops = n_writes // n_fields
+
+    def run():
+        for _ in range(loops):
+            for f in fields:
+                f._textual_write()
+
+    times = timeit.repeat(run, number=1, repeat=n_repeats)
+    per_write = [t / n_writes * 1e6 for t in times]
+    return (
+        name,
+        n_writes,
+        min(per_write),
+        sum(per_write) / len(per_write),
+        max(per_write),
+    )
+
+
+def run_benchmarks():
+    scenarios = [
+        (
+            "F fits at full precision",
+            _make_fields(12, 4, "F", [float(i) + 0.1234 for i in range(100)]),
+        ),
+        (
+            "F requires precision reduction",
+            _make_fields(8, 4, "F", [12345.6789 + i for i in range(100)]),
+        ),
+        (
+            "F rounding carry",
+            _make_fields(5, 2, "F", [999.99 + i * 1000 for i in range(100)]),
+        ),
+        (
+            "E non-zero",
+            _make_fields(
+                12, 4, "E", [float(i) + 0.1234 for i in range(1, 101)]
+            ),
+        ),
+        (
+            "D non-zero",
+            _make_fields(
+                12, 4, "D", [float(i) + 0.1234 for i in range(1, 101)]
+            ),
+        ),
+        (
+            "E/D zero",
+            _make_fields(12, 4, "E", [0.0] * 50)
+            + _make_fields(12, 4, "D", [0.0] * 50),
+        ),
+    ]
+
+    header = f"{'Scenario':<35} | {'N writes':>8} | {'min (us)':>9} | {'mean (us)':>10} | {'max (us)':>9}"
+    print("FloatField._textual_write() Benchmark")
+    print("=" * len(header))
+    print(header)
+    print("-" * len(header))
+
+    for name, fields in scenarios:
+        result = _bench_scenario(name, fields, N_WRITES, N_REPEATS)
+        print(
+            f"{result[0]:<35} | {result[1]:>8} | {result[2]:>9.2f} | {result[3]:>10.2f} | {result[4]:>9.2f}"
+        )
+
+
+if __name__ == "__main__":
+    run_benchmarks()

cfinterface-1.9.1/cfinterface/__init__.py

@@ -0,0 +1,20 @@
+"""
+cfi
+====
+
+cfi is a Python module for handling custom formatted files
+and provide reading, storing and writing utilities.
+"""
+
+__version__ = "1.9.1"
+
+from . import components  # noqa
+from . import data  # noqa
+from . import reading  # noqa
+from . import writing  # noqa
+from . import files  # noqa
+from .storage import StorageType  # noqa
+from .versioning import SchemaVersion as SchemaVersion  # noqa
+from .versioning import VersionMatchResult as VersionMatchResult  # noqa
+from .versioning import resolve_version as resolve_version  # noqa
+from .versioning import validate_version as validate_version  # noqa