pydocstyle - Интернет в облаке

ПРОГРАММА:

ИМЯ

pydocstyle - Документация по pydocstyle

(ранее pep257)

пидокстиль это инструмент статического анализа для проверки соответствия со строкой документации Python
конвенций.

пидокстиль поддерживает большинство PEP 257 прямо из коробки, но это не следует считать
эталонная реализация.

1. Устанавливать

pip установить pydocstyle

2. Работать

$ pydocstyle test.py
test.py:18 в закрытом вложенном классе `meta`:
D101: Отсутствует строка документации
test.py:22 в общедоступном методе `method`:
D102: Отсутствует строка документации
...

3. Исправьте свой код :)

Содержание:

ИСПОЛЬЗОВАНИЕ

погрузка
Используйте типун или easy_install:

pip установить pydocstyle

Кроме того, вы можете использовать pydocstyle.py исходный файл напрямую - он самодостаточен.

Command линия Интерфейс
Применение
Использование: pydocstyle [параметры] [ ...]

Опции:
--version показать номер версии программы и выйти
-h, --help показать это справочное сообщение и выйти
-e, --explain показать объяснение каждой ошибки
-s, --source показать источник для каждой ошибки
-d, --debug распечатать отладочную информацию
-v, --verbose информация о состоянии печати
--count вывести общее количество ошибок в стандартный вывод
--select = выберите основной список проверяемых ошибок, указав
какие ошибки проверять (со списком запятых-
разделенные коды ошибок). Например:
--select = D101, D202
--ignore = выберите основной список проверяемых ошибок, указав
какие ошибки следует игнорировать (со списком разделенных запятыми
коды ошибок). например: --ignore = D101, D202
--convention = выберите основной список проверяемых ошибок, указав
существующее соглашение. Возможные условные обозначения: pep257
--add-select = измените список ошибок, которые необходимо проверить, указав
дополнительные коды ошибок для проверки.
--add-ignore = измените список ошибок, которые необходимо проверить, указав
другие коды ошибок, которые следует игнорировать.
--match = проверять только файлы, которые точно совпадают обычный
выражение; по умолчанию --match = '(?! test _). * \. py', который
соответствует файлам, которые не начинаются с "test_", но заканчиваются
с .py
--match-dir =
искать только те каталоги, которые точно соответствуют обычный
выражение; по умолчанию --match-dir = '[^ \.]. *', что
соответствует всем каталогам, которые не начинаются с точки

ВОЗВРАТ Code
┌──┬────────────────────────────────────
│0 │ Успех - без нарушений │
├──┼────────────────────────────────────
│1 │ Обнаружены некоторые нарушения кода │
├──┼────────────────────────────────────
│2 │ Незаконное использование - см. Ошибку │
│ │ сообщение │
└──┴────────────────────────────────────

Конфигурация Файлы
пидокстиль поддерживает ини-подобные файлы конфигурации. Для того чтобы пидокстиль использовать это, это
должен быть назван одним из следующих вариантов и иметь [пидокстиль] .

· setup.cfg

· tox.ini

· .pydocstyle

· .pydocstylerc

При поиске файла конфигурации пидокстиль ищет один из указанных файлов
выше in который точный заказ. Если файл конфигурации не найден, он продолжает поиск
вверх по дереву каталогов, пока он не будет найден, или пока не будет использована конфигурация по умолчанию.

ПРИМЕЧАНИЕ:
В целях обратной совместимости пидокстиль поддерживает файлы конфигурации с именем
.pep257, а также заголовок раздела [pep257]. Однако они считаются устаревшими.
и поддержка будет удалена в следующей основной версии.

Доступна Опции
Не все параметры конфигурации доступны в файлах конфигурации. Доступные Варианты
составляют:

· соглашение

· выберите

· игнорировать

· add_select

· add_ignore

· совпадение

· каталог_соответствия

Смотрите пост в Применение раздел для получения дополнительной информации.

наследование
По умолчанию при нахождении файла конфигурации пидокстиль пытается наследовать родителя
конфигурации каталога и объединить их с локальными.

Процесс слияния выглядит следующим образом:

· Если один из выберите, игнорировать or соглашение было указано в дочерней конфигурации -
Игнорирует родительскую конфигурацию и устанавливает новые коды ошибок для проверки. В противном случае просто
копирует родительские проверенные коды ошибок.

· Если добавить-игнорировать or добавить-выбрать были указаны, добавляет или удаляет указанные коды ошибок
из списка проверенных кодов ошибок.

· Если совпадение or матч-директор были указаны - пользуйтесь ими. В противном случае используйте родительский.

Чтобы отключить это (полезно для файлов конфигурации, расположенных в корне вашего репо),
просто добавьте наследовать = ложь в ваш файл конфигурации.

