begin

Author: jet-logic

.github/workflows/publish.yml

@@ -0,0 +1,31 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+jobs:
+  build-and-publish:
+    name: Build and Publish
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: python -m pip install --upgrade pip build twine
+
+      - name: Build the package
+        run: python -m build
+
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+        run: twine upload --verbose dist/*

.github/workflows/tests.yml

@@ -0,0 +1,36 @@
+name: Tests
+
+on:
+  push:
+    branches: [main, devel]
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ".[dev,test]"
+
+      - name: Lint with flake8
+        run: |
+          # stop the build if there are Python syntax errors or undefined names
+          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+
+      - name: Run tests
+        run: sh tests/run_tests_with_coverage.sh
+
+      - name: Test with mypy
+        run: |
+          mypy . || true

.gitignore

@@ -0,0 +1,143 @@
+# 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/
+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
+
+# 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/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+.pytest_cache/
+.vscode/
+*.tar.*
+*.zip

pyproject.toml

@@ -0,0 +1,45 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.dynamic]
+version = {attr = "ra2csf.__init__.__version__"}
+
+[project]
+name = "ra2csf"
+dynamic = ["version"]
+description = "Read, write, update Command & Conquer: Red Alert 2 .csf files"
+readme = "README.md"
+authors = [
+    {name = "jet-logic"}
+]
+license = {file = "LICENSE"} 
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+]
+requires-python = ">=3.8"
+dependencies = [
+    "PyYAML>=5.1",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-cov>=4.0",
+    "black>=22.0",
+    "flake8>=5.0",
+    "mypy>=1.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/jet-logic/ra2csf"
+
+[project.scripts]
+ghrapt = "ra2csf.__main__:main"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["ra2csf*"]

ra2csf/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.0.1"

ra2csf/read.py

@@ -0,0 +1,67 @@
+from typing import IO
+from struct import unpack
+
+
+def read_str(fh: IO[bytes]):
+    (n,) = unpack("<I", fh.read(4))
+    return fh.read(n).decode("latin1")
+
+
+def read_wstr(fh: IO[bytes]):
+    (n,) = unpack("<I", fh.read(4))
+    return bytes([0xFF - b for b in fh.read(n * 2)]).decode("UTF-16-LE")
+
+
+def read_int(fh: IO[bytes]) -> int:
+    (n,) = unpack("<I", fh.read(4))
+    return n
+
+
+def read_entry(fh: IO[bytes], sig=b""):
+    if not sig:
+        sig = fh.read(4)
+    assert sig == b" LBL", f"sig = {sig}"
+    flag = read_int(fh)
+    key = read_str(fh)
+    kind = fh.read(4)
+    value = read_wstr(fh)
+    if kind == b"WRTS":
+        extra = read_str(fh)
+    else:
+        assert kind == b" RTS"
+        extra = None
+
+    return key, value, flag, extra
+
+
+def read_head(fh: IO[bytes]) -> bytes:
+    def fx(
+        identifier: int,
+        version: int,
+        labels: int,
+        extra_values: int,
+        flags: int,
+        language: int,
+    ):
+        return dict(locals())
+
+    return fx(*unpack("<IIIIII", fh.read(6 * 4)))
+
+
+def read_entries(fh: IO[bytes]):
+    b = fh.read(4)
+    while b == b" LBL":
+        key, value, flag, extra = read_entry(fh, b)
+        yield key, value, flag, extra
+        b = fh.read(4)
+
+
+def parse(fh: IO[bytes]):
+    head: tuple[int] = unpack("<IIIIII", fh.read(6 * 4))
+    strings = tuple(read_entries(fh))
+    return head, strings
+
+
+def parse_file(csf_file=""):
+    with open(csf_file, "br") as rh:
+        return parse(rh)

ra2csf/write.py

@@ -0,0 +1,31 @@
+from typing import IO
+from struct import pack
+
+
+def write_str(fh: IO[bytes], s=""):
+    fh.write(pack("<I", len(s)))
+    fh.write(s.encode("latin1"))
+
+
+def write_wstr(fh: IO[bytes], s=""):
+    e = s.encode("UTF-16-LE")
+    fh.write(pack("<I", len(e) // 2))
+    fh.write(bytes([(0xFF - b) for b in e]))
+
+
+def write_entry(fh: IO[bytes], key, value="", flag=1, extra=None):
+    fh.write(b" LBL")
+    fh.write(pack("<I", flag))
+    write_str(fh, key)
+    fh.write(b"WRTS" if extra else b" RTS")
+    write_wstr(fh, value)
+    if extra:
+        write_str(fh, extra)
+
+
+def write(
+    fh: IO[bytes], head=list[int], strings=list[tuple[str, str, int, str | None]]
+):
+    fh.write(pack("<IIIIII", *head))
+    for v in strings:
+        write_entry(fh, *v)

tests/ra2.csf

@@ -0,0 +1,24 @@
+#!/bin/bash
+# Clean previous coverage data
+NAME=$(basename $(realpath .))
+DOCS=/tmp/"$NAME"_coverage
+export COVERAGE_FILE=/tmp/."$NAME"_coverage
+echo [$NAME] $DOCS
+rm -f "$COVERAGE_FILE"*
+rm -rf $DOCS
+
+# Run tests with coverage
+python -m pytest -s tests/ \
+  --cov=$NAME \
+  --cov-append \
+  --cov-report=term-missing || exit 1
+
+# Combine all coverage data
+python -m coverage combine
+
+# Generate HTML report in /tmp
+python -m coverage html \
+  --directory="$DOCS" \
+  --title="$NAME Coverage Report"
+
+echo "Coverage report generated at: $DOCS/index.html"