pyrefactor 1.0.1__py3-none-any.whl

pyrefactor-1.0.1.dist-info/METADATA

@@ -0,0 +1,353 @@
+Metadata-Version: 2.4
+Name: pyrefactor
+Version: 1.0.1
+Summary: A Python refactoring and optimization linter that analyzes code for performance issues, complexity problems, and opportunities for improvement
+Author: tboy1337
+Maintainer: tboy1337
+License: Commercial Restricted License (CRL)
+Project-URL: Homepage, https://github.com/tboy1337/PyRefactor
+Project-URL: Repository, https://github.com/tboy1337/PyRefactor
+Project-URL: Issues, https://github.com/tboy1337/PyRefactor/issues
+Project-URL: Changelog, https://github.com/tboy1337/PyRefactor/releases
+Project-URL: Documentation, https://github.com/tboy1337/PyRefactor#readme
+Keywords: refactoring,linter,code-quality,static-analysis,ast,optimization,performance,complexity,code-analysis,python-linter,code-smell,maintainability,best-practices,code-review,cyclomatic-complexity
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: Other/Proprietary License
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Classifier: Environment :: Console
+Classifier: Natural Language :: English
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: colorama
+Dynamic: license-file
+
+# PyRefactor
+
+A powerful Python refactoring and optimization linter that analyzes your code for performance issues, complexity problems, and opportunities for improvement.
+
+[![Python 3.13+](https://img.shields.io/badge/python-3.13+-blue.svg)](https://www.python.org/downloads/)
+
+## Overview
+
+PyRefactor uses Abstract Syntax Tree (AST) analysis to identify code patterns that can be refactored for better performance, readability, and maintainability. It provides actionable insights with severity levels and detailed explanations for each detected issue.
+
+## Features
+
+- **Multi-threaded Analysis**: Analyze multiple files in parallel for faster results
+- **Configurable Detectors**: Enable or disable specific detectors based on your needs
+- **Severity Levels**: Issues categorized as INFO, LOW, MEDIUM, or HIGH severity
+- **Multiple Output Formats**: Group results by file or severity level
+- **Flexible Configuration**: Configure via `pyproject.toml`, custom config files, or command-line arguments
+- **Cross-platform**: Works on Windows, macOS, and Linux
+
+## Detectors
+
+PyRefactor includes the following specialized detectors:
+
+### Complexity Detector
+Identifies functions and methods with high cyclomatic complexity that should be refactored for better maintainability.
+
+### Performance Detector
+Finds performance anti-patterns including:
+- Inefficient string concatenation in loops
+- Multiple function calls that could be cached
+- Inefficient list operations
+- Unnecessary comprehensions
+
+### Boolean Logic Detector
+Detects overcomplicated boolean expressions and suggests simplifications:
+- Complex conditional chains
+- Redundant boolean operations
+- Opportunities for boolean algebra simplification
+
+### Loops Detector
+Identifies loop-related issues:
+- Nested loops that could be optimized
+- Loop invariant code that should be hoisted
+- Loops that could be replaced with comprehensions or built-in functions
+
+### Duplication Detector
+Finds duplicated code blocks that should be extracted into reusable functions.
+
+### Context Manager Detector
+Detects resource-allocating operations that should use `with` statements:
+- File operations (`open()`, etc.)
+- Lock acquisitions
+- Context managers not used properly
+- **Impact**: Prevents resource leaks and ensures proper cleanup
+
+### Control Flow Detector
+Identifies unnecessary control flow patterns:
+- Unnecessary `else` after `return` statement
+- Unnecessary `else` after `raise` statement
+- Unnecessary `else` after `break` statement
+- Unnecessary `else` after `continue` statement
+- **Impact**: Reduces nesting and improves code readability
+
+### Dictionary Operations Detector
+Finds inefficient or non-idiomatic dictionary operations:
+- Opportunities to use `dict.get(key, default)` instead of if/else
+- Unnecessary `.keys()` calls when iterating
+- Loops that should use `.items()` instead of indexing
+- Opportunities for dictionary comprehensions
+- **Impact**: More Pythonic and performant code
+
+### Comparisons Detector
+Detects non-idiomatic comparison patterns:
+- Multiple `==` comparisons that could use `in` operator
+- Comparisons that could be chained (e.g., `a < b < c`)
+- Singleton comparisons with `==` instead of `is` (for `None`, `True`, `False`)
+- Using `type()` instead of `isinstance()` for type checking
+- **Impact**: Cleaner, more idiomatic code
+
+## Installation
+
+### From Source
+
+```powershell
+# Clone the repository
+git clone https://github.com/tboy1337/PyRefactor.git
+cd PyRefactor
+
+# Install dependencies
+py -m pip install -r requirements.txt
+
+# Install in development mode
+py -m pip install -e .
+```
+
+### Requirements
+
+- Python 3.13 or higher
+- colorama (for colored console output)
+
+## Usage
+
+### Basic Usage
+
+```powershell
+# Analyze a single file
+pyrefactor myfile.py
+
+# Analyze a directory
+pyrefactor src/
+
+# Analyze multiple files
+pyrefactor file1.py file2.py src/module.py
+
+# Analyze with custom configuration
+pyrefactor --config custom.toml src/
+```
+
+### Command-line Options
+
+```
+positional arguments:
+  paths                 Python files or directories to analyze
+
+options:
+  -h, --help            show this help message and exit
+  -c CONFIG, --config CONFIG
+                        Path to configuration file (default: pyproject.toml)
+  -g {file,severity}, --group-by {file,severity}
+                        Group output by file or severity (default: file)
+  --min-severity {info,low,medium,high}
+                        Minimum severity level to report (default: info)
+  -j JOBS, --jobs JOBS  Number of parallel jobs (default: 4)
+  -v, --verbose         Enable verbose logging
+  --version             Show version and exit
+```
+
+### Examples
+
+```powershell
+# Show only HIGH and MEDIUM severity issues
+pyrefactor --min-severity medium src/
+
+# Group results by severity level
+pyrefactor --group-by severity src/
+
+# Use 8 parallel workers for faster analysis
+pyrefactor --jobs 8 large_project/
+
+# Verbose output with detailed logging
+pyrefactor -v src/
+```
+
+### Exit Codes
+
+PyRefactor uses the following exit codes:
+
+- `0` - No issues found, or only INFO/LOW severity issues
+- `1` - MEDIUM or HIGH severity issues found
+- `2` - Error during analysis (syntax errors, invalid paths, etc.)
+
+This makes PyRefactor suitable for use in CI/CD pipelines where you can fail builds based on code quality issues.
+
+## Configuration
+
+PyRefactor can be configured using a TOML configuration file. By default, it looks for configuration in `pyproject.toml` or a file specified with `--config`.
+
+### Example Configuration
+
+```toml
+[tool.pyrefactor]
+# Patterns to exclude from analysis
+exclude_patterns = [
+    "__pycache__",
+    ".venv",
+    "venv",
+    ".git",
+    "build",
+    "dist",
+]
+
+[tool.pyrefactor.complexity]
+# Maximum allowed cyclomatic complexity
+max_complexity = 10
+
+[tool.pyrefactor.performance]
+enabled = true
+# Minimum number of string concatenations to report
+min_concatenations = 3
+# Minimum number of duplicate calls to report
+min_duplicate_calls = 3
+
+[tool.pyrefactor.boolean_logic]
+enabled = true
+# Minimum depth of nested boolean expressions to report
+min_depth = 3
+
+[tool.pyrefactor.loops]
+enabled = true
+# Maximum allowed nesting depth for loops
+max_nesting = 3
+
+[tool.pyrefactor.duplication]
+enabled = true
+# Minimum number of lines for a code block to be considered for duplication detection
+min_lines = 5
+# Minimum similarity threshold (0.0 to 1.0)
+similarity_threshold = 0.8
+
+[tool.pyrefactor.context_manager]
+enabled = true
+
+[tool.pyrefactor.control_flow]
+enabled = true
+
+[tool.pyrefactor.dict_operations]
+enabled = true
+
+[tool.pyrefactor.comparisons]
+enabled = true
+```
+
+### Configuration File Location
+
+PyRefactor searches for configuration in the following order:
+
+1. Path specified with `--config` option
+2. `pyproject.toml` in the current directory
+3. `pyrefactor.ini` in the current directory
+4. Default configuration values
+
+## Integration
+
+### Pre-commit Hook
+
+Add PyRefactor to your `.pre-commit-config.yaml`:
+
+```yaml
+repos:
+  - repo: local
+    hooks:
+      - id: pyrefactor
+        name: PyRefactor
+        entry: pyrefactor
+        language: system
+        types: [python]
+        args: [--min-severity=medium]
+```
+
+### CI/CD Integration
+
+#### GitHub Actions
+
+```yaml
+name: Code Quality
+
+on: [push, pull_request]
+
+jobs:
+  pyrefactor:
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.13'
+      - name: Install dependencies
+        run: |
+          py -m pip install --upgrade pip
+          py -m pip install pyrefactor
+      - name: Run PyRefactor
+        run: pyrefactor --min-severity medium src/
+```
+
+## Troubleshooting
+
+### Common Issues
+
+**Issue**: `ModuleNotFoundError: No module named 'pyrefactor'`
+
+**Solution**: Make sure PyRefactor is installed: `py -m pip install -e .`
+
+---
+
+**Issue**: Syntax errors when analyzing Python 3.12 or older code
+
+**Solution**: PyRefactor requires Python 3.13+. Ensure your environment is using Python 3.13 or newer.
+
+---
+
+**Issue**: Analysis is slow on large codebases
+
+**Solution**: Increase the number of parallel workers: `pyrefactor --jobs 8 src/`
+
+## Contributing
+
+Contributions are welcome! Please note that this project is under a Commercial Restricted License (CRL). For commercial use, please contact the copyright holder.
+
+### Guidelines
+
+1. Follow the existing code style (Black, isort)
+2. Add tests for new features
+3. Ensure all tests pass and coverage remains >95%
+4. Update documentation as needed
+5. Run type checking and linting before submitting
+
+## License
+
+This project is licensed under the CRL license - see [LICENSE.md](LICENSE.md) for details.

pyrefactor-1.0.1.dist-info/RECORD

@@ -0,0 +1,24 @@
+pyrefactor/__init__.py,sha256=2177vJsLuSNphi6zgGTQI6QYJ0VvhEggqXbRxCv2XZg,91
+pyrefactor/__main__.py,sha256=U4Emvi0l0-PEVZA2Kuco6TJuccdSPBckJsMXM03pZOE,7017
+pyrefactor/analyzer.py,sha256=kuRhrR6R9vdrVh8CWcr_h0ibYFxvjxgOa5SwPYCOtpA,6538
+pyrefactor/ast_visitor.py,sha256=pRb-_IMG5bx46eOcsR4yIxUBFUFvoYUVOhrTFhfBwx4,6802
+pyrefactor/config.py,sha256=s1afhPkze8tUWdvAwhBK3V8_J2fCeexRc8HQ-0IYbyo,8237
+pyrefactor/models.py,sha256=4kDW3sGzQ8ckvcQ3spdU57196iyC8sGkosbQYgWTENk,3111
+pyrefactor/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pyrefactor/reporter.py,sha256=72NA-M3oC9JbywbCDygVuufXbw2ZMJ2blbRJwLUcCPM,7624
+pyrefactor/detectors/__init__.py,sha256=-JbOtWU5mFkS-IeBjxTBJeWxpsiWow9l6RIptPYA6b8,730
+pyrefactor/detectors/boolean_logic.py,sha256=JCYzv4BrayMoCsI_Bp_6lrvTlKE2auK1biz7-P7wHQk,8350
+pyrefactor/detectors/comparisons.py,sha256=QZ_KTudRCpbajcF2QIjPBfV6PbRKrLREy7kT3-hqT9A,12669
+pyrefactor/detectors/complexity.py,sha256=BlW1LPRxPPNqSCs2dkiOQYLzzVckYWpaVQqXsuRDugg,8844
+pyrefactor/detectors/context_manager.py,sha256=LIlfjeENkQiW2ahXmqyv54iol8yTwGriBcE2E7Ocfuo,6886
+pyrefactor/detectors/control_flow.py,sha256=NPUUCEUHTdVT0FfAU5jGShmlPPHgtbJZrnJShEift7M,5358
+pyrefactor/detectors/dict_operations.py,sha256=2muBMcIl-M9JJXmXQJ9DcBoG4xbhu2xfsHKBEsOjJsk,11817
+pyrefactor/detectors/duplication.py,sha256=_ErnVlBlLQjc9dSkbYc5zfUxDVP-SPWNb_I2fQR4rsY,13569
+pyrefactor/detectors/loops.py,sha256=9ZwiU9U_sv0E5tQeSlOjpOddSCks7mepUVGghxj2K7Y,9760
+pyrefactor/detectors/performance.py,sha256=uu1kK2FvZ30PUm4RS8Jt9f3EqCUyZaOEtsIqdftV0gQ,9528
+pyrefactor-1.0.1.dist-info/licenses/LICENSE.md,sha256=NYP65MjIOiBIzSEUIwUQw56lJYkP_7nGPFfgIgyl-iI,3035
+pyrefactor-1.0.1.dist-info/METADATA,sha256=z97BTSt4x6ULoOJ5JwjP8b0TbsLd6d-R7Znl_CT9P4I,10775
+pyrefactor-1.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pyrefactor-1.0.1.dist-info/entry_points.txt,sha256=xRew-6hh_lJPnaHeYDgetD0sseRGxaaz6EGitj0ztYE,56
+pyrefactor-1.0.1.dist-info/top_level.txt,sha256=gWLi3EgoB9D6SJvyeqPwvuQyoV3H-b4b6hFQ0_k2oSo,11
+pyrefactor-1.0.1.dist-info/RECORD,,

pyrefactor-1.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pyrefactor-1.0.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pyrefactor = pyrefactor.__main__:main

pyrefactor-1.0.1.dist-info/licenses/LICENSE.md

@@ -0,0 +1,70 @@
+# Commercial Restricted License (CRL)
+
+**Version 1.1**
+
+**Copyright (c) 2025 tboy1337**
+
+## Grant of Rights
+
+Subject to the terms and conditions of this license, the copyright holder grants you a worldwide, royalty-free, non-exclusive license to use, copy, modify, and distribute this software and associated documentation files (the "Software") for **Non-Commercial Use** only.
+
+## Definitions
+
+**"Non-Commercial Use"** means use of the Software that is not primarily intended for or directed toward commercial advantage or monetary compensation. Non-Commercial Use includes:
+
+- Personal use, learning, and experimentation
+- Academic research and education
+- Open source projects that are not monetized
+- Internal evaluation within a commercial organization (limited to 30 days)
+- Use by registered non-profit organizations for their non-profit activities
+
+**"Commercial Use"** means any use of the Software that is primarily intended for or directed toward commercial advantage or monetary compensation, including but not limited to:
+
+- Use in any product or service that generates revenue
+- Use by for-profit organizations in their business operations
+- Integration into commercial software or services
+- Use in providing paid consulting, support, or services
+- Use in any business process that contributes to revenue generation
+- Use by organizations with annual revenue exceeding $100,000 USD
+
+**Note:** Any Commercial Use of the Software requires a separate commercial license from the copyright holder.
+
+## Conditions
+
+For Non-Commercial Use, you may:
+
+- Use, copy, and modify the Software
+- Distribute copies of the Software
+- Distribute your modifications under this same license
+
+You must:
+
+- Include this license notice in all copies or substantial portions of the Software
+- Not remove or alter any copyright notices
+
+## Restrictions
+
+You may not:
+
+- Use the Software for Commercial Use without a commercial license
+- Sublicense the Software under different terms
+- Use the Software in any way that violates applicable laws
+- Remove, obscure, or modify any licensing, copyright, or other legal notices
+
+## No Warranty
+
+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.
+
+## Termination
+
+This license terminates automatically if you violate any of its terms. Upon termination, you must cease all use and distribution of the Software and destroy all copies in your possession.
+
+## Governing Law
+
+This license shall be governed by and construed in accordance with the laws of the United Kingdom, without regard to its conflict of law provisions.

pyrefactor-1.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+pyrefactor