mutmut 3.5.0__tar.gz → 3.7.0__tar.gz

{mutmut-3.5.0 → mutmut-3.7.0}/HISTORY.rst

@@ -1,12 +1,80 @@
 Changelog
 ---------
 
+3.7.0
+~~~~~
+
+* Fix the trampoline dropping a generator's return value, so ``yield from`` on a mutated generator no longer yields ``None`` instead of its result
+
+* Fix async generators, so that `aclose()`/`athrow()` are handled by the `except`/`finally` blocks of the mutated function instead of being swallowed by the trampoline
+
+* Fix `max_stack_depth` when a test changes the working directory (for example via a tmpdir fixture)
+
+* Fix `type_check_command` reporting type errors in copied files that have no mutants
+
+* Per-function source hashing for incremental cache invalidation — only re-test mutants in functions that changed
+
+* Cross-call dependency tracking — invalidate mutants in callers when a called function changes
+
+* Use git to detect non-Python dependency file changes; falls back to a curated file list when git is unavailable
+
+* Add `cache_invalidation_exclude` config to suppress noisy files from change detection
+
+* Add `use_git_change_detection` config (default true) to opt out of git-based detection
+
+* Add `uv.lock`, `poetry.lock`, `Pipfile.lock`, and `pdm.lock` to the list of files copied by default
+
+* Invalidate cached results automatically when result-affecting config fields change
+
+* Make `mutmut browse`, `show` and `apply` much faster and use far less memory, by storing where each mutant is in the mutated file instead of parsing the whole file to find it
+
+3.6.0
+~~~~~
+
+* Add `# pragma: no mutate block` and `# pragma: no mutate start/end` comments
+
+* Add `do_not_mutate_patterns` to disable mutations with a regex
+
+* Add `only_mutate` config to select which files get mutated
+
+* Also mutate methods decorated with (only) `@staticmethod` or `@classmethod`
+
+* Add `use_setproctitle` option to disable process renaming (automatically disabled on MacOS)
+
+* Add (unstable) `timeout_multiplier` and `timeout_constant` options
+
+* Rename `paths_to_mutate` to `source_paths`
+
+* Deprecate `tests_dir` in favor of `pytest_add_cli_args_test_selection`
+
+* Change `max_stack_depth` to only consider functions inside `source_paths`
+
+* Disable mutation of enums and `@staticmethod`/`@classmethod` methods when `type_check_command` is set, as these mutations break type checking
+
+* Fix mutation for enum class methods
+
+* Fix mutate_only_covered_lines when project uses custom coverage.py config
+
+* Fix execution when running mutmut via `python -m mutmut run`
+
+* Fix mutation of `class _SomePrivateClass` class methods
+
+* Fix mutation of default args
+
+* Fix `mutmut browse` crash when no file is selected yet
+
+* Fix timeout checker looking up the wrong mutant's expected test time, which could cause mutants to hang
+
+* Compare stats paths after resolving symlinks
+
+* Warn when mutmut cannot match mutants with the collected stats
+
 3.5.0
 ~~~~~
 
 * Filter mutants based on type annotations. This feature needs to be turned on with the `type_check_command` config.
 
