sltcodec 0.2.0__tar.gz

sltcodec-0.2.0/.github/workflows/publish_to_pypi.yml

@@ -0,0 +1,43 @@
+name: Publish to PyPI
+
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Extract version from pyproject.toml
+        id: version
+        run: |
+          VERSION=$(grep -m1 '^version = "' pyproject.toml | sed -E 's/^version = "([^"]+)"$/\1/')
+          echo "version=$VERSION" >> "$GITHUB_OUTPUT"
+          echo "tag=v$VERSION" >> "$GITHUB_OUTPUT"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Build distribution
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          packages-dir: dist
+
+      - name: Create GitHub release and upload artifacts
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ steps.version.outputs.tag }}
+          name: ${{ steps.version.outputs.tag }}
+          generate_release_notes: true
+          files: |
+            dist/*.tar.gz
+            dist/*.whl

sltcodec-0.2.0/.github/workflows/publish_to_testpypi.yml

@@ -0,0 +1,24 @@
+name: Publish to TestPyPI
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Build wheel
+        run: uv build
+
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+          repository-url: https://test.pypi.org/legacy/
+          packages-dir: dist

sltcodec-0.2.0/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+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/
+cover/
+
+# 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
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.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/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

sltcodec-0.2.0/.python-version

@@ -0,0 +1 @@
+3.14

sltcodec-0.2.0/.vscode/launch.json

@@ -0,0 +1,24 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Debug Pytest (single test)",
+            "type": "python",
+            "request": "launch",
+            "module": "pytest",
+            "args": [
+                "-k",
+                "${input:test_name}"
+            ],
+            "console": "integratedTerminal"
+        }
+    ],
+    "inputs": [
+        {
+            "id": "test_name",
+            "type": "promptString",
+            "description": "Enter pytest -k expression",
+            "default": "test_encode_and_decode_round_trip"
+        }
+    ]
+}

sltcodec-0.2.0/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "python.defaultInterpreterPath": "${workspaceFolder}/.venv/Scripts/python.exe"
+}

sltcodec-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 fangface
+
+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.

sltcodec-0.2.0/PKG-INFO

@@ -0,0 +1,233 @@
+Metadata-Version: 2.4
+Name: sltcodec
+Version: 0.2.0
+Summary: Decode and encode bytearrays according to struct layout definitions using sltcore.
+Project-URL: Homepage, https://github.com/fangface-hub/StructLayoutToolkitCodec
+Project-URL: Documentation, https://readthedocs.org
+Project-URL: Repository, https://github.com/fangface-hub/StructLayoutToolkitCodec
+Project-URL: Issues, https://github.com/fangface-hub/StructLayoutToolkitCodec/issues
+Author: fangface
+License-Expression: MIT
+License-File: LICENSE
+Keywords: byte,deserialization,layout,serialization,struct
+Requires-Python: >=3.12
+Requires-Dist: sltcalc>=0.1.0
+Requires-Dist: sltcore>=1.3.0
+Description-Content-Type: text/markdown
+
+# StructLayoutToolkitCodec
+
+sltcodec is a small package for decoding and encoding bytearrays according to structured layout definitions. It uses sltcore for bit-level access and provides a simple API for turning a layout definition into binary data and back again.
+
+## Installation
+
+```bash
+pip install sltcodec
+```
+
+## Quick Example
+
+`FieldDef.description` is an optional human-readable note that can be attached to each field definition.
+
+`decode` returns a `StructInstance`.
+`encode` accepts a `StructInstance` and a destination `bytearray`.
+
+```python
+from sltcore import InfoSize
+from sltcodec import (FieldDef, FieldInstance, StructDef, StructInstance,
+                      decode, encode)
+
+struct_def = [
+    FieldDef(name="flag",
+             offset=InfoSize(0, 0),
+             size=InfoSize(0, 1),
+             type="bool",
+             scale=1.0,
+             description="Whether the feature is enabled"),
+    FieldDef(name="value",
+             offset=InfoSize(0, 1),
+             size=InfoSize(1, 0),
+             type="unsigned int",
+             scale=1.0,
+             description="The encoded numeric payload"),
+]
+
+encoded = encode(
+    StructInstance(
+        struct_def=StructDef(fields=struct_def),
+        field_instances=[
+            FieldInstance(struct_def[0], True),
+            FieldInstance(struct_def[1], 0xA5),
+        ],
+    ),
+    bytearray(),
+)
+decoded = decode(struct_def, encoded)
+
+print(encoded)
+print(decoded)
+print(decoded.field_instances)
+```
+
+Output:
+
+```python
+bytearray(b"\xd2\x80")
+StructInstance(struct_def=StructDef(...), field_instances=[...])
+[FieldInstance(field_def=FieldDef(name='flag', offset=InfoSize(byte=0, bit=0), size=InfoSize(byte=0, bit=1), type='bool', scale=1.0, repeat=None), value=True),
+ FieldInstance(field_def=FieldDef(name='value', offset=InfoSize(byte=0, bit=1), size=InfoSize(byte=1, bit=0), type='unsigned int', scale=1.0, repeat=None), value=165)]
+
+```
+
+## Nested Field Types
+
+`FieldDef.type` can be a `StructDef`, not only a primitive type name.
+This allows you to define an inline nested structure and keep `encode_field` / `decode_field` behavior symmetrical.
+
+```python
+from sltcore import InfoSize
+from sltcodec import FieldDef, FieldInstance, StructDef, StructInstance, decode, encode
+
+child_struct_def = [
+    FieldDef(name="left", offset=InfoSize(0, 0), size=InfoSize(1, 0), type="unsigned int"),
+    FieldDef(name="right", offset=InfoSize(1, 0), size=InfoSize(1, 0), type="unsigned int"),
+]
+
+parent_field_def = FieldDef(
+    name="pair",
+    offset=InfoSize(0, 0),
+    size=InfoSize(2, 0),
+    type=StructDef(
+        name="Pair",
+        description="Two adjacent unsigned ints",
+        fields=child_struct_def,
+    ),
+)
+
+encoded = encode(
+    StructInstance(
+        struct_def=StructDef(fields=[parent_field_def]),
+        field_instances=[
+            FieldInstance(
+                parent_field_def,
+                StructInstance(
+                    struct_def=StructDef(fields=child_struct_def),
+                    field_instances=[
+                        FieldInstance(child_struct_def[0], 3),
+                        FieldInstance(child_struct_def[1], 4),
+                    ],
+                ),
+            )
+        ],
+    ),
+    bytearray(),
+)
+
+decoded = decode([parent_field_def], encoded)
+print(encoded)
+print(decoded)
+print(decoded.field_instances)
+```
+
+Output:
+
+```python
+bytearray(b"\x03\x04")
+StructInstance(struct_def=StructDef(...), field_instances=[...])
+[FieldInstance(field_def=FieldDef(name='pair', offset=InfoSize(byte=0, bit=0), size=InfoSize(byte=2, bit=0), type=[...], scale=1.0, repeat=None),
+               value=StructInstance(struct_def=StructDef(...), field_instances=[...]))]
+```
+
+## Expression-Based Type Selection
+
+`FieldDef.type` can also be an expression string.
+The expression is evaluated with previously processed field values in scope, so you can switch decoding/encoding type dynamically.
+
+```python
+from sltcore import InfoSize
+from sltcodec import (FieldDef, FieldInstance, StructDef, StructInstance,
+                      decode, encode)
+
+struct_def = [
+    FieldDef(name="kind", offset=InfoSize(0, 0), size=InfoSize(1, 0), type="unsigned int"),
+    FieldDef(
+        name="payload",
+        offset=InfoSize(1, 0),
+        size="{1: 1, 2: 4}[kind]",
+        type="{1: 'int', 2: 'float'}[kind]",
+    ),
+]
+
+# kind=1 -> payload is int (1 byte)
+encoded_int = encode(
+    StructInstance(
+        struct_def=StructDef(fields=struct_def),
+        field_instances=[
+            FieldInstance(struct_def[0], 1),
+            FieldInstance(struct_def[1], 7),
+        ],
+    ),
+    bytearray(),
+)
+decoded_int = decode(struct_def, encoded_int)
+
+# kind=2 -> payload is float (4 bytes)
+encoded_float = encode(
+    StructInstance(
+        struct_def=StructDef(fields=struct_def),
+        field_instances=[
+            FieldInstance(struct_def[0], 2),
+            FieldInstance(struct_def[1], 1.5),
+        ],
+    ),
+    bytearray(),
+)
+decoded_float = decode(struct_def, encoded_float)
+
+print(encoded_int, decoded_int)
+print(encoded_float, decoded_float)
+```
+
+## Saving And Loading StructDef Dictionaries
+
+You can persist reusable structure definitions by name with
+`save_struct_def_dict` / `load_struct_def_dict`.
+
+```python
+from pathlib import Path
+
+from sltcore import InfoSize
+from sltcodec import FieldDef, StructDef, load_struct_def_dict, save_struct_def_dict
+
+struct_defs = {
+    "Header": StructDef(
+        name="Header",
+        description="Simple header",
+        fields=[
+            FieldDef(name="kind", offset=InfoSize(0, 0), size=InfoSize(1, 0), type="unsigned int"),
+            FieldDef(name="flags", offset=InfoSize(1, 0), size=InfoSize(1, 0), type="unsigned int"),
+        ],
+    )
+}
+
+path = Path("struct_defs.json")
+save_struct_def_dict(path, struct_defs)
+loaded = load_struct_def_dict(path)
+
+print(loaded["Header"].name)
+print(loaded["Header"].description)
+```
+
+Example output:
+
+```python
+bytearray(b"\x01\x07") StructInstance(struct_def=StructDef(...), field_instances=[...])
+bytearray(b"\x02?\xc0\x00\x00") StructInstance(struct_def=StructDef(...), field_instances=[...])
+```
+
+## Development
+
+```bash
+uv sync --all-extras
+uv run pytest
+```