Kodstil och PEP8

När flera personer skriver kod tillsammans – eller när du själv jobbar med ett större projekt – är det viktigt att alla skriver på ett liknande sätt. Annars blir koden svår att läsa, underhålla och bygga vidare på.

Därför finns det något som kallas kodstil eller kodstandard.

Vad är PEP8?

PEP8 är den officiella stilguiden för Python. Den innehåller regler för hur koden ska se ut – inte vad den gör.

Tänk på PEP8 som en “språkregelbok” för Python – ungefär som grammatik för text.

Viktiga delar ur PEP8

1. Bra namn på variabler och funktioner

Beskrivande namn i små bokstäver, gärna med understreck _:

antal_elever = 23
def räkna_snitt(värden):

Dåliga exempel:

a = 23         # Otydligt
def RS():      # Svårtolkat

2. Klasser ska ha versal i början

class Person:

Detta kallas CamelCase och gäller bara för klassnamn.

3. Indrag (4 mellanslag)

Kod inuti funktioner och villkor ska ha 4 mellanslag som indrag:

def hej():
    print("Hej")

OBS: Använd aldrig tab + mellanslag blandat – det kan orsaka fel.

4. Tomma rader för läsbarhet

• En tom rad mellan funktioner
• Två tomma rader mellan klasser

Det gör det lättare att skilja olika delar av programmet.

5. Mellanslag i uttryck

Bra:

area = bredd * höjd
if x == 10:

Dåligt:

area=bredd*höjd
if(x==10):

6. Max 79 tecken per rad

Långa rader blir svåra att läsa – bryt hellre upp raden med \ eller lägg värden i flera steg.

Tips: Automatiskt hjälpmedel

I t.ex. VS Code kan man använda tillägg som:

• autopep8
• black (formatterar koden automatiskt enligt stilregler)

Sammanfattning – PEP8 i praktiken