-* Support running on Windows
+* Show error message when running on Windows
 
 * Save mutation stats for use with CI/CD pipeline (#460)
 

{mutmut-3.5.0 → mutmut-3.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mutmut
-Version: 3.5.0
+Version: 3.7.0
 Summary: mutation testing for Python 3
 Keywords: mutmut,mutant,mutation,test,testing
 Author: Anders Hovmöller
@@ -80,14 +80,13 @@ You can get started with a simple:
     pip install mutmut
     mutmut run
 
-This will by run pytest on tests in the "tests" or "test" folder and
+This will run pytest on tests in the "tests" or "test" folder and
 it will try to figure out where the code to mutate is.
 
 
 
 You can stop the mutation run at any time and mutmut will restart where you
-left off. It will continue where it left off, and re-test functions that were
-modified since last run.
+left off.
 
 To work with the results, use `mutmut browse` where you can see the mutants,
 retest them when you've updated your tests.
@@ -97,7 +96,7 @@ You can also write a mutant to disk from the `browse` interface, or via
 source code control and committed before you apply a mutant!
 
 
-If during the installation you get an error for the `libcst` dependency mentioning the lack of a rust compiler on your system, it is because your architecture does not have a prebuilt binary for `libcst` and it requires both `rustc` and `cargo` from the [rust toolchain](https://www.rust-lang.org/tools/install) to be built. This is known for at least the `x86_64-darwin` architecture.
+If during the installation you get an error for the `libcst` dependency mentioning the lack of a rust compiler on your system, it is because your architecture does not have a prebuilt binary for `libcst` and it requires both `rustc` and `cargo` from the `rust toolchain <https://www.rust-lang.org/tools/install>`_ to be built. This is known for at least the `x86_64-darwin` architecture.
 
 
 Wildcards for testing mutants
@@ -122,7 +121,7 @@ In `setup.cfg` in the root of your project you can configure mutmut if you need
 .. code-block:: ini
 
     [mutmut]
-    paths_to_mutate=src/
+    source_paths=src/
     pytest_add_cli_args_test_selection=tests/
 
 If you use `pyproject.toml`, you must specify the paths as array in a `tool.mutmut` section:
@@ -130,7 +129,7 @@ If you use `pyproject.toml`, you must specify the paths as array in a `tool.mutm
 .. code-block:: toml
 
     [tool.mutmut]
-    paths_to_mutate = [ "src/" ]
+    source_paths = [ "src/" ]
     pytest_add_cli_args_test_selection= [ "tests/" ]
 
 See below for more options for configuring mutmut.
@@ -162,8 +161,8 @@ introduced bug in those base functions will lead to many tests that fail which
 are hard to understand how they relate to the function with the change.
 
 You can configure mutmut to only count a test as being relevant for a function
-if the stack depth from the test to the function is below some limit. In your
-`setup.cfg` add:
+if the stack depth is below some limit. Only stack frames from code inside `source_paths`
+is counted towards the limit, 3rd party libraries are ignored. In your `setup.cfg` add:
 
 .. code-block:: ini
 
@@ -177,10 +176,14 @@ caught.
 Exclude files from mutation
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+By default mutmut mutates all python files in `source_paths`.
 You can exclude files from mutation in `setup.cfg`:
 
 .. code-block::
 
+    only_mutate=
+        src/api/*
+        src/services/*
     do_not_mutate=
         *__tests.py
 
@@ -221,7 +224,7 @@ To enable this filtering, configure the `type_check_command` to output json resu
     # for pyrefly
     type_check_command = ['pyrefly', 'check', '--output-format=json']
     # for mypy
-    type_check_command = ['mypy', 'traces_parser', '--output', 'json']
+    type_check_command = ['mypy', 'your_source_dir', '--output', 'json', '--disable-error-code', 'unused-ignore']
 
 Currently, only `pyrefly` and `mypy` are supported.
 With `pyright` and `ty`, mutating a class method `Foo.bar()` can break the types of all methods of `Foo`,
@@ -242,22 +245,174 @@ to failing tests.
     debug=true
 
 
-Whitelisting
-~~~~~~~~~~~~
+Disable setproctitle (macOS)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-You can mark lines like this:
+Mutmut uses ``setproctitle`` to show the current mutant name in the process
+list, which is helpful for monitoring long runs. However, ``setproctitle``
+uses CoreFoundation APIs on macOS that are not fork-safe, causing segfaults
+in child processes.
 
-.. code-block:: python
+By default, mutmut automatically disables ``setproctitle`` on macOS and
+enables it on other platforms. If you need to override this (e.g. to enable it on
+macOS at your own risk, or to disable it on other platforms), set ``use_setproctitle``:
+
+.. code-block:: toml
+
+    # pyproject.toml
+    [tool.mutmut]
+    use_setproctitle = false
 
-    some_code_here()  # pragma: no mutate
 
-to stop mutation on those lines. Some cases we've found where you need to
-whitelist lines are:
+Disabling mutation on specific code
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- The version string on your library. You really shouldn't have a test for this :P
+If you do not want to mutate specific parts of your code, you can disable mutation
+via the following options. Examples where this could be relevant:
+
+- If you don't want to test exact log messages (e.g. `logging.info("Foo")` versus the mutated `logging.info("XXFooXX")`)
 - Optimizing break instead of continue. The code runs fine when mutating break
   to continue, but it's slower.
 
+Skipping via regex
+^^^^^^^^^^^^^^^^^^
+
+You can use a regex on the source code, to tell mutmut which expressions it should not mutate:
+
+.. code-block:: toml
+
+    # pyproject.toml
+    [tool.mutmut]
+    do_not_mutate_patterns = [
+        # disable mutations of all logger.info/debug/... statements
+        'logger\.\w+',
+        # disable mutating exceptions
+        'raise \w+',
+    ]
+
+Mutmut will match the regex on the source code
+and skip mutating any expression on the matched lines.
+
+Skipping via code comments
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+You can use following comments to disable mutation:
+
+- `# pragma: no mutate`: disable mutation on this single line
+- `# pragma: no mutate block`: disable mutation in the whole intendation block
+- `# pragma: no mutate start/end`: disable mutation between the start and end comments
+
+Skipping single lines
+^^^^^^^^^^^^^^^^^^^^^
+
+You can mark lines like this to stop mutating them:
+
+.. code-block:: python
+
+    some_code_here()  # pragma: no mutate
+
+
+Skipping Code Blocks
+^^^^^^^^^^^^^^^^^^^^
+
+You can skip an entire indentation block from mutation using
+``# pragma: no mutate block``. This works on any compound statement --
+functions, classes, ``if``/``elif``/``else``, loops, context managers, etc.
+
+Both syntax styles are supported:
+
+- ``# pragma: no mutate block``
+- ``# pragma: no mutate: block``
+
+**Skipping an entire function or class** -- place the pragma inline on the
+definition line. The entire node (including all children) is skipped and no
+trampoline is generated:
+
+.. code-block:: python
+
+    def complex_algorithm():  # pragma: no mutate block
+        return some_complex_calculation()
+
+    class MySettings:  # pragma: no mutate block
+        DEBUG = True
+        MAX_RETRIES = 3
+
+**Skipping only the body of a function** -- place the pragma on its own line
+inside the function. The function definition (including default arguments) is
+still mutable, but the body is suppressed:
+
+.. code-block:: python
+
+    def foo(val=1):
+        # pragma: no mutate block
+        x = 1
+        y = complex_calculation()
+        z = x + y
+
+    def bar():
+        # this function is still mutated normally
+        return 42
+
+**Skipping an ``if`` branch without affecting ``elif``/``else``** -- place
+the pragma inline on the ``if``. Only the ``if`` condition and its indented
+body are suppressed; sibling branches (``elif``, ``else``) remain mutable
+because they exit the original indentation scope:
+
+.. code-block:: python
+
+    if error_condition:  # pragma: no mutate block
+        log_error()
+        send_alert()
+    elif other_condition:
+        # still mutated -- this branch is outside the block scope
+        handle_other()
+    else:
+        # still mutated
+        handle_success()
+
+The same principle applies to ``for``/``else``, ``while``/``else``,
+``try``/``except``/``finally``, and ``match``/``case``.
+
+This is useful for:
+
+- Functions or classes that should be excluded from mutation entirely
+- Error-handling branches that are hard to unit test in isolation
+- Logging or telemetry blocks that don't affect program correctness
+- Generated or boilerplate code within an otherwise mutable function
+
+
+Skipping Code Regions
+^^^^^^^^^^^^^^^^^^^^^
+
+For suppressing mutations across a range of lines regardless of indentation,
+use ``# pragma: no mutate start`` and ``# pragma: no mutate end``:
+
+.. code-block:: python
+
+    a = mutate_this()
+
+    # pragma: no mutate start
+    b = skip_this()
+    c = skip_this_too()
+    # pragma: no mutate end
+
+    d = mutate_this_too()
+
+Every line between the markers (inclusive) is suppressed. This works inside
+functions, classes, or at module level, and ignores indentation entirely.
+
+An unmatched ``# pragma: no mutate end`` without a preceding ``start`` raises
+a ``PragmaParseError`` at parse time.  An unclosed ``# pragma: no mutate start``
+(no matching ``end`` before end-of-file) raises a ``PragmaParseError``.
+Both errors include the filename and line number.
+
+**Nesting restriction:** opening a new ``block`` or ``start`` context while
+another context is already active is not allowed and raises a
+``PragmaParseError``.  The error message includes both the offending line and
+the line where the existing context was opened.  Close the current context
+first (dedent for ``block``, or ``# pragma: no mutate end`` for ``start``)
+before opening a new one.
+
 
 Modifying pytest arguments
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -279,6 +434,91 @@ You can add and override pytest arguments:
     also_copy = ["mutmut_pytest.ini"]
 
 
+Detecting dependency and config changes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Between runs, mutmut only re-tests mutants in functions whose source changed.
+Changes outside your Python source — a dependency upgrade, a data file, a
+config file — cannot be tied to a function, so they would otherwise be missed
+and you would get cached results that no longer reflect reality.
+
+To catch this, mutmut detects non-Python files that changed since the last full
+run and warns you about them. If your project is a git repository and git is
+installed, mutmut uses git (a soft dependency no extra package is required) to
+find every changed non-Python file, respecting your `.gitignore`. Python files
+are excluded because their changes are already tracked per function.
+
+On a full run with git available, mutmut also records the content hashes of the
+tracked non-Python files. This means a later run in an environment without git
+(for example a different CI stage) can still detect changes to that known set of
+files, even though it cannot discover brand-new ones.
+
+When git is unavailable, mutmut falls back to hashing a curated set of build and
+dependency files:
+
+- `pyproject.toml`
+- `setup.cfg`
+- `setup.py`
+- `requirements*.txt`
+- `poetry.lock`
+- `uv.lock`
+- `Pipfile`
+- `Pipfile.lock`
+
+You can watch additional files (for example data files your tests depend on)
+with the `cache_invalidation_files` config, which accepts glob patterns
+resolved against the project root. These are checked even when git ignores them,
+and are never dropped by the exclusions below:
+
+.. code-block:: toml
+
+    cache_invalidation_files = [ "queries/*.sql", "config/*.yaml" ]
+
+Git detection reports every changed non-Python file, so mutmut drops files that
+practically never affect tests (markdown, `LICENSE`, `CHANGELOG`, `docs/`, git
+and editor metadata, ...). Exclude additional noisy files with
+`cache_invalidation_exclude` (glob patterns, `*` spans directories):
+
+.. code-block:: toml
+
+    cache_invalidation_exclude = [ "*.json", "fixtures/snapshots/*" ]
+
+When a watched file changes, `on_dependency_change` controls what happens:
+
+- `warn` (default): list the changed files and keep the cache.
+- `rerun`: re-test all mutants.
+- `ignore`: do nothing.
+
+.. code-block:: toml
+
+    on_dependency_change = "warn"
+
+Git detection is on by default; disable it (forcing the curated-list fallback)
+with:
+
+.. code-block:: toml
+
+    use_git_change_detection = false
+
+Changes to mutmut's own result-affecting config (such as `pytest_add_cli_args`,
+`type_check_command`, or the timeout settings) are always detected and
+invalidate the affected cached results automatically.
+
+
+Unstable configs
+~~~~~~~~~~~~~~~~
+
+Following configurations exist, but may be changed in any minor version.
+If you use them, expect that a new version could change or break this feature.
+
+
+.. code-block:: toml
+
+    # Configure how long mutmut waits before killing a slow mutation
+    # Currently calculated as (duration_of_original_tests + timeout_constant) * timeout_multiplier seconds
+    timeout_constant = 1.0
+    timeout_multiplier = 15.0
+
 
 Example mutations
 -----------------
@@ -304,7 +544,7 @@ This section describes how to work with mutmut to enhance your test suite.
 4. Press `r` to rerun the mutant and see if you successfully managed to kill it.
 
 Mutmut keeps the data of what it has done and the mutants in the `mutants/`
-directory.If  you want to make sure you run a full mutmut run you can delete
+directory. If you want to make sure you run a full mutmut run you can delete
 this directory to start from scratch.
 
 Contributing to Mutmut