pyvista-frd-reader 0.1.0__tar.gz

pyvista_frd_reader-0.1.0/.clang-format

@@ -0,0 +1,7 @@
+# Google style at 100 columns, which is what the sources are written to.
+BasedOnStyle: Google
+ColumnLimit: 100
+DerivePointerAlignment: false
+PointerAlignment: Right
+AllowShortFunctionsOnASingleLine: Inline
+AllowShortCaseLabelsOnASingleLine: true

pyvista_frd_reader-0.1.0/.gitattributes

@@ -0,0 +1,25 @@
+# FRD fixtures are data, not source. Git must hand them back byte for byte.
+#
+# This is not housekeeping. tests/fixtures/mock_cr.frd and mock_crlf.frd exist
+# to prove the reader handles a lone CR and a CRLF the way Python's text mode
+# does, and without an attribute here git classifies them by guesswork: as of
+# writing, mock_crlf.frd is stored `i/crlf` and considered *text*. A clone with
+# core.autocrlf=true -- which is what the Git for Windows installer sets by
+# default -- or core.autocrlf=input normalises CRLF to LF on the way into the
+# index, which turns that fixture into a byte-for-byte copy of mock.frd.
+#
+# The reason that is worth an attribute rather than a note is what the suite
+# would do next. test_newline_variants_read_identically compares the three
+# encodings against each other, so once they are all LF it passes *because*
+# the fixtures were destroyed. The gate reports green at exactly the moment
+# its subject stops existing. tests/test_fixture_bytes.py is the other half of
+# this: it asserts the endings are still there, so the trivial pass is caught
+# even if this line is ever removed.
+#
+# `binary` is -text -diff: no end-of-line conversion in either direction, and
+# no textual diff. Losing the diff is a real cost when reviewing a hand-written
+# fixture; it is the smaller cost.
+*.frd binary
+
+# Same reasoning, for anything a future fixture generator emits.
+*.dat binary

pyvista_frd_reader-0.1.0/.github/dependabot.yml

@@ -0,0 +1,9 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    groups:
+      actions:
+        patterns: ["*"]

pyvista_frd_reader-0.1.0/.github/workflows/ci_cd.yml

@@ -0,0 +1,135 @@
+name: CI
+
+# The Python tier: style, and the conformance sweep that grades this reader
+# against PyVista's.
+#
+# The C++ tier, the wheels and the release live in native.yml, next to the
+# jobs that build the artefacts they publish.
+
+on:
+  pull_request:
+  workflow_dispatch:
+  schedule:
+    # Weekly, for the mutation sweep below. Nothing else here needs a timer.
+    - cron: "17 4 * * 1"
+  push:
+    tags:
+      - "*"
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  style:
+    name: Style
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.13"
+      - uses: pre-commit/action@v3.0.1
+
+  unit_testing:
+    name: Conformance (${{ matrix.os }}, py${{ matrix.python-version }}, vtk ${{ matrix.vtk-version }})
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 40
+    strategy:
+      fail-fast: false
+      matrix:
+        # Three platforms, because the ctypes binding declares the C structs
+        # by hand and nothing about that is checked by a compiler. A field in
+        # the wrong order or an int where an int64 belongs produces plausible
+        # garbage, and only on the platform whose alignment rules differ from
+        # the one the binding was written on. Linux alone cannot see it.
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.13"]
+        vtk-version: ["latest"]
+        include:
+          # VTK changed its linear-wedge node order at 9.7, and this reader
+          # picks its PE6 permutation from the installed version. Both sides
+          # of that boundary have to be exercised, or the branch that is not
+          # this runner's default never runs at all.
+          - os: ubuntu-latest
+            vtk-version: "9.3.1"
+            python-version: "3.11"
+          - os: ubuntu-latest
+            vtk-version: "9.6.2"
+            python-version: "3.12"
+          # The oldest interpreter the package claims to support.
+          - os: ubuntu-latest
+            vtk-version: "latest"
+            python-version: "3.10"
+
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v7
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: "pip"
+          cache-dependency-path: pyproject.toml
+
+      - name: Install
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[tests]
+
+      - name: Pin VTK
+        if: matrix.vtk-version != 'latest'
+        run: pip install vtk==${{ matrix.vtk-version }}
+
+      - name: Report what is actually installed
+        # Printed because the matrix says what was *asked for*. A resolver
+        # that quietly gave this runner a different VTK would otherwise make
+        # the wedge-order coverage above a claim rather than a fact.
+        shell: bash
+        run: |
+          python -c "
+          import pyvista as pv, pyvista_frd
+          from pyvista_frd.reader import _default_wedge_order
+          print('pyvista', pv.__version__)
+          print('vtk', pv.vtk_version_info)
+          print('wedge order', _default_wedge_order())
+          print('library', pyvista_frd.library_path())"
+
+      - name: Test
+        run: pytest -v --color=yes
+
+      - name: The sweep tools must still run
+        # tools/sweep_external.py and tools/bench_corpus.py are aimed at a
+        # corpus that cannot live here -- CalculiX's regression suite is GPL
+        # and 251 MB -- so nothing in CI would otherwise execute them, and a
+        # tool nobody runs is a tool that has already broken. Pointed at the
+        # fixture corpus they are cheap, and they still exercise every path
+        # that matters: both readers, the bit-exact comparison, the
+        # both-decline branch, and the skip reporting.
+        run: |
+          python tools/sweep_external.py tests/fixtures --json /tmp/sweep.json
+          python tools/bench_corpus.py tests/fixtures --repeats 1
+
+  mutation:
+    name: Mutation sweep
+    # Nineteen builds of the core, so not on every pull request: it would
+    # serialise the merge queue for a signal that changes only when the tests
+    # do. Weekly, and on request.
+    if: github.event_name == 'workflow_dispatch' || github.event_name == 'schedule'
+    runs-on: ubuntu-latest
+    timeout-minutes: 90
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.13"
+      - name: Install
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[tests]
+      - name: Every planted defect must redden something
+        run: python tools/mutate.py