oxiserial 0.1.0__tar.gz

oxiserial-0.1.0/.claude/settings.json

@@ -0,0 +1,58 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(uv run:*)",
+      "Bash(uv sync:*)",
+      "Bash(cargo fmt:*)",
+      "Bash(cargo clippy:*)",
+      "Bash(cargo test:*)",
+      "Bash(cargo build:*)",
+      "Bash(cargo check:*)",
+      "Bash(git commit:*)",
+      "Bash(git status:*)",
+      "Bash(git diff:*)",
+      "Bash(git log:*)",
+      "Bash(git show:*)",
+      "Bash(git rev-parse:*)",
+      "Bash(git branch:*)",
+      "Bash(git merge-base:*)",
+      "Bash(git ls-files:*)",
+      "Bash(git add:*)",
+      "Bash(gh pr view:*)",
+      "Bash(ls:*)",
+      "Bash(cat:*)",
+      "Bash(echo:*)",
+      "Bash(printf:*)",
+      "Bash(grep:*)",
+      "Bash(sed -n:*)",
+      "Bash(head:*)",
+      "Bash(tail:*)",
+      "Bash(find:*)",
+      "Bash(wc:*)",
+      "Bash(mkdir:*)",
+      "Edit",
+      "Write"
+    ],
+    "deny": [
+      "Bash(git push:*)",
+      "Bash(git push --force:*)",
+      "Bash(git reset --hard:*)",
+      "Bash(rm -rf:*)",
+      "Bash(rmdir /s:*)",
+      "Bash(Remove-Item:*)",
+      "Bash(gh pr merge:*)",
+      "Read(./.env)",
+      "Read(./.env.*)"
+    ]
+  },
+  "hooks": {
+    "PostToolUse": [
+      {
+        "matcher": "Edit|Write",
+        "hooks": [
+          { "type": "command", "command": "uv run ruff format python tests && uv run ruff check --fix python tests" }
+        ]
+      }
+    ]
+  }
+}

oxiserial-0.1.0/.github/workflows/build-wheels.yaml

@@ -0,0 +1,170 @@
+name: Build Wheels
+
+on:
+  workflow_call:
+
+jobs:
+  linux:
+    runs-on: ${{ matrix.platform.runner }}
+    strategy:
+      matrix:
+        platform:
+          - runner: ubuntu-22.04
+            target: x86_64
+          - runner: ubuntu-22.04
+            target: x86
+          - runner: ubuntu-22.04
+            target: aarch64
+          - runner: ubuntu-22.04
+            target: armv7
+          - runner: ubuntu-22.04
+            target: s390x
+          - runner: ubuntu-22.04
+            target: ppc64le
+    steps:
+      - uses: actions/checkout@v6
+      - &set-version
+        name: Set version from tag
+        if: startsWith(github.ref, 'refs/tags/v')
+        shell: bash
+        run: |
+          # PEP 440 pre-release (1.2.0rc1) -> semver (1.2.0-rc.1); maturin maps it back.
+          v="$(echo "${GITHUB_REF_NAME#v}" | sed -E 's/(a|b|rc)([0-9]+)$/-\1.\2/')"
+          sed -i.bak -E '/^\[package\]/,/^\[/ s/^version = ".*"/version = "'"$v"'"/' Cargo.toml
+          rm Cargo.toml.bak
+          cargo update --workspace
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.x"
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.platform.target }}
+          args: --release --out dist -i python3.11 -i python3.14t
+          sccache: ${{ !startsWith(github.ref, 'refs/tags/') }}
+          manylinux: auto
+      - name: Upload wheels
+        uses: actions/upload-artifact@v6
+        with:
+          name: wheels-linux-${{ matrix.platform.target }}
+          path: dist
+
+  musllinux:
+    runs-on: ${{ matrix.platform.runner }}
+    strategy:
+      matrix:
+        platform:
+          - runner: ubuntu-22.04
+            target: x86_64
+          - runner: ubuntu-22.04
+            target: x86
+          - runner: ubuntu-22.04
+            target: aarch64
+          - runner: ubuntu-22.04
+            target: armv7
+    steps:
+      - uses: actions/checkout@v6
+      - *set-version
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.x"
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.platform.target }}
+          args: --release --out dist -i python3.11 -i python3.14t
+          sccache: ${{ !startsWith(github.ref, 'refs/tags/') }}
+          manylinux: musllinux_1_2
+      - name: Upload wheels
+        uses: actions/upload-artifact@v6
+        with:
+          name: wheels-musllinux-${{ matrix.platform.target }}
+          path: dist
+
+  windows:
+    runs-on: ${{ matrix.platform.runner }}
+    strategy:
+      matrix:
+        platform:
+          - runner: windows-latest
+            target: x64
+            python_arch: x64
+          - runner: windows-latest
+            target: x86
+            python_arch: x86
+          - runner: windows-11-arm
+            target: aarch64
+            python_arch: arm64
+    steps:
+      - uses: actions/checkout@v6
+      - *set-version
+      - uses: actions/setup-python@v6
+        id: py311
+        with:
+          python-version: "3.11"
+          architecture: ${{ matrix.platform.python_arch }}
+      - uses: actions/setup-python@v6
+        id: py314t
+        with:
+          python-version: "3.14t"
+          architecture: ${{ matrix.platform.python_arch }}
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.platform.target }}
+          args: --release --out dist -i ${{ steps.py311.outputs.python-path }} -i ${{ steps.py314t.outputs.python-path }}
+          sccache: ${{ !startsWith(github.ref, 'refs/tags/') }}
+      - name: Upload wheels
+        uses: actions/upload-artifact@v6
+        with:
+          name: wheels-windows-${{ matrix.platform.target }}
+          path: dist
+
+  macos:
+    runs-on: ${{ matrix.platform.runner }}
+    strategy:
+      matrix:
+        platform:
+          - runner: macos-15-intel
+            target: x86_64
+          - runner: macos-latest
+            target: aarch64
+    steps:
+      - uses: actions/checkout@v6
+      - *set-version
+      - uses: actions/setup-python@v6
+        id: py311
+        with:
+          python-version: "3.11"
+      - uses: actions/setup-python@v6
+        id: py314t
+        with:
+          python-version: "3.14t"
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.platform.target }}
+          args: --release --out dist -i ${{ steps.py311.outputs.python-path }} -i ${{ steps.py314t.outputs.python-path }}
+          sccache: ${{ !startsWith(github.ref, 'refs/tags/') }}
+      - name: Upload wheels
+        uses: actions/upload-artifact@v6
+        with:
+          name: wheels-macos-${{ matrix.platform.target }}
+          path: dist
+
+  sdist:
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - *set-version
+      - name: Build sdist
+        uses: PyO3/maturin-action@v1
+        with:
+          command: sdist
+          args: --out dist
+      - name: Upload sdist
+        uses: actions/upload-artifact@v6
+        with:
+          name: wheels-sdist
+          path: dist

