pydocstyle — Online w chmurze

PROGRAM:

IMIĘ

pydocstyle — dokumentacja pydocstyle

(dawniej pep257)

pydocstyle to narzędzie do analizy statycznej służące do sprawdzania zgodności z dokumentacją Pythona
konwencje.

pydocstyle obsługuje większość PEP 257 od razu po wyjęciu z pudełka, ale nie należy tego uważać za
implementacja referencyjna.

1. Zainstalować

pip zainstaluj pydocstyle

2. run

$ pydocstyle test.py
test.py:18 w prywatnej klasie zagnieżdżonej „meta”:
D101: Brak dokumentu
test.py:22 w publicznej metodzie `method`:
D102: Brak dokumentu
...

3. Popraw swój kod :)

Spis treści:

ZASTOSOWANIE

instalacja sprzętu
Zastosowanie pypeć lub łatwa_instalacja:

pip zainstaluj pydocstyle

Alternatywnie można użyć pydocstyle.py bezpośrednio plik źródłowy — jest on samowystarczalny.

Command Linia Interfejs
Stosowanie
Użycie: pydocstyle [opcje] [ ...]

Opcje:
--version pokaż numer wersji programu i wyjdź
-h, --help pokaż tę wiadomość pomocy i wyjdź
-e, --explain pokazuje wyjaśnienie każdego błędu
-s, --source pokazuje źródło każdego błędu
-d, --debug wypisuje informacje o debugowaniu
-v, --verbose wypisuje informacje o statusie
--count wypisuje całkowitą liczbę błędów na standardowe wyjście
--wybierz= wybierz podstawową listę sprawdzanych błędów, określając
które błędy sprawdzić (z listą przecinków
oddzielne kody błędów). Na przykład:
--wybierz=D101,D202
--ignore= wybierz podstawową listę sprawdzanych błędów, określając
które błędy ignorować (z listą błędów oddzielonych przecinkami
kody błędów). na przykład: --ignore=D101,D202
--konwencja= wybierz podstawową listę sprawdzanych błędów, określając
obowiązująca konwencja. Możliwe konwencje: pep257
--dodaj-wybierz= zmień listę błędów do sprawdzenia, określając
więcej kodów błędów do sprawdzenia.
--add-ignore= zmień listę błędów do sprawdzenia, określając
więcej kodów błędów do zignorowania.
--dopasowanie= sprawdzaj tylko pliki, które dokładnie pasują regularny
wyrażenie; domyślnie --match='(?!test_).*\.py' który
dopasowuje pliki, które nie zaczynają się od „test_”, ale kończą
z „.py”
--dopasuj-katalog=
wyszukaj tylko dokładnie pasujące katalogi regularny
wyrażenie; domyślnie --match-dir='[^\.].*', co
dopasowuje wszystkie katalogi, które nie zaczynają się od kropki

Powrót Code
┌──┬──────────────────────────────────────┐
│0 │ Sukces - brak naruszeń │
├──┼──────────────────────────────────────┤
│1 │ Wykryto pewne naruszenia kodu │
├──┼──────────────────────────────────────┤
│2 │ Nielegalne użycie – patrz błąd │
│ │ wiadomość │
└──┴──────────────────────────────────────┘

Konfiguracja Akta
pydocstyle wspiera ini-jak pliki konfiguracyjne. w celu pydocstyle używać tego, to
musi mieć nazwę jednej z następujących opcji i mieć [pydocstyl]

· setup.cfg

· tox.ini

· .pydocstyle

· .pydocstylerc

Podczas wyszukiwania pliku konfiguracyjnego pydocstyle szuka jednego z określonych plików
powyżej in że dokładny zamówienie. Jeśli plik konfiguracyjny nie zostanie znaleziony, będzie go szukać
w górę drzewa katalogów, aż zostanie znaleziony lub użyje konfiguracji domyślnej.

UWAGA:
Dla celów kompatybilności wstecznej, pydocstyle obsługuje pliki konfiguracyjne o nazwie
pep257, a także nagłówek sekcji [pep257]. Są one jednak uważane za przestarzałe
a obsługa zostanie usunięta w następnej głównej wersji.

Dostępny Opcje
Nie wszystkie opcje konfiguracyjne są dostępne w plikach konfiguracyjnych. Dostępne opcje
należą:

· Konwencja

· wybierać

· ignorować

· dodaj_wybierz

· dodaj_ignore

· mecz

· katalog_dopasowania

Zobacz Stosowanie sekcja po więcej informacji.

Dziedzictwo
Domyślnie, po znalezieniu pliku konfiguracyjnego, pydocstyle próbuje odziedziczyć rodzica
konfiguracji katalogu i scalić je z lokalnymi.

Proces scalania wygląda następująco:

· Jeśli jeden z wybierać, ignorować or Konwencja został określony w konfiguracji potomnej -
Ignoruje konfigurację nadrzędną i ustawia nowe kody błędów do sprawdzenia. W przeciwnym razie po prostu
kopiuje nadrzędne sprawdzone kody błędów.

· Gdyby dodaj-zignoruj or dodaj-wybierz zostały określone, dodaje lub usuwa określone kody błędów
z listy sprawdzonych kodów błędów.

· Gdyby mecz or mecz-reż zostały określone - wykorzystaj je. W przeciwnym razie użyj rodzica.

Aby to wyłączyć (przydatne dla plików konfiguracyjnych znajdujących się w katalogu głównym repozytorium),
po prostu dodaj dziedziczenie=fałsz do swojego pliku konfiguracyjnego.

