Narzędzie do wymuszenia stylu/standardów kodu Pythona

Question

Próbuję znaleźć narzędzie do sprawdzania stylu kodowania w python.

dla PHP Widziałem tam jest Kodeks Sniffer, a mały perl script wykorzystywane przez Drupal. Czy istnieje takie narzędzie do kodu Pythona?

Answer 1

W przeszłości korzystałem głównie z PyLint - można wyróżnić, gdy użyto niezdefiniowanej zmiennej, podczas importowania rzeczy bez ich używania itd.

Może to być trochę gadatliwe, narzekając na takie rzeczy, jak linie o długości ponad 80 znaków, zmienne nie pasujące do konkretnych regexów, klasy mające zbyt mało publicznych metod, metody, których brakuje w dokumentach.

Na przykład dla skryptu ..

import os 
import somefakelib 

def myfunc(x): 
    blah = "Something" 
    print os.listdir(x+blh) 

pylint generuje następujące komunikaty:

C: 1: Missing docstring 
F: 2: Unable to import 'somefakelib' (No module named somefakelib) 
C: 4:myfunc: Missing docstring 
C: 4:myfunc: Invalid name "x" (should match [a-z_][a-z0-9_]{2,30}$) 
C: 4:myfunc: Invalid name "x" (should match [a-z_][a-z0-9_]{2,30}$) 
E: 6:myfunc: Undefined variable 'blh' 
W: 5:myfunc: Unused variable 'blah' 
W: 2: Unused import somefakelib 

wszystkie są ważne skarg, ale staram się wyłączyć wiele komunikatów konferencyjnych i refaktoryzacji . Można wyłączyć konkretne wiadomości, albo jako komentarze w kodzie:

#pylint:disable-msg=R0903,C0103,R0903,F0401,C0301 

..or jako argumenty wiersza polecenia do polecenia pylint:

pylint --disable-msg=R0903,C0103,R0903,F0401,C0301 myfile.py 

Z powyższych komunikatów wyłączony, generuje następujące komunikaty dla powyższego kodu:

C: 1: Missing docstring 
C: 4:myfunc: Missing docstring 
E: 6:myfunc: Undefined variable 'blh' 
W: 5:myfunc: Unused variable 'blah' 
W: 2: Unused import somefakelib 

pylint generuje również raport „kod”, w tym jak wiele linii kodu/komentarze/docstring/spacji plik, liczby wiadomości per-c ategory i daje swojemu kodowi "wynik" - 10 oznacza brak wiadomości, 0 ogólnie jest to błąd składni

Inną opcją jest PyFlakes, które uważam za nieco mniej przesadne (ostatnio zacząłem używać go w miejscu PyLint). Ponownie stosując powyższy scenariusz, PyFlakes daje następujące komunikaty:

example.py:2: 'somefakelib' imported but unused 
example.py:6: undefined name 'blh' 

Ostatnią opcją używam to pep8.py, który jak sama nazwa wskazuje wymusza PEP8. Jest to zdecydowanie najbardziej ... pedantyczny skrypt, wymuszający rzeczy takie jak poprawne puste linie przed/po funkcjach/klasach, odstępy wokół kodu, prawidłowe wcięcie 4-spacji itd.

bieganie na powyższym kodzie produkuje następujące:

example.py:4:1: E302 expected 2 blank lines, found 1 
example.py:6:23: E201 whitespace after '(' 
example.py:6:32: W292 no newline at end of file 

Jest przeważnie wymusza stylistyczne rzeczy jak poprawnej spacją, to nie robi dużo statyczną analizę kodu podobnego pylint lub PyFlakes, więc użyj pep8.py w połączeniu z PyLint lub PyFlakes.

pep8.py pierwotnie ogłoszono na python mailing list here, ale link do pobrania w tym jest teraz martwy .. Jest lustro github przez cburroughs, z kilkoma niewielkimi poprawkami w github.com/cburroughs/pep8.py, lub można pobrać w wersji niezmodyfikowanej od an older revision

PyChecker to inna opcja, chociaż nie używałem tego

Answer 2

Jest to skrypt o nazwie reindent.py, który czasami jest zawarty w dystrybucji Pythona systemu, który przejdzie przez wszystkie wcięcia i ponownie wcięcia do zalecanego wcięcia 4 spacji.

Herezje kopia w przypadku, gdy nie można go znaleźć w swojej dystrybucji: http://www.koders.com/python/fid24D30FCD2CE388C67CB980EF55630D25970CFB96.aspx?s=cdef%3Aparser

Answer 3

pylint i pyflakes byłby dobry początek.

pylint w szczególności jest bardzo konfigurowalny i można wymusić sporo rzeczy z nim.

Answer 4

Znalazłem to pytanie stackoverflow podczas wyszukiwania narzędzia egzekwowania stylu pep8 przy przejęciu istniejącego (starszego) projektu.

https://github.com/hhatto/autopep8

autopep8 -i yourpythonsourcefile.py 

automagicznie przekonwertować cały kod źródłowy, aby potwierdzić z pep8. Wypróbowałem to w moim starszym projekcie i działa świetnie. Pomyślałem więc, że zaktualizuję tę odpowiedź tutaj, w SO.