cfinterface 1.7.1__tar.gz → 1.8.0__tar.gz

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

@@ -0,0 +1,33 @@
+name: Docs
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+  
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+      - name: Set up Python
+        run: uv python install
+      - name: Install the project
+        run: |
+          uv sync --all-extras --dev
+      - name: Runs tests
+        run: |
+          uv run pytest ./tests
+      - name: Sphinx build
+        run: |
+          uv run sphinx-build -M html docs/source docs/build
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/build/html
+          force_orphan: true

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

@@ -0,0 +1,46 @@
+name: tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Install uv
+      uses: astral-sh/setup-uv@v3
+    - 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: Runs tests
+      run: |
+        uv run pytest  --cov-report=xml --cov=cfinterface ./tests
+    - uses: codecov/codecov-action@v4
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }} 
+        files: ./coverage.xml
+        flags: unittests
+        env_vars: OS,PYTHON
+        name: codecov-cfinterface
+        fail_ci_if_error: true 
+        verbose: true 
+    - name: Static type check
+      run: |
+        uv run mypy ./cfinterface
+    - name: Linter code check
+      run: |
+        uv run ruff check ./cfinterface
+    - name: Sphinx build
+      run: |
+        uv run sphinx-build -M html docs/source docs/build

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

@@ -0,0 +1,39 @@
+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@v3
+    - name: Set up Python
+      run: uv python install
+    - name: Install the project
+      run: |
+        uv sync --all-extras --dev
+    - name: Runs tests
+      run: |
+        uv run pytest ./tests
+    - name: Static typing check
+      run: |
+        uv run mypy ./cfinterface
+    - name: PEP8 check
+      run: |
+        uv run ruff check ./cfinterface
+    - name: Builds 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.0/.gitignore

@@ -0,0 +1,134 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+.vscode/
+
+# Build system
+uv.lock

cfinterface-1.7.1/LICENSE.md → cfinterface-1.8.0/LICENSE

@@ -18,4 +18,4 @@ 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.
+SOFTWARE.

{cfinterface-1.7.1 → cfinterface-1.8.0}/PKG-INFO

@@ -1,19 +1,51 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: cfinterface
-Version: 1.7.1
+Version: 1.8.0
 Summary: Interface for handling custom formatted files
-Home-page: https://github.com/rjmalves/cfi
-Author: Rogerio Alves
-Author-email: rogerioalves.ee@gmail.com
-Classifier: Programming Language :: Python :: 3
+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.
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Classifier: Development Status :: 4 - Beta
-Requires-Python: >=3.8
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: >=3.10
+Requires-Dist: numpy>=2.0.0
+Requires-Dist: pandas>=2.2.3
+Provides-Extra: dev
+Requires-Dist: matplotlib; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: numpydoc; extra == 'dev'
+Requires-Dist: plotly; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: sphinx; extra == 'dev'
+Requires-Dist: sphinx-gallery; extra == 'dev'
+Requires-Dist: sphinx-rtd-theme; extra == 'dev'
 Description-Content-Type: text/markdown
-License-File: LICENSE.md
-Requires-Dist: numpy
-Requires-Dist: pandas
 
 # cfinterface
 
@@ -27,6 +59,7 @@ Python package that contains a framework for dealing with custom file formats, m
 `cfinterface` is a framework for designing low-level interfaces that depends on complex text or binary file parsing. It provides components for modeling lines, registers, blocks and sections in a declarative way and aggregate these blocks as components for defining files.
 
 Suppose that a complex text file needs to be parsed and the contents of lines with a specific identifier must be extracted and validated. For instance, the line follows the format:
+
 ```
 DATA_HIGH  ID001   sudo.user  10/20/2025  901.25
 ```
@@ -34,7 +67,7 @@ DATA_HIGH  ID001   sudo.user  10/20/2025  901.25
 If `DATA_HIGH` is the identifier that specifies the lines to be read, than one can model it with the `Register` class in the `cfinterface` framework.
 
 ```python
-class DATA_HIGH(Register):
+class DataHigh(Register):
     IDENTIFIER = "DATA_HIGH"
     IDENTIFIER_DIGITS = 9
     LINE = Line(
@@ -49,15 +82,16 @@ class DATA_HIGH(Register):
 
 A `Register` depends on the definition of a `Line` object, that is composed of `Field` objects. By modeling these elements on a declarative way, the user gains access to reading / writing functions on the fly, and the `Register` may be added to a `RegisterFile` object, so that it can be read / written together with many other registers to files.
 
-Despite the `Register` model, files can also be composed of `Blocks` and `Sections`, and their interfaces can be done to `text` or `binary` formats. For more information, the docs are available [here](https://rjmalves.github.io/cfi).
+Despite the `Register` model, files can also be composed of `Blocks` and `Sections`, and their interfaces can be done to `text` or `binary` formats. For more information, the docs are available [here](https://rjmalves.github.io/cfinterface).
 
 ## Install
 
-`cfinterface` requires python >= 3.7. It this requirement is met, than one may install the framework with
+`cfinterface` requires python >= 3.10. It this requirement is met, than one may install the framework with
+
 ```
 python -m pip install cfinterface
 ```
 
 ## Documentation
 
-Guides, tutorials and references may be found at the package's official site: https://rjmalves.github.io/cfi
+Guides, tutorials and references may be found at the package's official site: https://rjmalves.github.io/cfinterface

{cfinterface-1.7.1 → cfinterface-1.8.0}/README.md

@@ -10,6 +10,7 @@ Python package that contains a framework for dealing with custom file formats, m
 `cfinterface` is a framework for designing low-level interfaces that depends on complex text or binary file parsing. It provides components for modeling lines, registers, blocks and sections in a declarative way and aggregate these blocks as components for defining files.
 
 Suppose that a complex text file needs to be parsed and the contents of lines with a specific identifier must be extracted and validated. For instance, the line follows the format:
+
 ```
 DATA_HIGH  ID001   sudo.user  10/20/2025  901.25
 ```
@@ -17,7 +18,7 @@ DATA_HIGH  ID001   sudo.user  10/20/2025  901.25
 If `DATA_HIGH` is the identifier that specifies the lines to be read, than one can model it with the `Register` class in the `cfinterface` framework.
 
 ```python