oxiserial-0.1.0/.github/workflows/ci.yaml

@@ -0,0 +1,50 @@
+# Started from `maturin generate-ci github`; maintained by hand.
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+      - master
+    tags:
+      - 'v*'
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Run Tests
+    uses: ./.github/workflows/run-tests.yaml
+
+  build:
+    name: Build Wheels
+    uses: ./.github/workflows/build-wheels.yaml
+
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    if: ${{ startsWith(github.ref, 'refs/tags/v') }}
+    needs: [test, build]
+    environment: pypi
+    permissions:
+      # Used for PyPI trusted publishing and to sign the release artifacts
+      id-token: write
+      # Used to upload release artifacts
+      contents: write
+      # Used to generate artifact attestation
+      attestations: write
+    steps:
+      - uses: actions/download-artifact@v7
+      - name: Generate artifact attestation
+        uses: actions/attest@v4
+        with:
+          subject-path: 'wheels-*/*'
+      - name: Install uv
+        if: ${{ startsWith(github.ref, 'refs/tags/v') }}
+        uses: astral-sh/setup-uv@v7
+      - name: Publish to PyPI
+        if: ${{ startsWith(github.ref, 'refs/tags/v') }}
+        run: uv publish --trusted-publishing always 'wheels-*/*'

oxiserial-0.1.0/.github/workflows/run-tests.yaml

