pytest-flakefighters 0.0.0__py3-none-any.whl → 0.1.5__py3-none-any.whl

_version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '0.1.5'
+__version_tuple__ = version_tuple = (0, 1, 5)
+
+__commit_id__ = commit_id = None

pytest_flakefighters/flakefighters/coverage_independence.py

@@ -18,13 +18,14 @@ class CoverageIndependence(FlakeFighter):
     """
     Classify tests as flaky if they fail independently of passing test cases that exercise overlapping code.
 
+    :ivar run_live: Run detection "live" after each test. Otherwise run as a postprocessing step after the test suite.
+                    This is always False as live classification is not supported.
     :ivar threshold: The minimum distance to consider as "similar", expressed as a proportion 0 <= threshold < 1 where 0
-    represents no difference and 1 represents complete difference.
-    :ivar metric: From `scipy.spatial.distance`: ['braycurtis', 'canberra', 'chebyshev', 'correlation', 'dice',
-    'hamming', 'jaccard', 'kulsinski', 'mahalanobis', 'minkowski', 'rogerstanimoto', 'russellrao', 'seuclidean',
-    'sokalmichener', 'sokalsneath', 'sqeuclidean', 'yule'].
+        represents no difference and 1 represents complete difference.
+    :ivar metric: The distance metric to use. For a full list of valid values,see the `SciPy documentation for spatial
+        distances <https://docs.scipy.org/doc/scipy/reference/spatial.distance.html>`_.
     :ivar linkage_method: From `scipy.cluster.hierarchy.linkage`: ['single', 'complete', 'average', 'weighted',
-    'centroid', 'median', 'ward']
+        'centroid', 'median', 'ward']
     """
 
     def __init__(self, threshold: float = 0, metric: str = "jaccard", linkage_method="single"):

pytest_flakefighters/flakefighters/deflaker.py

@@ -17,10 +17,11 @@ from pytest_flakefighters.flakefighters.abstract_flakefighter import FlakeFighte
 
 class DeFlaker(FlakeFighter):
     """
-    A python equivalent of the DeFlaker algorithm from Bell et al. 2019 [10.1145/3180155.3180164].
+    A python equivalent of the DeFlaker algorithm from `Bell et al. (2019) <https://doi.org/10.1145/3180155.3180164>`_.
     Given the subtle differences between JUnit and pytest, this is not intended to be an exact port, but it follows
     the same general methodology of checking whether covered code has been changed between commits.
 
+    :ivar run_live: Run detection "live" after each test. Otherwise run as a postprocessing step after the test suite.
     :ivar root: The root directory of the Git repository.
     :ivar source_commit: The source (older) commit hash. Defaults to HEAD^ (the previous commit to target).
     :ivar target_commit: The target (newer) commit hash. Defaults to HEAD (the most recent commit).
@@ -95,8 +96,8 @@ class DeFlaker(FlakeFighter):
         Classify an execution as flaky or not.
         :return: Boolean True of the test is classed as flaky and False otherwise.
         """
