Repolode
Предложить
PyCQA

PyCQA/docformatter

Инструмент командной строки для Python, который автоматически форматирует docstring по соглашениям PEP 257.

Открыть на GitHubСайт
Звёзды
600
Форки
98
Открытые issues
22
Последний коммит
4 дня назад

Что это?

docformatter — инструмент командной строки для Python, который переформатирует docstring, приводя их к части соглашений PEP 257. Он нормализует стиль кавычек, переносит закрывающие кавычки многострочных docstring на отдельную строку, отделяет краткое описание от основного пустой строкой, а также удаляет лишние отступы и пробелы в конце строк.

Инструмент можно запускать для отдельных файлов или всего проекта с изменением файлов на месте. Также доступен режим совместимости с black через опцию --black. Кроме того, он форматирует списки полей в стилях Epytext и Sphinx. Настройки можно считывать из pyproject.toml; в Python 3.11 и новее для этого используется стандартный модуль tomllib.

Инструмент пригодится разработчикам, которым нужно привести docstring во всей кодовой базе к единому стилю без ручного редактирования каждого описания, особенно если запускать его в рамках линтинга или pre-commit-проверки.

Ключевые возможности

  • 01Переформатирует docstring в соответствии с правилами PEP 257 для кавычек и структуры.
  • 02Поддерживает форматирование, совместимое с black, через опцию --black.
  • 03Форматирует списки полей в стилях Epytext и Sphinx.
  • 04Может изменять файлы на месте с помощью --in-place.
  • 05Читает настройки из pyproject.toml.

Сценарии использования

  • Приведение форматирования docstring во всём Python-проекте к единому стилю.
  • Автоматическая проверка единообразия docstring с помощью pre-commit hook или проверки в CI.
  • Очистка устаревшего кода с несогласованным стилем кавычек и отступов в docstring.

Быстрый старт

  1. 1

    Установите docformatter из PyPI с помощью pip

    pip install --upgrade docformatter
  2. 2

    Отформатируйте docstring-функции в файле на месте

    docformatter --in-place example.py

В подборках

Линтеры и форматировщики кода

Темы

#python#docstring#formatter#pep-257#code-style#linting#autoformat

Частые вопросы

Что такое docformatter?
Инструмент командной строки для Python, который автоматически форматирует docstring по соглашениям PEP 257. docformatter — инструмент командной строки для Python, который переформатирует docstring, приводя их к части соглашений PEP 257. Он нормализует стиль кавычек, переносит закрывающие кавычки многострочных docstring на отдельную строку, отделяет краткое описание от основного пустой строкой, а также удаляет лишние отступы и пробелы в конце строк.
docformatter можно использовать бесплатно? Какая у него лицензия?
docformatter распространяется с открытым исходным кодом под лицензией MIT. Перед использованием в коммерческих продуктах проверьте условия лицензии.
docformatter всё ещё поддерживается?
Активно поддерживается. Последний коммит в docformatter — 3 нояб. 2026 г..
Для чего можно использовать docformatter?
Приведение форматирования docstring во всём Python-проекте к единому стилю. Автоматическая проверка единообразия docstring с помощью pre-commit hook или проверки в CI. Очистка устаревшего кода с несогласованным стилем кавычек и отступов в docstring.
Как установить docformatter?
Установите docformatter из PyPI с помощью pip: pip install --upgrade docformatter Отформатируйте docstring-функции в файле на месте: docformatter --in-place example.py
Где скачать docformatter?
Исходный код и инструкции по установке — на GitHub: https://github.com/PyCQA/docformatter

Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.

Похожие проекты