mutmut-ratchet 0.1.0__tar.gz

mutmut_ratchet-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

mutmut_ratchet-0.1.0/NOTICE

@@ -0,0 +1,23 @@
+mutmut-ratchet
+Copyright 2026 Andrew Berry
+
+This product includes software extracted from two repositories in the
+rtl-433-hass organisation, both licensed under the Apache License, Version 2.0:
+
+  - rtl-433-hass/rtl_433   (https://github.com/rtl-433-hass/rtl_433)
+  - rtl-433-hass/pyrtl_433 (https://github.com/rtl-433-hass/pyrtl_433)
+
+The code originated as the near-identical `scripts/mutation_*.py` helpers and
+their tests carried by both repositories:
+
+  - scripts/mutation_ratchet.py
+  - scripts/mutation_shards.py
+  - scripts/mutation_stats.py
+  - scripts/mutation_targets.py
+  - scripts/mutation_timings.py
+  - tests/test_mutation_shards.py
+  - tests/test_mutation_targets.py
+
+Only the per-repository constants (package paths, escalation triggers, and the
+explicit test-to-source overrides) differed; those became configuration read
+from the consumer's pyproject.toml.

mutmut_ratchet-0.1.0/PKG-INFO

@@ -0,0 +1,289 @@
+Metadata-Version: 2.4
+Name: mutmut-ratchet
+Version: 0.1.0
+Summary: Shared mutmut CI tooling: PR scoping, time-balanced sharding, and a per-file mutation-score ratchet.
+Author: Andrew Berry
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/rtl-433-hass/mutmut-ratchet
+Project-URL: Repository, https://github.com/rtl-433-hass/mutmut-ratchet
+Project-URL: Issues, https://github.com/rtl-433-hass/mutmut-ratchet/issues
+Keywords: mutmut,mutation-testing,ci,ratchet,sharding,pytest
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: mutmut>=3.6
+Dynamic: license-file
+
+# mutmut-ratchet
+
+Shared CI tooling that makes a slow [mutmut](https://github.com/boxed/mutmut)
+run usable as a **blocking** pull-request gate: scope the run to what a PR
+touched, fan it across a time-balanced matrix, and fail only on a real per-file
+mutation-score regression.
+
+It is the de-duplicated form of the `scripts/mutation_*.py` helpers that were
+copy-pasted between [`rtl-433-hass/rtl_433`](https://github.com/rtl-433-hass/rtl_433)
+and [`rtl-433-hass/pyrtl_433`](https://github.com/rtl-433-hass/pyrtl_433). Only
+the per-repo constants differed; those are now configuration.
+
+## Why
+
+A full-package mutmut run is slow (tens of minutes), and its score is not
+perfectly reproducible. Naively gating on it either blocks every PR for an hour
+or fails spuriously. The five subcommands fix that:
+
+| Subcommand | What it does |
+| --- | --- |
+| `targets` | Turns `git diff --name-only` into the modules worth mutating, or escalates to a full run |
+| `shards`  | Deterministic LPT partition of the package into N **time**-balanced shards |
+| `stats`   | Reduces mutmut's on-disk `mutants/*.meta` into a comparable JSON payload |
+| `ratchet` | Compares that payload to a committed baseline with a mutant-denominated tolerance band |
+| `timings` | Records the measured per-file mutmut runtime that `shards` balances on |
+
+Two design choices carry most of the value:
+
+* **Shards balance by measured time, not mutant count.** Per-mutant test time
+  varies several-fold across modules, so a count-balanced split still leaves a
+  slow pole that the gate waits on. Modules are sorted heaviest first (ties by
+  path) and dropped into the lightest bin (ties by lowest index) — plain LPT,
+  within 4/3 of optimal makespan and fully reproducible, so every matrix job
+  computes the identical assignment with no coordination.
+* **The ratchet's tolerance band is denominated in mutants.** A flat percentage
+  is wrong in both directions: 2% is ~13 mutants on a 630-mutant module but
+  *zero* mutants on a 29-mutant one. The band is
+  `max(tolerance_fraction × total, tolerance_mutants)` mutants, converted back to
+  score space. That absorbs both run-to-run noise and the scoped-vs-full gap (a
+  scoped run is a slight lower bound: some mutants are only killed by tests in
+  other files) while still failing on a genuine regression, which typically
+  costs far more mutants than the band. The baseline only ever ratchets upward.
+
+## Install
+
+```bash
+uv add --dev mutmut-ratchet
+```
+
+`mutmut` itself is a dependency (the tooling reads mutmut's module walk and its
+per-file meta through `mutmut.__main__`), so installing this pulls it in. Pin
+the exact mutmut version you test against in your own dev group if you care
+which one CI uses.
+
+## Configure
+
+All settings live in your `pyproject.toml` under `[tool.mutmut_ratchet]`. Only
+`package_path` is required; unknown keys and wrong types are hard errors, so a
+typo can never silently weaken the gate.
+
+```toml
+[tool.mutmut_ratchet]
+package_path = "my_package"
+escalate_paths = ["pyproject.toml", "uv.lock", "tests/conftest.py"]
+
+[tool.mutmut_ratchet.explicit_test_sources]
+"tests/test_urls.py" = ["_urls.py"]
+"tests/test_mut_client_floor.py" = ["client.py"]
+```
+
+| Key | Type | Default | Meaning |
+| --- | --- | --- | --- |
+| `package_path` | string | *(required)* | Repo-relative path of the package under mutation, e.g. `pyrtl_433` or `custom_components/rtl_433`. |
+| `package_dotted` | string | `package_path` with `/` → `.` | Dotted name mutmut uses in mutant filters. Set it only when the two differ (e.g. a `src/` layout). |
+| `baseline` | string | `"scripts/mutation_baseline.json"` | Committed per-file score baseline. Relative paths anchor to the `pyproject.toml`'s directory. |
+| `timings` | string | `"scripts/mutation_timings.json"` | Committed per-file mutmut runtime profile, used as the shard bin-pack weight. |
+| `escalate_paths` | list of strings | `["pyproject.toml", "tests/conftest.py"]` | Changed paths that force a **full** run because they can move results package-wide. Exact repo-relative matches. |
+| `explicit_test_sources` | table of string → list of strings | `{}` | Test file → the source modules (relative to `package_path`) it exercises, for tests the `test[_mut]_<name>.py` → `<name>.py` convention cannot resolve. Genuinely broad tests are deliberately *left out* so they still escalate. |
+| `tolerance_fraction` | float | `0.02` | Fractional half of the band; scales the cushion on large files. |
+| `tolerance_mutants` | int | `3` | Absolute half of the band, in mutants; protects small files where a percentage rounds to nothing. |
+| `precision` | int | `6` | Decimals scores are rounded to before comparison. |
+| `floor` | float | `0.70` | Advisory floor recorded into a freshly written baseline payload. |
+| `fallback_seconds_per_mutant` | float | `1.0` | Weight used when neither a timing nor any timing profile exists at all (a fresh checkout). |
+
+A committed baseline carries the `tolerance_fraction` / `tolerance_mutants` it
+was written with, and those win over the config defaults — so retuning the band
+is a baseline edit, not a workflow edit. An explicit `--tolerance-*` flag beats
+both.
+
+Precedence throughout is **CLI flag → `pyproject.toml` → built-in default**.
+
+## Commands
+
+Every subcommand also accepts `--config PYPROJECT` (default: the nearest
+`pyproject.toml` at or above the cwd), `--package-path`, and `--package-dotted`.
+
+```
+mutmut-ratchet targets [PATH ...]
+```
+Maps changed paths to targets. With no arguments, reads whitespace-separated
+paths from stdin. Prints three lines: `all` or `scoped`; the mutmut filter
+patterns; the source paths. Exit 0.
+
+Patterns are derived the same way `shards` derives them, so a package
+`__init__.py` in scope emits the `x_*` / `xǁ*` trampoline patterns its
+mutants are actually named after — mutmut drops the `__init__` segment from
+mutant names, so a `<pkg>.sub.__init__.*` filter would match none of them and
+silently run zero mutants.
+
+```
+mutmut-ratchet shards --shard N --of M [--restrict PATH ...] [--baseline P] [--timings P]
+```
+Prints two lines: this shard's filter patterns, and its source paths (both blank
+for an empty shard). `--restrict` intersects the shard with a scoped set without
+changing the global assignment, so a scoped PR fans across the same shards.
+Exit 0, or 2 for out-of-range `--shard`/`--of`.
+
+```
+mutmut-ratchet stats [--paths PATH ...]
+```
+Prints the per-file stats JSON on stdout. `--paths` is **required after a
+filtered `mutmut run`**: mutants outside the filter stay "not checked", which
+would otherwise read as 0%. Exit 0.
+
+```
+mutmut-ratchet ratchet --mode floor|strict --stats FILE [--baseline P] [--update] [--tolerance-fraction F] [--tolerance-mutants N]
+```
+`floor` is the CI gate (improvements never fail); `strict` also fails on upward
+drift, as a local check that the committed baseline is still representative.
+`--update` writes current scores back, keeping the higher of baseline/current
+per file, and refuses while regressions stand. Exit 0 pass, 1 regression/drift,
+2 missing stats or baseline.
+
+```
+mutmut-ratchet timings [--out PATH]
+```
+Writes the runtime profile after a **full** `mutmut run`. Exit 0, or 2 when no
+timing data exists yet.
+
+## Worked GitHub Actions example
+
+Scoped on PRs, full on push/schedule, sharded six ways either way, with one
+aggregated status check.
+
+```yaml
+name: Mutation
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  schedule:
+    - cron: "0 3 * * *"
+
+permissions: {}
+
+jobs:
+  mutation:
+    name: "Mutation floor — shard ${{ matrix.shard }}"
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    strategy:
+      fail-fast: false
+      matrix:
+        shard: [0, 1, 2, 3, 4, 5]
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          # Need history back to the base branch to diff a PR's changed files.
+          fetch-depth: 0
+      - uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+      - run: uv sync --locked --dev
+
+      - name: Determine scope for this trigger
+        id: scope
+        run: |
+          if [ "${{ github.event_name }}" = "pull_request" ]; then
+            git fetch --no-tags origin "${{ github.base_ref }}"
+            changed=$(git diff --name-only "origin/${{ github.base_ref }}...HEAD")
+            uv run mutmut-ratchet targets $changed > targets.txt
+            cat targets.txt
+            {
+              echo "mode=$(sed -n '1p' targets.txt)"
+              echo "paths=$(sed -n '3p' targets.txt)"
+            } >> "$GITHUB_OUTPUT"
+          else
+            echo "mode=all" >> "$GITHUB_OUTPUT"
+            echo "paths=" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Determine this shard's modules
+        id: shard
+        run: |
+          if [ "${{ steps.scope.outputs.mode }}" = "all" ]; then
+            uv run mutmut-ratchet shards --shard ${{ matrix.shard }} --of 6 > shard.txt
+          elif [ -n "${{ steps.scope.outputs.paths }}" ]; then
+            uv run mutmut-ratchet shards --shard ${{ matrix.shard }} --of 6 --restrict ${{ steps.scope.outputs.paths }} > shard.txt
+          else
+            # Scoped run with nothing in scope (e.g. a docs-only PR): no work.
+            printf '\n\n' > shard.txt
+          fi
+          {
+            echo "patterns=$(sed -n '1p' shard.txt)"
+            echo "paths=$(sed -n '2p' shard.txt)"
+          } >> "$GITHUB_OUTPUT"
+          cat shard.txt
+
+      - name: Run mutation testing (this shard's modules)
+        if: steps.shard.outputs.patterns != ''
+        run: |
+          uv run mutmut run ${{ steps.shard.outputs.patterns }}
+          uv run mutmut-ratchet stats --paths ${{ steps.shard.outputs.paths }} > mutation-stats.json
+
+      - name: Enforce per-file floor vs baseline
+        if: steps.shard.outputs.patterns != ''
+        run: uv run mutmut-ratchet ratchet --mode floor --stats mutation-stats.json
+
+      - name: No modules in this shard
+        if: steps.shard.outputs.patterns == ''
+        run: echo "No modules in scope for this shard; nothing to check."
+
+  mutation-gate:
+    name: "Mutation floor"
+    needs: [mutation]
+    if: always()
+    runs-on: ubuntu-latest
+    steps:
+      - name: Aggregate shard results
+        run: |
+          if [ "${{ needs.mutation.result }}" != "success" ]; then
+            echo "One or more mutation shards failed."; exit 1
+          fi
+          echo "All mutation shards passed."
+```
+
+A simpler single-job form, for a package small enough not to need a matrix:
+
+```yaml
+      - name: Mutation test (per-module floor ratchet)
+        run: |
+          uv run mutmut run --max-children 4
+          uv run mutmut-ratchet stats > mutation-stats.json
+          uv run mutmut-ratchet ratchet --mode floor --stats mutation-stats.json
+```
+
+Never cache the `mutants/` working tree: a stale cache can report a higher score
+than reality and let a regression through. Caching uv's download cache is fine.
+
+## Bootstrapping a baseline
+
+```bash
+uv run mutmut run                                   # a FULL run
+uv run mutmut-ratchet stats > mutation-stats.json
+uv run mutmut-ratchet ratchet --mode floor --stats mutation-stats.json --update
+uv run mutmut-ratchet timings                       # writes the shard weights
+```
+
+Commit both JSON files. Refresh the timings profile periodically; a stale one
+degrades to a slightly suboptimal — never incorrect — split.
+
+## Licence
+
+Apache-2.0. See `LICENSE` and `NOTICE`.