complexipy 4.0.2__tar.gz → 4.2.0__tar.gz

{complexipy-4.0.2 → complexipy-4.2.0}/Cargo.lock

@@ -107,7 +107,7 @@ dependencies = [
 
 [[package]]
 name = "complexipy"
-version = "4.0.2"
+version = "4.2.0"
 dependencies = [
  "console_error_panic_hook",
  "csv",

{complexipy-4.0.2 → complexipy-4.2.0}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "complexipy"
-version = "4.0.2"
+version = "4.2.0"
 edition = "2024"
 authors = ["Robin Quintero <rohaquinlop301@gmail.com>"]
 license = "MIT"

{complexipy-4.0.2 → complexipy-4.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: complexipy
-Version: 4.0.2
+Version: 4.2.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -33,7 +33,7 @@ Project-URL: Repository, https://github.com/rohaquinlop/complexipy
 # complexipy
 
 <div align="center">
-  <img src="docs/img/complexipy_icon.svg" alt="complexipy" width="120" height="120">
+  <img src="https://raw.githubusercontent.com/rohaquinlop/complexipy/refs/heads/main/docs/img/complexipy_icon.svg" alt="complexipy" width="120" height="120">
   
   <p><em>Blazingly fast cognitive complexity analysis for Python, written in Rust.</em></p>
 
@@ -86,6 +86,9 @@ complexipy . --max-complexity-allowed 10
 
 # Save results to JSON/CSV
 complexipy . --output-json --output-csv
+
+# Analyze current directory while excluding specific files
+complexipy . --exclude path/to/exclude.py --exclude path/to/other/exclude.py
 ```
 
 ### Python API
@@ -168,6 +171,7 @@ quiet = false
 ignore-complexity = false
 details = "normal"
 sort = "asc"
+exclude = []
 
 [output]
 csv = true
@@ -183,6 +187,7 @@ quiet = false
 ignore-complexity = false
 details = "normal"
 sort = "asc"
+exclude = []
 
 [tool.complexipy.output]
 csv = true
@@ -193,6 +198,7 @@ json = true
 
 | Flag | Description | Default |
 |------|-------------|---------|
+| `--exclude` | Exclude entries relative to each provided path. Entries resolve to existing directories (prefix match) or files (exact match). Non-existent entries are ignored. |  |
 | `--max-complexity-allowed` | Complexity threshold | `15` |
 | `--output-json` | Save results as JSON | `false` |
 | `--output-csv` | Save results as CSV | `false` |
@@ -200,6 +206,29 @@ json = true
 | `--sort <asc\|desc\|name>` | Sort results | `asc` |
 | `--quiet` | Suppress output | `false` |
 | `--ignore-complexity` | Don't exit with error on threshold breach | `false` |
+| `--version` | Show installed complexipy version and exit | - |
+
+Example:
+
+```
+# Exclude only top-level 'tests' directory under the provided root
+complexipy . --exclude tests
+# This will not exclude './complexipy/utils.py' if you pass '--exclude utils' at repo root,
+# because there is no './utils' directory or file at that level.
+```
+
+### Inline Ignores
+
+You can explicitly ignore a known complex function inline, similar to Ruff's `C901` ignores:
+
+```python
+def legacy_adapter(x, y):  # noqa: complexipy (safe wrapper)
+    if x and y:
+        return x + y
+    return 0
+```
+
+Place `# noqa: complexipy` on the function definition line (or the line immediately above). An optional reason can be provided in parentheses or plain text, it’s ignored by the parser.
 
 ## API Reference
 
@@ -225,11 +254,11 @@ FunctionComplexity:
 
 <div align="center">
 
+<sub>Inspired by the <a href="https://www.sonarsource.com/resources/cognitive-complexity/">Cognitive Complexity</a> research by SonarSource, G. Ann Campbell</sub>
+
 **[Documentation](https://rohaquinlop.github.io/complexipy/) • [PyPI](https://pypi.org/project/complexipy/) • [GitHub](https://github.com/rohaquinlop/complexipy)**
 
 <sub>Built with ❤️ by <a href="https://github.com/rohaquinlop">@rohaquinlop</a> and <a href="https://github.com/rohaquinlop/complexipy/graphs/contributors">contributors</a></sub>
 
-<sub>Inspired by the <a href="https://www.sonarsource.com/resources/cognitive-complexity/">Cognitive Complexity</a> research by SonarSource</sub>
-
 </div>
 

{complexipy-4.0.2 → complexipy-4.2.0}/README.md

@@ -1,7 +1,7 @@
 # complexipy
 
 <div align="center">
-  <img src="docs/img/complexipy_icon.svg" alt="complexipy" width="120" height="120">
+  <img src="https://raw.githubusercontent.com/rohaquinlop/complexipy/refs/heads/main/docs/img/complexipy_icon.svg" alt="complexipy" width="120" height="120">
   
   <p><em>Blazingly fast cognitive complexity analysis for Python, written in Rust.</em></p>
 
@@ -54,6 +54,9 @@ complexipy . --max-complexity-allowed 10
 
 # Save results to JSON/CSV
 complexipy . --output-json --output-csv
+
+# Analyze current directory while excluding specific files
+complexipy . --exclude path/to/exclude.py --exclude path/to/other/exclude.py
 ```
 
 ### Python API
@@ -136,6 +139,7 @@ quiet = false
 ignore-complexity = false
 details = "normal"
 sort = "asc"
+exclude = []
 
 [output]
 csv = true
@@ -151,6 +155,7 @@ quiet = false
 ignore-complexity = false
 details = "normal"
 sort = "asc"
+exclude = []
 
 [tool.complexipy.output]
 csv = true
@@ -161,6 +166,7 @@ json = true
 
 | Flag | Description | Default |
 |------|-------------|---------|
+| `--exclude` | Exclude entries relative to each provided path. Entries resolve to existing directories (prefix match) or files (exact match). Non-existent entries are ignored. |  |
 | `--max-complexity-allowed` | Complexity threshold | `15` |
 | `--output-json` | Save results as JSON | `false` |
 | `--output-csv` | Save results as CSV | `false` |
@@ -168,6 +174,29 @@ json = true
 | `--sort <asc\|desc\|name>` | Sort results | `asc` |
 | `--quiet` | Suppress output | `false` |
 | `--ignore-complexity` | Don't exit with error on threshold breach | `false` |
+| `--version` | Show installed complexipy version and exit | - |
+
+Example:
+
+```
+# Exclude only top-level 'tests' directory under the provided root
+complexipy . --exclude tests
+# This will not exclude './complexipy/utils.py' if you pass '--exclude utils' at repo root,
+# because there is no './utils' directory or file at that level.
+```
+
+### Inline Ignores
+
+You can explicitly ignore a known complex function inline, similar to Ruff's `C901` ignores:
+
+```python
+def legacy_adapter(x, y):  # noqa: complexipy (safe wrapper)
+    if x and y:
+        return x + y
+    return 0
+```
+
+Place `# noqa: complexipy` on the function definition line (or the line immediately above). An optional reason can be provided in parentheses or plain text, it’s ignored by the parser.
 
 ## API Reference
 
@@ -193,10 +222,10 @@ FunctionComplexity:
 
 <div align="center">
 
+<sub>Inspired by the <a href="https://www.sonarsource.com/resources/cognitive-complexity/">Cognitive Complexity</a> research by SonarSource, G. Ann Campbell</sub>
+
 **[Documentation](https://rohaquinlop.github.io/complexipy/) • [PyPI](https://pypi.org/project/complexipy/) • [GitHub](https://github.com/rohaquinlop/complexipy)**
 
 <sub>Built with ❤️ by <a href="https://github.com/rohaquinlop">@rohaquinlop</a> and <a href="https://github.com/rohaquinlop/complexipy/graphs/contributors">contributors</a></sub>
 
-<sub>Inspired by the <a href="https://www.sonarsource.com/resources/cognitive-complexity/">Cognitive Complexity</a> research by SonarSource</sub>
-
 </div>

{complexipy-4.0.2 → complexipy-4.2.0}/complexipy/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from complexipy._complexipy import (
     CodeComplexity,
     FileComplexity,

{complexipy-4.0.2 → complexipy-4.2.0}/complexipy/main.py

@@ -25,6 +25,10 @@ from typing import (
 )
 import time
 import typer
+from importlib.metadata import (
+    PackageNotFoundError,
+    version as pkg_version,
+)
 
 app = typer.Typer(name="complexipy")
 console = Console()
@@ -32,12 +36,27 @@ INVOCATION_PATH = os.getcwd()
 TOML_CONFIG = get_complexipy_toml_config(INVOCATION_PATH)
 
 
+def _version_callback(value: bool):
+    if value:
+        try:
+            console.print(pkg_version("complexipy"))
+        except PackageNotFoundError:
+            console.print("Unknown version")
+        raise typer.Exit()
+
+
 @app.command()
 def main(
     paths: Optional[List[str]] = typer.Argument(
         None,
         help="Paths to the directories or files to analyze, it can be a local paths or a git repository URL.",
     ),
+    exclude: Optional[List[str]] = typer.Option(
+        None,
+        "--exclude",
+        "-e",
+        help="Paths to the directories or files to exclude.",
+    ),
     max_complexity_allowed: Optional[int] = typer.Option(
         None,
         "--max-complexity-allowed",
@@ -80,6 +99,13 @@ def main(
         "-j",
         help="Output the results to a JSON file.",
     ),
+    version: bool = typer.Option(  # type: ignore[assignment]
+        False,
+        "--version",
+        help="Show the complexipy version and exit.",
+        callback=_version_callback,
+        is_eager=True,
+    ),
 ):
     (
         paths,
@@ -90,6 +116,7 @@ def main(
         sort,
         output_csv,
         output_json,
+        exclude,
     ) = get_arguments_value(
         TOML_CONFIG,
         paths,
@@ -100,6 +127,7 @@ def main(
         sort,
         output_csv,
         output_json,
+        exclude,
     )
 
     if not quiet:
@@ -108,7 +136,9 @@ def main(
         else:
             console.rule(":octopus: complexipy")
     start_time = time.time()
-    result: Tuple[List[FileComplexity], List[str]] = _complexipy.main(paths, quiet)
+    result: Tuple[List[FileComplexity], List[str]] = _complexipy.main(
+        paths, quiet, exclude
+    )
     files_complexities, failed_paths = result
     execution_time = time.time() - start_time
     output_csv_path = f"{INVOCATION_PATH}/complexipy.csv"

{complexipy-4.0.2 → complexipy-4.2.0}/complexipy/utils.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import os
 import sys
 from complexipy.types import DetailTypes, Sort, TOMLType
@@ -35,11 +37,32 @@ def get_brain_icon():
         return ":brain:"
 
 
-def load_values_from_toml_key(value: str) -> TOMLType:
-    if value == "details":
-        DetailTypes[value]
-    if value == "sort":
-        Sort[value]
+def load_values_from_toml_key(key: str, value: TOMLType) -> TOMLType:
+    """Normalize TOML values to expected runtime types.
+
+    - Convert `details` and `sort` string values to their Enum variants.
+    - Ensure `paths` and `exclude` are lists when provided as strings.
+    """
+    if key == "details":
+        # Accept either Enum or string in TOML
+        if isinstance(value, DetailTypes):
+            return value
+        if isinstance(value, str):
+            return DetailTypes(value)
+        return value
+
+    if key == "sort":
+        if isinstance(value, Sort):
+            return value
+        if isinstance(value, str):
+            return Sort(value)
+        return value
+
+    if key in ("paths", "exclude"):
+        # Allow a single string, normalize to list for downstream processing
+        if isinstance(value, str):
+            return [value]
+        return value
 
     return value
 
@@ -69,7 +92,7 @@ def load_toml_config(invocation_path: str, config_file_name: str) -> TOMLType |
             return None
 
     for key, value in data.items():
-        data[key] = load_values_from_toml_key(value)
+        data[key] = load_values_from_toml_key(key, value)
 
     return data
 
@@ -125,7 +148,8 @@ def get_arguments_value(
     sort_arg: Sort | None,
     output_csv: bool | None,
     output_json: bool | None,
-) -> Tuple[List[str], int, bool, bool, DetailTypes, Sort, bool, bool]:
+    exclude: List[str] | None,
+) -> Tuple[List[str], int, bool, bool, DetailTypes, Sort, bool, bool, List[str]]:
     paths = get_argument_value(toml_config, "paths", paths)
     max_complexity_allowed = get_argument_value(
         toml_config, "max-complexity-allowed", max_complexity_allowed, 15
@@ -138,6 +162,7 @@ def get_arguments_value(
     sort_arg = get_argument_value(toml_config, "sort", sort_arg, Sort.asc)
     output_csv = get_argument_value(toml_config, "output-csv", output_csv, False)
     output_json = get_argument_value(toml_config, "output-json", output_json, False)
+    exclude = get_argument_value(toml_config, "exclude", exclude, [])
 
     return (
         paths,
@@ -148,6 +173,7 @@ def get_arguments_value(
         sort_arg,
         output_csv,
         output_json,
+        exclude,
     )
 
 

{complexipy-4.0.2 → complexipy-4.2.0}/complexipy.toml

@@ -1,9 +1,10 @@
-paths = ["src", "complexipy"]
+paths = ["."]
 max-complexity-allowed = 15
 quiet = false
 ignore-complexity = false
 details = "normal"
 sort = "asc"
+exclude = ["tests"]
 
 [output]
 csv = false

{complexipy-4.0.2 → complexipy-4.2.0}/docs/index.md

@@ -67,6 +67,10 @@ complexipy . --max-complexity-allowed 10
 
 # Generate reports
 complexipy . --output-json --output-csv
+
+# Analyze current directory while excluding specific files
+complexipy . --exclude file_to_exclude.py --exclude path/to/other/exclude.py
+
 ```
 
 ### Python API
@@ -131,6 +135,7 @@ quiet = false
 ignore-complexity = false
 details = "normal"
 sort = "asc"
+exclude = []
 
 [output]
 csv = true
@@ -148,6 +153,7 @@ quiet = false
 ignore-complexity = false
 details = "normal"
 sort = "asc"
+exclude = []
 
 [tool.complexipy.output]
 csv = true
@@ -161,6 +167,7 @@ json = true
 
 | Option | Description | Default |
 |--------|-------------|---------|
+| `--exclude` | Exclude entries relative to each provided path. Entries resolve to existing directories (prefix match) or files (exact match). Non-existent entries are ignored. |  |
 | `--max-complexity-allowed <N>` | Complexity threshold for warnings | `15` |
 | `--output-json` | Export results to JSON | `false` |
 | `--output-csv` | Export results to CSV | `false` |
@@ -168,6 +175,7 @@ json = true
 | `--sort <asc\|desc\|name>` | Sort results by complexity or name | `asc` |
 | `--quiet` | Suppress terminal output | `false` |
 | `--ignore-complexity` | Don't exit with error on threshold breach | `false` |
+| `--version` | Show installed complexipy version and exit | - |
 
 ### Examples
 
@@ -180,11 +188,29 @@ complexipy . --max-complexity-allowed 8 --output-json
 
 # Silent analysis sorted by name
 complexipy src/ --sort name --quiet
+
+# Exclude specific paths relative to root
+complexipy . --exclude tests --exclude utils
+# Note: this excludes only './tests/**' and './utils/**' under '.',
+# it does not exclude './complexipy/utils.py'.
 ```
 
 !!! tip "Exit Codes"
     complexipy returns exit code `1` when functions exceed the complexity threshold. Use `--ignore-complexity` to suppress this behavior in CI/CD pipelines.
 
+### Inline Ignores
+
+You can explicitly ignore a known complex function inline, similar to Ruff's `C901` ignores:
+
+```python
+def legacy_adapter(x, y):  # noqa: complexipy (safe wrapper)
+    if x and y:
+        return x + y
+    return 0
+```
+
+Place `# noqa: complexipy` on the function definition line (or the line immediately above). An optional reason can be provided in parentheses or plain text, it’s ignored by the parser.
+
 ## API Reference
 
 ### Functions
@@ -365,7 +391,7 @@ def process_orders(orders):           # Base: 0
 ```bash
 $ complexipy example.py
 
-───────────────────────────── 🐙 complexipy 4.0.0 ──────────────────────────────
+───────────────────────────── 🐙 complexipy ──────────────────────────────
                                     Summary
            ┏━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┓
            ┃ Path       ┃ File       ┃ Function       ┃ Complexity ┃
@@ -384,7 +410,7 @@ $ complexipy example.py
 
 ## Links & Resources
 
-- **📚 [Research Paper](https://www.sonarsource.com/resources/cognitive-complexity/)** - Original cognitive complexity research by SonarSource
+- **📚 [Research Paper](https://www.sonarsource.com/resources/cognitive-complexity/)** - Original cognitive complexity research by SonarSource, G. Ann Campbell
 - **🐙 [GitHub Repository](https://github.com/rohaquinlop/complexipy)** - Source code and issue tracking  
 - **📦 [PyPI Package](https://pypi.org/project/complexipy/)** - Installation and version history
 - **🛠️ [GitHub Action](https://github.com/marketplace/actions/complexipy)** - CI/CD integration