cytoscnpy 1.0.1

High-performance dead code elimination analysis tool for Python.

CytoScnPy - High-Performance Python Static Analysis 🦀🐍

A lightning-fast static analysis tool for Python codebases, powered by Rust with hybrid Python integration. Detects dead code, security vulnerabilities (including taint analysis), and code quality issues with extreme speed.Code quality metrics are also provided.

🚀 Why CytoScnPy?

• 🔥 Blazing Fast: Faster in dead code detection.
• 💾 Memory Efficient: Uses less memory.
• 🐍 Python Native: Installable via pip, importable in Python code
• ⚡ CLI Ready: Standalone command-line tool with rich output
• 🔍 Comprehensive: Dead code, secrets, security, taint analysis, quality metrics
• 🎯 Framework Aware: Understands Flask, Django, FastAPI patterns
• 📊 Benchmarked: Continuous benchmarking with 126-item ground truth suite

📦 Installation

pip install cytoscnpy

# Or install from source
git clone https://github.com/djinn09/CytoScnPy.git
cd CytoScnPy
pip install maturin
maturin develop -m cytoscnpy/Cargo.toml

✨ Features

• Dead Code Detection: Unused functions, classes, imports, and variables with cross-module tracking.
• Security Analysis: Taint analysis (SQLi, XSS), secret scanning (API keys), and dangerous code patterns (eval, exec).
• Code Quality Metrics: Cyclomatic complexity, Halstead metrics, Maintainability Index, and raw metrics (LOC, SLOC).
• Framework Support: Native understanding of Flask, Django, and FastAPI patterns.
• Smart Heuristics: Handles dataclasses, __all__ exports, visitor patterns, and dynamic attributes intelligently.

🛠️ Usage

Command Line

cytoscnpy [PATHS]... [OPTIONS]

Examples:

# Dead code analysis
cytoscnpy .                                     # Analyze current directory
cytoscnpy /path/to/project --json               # JSON output for CI/CD

# Security checks
cytoscnpy . --secrets --danger --quality --taint

# Confidence threshold (0-100)
cytoscnpy . --confidence 80

# Path filtering
cytoscnpy . --exclude-folder venv --exclude-folder build
cytoscnpy . --include-folder specific_venv      # Override defaults
cytoscnpy . --include-tests

# Jupyter notebooks
cytoscnpy . --include-ipynb --ipynb-cells

Options:

Flag	Description
-c, --confidence <N>	Set confidence threshold (0-100)
--secrets	Scan for API keys, tokens, credentials
--danger	Scan for dangerous code patterns
--quality	Scan for code quality issues
--taint	Enable taint analysis
--json	Output results as JSON
--include-tests	Include test files in analysis
--exclude-folder <DIR>	Exclude specific folders
--include-folder <DIR>	Force include folders
--include-ipynb	Include Jupyter notebooks
--ipynb-cells	Report findings per notebook cell

Metric Subcommands

cytoscnpy raw .                    # Raw Metrics (LOC, SLOC, Comments)
cytoscnpy cc .                     # Cyclomatic Complexity
cytoscnpy hal .                    # Halstead Metrics
cytoscnpy mi .                     # Maintainability Index

Tip: Add --json for machine-readable output, --exclude-folder <DIR> to skip directories.

⚙️ Configuration

Create .cytoscnpy.toml or add to pyproject.toml:

[tool.cytoscnpy]
# General Settings
confidence = 60  # Minimum confidence threshold (0-100)
exclude_folders = ["venv", ".tox", "build", "node_modules", ".git"]
include_folders = ["src", "tests"]  # Optional: whitelist folders
include_tests = false

# Analysis Features
secrets = true
danger = true
quality = true

# Fail Threshold (exit code 1 if exceeded)
fail_threshold = 10.0  # Fail if >10% of code is unused
# fail_threshold = 0.0  # Zero tolerance: fail on any unused code

# Code Quality Thresholds
max_lines = 100       # Max lines per function
max_args = 5          # Max arguments per function
complexity = 10       # Max cyclomatic complexity
nesting = 4           # Max indentation depth
min_mi = 65.0         # Minimum Maintainability Index
ignore = ["R001"]     # Ignore specific rule IDs

# CI/CD Integration
fail_threshold = 5.0  # Exit with code 1 if unused code % exceeds this

# Advanced Secret Scanning
[tool.cytoscnpy.secrets_config]
entropy_enabled = true
entropy_threshold = 4.0  # Higher = more random (API keys usually > 4.0)
min_length = 16          # Min length to check for entropy
scan_comments = true     # Scan comments for secrets

# Custom Secret Patterns
[[tool.cytoscnpy.secrets_config.patterns]]
name = "Slack Token"
regex = "xox[baprs]-([0-9a-zA-Z]{10,48})"
severity = "HIGH"

Fail Threshold

Configure a fail threshold for unused code. If the percentage exceeds this threshold, the CLI exits with code 1.

• Default: 100.0 (effectively disabled)
• Zero Tolerance: Set to 0.0 to fail on any unused code

📊 Performance

Speed Comparison

Metric	Rust (CytoScnPy)
Time	0.07s
Memory	~14MB

Accuracy (Benchmark Suite: 126 items)

Detection Type	Precision	Recall	F1 Score
Classes	0.75	0.82	0.78
Functions	0.57	0.74	0.64
Methods	1.00	0.59	0.74
Imports	0.50	0.37	0.42
Variables	0.25	0.16	0.19
Overall	0.61	0.57	0.59

See benchmark/README.md for detailed comparison against Vulture, Flake8, Pylint, Ruff, and others.

🏗️ Architecture

See cytoscnpy/README.md for detailed architecture and technology stack information.

🧪 Testing

See CONTRIBUTING.md for testing instructions.

🤝 Contributing

See CONTRIBUTING.md for development setup and guidelines.

📝 License

Apache-2.0 License - see License file for details.

🔗 Links

• Rust Core Documentation
• Benchmarks & Accuracy
• Roadmap
• Changelog
• Contributing

📚 References

CytoScnPy's design and implementation are inspired by:

• Skylos
• Radon