@@ -0,0 +1,141 @@
+name: Run Tests
+
+on:
+  workflow_call:
+
+jobs:
+  test:
+    name: test (${{ matrix.os }}, ${{ matrix.python }}${{ matrix.python == '3.14' && ', release' || '' }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python: ["3.11", "3.14", "3.14t"]
+    env:
+      UV_PYTHON: ${{ matrix.python }}
+      UV_PYTHON_PREFERENCE: only-managed
+    steps:
+      - uses: actions/checkout@v6
+      - uses: astral-sh/setup-uv@v7
+      - run: uv sync --locked
+      - name: Point PyO3 at the test interpreter
+        shell: bash
+        run: |
+          base="$(uv run python -c 'import sys; print(sys.base_prefix)')"
+          echo "PYO3_PYTHON=$(uv python find)" >> "$GITHUB_ENV"
+          echo "$base" >> "$GITHUB_PATH"
+      - run: cargo fmt --check
+      - run: cargo clippy --all-targets -- -D warnings
+      - run: cargo clippy --all-targets --features test-backend -- -D warnings
+      - name: cargo test
+        shell: bash
+        run: |
+          base="$(uv run python -c 'import sys; print(sys.base_prefix)')"
+          LD_LIBRARY_PATH="$base/lib" DYLD_LIBRARY_PATH="$base/lib" cargo test --features test-backend
+      - run: uv run maturin develop --uv --features test-backend ${{ matrix.python == '3.14' && '--release' || '' }}
+      - name: Virtual port pair (Linux)
+        if: runner.os == 'Linux'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y socat
+          # socat exits when a slave is closed, so restart it to keep both links alive between tests.
+          nohup sh -c 'while true; do socat pty,raw,echo=0,link=/tmp/ttyA pty,raw,echo=0,link=/tmp/ttyB; done' > socat.log 2>&1 &
+          for _ in $(seq 20); do
+            [ -e /tmp/ttyA ] && [ -e /tmp/ttyB ] && break
+            sleep 0.5
+          done
+          test -e /tmp/ttyA && test -e /tmp/ttyB
+          echo "OXISERIAL_PORT_A=/tmp/ttyA" >> "$GITHUB_ENV"
+          echo "OXISERIAL_PORT_B=/tmp/ttyB" >> "$GITHUB_ENV"
+      - name: Download com0com
+        id: com0com-download
+        if: runner.os == 'Windows'
+        continue-on-error: true
+        shell: pwsh
+        run: |
+          $ErrorActionPreference = 'Stop'
+          $dir = Join-Path $env:RUNNER_TEMP "com0com"
+          Invoke-WebRequest -UserAgent "oxiserial-ci" -OutFile "$dir.zip" `
+            -Uri "https://sourceforge.net/projects/com0com/files/com0com/2.2.2.0/com0com-2.2.2.0-x64-fre-signed.zip/download"
+      - name: Extract com0com
+        id: com0com-extract
+        if: runner.os == 'Windows' && steps.com0com-download.outcome == 'success'
+        continue-on-error: true
+        shell: pwsh
+        run: |
+          $ErrorActionPreference = 'Stop'
+          $dir = Join-Path $env:RUNNER_TEMP "com0com"
+          Expand-Archive "$dir.zip" $dir
+          $setup = Get-ChildItem $dir -Recurse -Filter setup.exe | Select-Object -First 1
+          if (-not $setup) { throw "setup.exe not found in $dir" }
+          7z x -y "-o$dir\driver" $setup.FullName
+          if ($LASTEXITCODE -ne 0) { throw "7z failed with exit code $LASTEXITCODE" }
+          foreach ($f in "com0com.inf", "com0com.cat", "setupc.exe") {
+            if (-not (Test-Path "$dir\driver\$f")) { throw "$f missing from the extracted driver" }
+          }
+          "COM0COM_DIR=$dir\driver" >> $env:GITHUB_ENV
+      - name: Trust the com0com signer
+        id: com0com-trust
+        if: runner.os == 'Windows' && steps.com0com-extract.outcome == 'success'
+        continue-on-error: true
+        shell: pwsh
+        run: |
+          $ErrorActionPreference = 'Stop'
+          # A silent driver install needs the publisher certificate trusted first; the driver catalog, not setup.exe, carries the signature.
+          $sig = Get-AuthenticodeSignature (Join-Path $env:COM0COM_DIR 'com0com.cat')
+          if ($sig.Status -ne 'Valid' -or -not $sig.SignerCertificate) { throw "com0com.cat signature is $($sig.Status)" }
+          $store = New-Object System.Security.Cryptography.X509Certificates.X509Store("TrustedPublisher", "LocalMachine")
+          $store.Open("ReadWrite")
+          $store.Add($sig.SignerCertificate)
+          $store.Close()
+      - name: Create the port pair
+        id: com0com-pair
+        if: runner.os == 'Windows' && steps.com0com-trust.outcome == 'success'
+        continue-on-error: true
+        shell: pwsh
+        env:
+          PORT_A: COM90
+          PORT_B: COM91
+        run: |
+          $ErrorActionPreference = 'Stop'
+          # setupc.exe installs the driver from the .inf in its current directory.
+          Push-Location $env:COM0COM_DIR
+          try {
+            .\setupc.exe --silent install PortName=$env:PORT_A PortName=$env:PORT_B
+            if ($LASTEXITCODE -ne 0) { throw "setupc install failed with exit code $LASTEXITCODE" }
+          } finally {
+            Pop-Location
+          }
+      - name: Check the ports exist
+        id: com0com-check
+        if: runner.os == 'Windows' && steps.com0com-pair.outcome == 'success'
+        continue-on-error: true
+        shell: pwsh
+        env:
+          PORT_A: COM90
+          PORT_B: COM91
+        run: |
+          $ErrorActionPreference = 'Stop'
+          $names = [System.IO.Ports.SerialPort]::GetPortNames()
+          Write-Host "Ports: $($names -join ', ')"
+          foreach ($p in $env:PORT_A, $env:PORT_B) {
+            if ($names -notcontains $p) { throw "Port $p was not created" }
+          }
+      - name: Export the ports
+        id: com0com-export
+        if: runner.os == 'Windows' && steps.com0com-check.outcome == 'success'
+        continue-on-error: true
+        shell: pwsh
+        env:
+          PORT_A: COM90
+          PORT_B: COM91
+        run: |
+          $ErrorActionPreference = 'Stop'
+          "OXISERIAL_PORT_A=$env:PORT_A" >> $env:GITHUB_ENV
+          "OXISERIAL_PORT_B=$env:PORT_B" >> $env:GITHUB_ENV
+      - run: uv run pytest -v
+      - run: uv run mypy
+      - run: uv run python -m mypy.stubtest oxiserial
+      - run: uv run ruff check python tests
+      - run: uv run ruff format --check python tests

oxiserial-0.1.0/.gitignore

@@ -0,0 +1,80 @@
+/target
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+.pytest_cache/
+*.py[cod]
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+.venv/
+env/
+bin/
+build/
+develop-eggs/
+dist/
+eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+include/
+man/
+venv/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+pip-selfcheck.json
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.cache
+nosetests.xml
+coverage.xml
+
+# Translations
+*.mo
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+# Rope
+.ropeproject
+
+# Django stuff:
+*.log
+*.pot
+
+.DS_Store
+
+# Sphinx documentation
+docs/_build/
+
+# PyCharm
+.idea/
+
+# VSCode
+.vscode/
+
+# Pyenv
+.python-version
+
+# claude
+.claude/settings.local.json
+.claude/plans
+.superpowers/
+.mypy_cache/
+*.pyd
+*.pdb

oxiserial-0.1.0/CLAUDE.md

@@ -0,0 +1,51 @@
+# oxiserial
+
+Serial port library for Python, implemented in Rust with PyO3 and built with
+maturin. `import oxiserial as serial` replaces `pyserial` 3.5.
+`oxiserial.aio.Serial` has the same API, but its I/O methods return a future
+that can be waited on (`.wait()`) or awaited.
+
+## Layout
+
+- `src/`: all runtime code (Rust). The extension module is
+  `oxiserial._oxiserial`.
+- `python/oxiserial/`: `.pyi` stubs, `py.typed`, and an `__init__.py` that
+  only re-exports `oxiserial._oxiserial`.
+- `.github/workflows/`: `ci.yaml` calls `run-tests.yaml` and
+  `build-wheels.yaml`, then publishes. Started from `maturin generate-ci
+  github`, now maintained by hand.
+
+## Rules
+
+- `pyserial` 3.5 is the specification for the public API: names, signatures,
+  defaults, exception types and behaviour.
+- Code or text taken from pyserial gets a one-line comment saying so; the
+  notice is in `LICENSES/pyserial.txt`.
+- OS access goes through crates (`serialport`, `tokio-serial`, and `nix` or
+  `windows-sys` for what those lack). No hand-written FFI.
+- Every item exposed to Python has a matching stub entry; `stubtest` checks
+  they agree.
+- Blocking calls release the GIL. Shared state is behind a `Mutex` or
+  atomics, since the module supports free-threaded CPython.
+- CPython 3.11 or newer. Wheels are `abi3-py311` plus `cp314t`.
+- Releases are cut by pushing a `vX.Y.Z` tag; CI sets the version from it.
+- Dependencies go through `uv add` and `cargo add`, never by editing
+  `pyproject.toml` or `Cargo.toml` by hand.
+
+## Commands
+
+```sh
+uv sync
+uv run maturin develop --uv --features test-backend
+cargo fmt --check
+cargo clippy --all-targets --features test-backend -- -D warnings
+cargo test --features test-backend
+uv run pytest
+uv run ruff check python tests
+uv run ruff format --check python tests
+uv run mypy
+uv run python -m mypy.stubtest oxiserial
+```
+
+Run all of them before reporting a change as done. Real-port tests need a
+connected pair: `uv run pytest --port-a <A> --port-b <B>`.