Koodistiil Pythonis
Koodi kirjutamisel tuleb arvestada, et sellele kehtivad teatud normid ja standardid.
Need standardid on kehtestatud selleks, et lihtsustada selge koodi kirjutamist ning
vähendada tulevikus selle haldamist ja täiendamist. Igas programmeerimiskeeles on pisut erinev koodistiil,
ning uute keelte õppimisel tuleb üle vaadata ka koodistiil.
Pythoni koodistiili võtmenimeks on PEP 8 ning docstring'ide koodistiili
võtmenimeks on PEP 257.
Peamised stiilireeglid
Vaatame üle mõningad peamised reeglid PEP 8 standardi järgi:
-
Funktsioonide, meetodite ja muutujate nimed: kirjutatakse alati väikese algustähega
ning sõnad eraldatakse alakriipsuga:
lowercase_words_separated_by_underscores.
-
Funktsiooni nimi: peaks arusaadavalt kirjeldama, mida funktsioon teeb.
-
Matemaatiliste operaatorite ees ja järel: peab kasutama tühikuid, näiteks:
1 + 2 = 3.
-
Konstandid: kirjutatakse alati suurtähtedega, sõnad eraldatakse alakriipsuga ning konstandid asuvad mooduli tasemel:
ARE_UPPERCASE.
-
Klassi nimi: iga sõna algab suure algustähega, sõnu ei eraldata:
HelloThisIsAnExampleClass.
-
Mooduli struktuur: algab mooduli funktsionaalsuse kirjeldusega (docstring), peale seda tulevad import-lauseid ja seejärel juba kood.
-
Reavahed ja tühjad read: faili lõpus peab olema üks tühi rida, funktsiooni ees peab olema kaks tühja rida. Rea lõpus ei tohi olla üleliigseid tühikuid.
-
Kommentaarid: peaksid olema täislaused ning algama suure algustähega, va juhtudel kui lause algab väikese algustähega identifikaatoriga.