-        return not any(
-            execution.outcome == "failed" and self.line_modified_by_target_commit(file_path, line_number)
+        return execution.outcome != "passed" and not any(
+            self.line_modified_by_target_commit(file_path, line_number)
             for file_path in execution.coverage
             for line_number in execution.coverage[file_path]
             if file_path in self.lines_changed

pytest_flakefighters/flakefighters/traceback_matching.py

@@ -20,16 +20,18 @@ from pytest_flakefighters.flakefighters.abstract_flakefighter import FlakeFighte
 
 class TracebackMatching(FlakeFighter):
     """
-    Simple text-based matching classifier from Section II.A of [Alshammari et. al.].
+    Simple text-based matching classifier from Section II.A of
+    `Alshammari et al. (2024) <https://doi.org/10.1109/ICST60714.2024.00031>`_.
     We implement text-based matching on the failure logs for each test. Each failure log is represented by its failure
     exception and stacktrace.
+
+    :ivar run_live: Run detection "live" after each test. Otherwise run as a postprocessing step after the test suite.
     """
 
     def __init__(self, run_live: bool, previous_runs: list[Run], root: str = "."):
         super().__init__(run_live)
         self.root = os.path.abspath(root)
         self.previous_runs = previous_runs
-        print("TracebackMatching")
 
     @classmethod
     def from_config(cls, config: dict):
@@ -119,8 +121,11 @@ class TracebackMatching(FlakeFighter):
 
 class CosineSimilarity(TracebackMatching):
     """
-    TF-IDF cosine similarity matching classifier from Section II.C of [Alshammari et. al.].
+    TF-IDF cosine similarity matching classifier from Section II.C of
+    `Alshammari et al. (2024) <https://doi.org/10.1109/ICST60714.2024.00031>`_.
     Test executions are classified as flaky if the stack trace is sufficiently similar to a previous flaky execution.
+
+    :ivar run_live: Run detection "live" after each test. Otherwise run as a postprocessing step after the test suite.
     """
 
     def __init__(self, run_live: bool, previous_runs: list[Run], root: str = ".", threshold: float = 1):

pytest_flakefighters/function_coverage.py

@@ -16,7 +16,7 @@ class Profiler:
 
     :ivar coverage_data: The (potentially) covered lines for each module.
     :ivar function_defs: The lines that define a given function in a given module, accessed as
-    `function_defs[module][function]`.
+        `function_defs[module][function]`.
     """
 
     def __init__(self):

pytest_flakefighters/main.py

@@ -132,7 +132,12 @@ def pytest_configure(config: pytest.Config):
 
     flakefighters = []
     if flakefighter_configs is not None:
-        flakefighter_configs = yaml.safe_load(flakefighter_configs.value)
+        if isinstance(flakefighter_configs, str):
+            flakefighter_configs = yaml.safe_load(flakefighter_configs)
+        elif hasattr(flakefighter_configs, "value"):
+            flakefighter_configs = yaml.safe_load(flakefighter_configs.value)
+        else:
+            raise TypeError(f"Unexpected type for config: {type(flakefighter_configs)}")
         for flakefighter in algorithms:
             if flakefighter.name in flakefighter_configs:
                 flakefighters.append(

pytest_flakefighters/plugin.py

@@ -193,7 +193,7 @@ class FlakeFighterPlugin:  # pylint: disable=R0902
         :param config: The pytest config object.
         :returns: The test status.
         """
-        if getattr(report, "flaky", False):
+        if getattr(report, "flaky", False) and not report.passed:
             return report.outcome, "F", ("FLAKY", {"yellow": True})
         return None
 

pytest_flakefighters/rerun_strategies.py

@@ -81,7 +81,7 @@ class PreviouslyFlaky(FlakyFailure):
     def rerun(self, report: pytest.TestReport) -> bool:
         """
         :return: Boolean true if a test is a flaky failure or has previously been marked as flaky and has the same name
-        as the current test.
+            as the current test.
         """
         return super().rerun(report) or any(test.name == report.nodeid for test in self.previously_flaky)
 

{pytest_flakefighters-0.0.0.dist-info → pytest_flakefighters-0.1.5.dist-info}/METADATA

@@ -1,32 +1,9 @@
 Metadata-Version: 2.4
 Name: pytest-flakefighters
-Version: 0.0.0
+Version: 0.1.5
 Summary: Pytest plugin implementing flaky test failure detection and classification.
 Author: TestFLARE Team
-License: 
-        The MIT License (MIT)
-        
-        Copyright (c) 2025 TestFLARE Team
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in
-        all copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-        THE SOFTWARE.
-        
-Project-URL: Repository, https://github.com/test-flare/pytest-flakefighter
+Project-URL: Repository, https://github.com/test-flare/pytest-flakefighters
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -49,6 +26,8 @@ Requires-Dist: pre_commit; extra == "dev"
 Requires-Dist: sphinx-autoapi; extra == "dev"
 Requires-Dist: sphinx_rtd_theme; extra == "dev"
 Requires-Dist: tox>=4.31.0; extra == "dev"
+Requires-Dist: myst_parser; extra == "dev"
+Requires-Dist: nbsphinx; extra == "dev"
 Dynamic: license-file
 
 # Pytest FlakeFighters

pytest_flakefighters-0.1.5.dist-info/RECORD

@@ -0,0 +1,18 @@
+_version.py,sha256=rdxBMYpwzYxiWk08QbPLHSAxHoDfeKWwyaJIAM0lSic,704
+pytest_flakefighters/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pytest_flakefighters/database_management.py,sha256=MDwwpF8FwmFX6is9pVPye7qEOrjZXOsfXG2UI5I7uk4,7029
+pytest_flakefighters/function_coverage.py,sha256=IgzWHMFgkVrc68ZjQ1o27tGxKa8WvcMcGW8RWnpFLVw,2187
+pytest_flakefighters/main.py,sha256=N0yGSGA-ZLtsKRCtSCIdnw7RPVEtLnXUhnftQGHjujA,5430
+pytest_flakefighters/plugin.py,sha256=0XcbZooY_hCwCI1Kg1YntiWQPUn_buDsWBcal0cbEtQ,8802
+pytest_flakefighters/rerun_strategies.py,sha256=YI-spvm0dhB-gGM9IEgDz19NHvzD_XesZ8lDcBDGSJM,2536
+pytest_flakefighters/flakefighters/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pytest_flakefighters/flakefighters/abstract_flakefighter.py,sha256=bchRwoNzQaFhSknT9wKDpbf3EiReHPsHsDhm5qi8y_o,1953
+pytest_flakefighters/flakefighters/coverage_independence.py,sha256=5swoY1jOaaGFlZNX6PdejBFVd7Gpi3zsaW5W6toIzk8,4480
+pytest_flakefighters/flakefighters/deflaker.py,sha256=g0vPS2sEiD9XWFVu_FEZAw2pVkw9vGMWFa7Do1C3sck,5388
+pytest_flakefighters/flakefighters/traceback_matching.py,sha256=LheOEqCvrBDrZJm4RK4ZFFcebWs4ggP7qRiUPg8HQpM,6926
+pytest_flakefighters-0.1.5.dist-info/licenses/LICENSE,sha256=tTzR2CWQMPOp-mQIQqi0cTRkaogeBUmW06blQsBLdQg,1082
+pytest_flakefighters-0.1.5.dist-info/METADATA,sha256=oJo4dnKiNGWO0-kPdvAz1zyCESfAWTh87k_-P8KRwf0,4390
+pytest_flakefighters-0.1.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pytest_flakefighters-0.1.5.dist-info/entry_points.txt,sha256=xockvN1AszN2XqaET77JDIRdOafgm3DdvOtHgVw-aDU,424
+pytest_flakefighters-0.1.5.dist-info/top_level.txt,sha256=bWwe0xVZ_l2CP8KSnztW6FafZKQZ7zUTMa1U32geY28,30
+pytest_flakefighters-0.1.5.dist-info/RECORD,,

{pytest_flakefighters-0.0.0.dist-info → pytest_flakefighters-0.1.5.dist-info}/top_level.txt

@@ -1 +1,2 @@
+_version
 pytest_flakefighters

pytest_flakefighters-0.0.0.dist-info/RECORD

@@ -1,17 +0,0 @@
-pytest_flakefighters/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pytest_flakefighters/database_management.py,sha256=MDwwpF8FwmFX6is9pVPye7qEOrjZXOsfXG2UI5I7uk4,7029
-pytest_flakefighters/function_coverage.py,sha256=_WAENobGFbvlbT_CZO6_Ohf8lWaspi5DrWLZd4BdbxY,2183
-pytest_flakefighters/main.py,sha256=u2tgDVLcQ7bbCb55aLG7Nqu5KVx_9GyRAuMBdojCHeM,5148
-pytest_flakefighters/plugin.py,sha256=Y3eQRK58ydO-c77PpnQ8cjWFtOVHop4yf8iAPKEO6TU,8780
-pytest_flakefighters/rerun_strategies.py,sha256=nu6V6sqIMTVqkMBiYek30pe_zolGtdHQwTrgtj13ZG4,2532
-pytest_flakefighters/flakefighters/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pytest_flakefighters/flakefighters/abstract_flakefighter.py,sha256=bchRwoNzQaFhSknT9wKDpbf3EiReHPsHsDhm5qi8y_o,1953
-pytest_flakefighters/flakefighters/coverage_independence.py,sha256=6Ic5SN1Np7vQbvNSRgWwiSF9ReQ293mvNwcn0ZS5js8,4349
-pytest_flakefighters/flakefighters/deflaker.py,sha256=L0pPCWTaKaK_lr7qGh4uhI1ofJXgDr9m-CCjOk-_2KM,5248
-pytest_flakefighters/flakefighters/traceback_matching.py,sha256=DVH8OeoDFmBQW277ap_-e2xe8UBJWkZl5HH-iMdb_Ag,6605
-pytest_flakefighters-0.0.0.dist-info/licenses/LICENSE,sha256=tTzR2CWQMPOp-mQIQqi0cTRkaogeBUmW06blQsBLdQg,1082
-pytest_flakefighters-0.0.0.dist-info/METADATA,sha256=rm_arh8KcYnTVM-qEaJNFyC_JSRvJ7hYhJugNak-9vg,5574
-pytest_flakefighters-0.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pytest_flakefighters-0.0.0.dist-info/entry_points.txt,sha256=xockvN1AszN2XqaET77JDIRdOafgm3DdvOtHgVw-aDU,424
-pytest_flakefighters-0.0.0.dist-info/top_level.txt,sha256=mRzzeCn_6fy5c4knXqUVx2n0d86SvnOpeJcSRUevhWg,21
-pytest_flakefighters-0.0.0.dist-info/RECORD,,