Treść książki
Przejdź do opcji czytnikaPrzejdź do nawigacjiPrzejdź do informacjiPrzejdź do stopki
Wszelkieopcje,którechcemywprowadzić,umieszczamyprzedinstrukcją
--generate-rcfile>nazwa.pylintrc,wpisującnasząwłasnąnazwęprzedrozsze-
rzeniem.pylintrc.Plikkonfiguracjimożemyutworzyćsamodzielnie,jakto
pokazaliśmy,alboteżwczasieocenianiaprogramuwPythonie.Plik.pylintrc
jestautomatyczniezapisywanywnaszymbieżącymkataloguroboczym,przy
czymistniejeopcjapozwalającanadodanieścieżkidokatalogu(więcejin-
formacjinatentematmożnaznaleźćnastronachhttps://pylint.orgorazhttps://
pylint.readthedocs.io/en/latest/user_guide/run.html).
Abywykorzystaćponownienaszniestandardowyplikkonfiguracji,uży-
wamyopcji--rcfile,poktórejpodajemynazwętegoplikuinazwęprogramu,
któryoceniamy.Przykładowo,abyużyćplikumyconfig.pylintrcdlaprogramu
pseudonyms_main.py,należyużyćpolecenia:
C:\Python35\Python3Stuff\Psych>pylint--rcfilemyconfig.pylintrcpseudonyms-main
Opisywaniekoduzapomocąciągówdocstring
Pylintwskazuje,żewprogramiepseudonyms_main.pybrakujeciągudokumen-
tacyjnegodocstring.ZgodniezprzewodnikiempostylachPEP257(https://
www.python.org/dev/peps/pep-0257/),ciągdokumentacyjnydocstringjestlitera-
łemznakowym,występującymjakopierwszainstrukcjawdefinicjimodułu,
funkcji,klasylubmetody.Ciągdocstringjestpoprostukrótkimopisemtego,
corobinaszkod,imożezawieraćszczegółynatematróżnychaspektówkodu,
takichjaknaprzykładwymaganeprzezniegodane.Poniżej,wpotrójnych
znakachcudzysłowu,znajdujesięprzykładpojedynczegociągudocstring
dlafunkcji:
defcirc(r):
"""Returnthecircumferenceofacirclewithradiusofr."""
c:2*r*math.pi
returnc
Powyższyciągdocstringokreśla,codanafunkcjarobi,aleciągidocstring
mogąbyćdłuższeizawieraćwięcejinformacji.Naprzykładponiżejznajduje
sięwielowierszowyciągdocstringdlatejsamejfunkcji,którywyświetlainfor-
macjedotyczącedanychiwartościwyjściowychtejfunkcji:
defcirc(r):
"""Returnthecircumferenceofacirclewithradiusofr.
Arguments:
r–radiusofcircle
Returns:
float:circumferenceofcircle
"""
c:2*r*math.pi
returnc
Niestetyciągidocstringzależąodkonkretnejosoby,projektuifirmy,
takwięcistniejedlanichwielezaleceń,którestojązesobąwsprzeczności.
Generatorzabawnychpseudonimów
11
