pydocstyle - Online in de cloud

PROGRAMMA:

NAAM

pydocstyle - pydocstyle Documentatie

(voorheen pep257)

pydocstijl is een statische analysetool voor het controleren van de naleving van Python docstring
conventies.

pydocstijl ondersteunt de meeste PEP 257 out of the box, maar het moet niet worden beschouwd als een
referentie uitvoering.

1. Installeren

pip installeer pydocstyle

2. Lopen

$ pydocstijl test.py
test.py:18 in privé geneste klasse `meta`:
D101: Docstring ontbreekt
test.py:22 in openbare methode `methode`:
D102: Docstring ontbreekt
...

3. Corrigeer je code :)

Inhoud:

GEBRUIK

Installatie
Te gebruiken pit of easy_install:

pip installeer pydocstyle

Als alternatief kunt u gebruiken pydocstyle.py bronbestand rechtstreeks - het is op zichzelf staand.

commando Lijn Interface
Gebruik
Gebruik: pydocstyle [opties] [ ...]

Opties:
--versie laat het versienummer van het programma zien en sluit af
-h, --help toon dit helpbericht en sluit af
-e, --explain toon uitleg van elke fout
-s, --source toon bron voor elke fout
-d, --debug foutopsporingsinformatie afdrukken
-v, --verbose afdrukstatusinformatie
--count print totaal aantal fouten naar stdout
--selecteer= kies de basislijst van gecontroleerde fouten door te specificeren
op welke fouten gecontroleerd moet worden (met een lijst met komma-
afzonderlijke foutcodes). Bijvoorbeeld:
--select=D101,D202
--negeren= kies de basislijst van gecontroleerde fouten door te specificeren
welke fouten moeten worden genegeerd (met een lijst met door komma's gescheiden
foutcodes). bijvoorbeeld: --ignore=D101,D202
--conventie= kies de basislijst van gecontroleerde fouten door te specificeren
een bestaand verdrag. Mogelijke conventies: pep257
--add-select= wijzig de lijst met te controleren fouten door te specificeren
meer foutcodes om te controleren.
--toevoegen-negeren= wijzig de lijst met te controleren fouten door te specificeren
meer foutcodes om te negeren.
--overeenkomst= controleer alleen bestanden die exact overeenkomen normaal
uitdrukking; standaard is --match='(?!test_).*\.py' welke
komt overeen met bestanden die niet beginnen met 'test_' maar eindigen
met '.py'
--match-dir=
zoek alleen dirs die exact overeenkomen normaal
uitdrukking; standaard is --match-dir='[^\.].*', welke
komt overeen met alle mappen die niet met een punt beginnen

Retourneren Code
┌──┬──────────────────────────────────┐
│0 │ Succes - geen overtredingen │
├──┼──────────────────────────────────┤
│1 │ Er zijn enkele codeschendingen gevonden │
├──┼──────────────────────────────────┤
│2 │ Illegaal gebruik - zie fout │
│ │ bericht │
└──┴──────────────────────────────────┘

Configuratie Bestanden
pydocstijl ondersteunt ini-achtige configuratiebestanden. Om voor pydocstijl om het te gebruiken, het
moet een van de volgende opties worden genoemd en een [pydocstijl] pagina.

· setup.cfg

· tox.ini

· .pydocstijl

· .pydocstylerc

Bij het zoeken naar een configuratiebestand, pydocstijl zoekt naar een van de opgegeven bestanden
boven in uit die exact bestellen. Als er geen configuratiebestand is gevonden, blijft het ernaar zoeken
omhoog in de directorystructuur totdat er een is gevonden of de standaardconfiguratie gebruikt.

NOTITIE:
Voor achterwaartse compatibiliteitsdoeleinden, pydocstijl ondersteunt configuratiebestanden met de naam
.pep257, evenals sectiekop [pep257]. Deze worden echter als verouderd beschouwd
en ondersteuning wordt verwijderd in de volgende hoofdversie.

Beschikbaar Opties
Niet alle configuratie-opties zijn beschikbaar in de configuratiebestanden. Beschikbare opties
zijn:

· conventie

· kiezen

· negeren

· toevoegen_selecteren

· toevoegen_negeren

· match

· match_dir

Zie de Gebruik sectie voor meer informatie.

Erfenis
Standaard, bij het vinden van een configuratiebestand, pydocstijl probeert de ouder te erven
directory's configuratie en voeg ze samen met de lokale.

Het samenvoegproces is als volgt:

· Als een van kiezen, negeren or conventie werd opgegeven in de kinderconfiguratie -
Negeert de bovenliggende configuratie en stelt de nieuwe foutcodes in om te controleren. Anders gewoon
kopieert de door de ouder gecontroleerde foutcodes.

· Indien toevoegen-negeren or toevoegen-selecteren zijn opgegeven, voegt de opgegeven foutcodes toe of verwijdert deze
uit de lijst met gecontroleerde foutcodes.

· Indien match or wedstrijd-dir zijn gespecificeerd - gebruik ze. Gebruik anders die van de ouders.

Om dit uit te schakelen (handig voor configuratiebestanden die zich in de root van uw repo bevinden),
gewoon toevoegen erven=false naar uw configuratiebestand.

