pydocstyle - Online in der Cloud

PROGRAMM:

NAME/FUNKTION

pydocstyle - pydocstyle-Dokumentation

(ehemals pep257)

Pydoc-Stil ist ein statisches Analysetool zur Überprüfung der Einhaltung von Python-Docstring
Konventionen.

Pydoc-Stil unterstützt die meisten PEP 257 out of the box, aber es sollte nicht als
Referenzimplementierung.

1. Installieren

pip installiere pydocstyle

2. Führen

$ pydocstyle test.py
test.py:18 in der privaten verschachtelten Klasse `meta`:
D101: Docstring fehlt
test.py:22 in der öffentlichen Methode `Methode`:
D102: Docstring fehlt
...

3. Korrigiere deinen Code :)

Inhaltsverzeichnis:

ANWENDUNG

Installation
Wasser Pip oder easy_install:

pip installiere pydocstyle

Alternativ können Sie auch verwenden pydocstyle.py Quelldatei direkt - sie ist in sich abgeschlossen.

Befehl Line Interface
Anwendungsbereich
Verwendung: pydocstyle [Optionen] [ ...]

Option:
--version Versionsnummer des Programms anzeigen und beenden
-h, --help Diese Hilfemeldung anzeigen und beenden
-e, --explain zeigt Erklärungen zu jedem Fehler
-s, --source Quelle für jeden Fehler anzeigen
-d, --debug Debug-Informationen ausgeben
-v, --verbose Druckstatusinformationen
--count drucke die Gesamtzahl der Fehler auf stdout
--select= Wählen Sie die Grundliste der geprüften Fehler durch Angabe von
nach welchen Fehlern gesucht werden soll (mit einer Liste von Komma-
getrennte Fehlercodes). zum Beispiel:
--select=D101,D202
--ignore= Wählen Sie die Grundliste der geprüften Fehler durch Angabe von
welche Fehler ignoriert werden sollen (mit einer Liste von durch Kommas getrennten
Fehlercodes). zum Beispiel: --ignore=D101,D202
--convention= Wählen Sie die Grundliste der geprüften Fehler durch Angabe von
eine bestehende Konvention. Mögliche Konventionen: pep257
--add-select= die Liste der zu überprüfenden Fehler ändern, indem Sie angeben
weitere Fehlercodes zu überprüfen.
--add-ignore= die Liste der zu überprüfenden Fehler ändern, indem Sie angeben
weitere Fehlercodes zu ignorieren.
--match= nur Dateien prüfen, die genau übereinstimmen regulär
Ausdruck; Standard ist --match='(?!test_).*\.py' was
stimmt mit Dateien überein, die nicht mit 'test_' beginnen, sondern enden
mit '.py'
--match-dir=
nur Verzeichnisse suchen, die genau übereinstimmen regulär
Ausdruck; Standard ist --match-dir='[^\.].*', was
stimmt mit allen Verzeichnissen überein, die nicht mit einem Punkt beginnen

Return Code
┌──────────────────────────────────┐.
│0 │ Erfolg - keine Verstöße │
├──────────────────────────────────┤.
│1 │ Es wurden einige Verstöße gegen den Code festgestellt │
├──────────────────────────────────┤.
│2 │ Illegaler Gebrauch - siehe Fehler │
│ │ Nachricht │
└──────────────────────────────────┘.

Konfiguration Mappen
Pydoc-Stil unterstützt ini-ähnliche Konfigurationsdateien. Damit Pydoc-Stil um es zu benutzen, es
muss eine der folgenden Optionen genannt werden und a [pydoc-Stil] .

· setup.cfg

· tox.ini

· .pydocstyle

· .pydocstylerc

Wenn Sie nach einer Konfigurationsdatei suchen, Pydoc-Stil sucht nach einer der angegebenen Dateien
oben in zur Abwicklung, Integrierung, Speicherung und genau Auftrag. Wenn eine Konfigurationsdatei nicht gefunden wurde, wird immer wieder danach gesucht
den Verzeichnisbaum auf, bis einer gefunden wird oder die Standardkonfiguration verwendet.

Anmerkungen:
Aus Gründen der Abwärtskompatibilität, Pydoc-Stil unterstützt Konfigurationsdateien namens
.pep257, sowie Abschnittsüberschrift [pep257]. Diese gelten jedoch als veraltet
und die Unterstützung wird in der nächsten Hauptversion entfernt.

Verfügbare Optionen
In den Konfigurationsdateien sind nicht alle Konfigurationsoptionen verfügbar. Verfügbare Optionen
sind:

· Konvention

· wählen

· ignorieren

· add_select

· add_ignore

· Spiel

· match_dir

Weitere Informationen im Anwendungsbereich Abschnitt für weitere Informationen.

Erbe
Standardmäßig wird beim Suchen einer Konfigurationsdatei Pydoc-Stil versucht, die Eltern zu erben
die Konfiguration des Verzeichnisses und fügen Sie sie mit den lokalen zusammen.

Der Zusammenführungsprozess ist wie folgt:

· Wenn einer von wählen, ignorieren or Konvention wurde in der untergeordneten Konfiguration angegeben -
Ignoriert die übergeordnete Konfiguration und legt die neuen Fehlercodes zur Überprüfung fest. Ansonsten einfach
kopiert die übergeordneten geprüften Fehlercodes.

· Wenn hinzufügen-ignorieren or hinzufügen-auswählen angegeben wurden, fügt die angegebenen Fehlercodes hinzu oder entfernt sie
aus der Liste der geprüften Fehlercodes.

· Wenn Spiel or Spielverzeichnis angegeben wurden - verwenden Sie sie. Andernfalls verwenden Sie die der Eltern.

