PEP257. Python docstring-style-Checker
Jetzt downloaden

PEP257. Ranking & Zusammenfassung

PEP257. Stichworte

Stil Python docstring. Stil Checker.

PEP257. Beschreibung

PEP275 ist ein statisches Analyse-Tool zum Überprüfen der Einhaltung von Python Pep 257: http://www.python.org/dev/peps/pep-0257/.Das Framework für die Überprüfung des DOCSTRING-Stils ist flexibel, und benutzerdefinierte Prüfungen können leicht hinzugefügt werden, Zum Beispiel, um die Anzahl der Anzahl von docstring-Konventionen abzudecken: https://github.com/numpy/numpy/blob/master/doc/howto_document.rst.txt.Das neue Kontrollen wird in DocString von PEP257.py file.installationuse PIP oder EASY_INSTALL beschrieben: Pip installieren Pep257Alternativ, Sie können pep257.py-Quelldatei direkt verwenden - es ist in sich selbst enthalten.Pep257 wird mit Python 2.4, 2,5, 2.6, 2.7, 3.1, 3.2.Example $ Pep257 --HelpuSage getestet: PEP257 Optionen : -h, --help Diese Hilfsnachricht anzeigen und EXIT -E -E, --explain Erläuterung jedes Fehlers anzeigen pydocopt.py:1:0: PEP257 Module sollten docstrings.docopt.py:14:4: PEP257 Klasse docstring sollte 1 leere Linie um sie herum haben. DOCOPT.PY:27:0: PEP257 Exportierte Klassen sollten haben docstrings.docopt.py:43:4: PEP257 Exportierte Definitionen sollten docstrings verfügen .... $ pep257 * .py -explaindocopt.py:1:0: PEP257-Module sollten docstrings.pep257-Module docsstrings haben. Alle Module sollten normalerweise docstrings.docopt.py:14:4: PEP257-Klasse docstring sollte 1 leere Zeile um sie herum haben. Legen Sie eine leere Linie vor und nachdem alle DocStrings (ONE-LINE- oder MULTI-LINE) ein, die eine Klasse dokumentieren - im Allgemeinen, die Methoden der Klasse voneinander durch eine einzelne Leerzeichen voneinander getrennt sind, und der DOCString muss von der ausgeglichen werden erste Methode von einer leeren Linie; Setzen Sie für Symmetrie eine leere Linie zwischen dem Klassenkopf und dem DocString .... $ PEP257 --QUOTE * .puttocopt.py: 1: 0: PEP257-Module sollten DocStrings haben. Import SYS Import RE # Python 3 Kompatibilität Versuchen Sie: Bossstring außer NamesError: Docopt.py: 14: 4: PEP257 Klasse docstring sollte 1 leere Linie um sie herum haben. "" "Fehler beim Aufbau der Nutzungsnachricht." "" Docopt.py:27:0: PEP257 exportierte Klassen sollten DocStrings haben. Klassenmuster (Objekt): Docopt.py: 43: 4: PEP257 exportierte Definitionen sollten DocStrings haben. Def Flat (Self): ... Python Apipep257 Python API ist nützlich, wenn Sie PEP 257-Überprüfungen in Ihre Test-Suite einfügen möchten. >>> Importieren Pep257 >>> Pep257.Check_Files () Ein Pytest-Stil-Test kann so aussehen: PEP257Test_Pep257 (): Fehler = PEP257.Check_Files ( ) Assert Len (Fehler) == 0Product's Homepage

PEP257. Zugehörige Software