Kódím.cz
2

Coding style

Jakým způsobem psát kód, aby se všem dobře četl

Coding style

Programovací jazyk Python byl od začátku navržen s ohledem na snadné čtení a pochopení programu napsaného někým jiným. Například odsazování bloků kódu je vynucenou součástí jazyka. Jiné programovací jazyky v tomto striktní nejsou. V zápise kódu se však mezery na různých místech mohou nebo nemusí psát.

  • Obecný cyklus while se provádí opakovaně dokud jeho podmínka platí
  • Příkaz continue přeskočí zbytek těla cyklu a pokračuje další iterací, v případě while dojde opět k vyhodnocování jeho podmínky
from random import randrange


def generate():
    '''Generate a 4-digit secret number. The digits must be all different.'''
    secret = ''

    while len(secret) < 4:
        digit = str(randrange(0, 10))
        if digit in secret:
            continue
        secret += digit

    return secret


number = generate()
print(number)

print(number[0])  # first digit
print(number[-1])  # last digit

Pro začátek si ukážeme, kde se píší a nepíší mezery.

Dodržování stylu kódu v Pythonu, jak je definováno v PEP 8 (Python Enhancement Proposal 8), je klíčové pro zlepšení čitelnosti, udržovatelnosti a spolupráce v projektech. PEP 8 poskytuje doporučené standardy a konvence pro formátování kódu, čímž usnadňuje tvorbu kvalitního a čitelného kódu a přispívá k jednotnému vzhledu pythonových projektů.

Dokud se sami nepropracujeme ke zcela podvědomému psaní kódu podle PEP 8, je vhodné využít pomoc automatizovaných nástrojů.

Kromě různých vestavěných funkcionalit IDE jako např. PyCharm je asi nejjednodušší použít v příkazová řádce program autopep8, který přeformátovaný kód vypíše a nedělá v základním nastavení příliš agresivní změny (zalamování dlouhých řádku atd.). Alternativou může být nástroj black. autopep8 si nainstalujeme v příkazové řádce pomocí

pip install autopep8

Pro zobrazení změn, které v kódu nastaly, se dá použít vestavěný diff ve VS Code. autopep8 -i pak udělá změny in-place (přepíše náš skript).