-class DATA_HIGH(Register):
+class DataHigh(Register):
     IDENTIFIER = "DATA_HIGH"
     IDENTIFIER_DIGITS = 9
     LINE = Line(
@@ -32,15 +33,16 @@ class DATA_HIGH(Register):
 
 A `Register` depends on the definition of a `Line` object, that is composed of `Field` objects. By modeling these elements on a declarative way, the user gains access to reading / writing functions on the fly, and the `Register` may be added to a `RegisterFile` object, so that it can be read / written together with many other registers to files.
 
-Despite the `Register` model, files can also be composed of `Blocks` and `Sections`, and their interfaces can be done to `text` or `binary` formats. For more information, the docs are available [here](https://rjmalves.github.io/cfi).
+Despite the `Register` model, files can also be composed of `Blocks` and `Sections`, and their interfaces can be done to `text` or `binary` formats. For more information, the docs are available [here](https://rjmalves.github.io/cfinterface).
 
 ## Install
 
-`cfinterface` requires python >= 3.7. It this requirement is met, than one may install the framework with
+`cfinterface` requires python >= 3.10. It this requirement is met, than one may install the framework with
+
 ```
 python -m pip install cfinterface
 ```
 
 ## Documentation
 
-Guides, tutorials and references may be found at the package's official site: https://rjmalves.github.io/cfi
+Guides, tutorials and references may be found at the package's official site: https://rjmalves.github.io/cfinterface

{cfinterface-1.7.1 → cfinterface-1.8.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.7.1"
+__version__ = "1.8.0"
 
 from . import components  # noqa
 from . import data  # noqa

cfinterface-1.8.0/cfinterface/components/__init__.py

@@ -0,0 +1,8 @@
+from .datetimefield import DatetimeField  # noqa
+from .literalfield import LiteralField  # noqa
+from .integerfield import IntegerField  # noqa
+from .floatfield import FloatField  # noqa
+from .line import Line  # noqa
+from .block import Block  # noqa
+from .section import Section  # noqa
+from .register import Register  # noqa

cfinterface-1.8.0/cfinterface/files/__init__.py

@@ -0,0 +1,3 @@
+from .blockfile import BlockFile  # noqa
+from .sectionfile import SectionFile  # noqa
+from .registerfile import RegisterFile  # noqa

{cfinterface-1.7.1 → cfinterface-1.8.0}/cfinterface/files/blockfile.py

@@ -1,4 +1,4 @@
-from typing import List, Dict, Type, Optional, Union, IO
+from typing import IO, Dict, List, Optional, Type, Union
 
 from cfinterface.components.block import Block
 from cfinterface.components.defaultblock import DefaultBlock
@@ -17,7 +17,7 @@ class BlockFile:
 
     VERSIONS: Dict[str, List[Type[Block]]] = {}
     BLOCKS: List[Type[Block]] = []
-    ENCODING = "utf-8"
+    ENCODING: Union[str, List[str]] = ["utf-8", "latin-1", "ascii"]
     STORAGE = "TEXT"
     __VERSION = "latest"
 
@@ -27,7 +27,11 @@ class BlockFile:
     ) -> None:
         self.__data = data
         self.__storage = self.__class__.STORAGE
-        self.__encoding = self.__class__.ENCODING
+        self.__encoding = (
+            self.__class__.ENCODING
+            if type(self.__class__.ENCODING) is str
+            else self.__class__.ENCODING[0]
+        )
 
     def __eq__(self, o: object) -> bool:
         if not isinstance(o, BlockFile):
@@ -44,7 +48,17 @@ class BlockFile:
         :type content: str | bytes
         """
         reader = BlockReading(cls.BLOCKS, cls.STORAGE)
-        return cls(reader.read(content, cls.ENCODING, *args, **kwargs))
+        if type(cls.ENCODING) is str:
+            return cls(reader.read(content, cls.ENCODING, *args, **kwargs))
+        else:
+            for encoding in cls.ENCODING:
+                try:
+                    return cls(reader.read(content, encoding, *args, **kwargs))
+                except UnicodeDecodeError:
+                    pass
+        raise EncodingWarning(
+            "Failed to decode content with all specified encodings."
+        )
 
     def write(self, to: Union[str, IO], *args, **kwargs):
         """

{cfinterface-1.7.1 → cfinterface-1.8.0}/cfinterface/files/registerfile.py

@@ -1,7 +1,9 @@
-from typing import List, Dict, Type, Optional, Union, IO
+from typing import IO, Dict, List, Optional, Type, Union
+
 import pandas as pd  # type: ignore
-from cfinterface.components.register import Register
+
 from cfinterface.components.defaultregister import DefaultRegister
+from cfinterface.components.register import Register
 from cfinterface.data.registerdata import RegisterData
 from cfinterface.reading.registerreading import RegisterReading
 from cfinterface.writing.registerwriting import RegisterWriting
@@ -17,7 +19,7 @@ class RegisterFile:
 
     VERSIONS: Dict[str, List[Type[Register]]] = {}
     REGISTERS: List[Type[Register]] = []
-    ENCODING = "utf-8"
+    ENCODING: Union[str, List[str]] = ["utf-8", "latin-1", "ascii"]
     STORAGE = "TEXT"
     __VERSION = "latest"
 
@@ -27,7 +29,11 @@ class RegisterFile:
     ) -> None:
         self.__data = data
         self.__storage = self.__class__.STORAGE
-        self.__encoding = self.__class__.ENCODING
+        self.__encoding = (
+            self.__class__.ENCODING
+            if type(self.__class__.ENCODING) is str
+            else self.__class__.ENCODING[0]
+        )
 
     def __eq__(self, o: object) -> bool:
         if not isinstance(o, RegisterFile):
@@ -63,7 +69,17 @@ class RegisterFile:
         :type content: str | bytes
         """
         reader = RegisterReading(cls.REGISTERS, cls.STORAGE, *args, **kwargs)
-        return cls(reader.read(content, cls.ENCODING, *args, **kwargs))
+        if type(cls.ENCODING) is str:
+            return cls(reader.read(content, cls.ENCODING, *args, **kwargs))
+        else:
+            for encoding in cls.ENCODING:
+                try:
+                    return cls(reader.read(content, encoding, *args, **kwargs))
+                except UnicodeDecodeError:
+                    pass
+        raise EncodingWarning(
+            "Failed to decode content with all specified encodings."
+        )
 
     def write(self, to: Union[str, IO], *args, **kwargs):
         """

{cfinterface-1.7.1 → cfinterface-1.8.0}/cfinterface/files/sectionfile.py

@@ -1,7 +1,7 @@
-from typing import List, Dict, Type, Optional, Union, IO
+from typing import IO, Dict, List, Optional, Type, Union
 
-from cfinterface.components.section import Section
 from cfinterface.components.defaultsection import DefaultSection
+from cfinterface.components.section import Section
 from cfinterface.data.sectiondata import SectionData
 from cfinterface.reading.sectionreading import SectionReading
 from cfinterface.writing.sectionwriting import SectionWriting
@@ -17,7 +17,7 @@ class SectionFile:
 
     VERSIONS: Dict[str, List[Type[Section]]] = {}
     SECTIONS: List[Type[Section]] = []
-    ENCODING = "utf-8"
+    ENCODING: Union[str, List[str]] = ["utf-8", "latin-1", "ascii"]
     STORAGE = "TEXT"
     __VERSION = "latest"
 
@@ -27,7 +27,11 @@ class SectionFile:
     ) -> None:
         self.__data = data
         self.__storage = self.__class__.STORAGE
-        self.__encoding = self.__class__.ENCODING
+        self.__encoding = (
+            self.__class__.ENCODING
+            if type(self.__class__.ENCODING) is str
+            else self.__class__.ENCODING[0]
+        )
 
     def __eq__(self, o: object) -> bool:
         if not isinstance(o, SectionFile):
@@ -44,7 +48,17 @@ class SectionFile:
         :type content: str | bytes
         """
         reader = SectionReading(cls.SECTIONS, cls.STORAGE)
-        return cls(reader.read(content, cls.ENCODING, *args, **kwargs))
+        if type(cls.ENCODING) is str:
+            return cls(reader.read(content, cls.ENCODING, *args, **kwargs))
+        else:
+            for encoding in cls.ENCODING:
+                try:
+                    return cls(reader.read(content, encoding, *args, **kwargs))
+                except UnicodeDecodeError:
+                    pass
+        raise EncodingWarning(
+            "Failed to decode content with all specified encodings."
+        )
 
     def write(self, to: Union[str, IO], *args, **kwargs):
         """