format-docstring 0.1.0__tar.gz

format_docstring-0.1.0/.github/workflows/python-package.yml

@@ -0,0 +1,28 @@
+---
+name: Python package
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+jobs:
+  build:
+    name: Test Python ${{ matrix.python-version }} (${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macOS-latest]
+        python-version: ['3.10', '3.11', '3.12', '3.13']
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install tox tox-gh-actions
+      - name: Test with tox
+        run: tox

format_docstring-0.1.0/.github/workflows/python-publish.yml

@@ -0,0 +1,28 @@
+---
+name: Upload Python Package
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+permissions:
+  contents: read
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+      - name: Build package
+        run: python -m build
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}

format_docstring-0.1.0/.gitignore

@@ -0,0 +1,210 @@
+# 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
+
+# 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
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# JetBrains IDEs
+.idea/

format_docstring-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,42 @@
+---
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: debug-statements
+      - id: double-quote-string-fixer
+      - id: requirements-txt-fixer
+      - id: pretty-format-json
+        args: [--no-ensure-ascii, --indent=4, --no-sort-keys]
+        exclude: \.ipynb$
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.20.0
+    hooks:
+      - id: pyupgrade
+        args: [--py310-plus]
+  - repo: https://github.com/jsh9/muff-pre-commit
+    rev: 0.13.2
+    hooks:
+      - id: muff-format
+        args: [--config, muff.toml]
+  - repo: https://github.com/jsh9/blank-line-after-blocks
+    rev: 0.1.4
+    hooks:
+      - id: blank-line-after-blocks
+      - id: blank-line-after-blocks-jupyter
+  - repo: https://github.com/lyz-code/yamlfix
+    rev: 1.18.0
+    hooks:
+      - id: yamlfix
+  - repo: https://github.com/hukkin/mdformat
+    rev: 0.7.22
+    hooks:
+      - id: mdformat
+        args: [--wrap, '79', --number]
+        additional_dependencies: [mdformat-tables]
+  - repo: https://github.com/jsh9/markdown-toc-creator
+    rev: 0.0.10
+    hooks:
+      - id: markdown-toc-creator

format_docstring-0.1.0/.pre-commit-hooks.yaml

@@ -0,0 +1,13 @@
+---
+- id: format-docstring
+  name: Wrap long docstring lines (in .py files)
+  description: Python formatter CLI for docstring line wrapping in Python files.
+  entry: format-docstring
+  language: python
+  types: [python]
+- id: format-docstring-jupyter
+  name: Wrap long docstring lines (in .ipynb files)
+  description: Python formatter for docstring line wrapping in Jupyter notebooks.
+  entry: format-docstring-jupyter
+  language: python
+  files: ^.*\.ipynb$

format_docstring-0.1.0/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project
+adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2025-09-07
+
+- Added
+  - Initial release
+- Full diff
+  - N/A

format_docstring-0.1.0/CLAUDE.md

