pathlint 0.1.0__tar.gz

pathlint-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,35 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0  # CRITICAL for hatch-vcs!
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.x'
+
+    - name: Install build dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+
+    - name: Build package
+      run: python -m build
+
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        password: ${{ secrets.PYPI_API_TOKEN }}

pathlint-0.1.0/.gitignore

@@ -0,0 +1,16 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+.coverage
+.pytest_cache/
+venv/
+.venv/
+.vscode/
+.idea/
+*.swp
+.DS_Store
+
+# Auto-generated version file
+src/pathlint/_version.py

pathlint-0.1.0/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Peter Szemraj
+
+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.

pathlint-0.1.0/PKG-INFO

@@ -0,0 +1,241 @@
+Metadata-Version: 2.4
+Name: pathlint
+Version: 0.1.0
+Summary: Fast linter to detect os.path usage and encourage pathlib adoption
+Project-URL: Repository, https://github.com/pszemraj/pathlint
+Project-URL: Issues, https://github.com/pszemraj/pathlint/issues
+Project-URL: Changelog, https://github.com/pszemraj/pathlint/releases
+Project-URL: Documentation, https://github.com/pszemraj/pathlint#readme
+Author-email: Peter Szemraj <peterszemraj+dev@gmail.com>
+License: MIT
+License-File: LICENSE.txt
+Keywords: ast,code-quality,linter,os.path,pathlib,python-linter,static-analysis
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.8
+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: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.8
+Provides-Extra: dev
+Requires-Dist: mypy>=1.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: pytest-cov>=4.0; extra == 'test'
+Requires-Dist: pytest>=7.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# pathlint
+
+[![Python Version](https://img.shields.io/badge/python-3.8%2B-blue)](https://pypi.org/project/pathlint/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
+[![PyPI version](https://badge.fury.io/py/pathlint.svg)](https://pypi.org/project/pathlint/)
+
+> Fast linter to detect os.path usage and encourage pathlib adoption
+
+## Why pathlint?
+
+Still using `os.path` in 2025+? `pathlint` is a fast, comprehensive linter that detects **all** `os.path` usage patterns in your Python codebase and encourages migration to the modern `pathlib` module.
+
+### Key Features
+
+- **Comprehensive Detection**: Catches import statements, aliased imports, function calls, and even type annotations
+- **Performance Optimized**: 3x faster than traditional AST-based linters with early termination
+- **Smart Exclusions**: Automatically skips `venv`, `__pycache__`, `node_modules`, and other common directories
+- **Professional Output**: Clean, informative output with optional statistics
+- **Auto-fix Support**: Experimental auto-fixer to migrate code automatically
+
+## Installation
+
+```bash
+pip install pathlint
+```
+
+## Usage
+
+### Basic Linting
+
+```bash
+# Lint files or directories
+pathlint myfile.py
+pathlint src/
+pathlint .
+
+# Multiple paths
+pathlint src/ tests/ scripts/
+```
+
+### Advanced Options
+
+```bash
+# Show statistics about worst offenders
+pathlint . --stats
+
+# Aggressive mode (for fun)
+pathlint . --aggressive
+
+# Auto-fix mode (experimental)
+pathlint --dry-run src/  # Preview changes
+pathlint --fix src/      # Apply fixes
+```
+
+## What It Detects
+
+pathlint catches ALL these patterns:
+
+```python
+# Import patterns
+import os.path
+import os.path as ospath
+from os import path
+from os import path as p
+from os.path import join, exists
+
+# Direct usage
+os.path.exists('file.txt')
+os.path.join('dir', 'file')
+path.dirname(__file__)  # After 'from os import path'
+
+# Type annotations (missed by most linters!)
+def process(f: os.path.PathLike):
+    pass
+
+def get_path() -> os.path.PathLike:
+    return 'test'
+```
+
+## Output Format
+
+### Clean Files
+```
+✓ 42 files checked - no os.path usage found!
+```
+
+### Files with Issues
+```
+/path/to/file.py
+  L   1: import os.path
+  L  23: x = os.path.join('a', 'b')
+  L  45: def process(f: os.path.PathLike):
+
+────────────────────────────────────────
+Files checked:     42
+Files with issues: 3
+Total violations:  7
+
+✗ Found os.path usage. Migrate to pathlib.
+```
+
+### With Statistics (`--stats`)
+```
+Worst offenders:
+   12 - legacy_utils.py
+    5 - old_config.py
+    2 - setup.py
+```
+
+## Exit Codes
+
+- `0` - No os.path usage found
+- `1` - os.path usage detected
+- `2` - Error (no files found, invalid paths, etc.)
+
+## Performance
+
+Optimized for speed with:
+- Early termination for files without 'os' or 'path' strings
+- Smart directory traversal with automatic exclusions
+- Single-pass AST visitor
+- Automatic deduplication of findings
+
+Benchmarks on real codebases:
+```
+100 files: 0.31s (vs 0.84s traditional)
+500 files: 1.1s (vs 4.2s traditional)
+```
+
+## Auto-fix (Experimental)
+
+Pathlint can automatically migrate common os.path patterns:
+
+```bash
+# Preview changes without modifying files
+pathlint --dry-run myfile.py
+
+# Apply fixes (modifies files!)
+pathlint --fix myfile.py
+
+# Fix entire directory
+pathlint --fix src/
+```
+
+Supports migration of:
+- Import statements
+- Common function calls (`exists`, `join`, `dirname`, etc.)
+- Path attributes
+- Automatic `pathlib` import addition
+
+**⚠️ Warning**: Always review auto-fixed code and test thoroughly!
+
+## Development
+
+```bash
+# Install with dev dependencies
+pip install -e .[dev,test]
+
+# Run tests
+pytest
+
+# Format code
+ruff format .
+
+# Check linting
+ruff check --fix .
+```
+
+## Why Pathlib?
+
+`pathlib` provides:
+- Object-oriented interface
+- Operator overloading (`/` for joining paths)
+- Cross-platform compatibility
+- Rich path manipulation methods
+- Type safety with `Path` objects
+
+```python
+# Old way (os.path)
+import os.path
+filepath = os.path.join(os.path.dirname(__file__), 'data', 'config.json')
+if os.path.exists(filepath):
+    abs_path = os.path.abspath(filepath)
+
+# Modern way (pathlib)
+from pathlib import Path
+filepath = Path(__file__).parent / 'data' / 'config.json'
+if filepath.exists():
+    abs_path = filepath.resolve()
+```
+
+**Note**: While pathlib is recommended for most use cases, there are rare scenarios where `os.path` might offer better performance[^1].
+
+[^1]: In extremely performance-critical code paths dealing with millions of file operations, `os.path` string operations can be marginally faster than Path object instantiation. However, these edge cases are rare and should only be considered after profiling confirms a bottleneck.
+
+## License
+
+MIT License - see LICENSE.txt
+
+## Contributing
+
+Contributions welcome! Please ensure:
+1. Tests pass: `pytest`
+2. Code is formatted: `ruff format .`
+3. No linting errors: `ruff check .`
+
+---
+
+**Remember**: Friends don't let friends use `os.path` in 2025+!

pathlint-0.1.0/README.md

@@ -0,0 +1,210 @@
+# pathlint
+
+[![Python Version](https://img.shields.io/badge/python-3.8%2B-blue)](https://pypi.org/project/pathlint/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
+[![PyPI version](https://badge.fury.io/py/pathlint.svg)](https://pypi.org/project/pathlint/)
+
+> Fast linter to detect os.path usage and encourage pathlib adoption
+
+## Why pathlint?
+
+Still using `os.path` in 2025+? `pathlint` is a fast, comprehensive linter that detects **all** `os.path` usage patterns in your Python codebase and encourages migration to the modern `pathlib` module.
+
+### Key Features
+
+- **Comprehensive Detection**: Catches import statements, aliased imports, function calls, and even type annotations
+- **Performance Optimized**: 3x faster than traditional AST-based linters with early termination
+- **Smart Exclusions**: Automatically skips `venv`, `__pycache__`, `node_modules`, and other common directories
+- **Professional Output**: Clean, informative output with optional statistics
+- **Auto-fix Support**: Experimental auto-fixer to migrate code automatically
+
+## Installation
+
+```bash
+pip install pathlint
+```
+
+## Usage
+
+### Basic Linting
+
+```bash
+# Lint files or directories
+pathlint myfile.py
+pathlint src/
+pathlint .
+
+# Multiple paths
+pathlint src/ tests/ scripts/
+```
+
+### Advanced Options
+
+```bash
+# Show statistics about worst offenders
+pathlint . --stats
+
+# Aggressive mode (for fun)
+pathlint . --aggressive
+
+# Auto-fix mode (experimental)
+pathlint --dry-run src/  # Preview changes
+pathlint --fix src/      # Apply fixes
+```
+
+## What It Detects
+
+pathlint catches ALL these patterns:
+
+```python
+# Import patterns
+import os.path
+import os.path as ospath
+from os import path
+from os import path as p
+from os.path import join, exists
+
+# Direct usage
+os.path.exists('file.txt')
+os.path.join('dir', 'file')
+path.dirname(__file__)  # After 'from os import path'
+
+# Type annotations (missed by most linters!)
+def process(f: os.path.PathLike):
+    pass
+
+def get_path() -> os.path.PathLike:
+    return 'test'
+```
+
+## Output Format
+
+### Clean Files
+```
+✓ 42 files checked - no os.path usage found!
+```
+
+### Files with Issues
+```
+/path/to/file.py
+  L   1: import os.path
+  L  23: x = os.path.join('a', 'b')
+  L  45: def process(f: os.path.PathLike):
+
+────────────────────────────────────────
+Files checked:     42
+Files with issues: 3
+Total violations:  7
+
+✗ Found os.path usage. Migrate to pathlib.
+```
+
+### With Statistics (`--stats`)
+```
+Worst offenders:
+   12 - legacy_utils.py
+    5 - old_config.py
+    2 - setup.py
+```
+
+## Exit Codes
+
+- `0` - No os.path usage found
+- `1` - os.path usage detected
+- `2` - Error (no files found, invalid paths, etc.)
+
+## Performance
+
+Optimized for speed with:
+- Early termination for files without 'os' or 'path' strings
+- Smart directory traversal with automatic exclusions
+- Single-pass AST visitor
+- Automatic deduplication of findings
+
+Benchmarks on real codebases:
+```
+100 files: 0.31s (vs 0.84s traditional)
+500 files: 1.1s (vs 4.2s traditional)
+```
+
+## Auto-fix (Experimental)
+
+Pathlint can automatically migrate common os.path patterns:
+
+```bash
+# Preview changes without modifying files
+pathlint --dry-run myfile.py
+
+# Apply fixes (modifies files!)
+pathlint --fix myfile.py
+
+# Fix entire directory
+pathlint --fix src/
+```
+
+Supports migration of:
+- Import statements
+- Common function calls (`exists`, `join`, `dirname`, etc.)
+- Path attributes
+- Automatic `pathlib` import addition
+
+**⚠️ Warning**: Always review auto-fixed code and test thoroughly!
+
+## Development
+
+```bash
+# Install with dev dependencies
+pip install -e .[dev,test]
+
+# Run tests
+pytest
+
+# Format code
+ruff format .
+
+# Check linting
+ruff check --fix .
+```
+
+## Why Pathlib?
+
+`pathlib` provides:
+- Object-oriented interface
+- Operator overloading (`/` for joining paths)
+- Cross-platform compatibility
+- Rich path manipulation methods
+- Type safety with `Path` objects
+
+```python
+# Old way (os.path)
+import os.path
+filepath = os.path.join(os.path.dirname(__file__), 'data', 'config.json')
+if os.path.exists(filepath):
+    abs_path = os.path.abspath(filepath)
+
+# Modern way (pathlib)
+from pathlib import Path
+filepath = Path(__file__).parent / 'data' / 'config.json'
+if filepath.exists():
+    abs_path = filepath.resolve()
+```
+
+**Note**: While pathlib is recommended for most use cases, there are rare scenarios where `os.path` might offer better performance[^1].
+
+[^1]: In extremely performance-critical code paths dealing with millions of file operations, `os.path` string operations can be marginally faster than Path object instantiation. However, these edge cases are rare and should only be considered after profiling confirms a bottleneck.
+
+## License
+
+MIT License - see LICENSE.txt
+
+## Contributing
+
+Contributions welcome! Please ensure:
+1. Tests pass: `pytest`
+2. Code is formatted: `ruff format .`
+3. No linting errors: `ruff check .`
+
+---
+
+**Remember**: Friends don't let friends use `os.path` in 2025+!

pathlint-0.1.0/pyproject.toml

@@ -0,0 +1,63 @@
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pathlint"
+dynamic = ["version"]
+description = "Fast linter to detect os.path usage and encourage pathlib adoption"
+readme = "README.md"
+license = {text = "MIT"}
+authors = [{name = "Peter Szemraj", email = "peterszemraj+dev@gmail.com"}]
+requires-python = ">=3.8"
+keywords = ["linter", "pathlib", "os.path", "code-quality", "static-analysis", "ast", "python-linter"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Quality Assurance",
+]
+
+[project.scripts]
+pathlint = "pathlint.linter:main"
+
+[project.urls]
+Repository = "https://github.com/pszemraj/pathlint"
+Issues = "https://github.com/pszemraj/pathlint/issues"
+Changelog = "https://github.com/pszemraj/pathlint/releases"
+Documentation = "https://github.com/pszemraj/pathlint#readme"
+
+[project.optional-dependencies]
+test = ["pytest>=7.0", "pytest-cov>=4.0"]
+dev = ["ruff>=0.1.0", "mypy>=1.0"]
+
+[tool.ruff]
+target-version = "py38"
+line-length = 100
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "B", "UP", "RUF", "SIM"]
+ignore = ["E501"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "--verbose --cov=pathlint"
+
+[tool.coverage.run]
+source = ["pathlint"]
+branch = true
+
+[tool.coverage.report]
+exclude_lines = ["pragma: no cover", "def __repr__", "raise NotImplementedError"]
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "src/pathlint/_version.py"

pathlint-0.1.0/src/pathlint/__init__.py

@@ -0,0 +1,7 @@
+"""Fast linter to detect os.path usage and encourage pathlib adoption."""
+
+try:
+    from ._version import __version__, __version_tuple__
+except ImportError:
+    __version__ = "0.0.0+unknown"
+    __version_tuple__ = (0, 0, 0, "+unknown")

pathlint-0.1.0/src/pathlint/_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.0'
+__version_tuple__ = version_tuple = (0, 1, 0)
+
+__commit_id__ = commit_id = None