mutmut 3.4.0__tar.gz → 3.6.0__tar.gz

{mutmut-3.4.0 → mutmut-3.6.0}/HISTORY.rst

@@ -1,6 +1,63 @@
 Changelog
 ---------
 
+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.
+
+* Show error message when running on Windows
+
+* Save mutation stats for use with CI/CD pipeline (#460)
+
+* Async functions fixed
+
+* Fix for functions with positional only arguments
+
+* Support signatures with PEP 649 deferred annotations
+
+
 3.4.0
 ~~~~~
 

{mutmut-3.4.0 → mutmut-3.6.0}/PKG-INFO

@@ -1,7 +1,8 @@
 Metadata-Version: 2.4
 Name: mutmut
-Version: 3.4.0
+Version: 3.6.0
 Summary: mutation testing for Python 3
+Keywords: mutmut,mutant,mutation,test,testing
 Author: Anders Hovmöller
 Author-email: Anders Hovmöller <boxed@killingar.net>
 License-Expression: BSD-3-Clause
@@ -85,8 +86,7 @@ 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.
@@ -121,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:
@@ -129,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.
@@ -161,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
 
@@ -176,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
 
@@ -199,6 +203,34 @@ If you only want to mutate lines that are called (according to coverage.py), you
     mutate_only_covered_lines=true
 
 
+Filter generated mutants with type checker
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+When your project is type checked using `mypy` or `pyrefly`, you can also use it to filter out invalid mutants.
+For instance, mutmut mutates `x: str = 'foo'` to `x: str = None` which can easily caught by type checkers.
+
+Using this filter can improve performance and reduce noise, however it can also hide a few relevant mutations:
+
+1. `x: str = None` may not be valid, but if your tests do not detect such a change it indicates that
+    the value of `x` is not properly tested (even if your type checker would catch this particular modification)
+2. In some edge cases with class properties (usually in the `__init__` method), the way `mypy` and `pyrefly` infer types does not work well
+    with the way mutmut mutates code. Some valid mutations like changing `self.x = 123` to `self.x = None` can
+    be filtered out, even though the may be valid.
+
+To enable this filtering, configure the `type_check_command` to output json results as follows:
+
+.. code-block::
+
+    # for pyrefly
+    type_check_command = ['pyrefly', 'check', '--output-format=json']
+    # for mypy
+    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`,
+and therefore mutmut cannot match the type error with the mutant that caused the type error.
+
+
 Enable debug output (increase verbosity)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -213,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``:
 
-    some_code_here()  # pragma: no mutate
+.. code-block:: toml
 
-to stop mutation on those lines. Some cases we've found where you need to
-whitelist lines are:
+    # pyproject.toml
+    [tool.mutmut]
+    use_setproctitle = false
 
-- The version string on your library. You really shouldn't have a test for this :P
+
+Disabling mutation on specific code
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+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
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -250,6 +434,20 @@ You can add and override pytest arguments:
     also_copy = ["mutmut_pytest.ini"]
 
 
+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
 -----------------