@@ -0,0 +1,151 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with
+code in this repository.
+
+## Commands
+
+### Development Commands
+
+- `pytest --tb=long` - Run all tests with detailed traceback
+- `pytest tests/test_specific_file.py` - Run a specific test file
+- `pytest tests/test_specific_file.py::test_function_name` - Run a specific
+  test function
+
+### Linting and Formatting
+
+- `mypy format_docstring/` - Type checking
+- `muff check --fix --config=muff.toml format_docstring tests` - Lint and
+  auto-fix with muff
+- `muff format --diff --config=muff.toml format_docstring tests` - Show
+  formatting differences (use `--diff` to preview)
+- `flake8 --select CLB,PAR,N400 .` - Additional linting checks
+- `pre-commit run -a` - Run all pre-commit hooks
+
+### Tox Commands
+
+- `tox` - Run all tox environments (Python 3.10-3.13, mypy, linting)
+- `tox -e py311` - Run tests on Python 3.11
+- `tox -e mypy` - Run type checking
+- `tox -e muff-lint` - Run muff linting
+- `tox -e muff-format` - Run muff formatting check
+
+### Building and Installation
+
+- `pip install -e .` - Install in development mode
+- `format-docstring --help` - Run the CLI tool
+- `format-docstring-jupyter --help` - Run the Jupyter notebook version
+
+## Code Architecture
+
+### Core Components
+
+1. **Entry Points**: Two main CLI tools defined in `pyproject.toml`:
+
+   - `format-docstring` → `format_docstring.main_py:main` - For Python files
+   - `format-docstring-jupyter` → `format_docstring.main_jupyter:main` - For
+     Jupyter notebooks
+
+2. **Base Architecture**:
+
+   - `base_fixer.py` - Abstract base class `BaseFixer` for file processing
+   - Implements file discovery, exclusion patterns, and batch processing logic
+   - Subclasses implement `fix_one_file()` method for specific file types
+
+3. **Docstring Processing**:
+
+   - `docstring_rewriter.py` - Core docstring parsing and rewriting logic
+   - `line_wrap_numpy.py` - NumPy style docstring formatting
+   - `line_wrap_google.py` - Google style docstring formatting (limited
+     support)
+   - `line_wrap_utils.py` - Shared utilities for line wrapping
+
+4. **Configuration System**:
+
+   - `config.py` - Configuration file parsing and management
+   - Loads settings from `pyproject.toml` ([tool.format_docstring] section)
+   - Auto-discovers config file by walking up directory tree from target paths
+   - CLI options override config file settings
+   - Uses `tomllib` (Python 3.11+) or `tomli` (Python 3.10) for TOML parsing
+
+5. **Style Support**:
+
+   - Primary support: NumPy docstring style
+   - Limited support: Google docstring style
+   - Uses `docstring_parser_fork` library for parsing
+
+### Key Dependencies
+
+- `click>=8.0` - CLI framework
+- `docstring_parser_fork>=0.0.14` - Docstring parsing
+- `jupyter-notebook-parser>=0.1.4` - Jupyter notebook support
+- `tomli>=1.1.0` (Python < 3.11) - TOML file parsing
+
+### Configuration
+
+- **Config File**: `pyproject.toml` with `[tool.format_docstring]` section
+  - `line_length` (int): Maximum line length for wrapping (default: 79)
+  - `docstring_style` (str): `"numpy"` or `"google"` (default: `"numpy"`)
+  - `exclude` (str): Regex pattern to exclude files/directories
+- **CLI Options**: `--line-length`, `--docstring-style`, `--exclude`,
+  `--config`
+- **Priority**: CLI arguments override config file settings
+- **Auto-discovery**: Searches for `pyproject.toml` in parent directories
+- Muff configuration in `muff.toml` with 79 character line length and single
+  quotes
+
+### Test Structure
+
+- `tests/` directory with comprehensive test coverage
+- `test_data/` subdirectory contains test fixtures
+- Tests cover all main modules: line wrapping, docstring rewriting, CLI tools,
+  config parsing
+- Use pytest framework with detailed tracebacks
+- Test case format in `test_data/`: `LINE_LENGTH: <int>` header, then
+  BEFORE/AFTER sections separated by `**********`
+- Config tests in `tests/test_config.py` verify TOML parsing, auto-discovery,
+  and CLI override behavior
+
+## Important Development Patterns
+
+### Code Preservation Philosophy
+
+- **Direct String Replacement**: The tool uses precise AST-to-source mapping to
+  replace only docstrings, preserving all other code formatting, comments, and
+  whitespace exactly
+- **Line-Aware Processing**: Uses `calc_line_starts()` to maintain exact line
+  positioning without using `ast.unparse()`
+- **Conservative Approach**: Only modifies docstring content, never touches
+  surrounding code structure
+
+### NumPy Style Processing Rules
+
+- **Section Recognition**: Automatically detects section headers (Parameters,
+  Returns, etc.) and their underlines
+- **Signature vs Description**: Distinguishes parameter signature lines (e.g.,
+  `arg : type`) from indented description text
+- **Special Case Handling**: Preserves without wrapping:
+  - Examples sections with `>>>` prompts
+  - rST tables (lines with `===` or `---` separators)
+  - Content following `::` (literal blocks)
+  - Bullet lists (lines starting with `-`)
+  - Fenced code blocks (\`\`\`\` ... \`\`\`\`\`)
+- **Colon Spacing**: Automatically fixes spacing around colons in parameter
+  signatures to use `:` format (e.g., `arg: int` → `arg : int`, `arg    : int`
+  → `arg : int`)
+- **Section Title Fixes**: Corrects common typos (e.g., `Parameter` →
+  `Parameters`, `ReTurn` → `Returns`) and underline lengths
+
+### File-Based Test Pattern
+
+- Test cases use structured text files with BEFORE/AFTER sections
+- Helper function `load_cases_from_dir()` automatically discovers and loads
+  test cases
+- Use `pytest.mark.parametrize` with test data files for comprehensive coverage
+
+### Pre-commit Hook
+
+Available as pre-commit hooks (see `.pre-commit-hooks.yaml`):
+
+- `format-docstring` - For `.py` files
+- `format-docstring-jupyter` - For `.ipynb` files

format_docstring-0.1.0/LICENSE

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