UWAGA:
Jeśli którykolwiek z wybierać, ignorować or Konwencja zostały określone w CLI, plik configuration
nie będą brać udziału w wyborze, które kody błędów będą sprawdzane. mecz oraz
mecz-reż nadal będzie obowiązywać.

Przykład
[pydocstyl]
dziedziczyć = fałsz
ignoruj ​​= D100,D203,D405
dopasowanie = *.py

BŁĄD KODY

Grupowanie
┌─────────────────────────┬───────────── ────────── ───────────┐
│brakujący Dokumenty │ │.
├─────────────────────────┼───────────── ────────── ───────────┤
│D100 │ Brakujące dokumenty w miejscu publicznym │
│ │ moduł │
├─────────────────────────┼───────────── ────────── ───────────┤
│D101 │ Brakujące dokumenty w miejscu publicznym │
│ │ klasa │
├─────────────────────────┼───────────── ────────── ───────────┤
│D102 │ Brakujące dokumenty w miejscu publicznym │
│ │ metoda │
├─────────────────────────┼───────────── ────────── ───────────┤
│D103 │ Brakujące dokumenty w miejscu publicznym │
│ │ funkcja │
├─────────────────────────┼───────────── ────────── ───────────┤
│D104 │ Brakujące dokumenty w miejscu publicznym │
│ │ paczka │
├─────────────────────────┼───────────── ────────── ───────────┤
│D105 │ Brakujący ciąg dokumentów w magii │
│ │ metoda │
├─────────────────────────┼───────────── ────────── ───────────┤
│Biała przestrzeń pytania │ │.
├─────────────────────────┼───────────── ────────── ───────────┤
│D200 │ Docstring jednowierszowy powinien pasować do │
│ │ jeden wiersz z cudzysłowami │
├─────────────────────────┼───────────── ────────── ───────────┤
│D201 │ Brak pustych linii przed │
│ │ dokumentowanie funkcji │
├─────────────────────────┼───────────── ────────── ───────────┤
│D202 │ Brak pustych linii po │
│ │ dokumentowanie funkcji │
├─────────────────────────┼───────────── ────────── ───────────┤
│D203 │ 1 pusty wiersz wymagany przed │
│ │ dokumentowanie klasy │
├─────────────────────────┼───────────── ────────── ───────────┤
│D204 │ 1 pusty wiersz wymagany po │
│ │ dokumentowanie klasy │
├─────────────────────────┼───────────── ────────── ───────────┤
│D205 │ Wymagany 1 pusty wiersz pomiędzy │
│ │ wiersz podsumowania i opis │
└─────────────────────────┴───────────── ────────── ───────────┘

│D206 │ Docstring powinien być wcięty │
│ │ ze spacjami, a nie tabulatorami │
├─────────────────────────┼───────────── ────────── ───────────┤
│D207 │ Docstring jest niedostatecznie wcięty │
├─────────────────────────┼───────────── ────────── ───────────┤
│D208 │ Ciąg dokumentów jest nadmiernie wcięty │
├─────────────────────────┼───────────── ────────── ───────────┤
│D209 │ Wielowierszowe zamykanie dokumentu │
│ │ cytaty powinny znajdować się na osobnym │
│ │ linia │
├─────────────────────────┼───────────── ────────── ───────────┤
│D210 │ Brak dozwolonych spacji │
│ │ otaczający tekst docstringu │
├─────────────────────────┼───────────── ────────── ───────────┤
│D211 │ Brak pustych linii przed │
│ │ dokumentowanie klasy │
├─────────────────────────┼───────────── ────────── ───────────┤
│Cytaty pytania │ │.
├─────────────────────────┼───────────── ────────── ───────────┤
│D300 │ Użyj """potrójnych podwójnych cudzysłowów""" │
├─────────────────────────┼───────────── ────────── ───────────┤
│D301 │ Użyj r""" jeśli jakieś ukośniki odwrotne w │
│ │ ciąg dokumentów │
├─────────────────────────┼───────────── ────────── ───────────┤
│D302 │ Użyj u""" dla dokumentów Unicode │
├─────────────────────────┼───────────── ────────── ───────────┤
│Dokumentacja Treść pytania │ │.
├─────────────────────────┼───────────── ────────── ───────────┤
│D400 │ Pierwszy wiersz powinien kończyć się znakiem │
│ │ kropka │
├─────────────────────────┼───────────── ────────── ───────────┤
│D401 │ Pierwsza linia powinna być w │
│ │ tryb rozkazujący │
├─────────────────────────┼───────────── ────────── ───────────┤
│D402 │ Pierwsza linia nie powinna być │
│ │ „podpis” funkcji │
├─────────────────────────┼───────────── ────────── ───────────┤
│D403 │ Pierwsze słowo pierwszej linii │
│ │ należy pisać dużą literą │
└─────────────────────────┴───────────── ────────── ───────────┘

Domyślnie Wykrywanie urządzeń szpiegujących
Nie wszystkie kody błędów są domyślnie sprawdzane. Domyślnym zachowaniem jest tylko sprawdzanie
kody błędów, które są częścią pliku PEP257 oficjalna konwencja.

Wszystkie powyższe kody błędów są sprawdzane domyślnie, z wyjątkiem D203.

pydocstyle to zmiana nazwy i kontynuacja pep257, projektu stworzonego przez Vladimira Kelesheva.

Utrzymywany przez Amira Rachuma.

Używaj pydocstyle online, korzystając z usług onworks.net