[Python] PEP8 스타일 코딩

PEP 8 – Style Guide for Python Code | peps.python.org

 

공백

: 탭, 스패이스, 새 줄

• 스페이스로 들여쓰기 → 4칸
• 한 라인에 79개 문자 이하
• 함수와 클래스 사이에는 빈 두 줄
• 메서드와 메서드 사이느 ㄴ빈 줄 한 줄
• 딕셔너리에서 키와 콜론(:) 사이에 공백 안 넣기
• = 전후에는 스페이스 하나

 

명명 규약(네이밍)

• lowercase_underscore 소문자와 밑줄 사용
• 보호돼야 하는 인스턴스 애트리뷰트는 일반적 이름 규칙을 따르되, _ 밑줄로 시작
• 비공개(한 클래스 안에서만 사용되어야 하는 경우), __ 밑줄 두 개
• 클래스는 CapitalizesWord처럼 여러 단어 이어 붙이되, 대문자
• 클래스 첫 번째 인자는 self
• 모듈 수준 상수는 ALL_CAPS처럼 모두 대문자

 

식과 문

• 긍정을 부정 X, 부정을 내부에 넣기
• if not a is b -> x if a is not b -> o
• len(something)==0 하지말고, if not 컨테이너 사용, 빈 컨테이너나 시퀀스는 False임
• 반대로 비어있지 않은 경우도 True 라는 점 명심
• if, for, while, except 한 줄로 쓰지마
• 식은 괄호 안에 넣고, 줄바꿈, 들여쓰기 넣기

 

임포트

• 임포트 문은 항상 맨 앞에 위치
• 모듈의 이름은 절대적 이름
  • from bar import foo 라고 해야하지, import foo 라고 하면 안 된다
• 상대적 경로로 임포트 해야하는 경우, from . import foo 처럼 명시적 구문 사용

 

PEP8 사이트의 코드를 연습

PEP 8 - Style Guide for Python Code

import os
import sys

# Wrong
import sys, os

# Correct
from subprocess import Popen, PIPE

# Sys.apth
import mypkg.sibling
from mypkg import sibling
from mypkg.sibling import example

# explicit relative imports
from . import silbing
from .sibling import example

# import a class from a class-containing module
from myclass import MYCLASS
from foo.bar.yourclass import YOURCLASS

# Correct:
i = i + 1
submitted += 1
x = x*2 - 1
hypot2 = x*x + y*y
c = (a+b) * (a-b)

# Wrong:
i=i+1
submitted +=1
x = x * 2 - 1
hypot2 = x * x + y * y
c = (a + b) * (a - b)

# Correct:
def munge(input: AnyStr): ...
def munge() -> PosInt: ...

# Wrong:
def munge(input:AnyStr): ...
def munge()->PosInt: ...

# Correct:
def complex(real, imag=0.0):
    return magic(r=real, i=imag)

# Wrong:
def complex(real, imag = 0.0):
    return magic(r = real, i = imag)

# Correct:
if foo == 'blah':
    do_blah_thing()
do_one()
do_two()
do_three()

# Wrong:
if foo == 'blah': do_blah_thing()
do_one(); do_two(); do_three()

# Correct
if foo == 'blah':
    do_blah_thing()
for x in lst:
    total += x
while t < 10:
    t = delay()

# Wrong:
if foo == 'blah': do_blah_thing()
for x in lst: total += x
while t < 10: t = delay()