Koodistiil

Koodi kirjutamisel tuleb arvestada ka seda, et sellele kehtivad teatud normid ja standardid. Need standardid on kehtestatud selleks, et lihtsustada selge koodi kirjutamist. Igas programmeerimiskeeles on pisut erinev koodistiil ning selguse mõttes tuleb uute keelte õppimisel vaadata üle ka koodistiil.

Pythoni koodistiili võtmenimeks on PEP 8

Vaatame üle mõningad reeglid PEP 8 standardi järgi:

Funktsioonide, meetodite && muutujate nimed: lowercase_words_separated_by_underscores

Konstandid: ARE_UPPERCASE ja asuvad mooduli tasemel.

Klassid: HelloThisIsExampleClass

Mooduli struktuur peab olema järgmine:

"""This module does nothing at all and is just an example."""

import math
import random as r
from sys import stdout, __stdout__


def do_nothing(params):
    """
    Summary of the func.

    Description of the func. This function takes one parameter and does nothing.
    :param params: the data type of the parameter <params>, description
    :return: What the function returns, data type
    """
    return None

Ehk esimesena läheb docstring mooduli funktsionaalsuse kirjeldusega, pärast lähevad import laused ja seejärel juba kood. Üldisemalt öeldes tuleb lihtsalt jälgida seda, et kood oleks arusaadav ja selge. Mõned näited:

# OK
if example_boolean:
    # Do smth

# Both are not OK
if example_boolean == True:
    # Do smth

if example_boolean is True:
    # Do smth


# OK
def foo(x):
    return 5 * x

# Not OK
def foo(x):
    result = 5 * x
    return result

# OK
5 * 10
[12, 25, 33, 444]
{"Apple": 3, "Orange": 2}
("abc",)

# Not OK
5/ 2
3 *12
[12,23,434,5,56]
(12, )

Nõudeid on palju ja neid kõiki pole mõtet siia ümber kirjutada. Kogu nimekiri on leitav siit:

https://www.python.org/dev/peps/pep-0008/

Samuti kergesti loetav ning soovitatav on see artikkel, kus allpool on palju näiteid sellest, mis on hea ning mis on halb:

http://docs.python-guide.org/en/latest/writing/style/