Um dies zu deaktivieren (nützlich für Konfigurationsdateien, die sich im Stammverzeichnis Ihres Repositorys befinden),
einfach hinzufügen erben=falsch in Ihre Konfigurationsdatei.

Anmerkungen:
Wenn einer von wählen, ignorieren or Konvention wurden in der CLI angegeben, die Konfiguration
Dateien sind nicht an der Auswahl der zu prüfenden Fehlercodes beteiligt. Spiel und
Spielverzeichnis wird noch wirksam.

Beispiel
[pydoc-Stil]
erben = falsch
ignorieren = D100,D203,D405
match = *.py

ERROR CODES

Gruppierung
┌─────────────────────────┬─────────────────────── ───────────┐
│Vermisst Dokumentzeichenfolgen │ │
├─────────────────────────┼─────────────────────── ───────────┤
│D100 │ Fehlender Docstring in der Öffentlichkeit │
│ │ Modul │
├─────────────────────────┼─────────────────────── ───────────┤
│D101 │ Fehlender Docstring in der Öffentlichkeit │
│ │ Klasse │
├─────────────────────────┼─────────────────────── ───────────┤
│D102 │ Fehlender Docstring in der Öffentlichkeit │
│ │ Methode │
├─────────────────────────┼─────────────────────── ───────────┤
│D103 │ Fehlender Docstring in der Öffentlichkeit │
│ │ Funktion │
├─────────────────────────┼─────────────────────── ───────────┤
│D104 │ Fehlender Docstring in der Öffentlichkeit │
│ │ Paket │
├─────────────────────────┼─────────────────────── ───────────┤
│D105 │ Fehlender Docstring in Magie │
│ │ Methode │
├─────────────────────────┼─────────────────────── ───────────┤
│Leerzeichen Fragen │ │
├─────────────────────────┼─────────────────────── ───────────┤
│D200 │ Einzeiliger Docstring sollte auf │ . passen
│ │ eine Zeile mit Anführungszeichen │
├─────────────────────────┼─────────────────────── ───────────┤
│D201 │ Keine Leerzeilen erlaubt vor │
│ │ Funktion docstring │
├─────────────────────────┼─────────────────────── ───────────┤
│D202 │ Keine Leerzeilen nach │ . erlaubt
│ │ Funktion docstring │
├─────────────────────────┼─────────────────────── ───────────┤
│D203 │ 1 Leerzeile erforderlich vor │
│ │ Klasse docstring │
├─────────────────────────┼─────────────────────── ───────────┤
│D204 │ 1 Leerzeile nach │ . erforderlich
│ │ Klasse docstring │
├─────────────────────────┼─────────────────────── ───────────┤
│D205 │ 1 Leerzeile erforderlich zwischen │
│ │ Zusammenfassungszeile und Beschreibung │
└─────────────────────────┴─────────────────────── ───────────┘

│D206 │ Docstring sollte eingerückt sein │
│ │ mit Leerzeichen, nicht mit Tabs │
├─────────────────────────┼─────────────────────── ───────────┤
│D207 │ Docstring ist zu wenig eingerückt │
├─────────────────────────┼─────────────────────── ───────────┤
│D208 │ Docstring ist zu stark eingerückt │
├─────────────────────────┼─────────────────────── ───────────┤
│D209 │ Schließen von mehrzeiligen Docstrings │
│ │ Anführungszeichen sollten auf einem separaten . stehen
│ │ Linie │
├─────────────────────────┼─────────────────────── ───────────┤
│D210 │ Keine Leerzeichen erlaubt │
│ │ umgebender Docstring-Text │
├─────────────────────────┼─────────────────────── ───────────┤
│D211 │ Keine Leerzeilen erlaubt vor │
│ │ Klasse docstring │
├─────────────────────────┼─────────────────────── ───────────┤
│Zitate Fragen │ │
├─────────────────────────┼─────────────────────── ───────────┤
│D300 │ Verwenden Sie """dreifache doppelte Anführungszeichen""" │
├─────────────────────────┼─────────────────────── ───────────┤
│D301 │ Verwenden Sie r""", wenn Backslashes in einem │
│ │ Dokumentstring │
├─────────────────────────┼─────────────────────── ───────────┤
│D302 │ Verwenden Sie u""" für Unicode-Docstrings │
├─────────────────────────┼─────────────────────── ───────────┤
│Dokumentstring Inhalt Fragen │ │
├─────────────────────────┼─────────────────────── ───────────┤
│D400 │ Die erste Zeile sollte mit einem │ enden
│ │ Zeitraum │
├─────────────────────────┼─────────────────────── ───────────┤
│D401 │ Die erste Zeile sollte in │ . stehen
│ │ zwingende Stimmung │
├─────────────────────────┼─────────────────────── ───────────┤
│D402 │ Die erste Zeile sollte nicht die │ . sein
│ │ "Signatur" der Funktion │
├─────────────────────────┼─────────────────────── ───────────┤
│D403 │ Erstes Wort der ersten Zeile │
│ │ sollte richtig groß geschrieben werden │
└─────────────────────────┴─────────────────────── ───────────┘

Standard Schecks
Nicht alle Fehlercodes werden standardmäßig überprüft. Das Standardverhalten besteht darin, nur zu überprüfen
Fehlercodes, die Teil der PEP257 offizieller Kongress.

Alle oben genannten Fehlercodes werden standardmäßig überprüft, mit Ausnahme von D203.

pydocstyle ist eine Umbenennung und Fortsetzung von pep257, einem Projekt von Vladimir Keleshev.

Verwaltet von Amir Rachum.

Verwenden Sie pydocstyle online mit den onworks.net-Diensten