ПРИМЕЧАНИЕ:
Если любой из выберите, игнорировать or соглашение были указаны в CLI, конфигурация
файлы не будут принимать участие в выборе проверяемых кодов ошибок. совпадение и
матч-директор по-прежнему будет действовать.

Пример
[пидокстиль]
наследовать = ложь
игнорировать = D100, D203, D405
match = * .py

ОШИБКА КОДЫ

группирование
┌──────────────────────────┬───────────────────────── ───────────
│Отсутствующий Строки документации │ │
├──────────────────────────┼───────────────────────── ───────────
│D100 │ Отсутствует общедоступная строка документации │
│ │ модуль │
├──────────────────────────┼───────────────────────── ───────────
│D101 │ Отсутствует общедоступная строка документации │
│ │ класс │
├──────────────────────────┼───────────────────────── ───────────
│D102 │ Отсутствует общедоступная строка документации │
│ │ метод │
├──────────────────────────┼───────────────────────── ───────────
│D103 │ Отсутствует общедоступная строка документации │
│ │ функция │
├──────────────────────────┼───────────────────────── ───────────
│D104 │ Отсутствует общедоступная строка документации │
│ │ пакет │
├──────────────────────────┼───────────────────────── ───────────
│D105 │ В магии отсутствует строка документации │
│ │ метод │
├──────────────────────────┼───────────────────────── ───────────
│Пробелы вопросы │ │
├──────────────────────────┼───────────────────────── ───────────
│D200 │ Однострочная строка документа должна уместиться на │
│ │ одна строка в кавычках │
├──────────────────────────┼───────────────────────── ───────────
│D201 │ Пустые строки не допускаются до │
│ │ строка документации функции │
├──────────────────────────┼───────────────────────── ───────────
│D202 │ После │ пустые строки не допускаются.
│ │ строка документации функции │
├──────────────────────────┼───────────────────────── ───────────
│D203 │ Перед │ требуется 1 пустая строка.
│ │ строка документации класса │
├──────────────────────────┼───────────────────────── ───────────
│D204 │ После │ требуется 1 пустая строка.
│ │ строка документации класса │
├──────────────────────────┼───────────────────────── ───────────
│D205 │ Требуется 1 пустая строка между │
│ │ итоговая строка и описание │
└──────────────────────────┴───────────────────────── ───────────

│D206 │ Строка документа должна быть с отступом │
│ │ с пробелами, а не с табуляцией │
├──────────────────────────┼───────────────────────── ───────────
│D207 │ Строка документации с недостаточным отступом │
├──────────────────────────┼───────────────────────── ───────────
│D208 │ Строка документации имеет слишком большой отступ │
├──────────────────────────┼───────────────────────── ───────────
│D209 │ Закрытие многострочной документации │
│ │ цитаты должны быть на отдельном │
│ │ строка │
├──────────────────────────┼───────────────────────── ───────────
│D210 │ Пробелы не допускаются │
│ │ окружающий текст строки документации │
├──────────────────────────┼───────────────────────── ───────────
│D211 │ Пустые строки не допускаются до │
│ │ строка документации класса │
├──────────────────────────┼───────────────────────── ───────────
│Цитаты вопросы │ │
├──────────────────────────┼───────────────────────── ───────────
│D300 │ Используйте "" "тройные двойные кавычки" "" │
├──────────────────────────┼───────────────────────── ───────────
│D301 │ Используйте r "" ", если есть обратная косая черта в │
│ │ строка документации │
├──────────────────────────┼───────────────────────── ───────────
│D302 │ Используйте u "" "для строк документации Unicode │
├──────────────────────────┼───────────────────────── ───────────
│строка документации Контент вопросы │ │
├──────────────────────────┼───────────────────────── ───────────
│D400 │ Первая строка должна заканчиваться │
│ │ период │
├──────────────────────────┼───────────────────────── ───────────
│D401 │ Первая строка должна быть в │
│ │ повелительное настроение │
├──────────────────────────┼───────────────────────── ───────────
│D402 │ В первой строке не должно быть │
│ │ "подпись" функции │
├──────────────────────────┼───────────────────────── ───────────
│D403 │ Первое слово первой строки │
│ │ должно быть написано правильно
└──────────────────────────┴───────────────────────── ───────────

По умолчанию Проверки
По умолчанию проверяются не все коды ошибок. По умолчанию проверяется только
коды ошибок, которые являются частью PEP257 официальная конвенция.

По умолчанию проверяются все вышеперечисленные коды ошибок, кроме D203.

pydocstyle - это переименование и продолжение pep257, проекта Владимира Келешева.

Поддерживает Амир Рахум.

Используйте pydocstyle онлайн с помощью сервисов onworks.net