NOTITIE:
als een van kiezen, negeren or conventie werden gespecificeerd in de CLI, de configuratie
bestanden spelen geen rol bij het kiezen welke foutcodes worden gecontroleerd. match en
wedstrijd-dir zal alsnog van kracht worden.

Voorbeeld
[pydocstijl]
erven = onwaar
negeren = D100,D203,D405
overeenkomst = *.py

FOUT CODES

Groepering
┌─────────────────────────┬───────────── ────────── ───────────┐
│Vermist Docstrings │
├─────────────────────────┼───────────── ────────── ───────────┤
│D100 │ Ontbrekende docstring in het openbaar │
│ │module │
├─────────────────────────┼───────────── ────────── ───────────┤
│D101 │ Ontbrekende docstring in het openbaar │
│ │ klasse │
├─────────────────────────┼───────────── ────────── ───────────┤
│D102 │ Ontbrekende docstring in het openbaar │
│ │ methode │
├─────────────────────────┼───────────── ────────── ───────────┤
│D103 │ Ontbrekende docstring in het openbaar │
│ │ functie │
├─────────────────────────┼───────────── ────────── ───────────┤
│D104 │ Ontbrekende docstring in het openbaar │
│ │ pakket │
├─────────────────────────┼───────────── ────────── ───────────┤
│D105 │ Ontbrekende docstring in magie │
│ │ methode │
├─────────────────────────┼───────────── ────────── ───────────┤
│Witte ruimte Problemen │
├─────────────────────────┼───────────── ────────── ───────────┤
│D200 │ Docstring van één regel zou op │ moeten passen
│ │ één regel met aanhalingstekens │
├─────────────────────────┼───────────── ────────── ───────────┤
│D201 │ Geen lege regels toegestaan ​​voor │
│ │ functie docstring │
├─────────────────────────┼───────────── ────────── ───────────┤
│D202 │ Geen lege regels toegestaan ​​na │
│ │ functie docstring │
├─────────────────────────┼───────────── ────────── ───────────┤
│D203 │ 1 lege regel vereist voor │
│ │ klasse docstring │
├─────────────────────────┼───────────── ────────── ───────────┤
│D204 │ 1 lege regel vereist na │
│ │ klasse docstring │
├─────────────────────────┼───────────── ────────── ───────────┤
│D205 │ 1 lege regel vereist tussen │
│ │ samenvattingsregel en beschrijving │
└─────────────────────────┴───────────── ────────── ───────────┘

│D206 │ Docstring moet ingesprongen zijn │
│ │ met spaties, geen tabs │
├─────────────────────────┼───────────── ────────── ───────────┤
│D207 │ Docstring is te weinig ingesprongen │
├─────────────────────────┼───────────── ────────── ───────────┤
│D208 │ Docstring is te sterk ingesprongen │
├─────────────────────────┼───────────── ────────── ───────────┤
│D209 │ Meerregelige docstring sluiten │
│ │ aanhalingstekens moeten op een aparte │ staan
│ │ lijn │
├─────────────────────────┼───────────── ────────── ───────────┤
│D210 │ Geen witruimte toegestaan ​​│
│ │ omringende docstring-tekst │
├─────────────────────────┼───────────── ────────── ───────────┤
│D211 │ Geen lege regels toegestaan ​​voor │
│ │ klasse docstring │
├─────────────────────────┼───────────── ────────── ───────────┤
│Zitate Problemen │
├─────────────────────────┼───────────── ────────── ───────────┤
│D300 │ Gebruik """driedubbele dubbele aanhalingstekens""" │
├─────────────────────────┼───────────── ────────── ───────────┤
│D301 │ Gebruik r""" als er backslashes in een │
│ │ doctekenreeks │
├─────────────────────────┼───────────── ────────── ───────────┤
│D302 │ Gebruik u""" voor Unicode-docstrings │
├─────────────────────────┼───────────── ────────── ───────────┤
│Docstring Content Problemen │
├─────────────────────────┼───────────── ────────── ───────────┤
│D400 │ De eerste regel moet eindigen op een │
│ │ periode │
├─────────────────────────┼───────────── ────────── ───────────┤
│D401 │ Eerste regel moet in │ staan
│ │ gebiedende wijs │
├─────────────────────────┼───────────── ────────── ───────────┤
│D402 │ Eerste regel mag niet de │ zijn
│ │ de "handtekening" van de functie │
├─────────────────────────┼───────────── ────────── ───────────┤
│D403 │ Eerste woord van de eerste regel │
│ │ moet correct worden gekapitaliseerd │
└─────────────────────────┴───────────── ────────── ───────────┘

Standaard Controles
Niet alle foutcodes worden standaard gecontroleerd. Het standaardgedrag is alleen controleren
foutcodes die deel uitmaken van de PEP257 officiële conventie.

Alle bovenstaande foutcodes worden standaard gecontroleerd, behalve D203.

pydocstyle is een hernoeming en voortzetting van pep257, een project gemaakt door Vladimir Keleshev.

Onderhouden door Amir Rachum.

Gebruik pydocstyle online met behulp van onworks.net-services