pydocfix 0.1.0a1__tar.gz

pydocfix-0.1.0a1/.devcontainer/Dockerfile

@@ -0,0 +1,14 @@
+FROM python:3.13.12-bookworm
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+RUN apt update && apt install -y --no-install-recommends \
+    git \
+    && rm -rf /var/lib/apt/lists/*
+
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /usr/local/bin/
+RUN uv pip install --system pydocstring-rs
+
+RUN mkdir -p /workspace
+
+WORKDIR /workspace

pydocfix-0.1.0a1/.devcontainer/devcontainer.json

@@ -0,0 +1,26 @@
+{
+    "name": "pydocfix",
+    "build": {
+        "dockerfile": "Dockerfile"
+    },
+    "customizations": {
+        "vscode": {
+            "extensions": [
+                "ms-python.python",
+                "charliermarsh.ruff"
+            ],
+            "settings": {
+                "editor.formatOnSave": true,
+                "python.analysis.extraPaths": [
+                    "src"
+                ],
+                "[python]": {
+                    "editor.codeActionsOnSave": {
+                        "source.organizeImports": "explicit"
+                    },
+                    "editor.defaultFormatter": "charliermarsh.ruff"
+                }
+            }
+        }
+    }
+}

pydocfix-0.1.0a1/.github/copilot-instructions.md

@@ -0,0 +1,6 @@
+# pydocfixについて
+- Pythonのdocstringのリンターです
+- Pythonで実装します
+- docstringパーサに[pydocstring-rs](https://pypi.org/project/pydocstring-rs)を採用します
+- pydocstyleやpydoclint、ruffなどを参考にしますが、auto-fixを最大の特徴とします
+- カスタムルール(プラグイン)もサポートする予定です

pydocfix-0.1.0a1/.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          pip install -e . pytest pytest-cov
+
+      - name: Run tests
+        run: pytest tests/ --tb=short -q

pydocfix-0.1.0a1/.github/workflows/release.yml

@@ -0,0 +1,46 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install dependencies
+        run: pip install -e . pytest pytest-cov
+
+      - name: Run tests
+        run: pytest tests/ --tb=short -q
+
+  publish:
+    needs: test
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      id-token: write  # for trusted publishing
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Build package
+        run: |
+          pip install build
+          python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

pydocfix-0.1.0a1/.gitignore

@@ -0,0 +1,216 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer,
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

pydocfix-0.1.0a1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ryuma Asai
+
+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.

pydocfix-0.1.0a1/PKG-INFO

@@ -0,0 +1,187 @@
+Metadata-Version: 2.4
+Name: pydocfix
+Version: 0.1.0a1
+Summary: A Python docstring linter with auto-fix support
+Author: Ryuma Asai
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.11
+Requires-Dist: click>=8.0
+Requires-Dist: pydocstring-rs>=0.1.9
+Description-Content-Type: text/markdown
+
+# pydocfix
+
+A Python docstring linter that checks **signature ↔ docstring consistency** and **auto-fixes** violations.
+
+> [!WARNING]
+> This project is currently under active development (v0.1.0a1).
+> APIs and behavior may change without notice.
+
+## Why pydocfix?
+
+Existing signature ↔ docstring consistency checkers (such as pydoclint) can report violations but cannot fix them — leaving all corrections to the developer.
+
+pydocfix is built on [pydocstring-rs](https://github.com/aita/pydocstring-rs), a **CST (Concrete Syntax Tree) parser** for docstrings written in Rust by the same author. CST preserves every token's byte offset, whitespace, and formatting, enabling:
+
+- **Byte-level diagnostics** — point to the exact token (parameter name, type annotation, section header), not just the line
+- **Surgical auto-fix** — edits replace precise byte ranges, so fixes never corrupt adjacent content
+- **Iterative fix loop** — apply non-overlapping fixes, re-parse, repeat until stable
+
+## Features
+
+- **Auto-fix** — Automatically repair docstring issues with safe/unsafe classification
+- **35 rules** across 6 categories: Summary, Parameters, Returns, Yields, Raises, Docstring
+- **Google & NumPy style** support (powered by [pydocstring-rs](https://github.com/aita/pydocstring-rs))
+- **Signature ↔ docstring consistency** — type mismatches, missing/extra parameters, ordering
+- **Default value checking** — detect missing `optional` / `default` annotations
+- **Precise diagnostics** — byte-level position information for every violation
+
+## Installation
+
+```bash
+pip install pydocfix
+```
+
+Requires Python 3.11+.
+
+## Quick Start
+
+```bash
+# Check docstrings (report only)
+pydocfix check src/
+
+# Show diff of proposed fixes
+pydocfix check src/ --diff
+
+# Apply safe fixes
+pydocfix check src/ --fix
+
+# Apply safe + unsafe fixes
+pydocfix check src/ --fix --unsafe-fixes
+
+# Enable all rules (including non-default)
+pydocfix check src/ --select ALL
+
+# Select specific rules
+pydocfix check src/ --select PRM,RTN
+
+# Ignore specific rules
+pydocfix check src/ --ignore SUM001,PRM008
+```
+
+## Configuration
+
+Configure via `pyproject.toml`:
+
+```toml
+[tool.pydocfix]
+# Rules to enable (overrides defaults); supports category prefixes and "ALL"
+select = ["ALL"]
+
+# Rules to disable
+ignore = ["PRM001", "RTN001", "YLD001", "RIS001"]
+
+# Type annotation style: "signature" (default) or "docstring"
+type_annotation_style = "signature"
+
+# Paths/patterns to exclude (in addition to built-in defaults)
+exclude = ["tests/", "docs/"]
+```
+
+## Rules
+
+35 rules across 6 categories. Each rule is classified as **safe** fix, **unsafe** fix, or report-only.
+
+- **Safe** fixes can be applied automatically with `--fix` (no risk of changing semantics)
+- **Unsafe** fixes require `--fix --unsafe-fixes` (may alter docstring meaning)
+
+### Summary (SUM)
+
+| Code | Default | Fix | Description |
+|------|:-------:|:---:|-------------|
+| SUM001 | ✅ | — | Missing summary line |
+| SUM002 | ✅ | safe | Summary doesn't end with period |
+
+### Parameters (PRM)
+
+| Code | Default | Fix | Description |
+|------|:-------:|:---:|-------------|
+| PRM001 | ✅ | unsafe | Missing Args/Parameters section |
+| PRM002 | ✅ | safe | Unnecessary Args/Parameters section |
+| PRM003 | ✅ | safe | `self`/`cls` documented in docstring |
+| PRM004 | ✅ | unsafe | Parameter in signature missing from docstring |
+| PRM005 | ✅ | unsafe | Parameter in docstring not in signature |
+| PRM006 | ✅ | unsafe | Parameter order mismatch |
+| PRM007 | ✅ | unsafe | Duplicate parameter name |
+| PRM008 | ✅ | — | Parameter has no description |
+| PRM009 | ✅ | safe | Missing `*`/`**` prefix on `*args`/`**kwargs` |
+| PRM101 | ✅ | unsafe | Docstring type doesn't match signature annotation |
+| PRM102 | ✅ | unsafe | No type in docstring or signature |
+| PRM103 | | safe | Redundant type in docstring (signature has annotation) |
+| PRM104 | | unsafe | No type in docstring |
+| PRM201 | ✅ | unsafe | Missing `optional` for parameter with default |
+| PRM202 | | unsafe | Missing `default` for parameter with default |
+
+### Returns (RTN)
+
+| Code | Default | Fix | Description |
+|------|:-------:|:---:|-------------|
+| RTN001 | ✅ | unsafe | Missing Returns section |
+| RTN002 | ✅ | safe | Unnecessary Returns section |
+| RTN003 | ✅ | — | Returns entry has no description |
+| RTN101 | ✅ | unsafe | Return type mismatch |
+| RTN102 | ✅ | unsafe | No return type anywhere |
+| RTN103 | | safe | Redundant return type in docstring |
+| RTN104 | | unsafe | No return type in docstring |
+
+### Yields (YLD)
+
+| Code | Default | Fix | Description |
+|------|:-------:|:---:|-------------|
+| YLD001 | ✅ | unsafe | Missing Yields section |
+| YLD002 | ✅ | safe | Unnecessary Yields section |
+| YLD003 | ✅ | — | Yields entry has no description |
+| YLD101 | ✅ | unsafe | Yield type mismatch |
+| YLD102 | ✅ | unsafe | No yield type anywhere |
+| YLD103 | | safe | Redundant yield type in docstring |
+| YLD104 | | unsafe | No yield type in docstring |
+
+### Raises (RIS)
+
+| Code | Default | Fix | Description |
+|------|:-------:|:---:|-------------|
+| RIS001 | ✅ | unsafe | Missing Raises section |
+| RIS002 | ✅ | safe | Unnecessary Raises section |
+| RIS003 | ✅ | — | Raises entry has no description |
+| RIS004 | ✅ | unsafe | Raised exception not documented |
+| RIS005 | ✅ | unsafe | Documented exception not raised |
+
+### Docstring (DOC)
+
+| Code | Default | Fix | Description |
+|------|:-------:|:---:|-------------|
+| DOC001 | ✅ | unsafe | Section order doesn't match convention |
+
+## Benchmark
+
+pydocfix performs linting **and** auto-fix generation in a single pass, yet achieves comparable speed to lint-only tools. Below is a comparison with [pydoclint](https://github.com/jsh9/pydoclint), the closest tool in scope (signature ↔ docstring consistency checking, lint-only):
+
+| Project | Files | Lines | pydocfix | pydoclint |
+|---------|------:|------:|---------:|----------:|
+| [numpy](https://github.com/numpy/numpy) | 425 | 251K | 4.2 sec | 4.6 sec |
+| [scikit-learn](https://github.com/scikit-learn/scikit-learn) | 635 | 372K | 4.1 sec | 5.3 sec |
+
+> pydocfix is in early development. The majority of processing time is spent in the Rust-based CST parser (pydocstring-rs); adding more Python-side rules has limited impact on overall throughput.
+
+## License
+
+MIT