pytest-api-cov 1.1.0__tar.gz → 1.1.1__tar.gz

{pytest_api_cov-1.1.0 → pytest_api_cov-1.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytest-api-cov
-Version: 1.1.0
+Version: 1.1.1
 Summary: Pytest Plugin to provide API Coverage statistics for Python Web Frameworks
 Author-email: Barnaby Gill <barnabasgill@gmail.com>
 License: Apache-2.0
@@ -259,14 +259,17 @@ show_uncovered_endpoints = true
 show_covered_endpoints = false
 show_excluded_endpoints = false
 
-# Exclude endpoints from coverage using simple wildcard patterns
+# Exclude endpoints from coverage using wildcard patterns with negation support
 # Use * for wildcard matching, all other characters are matched literally
+# Use ! at the start to negate a pattern (include what would otherwise be excluded)
 exclusion_patterns = [
     "/health",        # Exact match
     "/metrics",       # Exact match
     "/docs/*",        # Wildcard: matches /docs/swagger, /docs/openapi, etc.
     "/admin/*",       # Wildcard: matches all admin endpoints
-    "/api/v1.0/*"     # Exact version match (won't match /api/v1x0/*)
+    "!/admin/public", # Negation: include /admin/public even though /admin/* excludes it
+    "/api/v1.0/*",    # Exact version match (won't match /api/v1x0/*)
+    "!/api/v1.0/health" # Negation: include /api/v1.0/health even though /api/v1.0/* excludes it
 ]
 
 # Save detailed JSON report
@@ -308,9 +311,12 @@ pytest --api-cov-report --api-cov-show-uncovered-endpoints=false
 # Save JSON report
 pytest --api-cov-report --api-cov-report-path=api_coverage.json
 
-# Exclude specific endpoints (supports wildcards)
+# Exclude specific endpoints (supports wildcards and negation)
 pytest --api-cov-report --api-cov-exclusion-patterns="/health" --api-cov-exclusion-patterns="/docs/*"
 
+# Exclude with negation (exclude all admin except admin/public)
+pytest --api-cov-report --api-cov-exclusion-patterns="/admin/*" --api-cov-exclusion-patterns="!/admin/public"
+
 # Verbose logging (shows discovery process)
 pytest --api-cov-report -v
 

{pytest_api_cov-1.1.0 → pytest_api_cov-1.1.1}/README.md

@@ -241,14 +241,17 @@ show_uncovered_endpoints = true
 show_covered_endpoints = false
 show_excluded_endpoints = false
 
-# Exclude endpoints from coverage using simple wildcard patterns
+# Exclude endpoints from coverage using wildcard patterns with negation support
 # Use * for wildcard matching, all other characters are matched literally
+# Use ! at the start to negate a pattern (include what would otherwise be excluded)
 exclusion_patterns = [
     "/health",        # Exact match
     "/metrics",       # Exact match
     "/docs/*",        # Wildcard: matches /docs/swagger, /docs/openapi, etc.
     "/admin/*",       # Wildcard: matches all admin endpoints
-    "/api/v1.0/*"     # Exact version match (won't match /api/v1x0/*)
+    "!/admin/public", # Negation: include /admin/public even though /admin/* excludes it
+    "/api/v1.0/*",    # Exact version match (won't match /api/v1x0/*)
+    "!/api/v1.0/health" # Negation: include /api/v1.0/health even though /api/v1.0/* excludes it
 ]
 
 # Save detailed JSON report
@@ -290,9 +293,12 @@ pytest --api-cov-report --api-cov-show-uncovered-endpoints=false
 # Save JSON report
 pytest --api-cov-report --api-cov-report-path=api_coverage.json
 
-# Exclude specific endpoints (supports wildcards)
+# Exclude specific endpoints (supports wildcards and negation)
 pytest --api-cov-report --api-cov-exclusion-patterns="/health" --api-cov-exclusion-patterns="/docs/*"
 
+# Exclude with negation (exclude all admin except admin/public)
+pytest --api-cov-report --api-cov-exclusion-patterns="/admin/*" --api-cov-exclusion-patterns="!/admin/public"
+
 # Verbose logging (shows discovery process)
 pytest --api-cov-report -v
 

{pytest_api_cov-1.1.0 → pytest_api_cov-1.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pytest-api-cov"
-version = "1.1.0"
+version = "1.1.1"
 description = "Pytest Plugin to provide API Coverage statistics for Python Web Frameworks"
 readme = "README.md"
 authors = [{ name = "Barnaby Gill", email = "barnabasgill@gmail.com" }]

{pytest_api_cov-1.1.0 → pytest_api_cov-1.1.1}/src/pytest_api_cov/report.py

@@ -30,31 +30,59 @@ def categorise_endpoints(
 ) -> Tuple[List[str], List[str], List[str]]:
     """Categorise endpoints into covered, uncovered, and excluded.
 
-    Exclusion patterns support simple wildcard matching:
+    Exclusion patterns support simple wildcard matching with negation:
     - Use * for wildcard (matches any characters)
+    - Use ! at the start to negate a pattern (include what would otherwise be excluded)
     - All other characters are matched literally
-    - Examples: "/admin/*", "/health", "/docs/*"
+    - Examples: "/admin/*", "/health", "!users/bob" (negates exclusion)
+    - Pattern order matters: exclusions are applied first, then negations override them
     """
     covered, uncovered, excluded = [], [], []
 
-    compiled_patterns = (
-        [re.compile("^" + re.escape(pattern).replace(r"\*", ".*") + "$") for pattern in exclusion_patterns]
-        if exclusion_patterns
-        else None
-    )
+    if not exclusion_patterns:
+        compiled_exclusions = None
+        compiled_negations = None
+    else:
+        # Separate exclusion and negation patterns
+        exclusion_only = [p for p in exclusion_patterns if not p.startswith("!")]
+        negation_only = [p[1:] for p in exclusion_patterns if p.startswith("!")]  # Remove the '!' prefix
+
+        compiled_exclusions = (
+            [re.compile("^" + re.escape(pattern).replace(r"\*", ".*") + "$") for pattern in exclusion_only]
+            if exclusion_only
+            else None
+        )
+        compiled_negations = (
+            [re.compile("^" + re.escape(pattern).replace(r"\*", ".*") + "$") for pattern in negation_only]
+            if negation_only
+            else None
+        )
 
     for endpoint in endpoints:
         # Check exclusion patterns against both full "METHOD /path" and just "/path"
         is_excluded = False
-        if compiled_patterns:
+        if compiled_exclusions:
             # Extract path from "METHOD /path" format for pattern matching
             if " " in endpoint:
                 _, path_only = endpoint.split(" ", 1)
-                is_excluded = any(p.match(endpoint) for p in compiled_patterns) or any(
-                    p.match(path_only) for p in compiled_patterns
+                is_excluded = any(p.match(endpoint) for p in compiled_exclusions) or any(
+                    p.match(path_only) for p in compiled_exclusions
+                )
+            else:
+                is_excluded = any(p.match(endpoint) for p in compiled_exclusions)
+
+        # Check negation patterns - these override exclusions
+        if is_excluded and compiled_negations:
+            if " " in endpoint:
+                _, path_only = endpoint.split(" ", 1)
+                is_negated = any(p.match(endpoint) for p in compiled_negations) or any(
+                    p.match(path_only) for p in compiled_negations
                 )
             else:
-                is_excluded = any(p.match(endpoint) for p in compiled_patterns)
+                is_negated = any(p.match(endpoint) for p in compiled_negations)
+
+            if is_negated:
+                is_excluded = False  # Negation overrides exclusion
 
         if is_excluded:
             excluded.append(endpoint)