Python Code convention Guide

파이썬 코드 컨벤션 정리

Naming Conventions

• 함수명 (소문자 + 밑줄)

# Correct
def get_text()

# Wrong
def get_Text()
def Get_Text()
def Get_text()

• 변수명 (소문자 + 밑줄)

# Correct
text
text_length

# Wrong
Text
text_Length
Text_length

• 전역변수명 (g + 밑줄 + 변수명)

# Correct
g_text
g_text_length

# Wrong
G_text
g_Text_length
g_text_Length

• 모듈명 (소문자 + 밑줄)

# Correct
dataset.py
text_style.py

# Wrong
Dataset.py
text_Style.py

• 클래스명 (대문자 시작 및 대문자로 단어 구분)

# Correct
class VideoCapture()
class VideoWriter()

# Wrong
class videoCapture()
class Video_writer()

• 상수명 (모두 대문자 사용 + 밑줄)

# Correct
PATH
WINDOW_SIZE

# Wrong
Path
window_SIZE

들여쓰기

• 스페이스 4 줄 또는 탭으로 들여쓰기하기

# Correct
    x = y

# Wrong
  x = y

Imports

• import 줄에 한개의 모듈 또는 라이브러리 임포트하기

# Correct:
import os
import sys

# Wrong
import sys, os

• 하지만 from 사용시 여러가지 모듈 또는 라이브러리 사용가능

# Correct
from subprocess import Popen, PIPE

표현식, 조건식의 공백

• (), [], {} 안에 공백 최소화

# Correct
spam(ham[1], {egg: 2})

# Wrong
spam( ham[ 1 ], { eggs: 2} )

• ,와 닫는 괄호( ")" ) 사이 공백 최소화

# Correct:
foo = (0,)

# Wrong
bar = (0, )

• ,와 ; 그리고 : 사이 공백 최소화

# Correct
if x == 4: print x, y; x, y = y, x

# Wrong
if x == 4 : print x , y ; x , y = y , x

예외
# Correct 
ham[1:9], ham[1:9:3], ham[:9:3], ham[1::3], ham[1:9:]
ham[lower:upper], ham[lower:upper:], ham[lower::step]
ham[lower+offset : upper+offset]
ham[: upper_fn(x) : step_fn(x)], ham[:: step_fn(x)]
ham[lower + offset : upper + offset]
# Wrong
ham[lower + offset:upper + offset]
ham[1: 9], ham[1 :9], ham[1:9 :3]
ham[lower : : upper]
ham[ : upper]

• 열린 괄호 ( "(" ) 전에 함수 또는 리스트 사이 공백 최소화

# Correct:
spam(1)

# Wrong:
spam (1)

• 열린 괄호 ( "[" ) 전에 함수 또는 리스트 사이 공백 최소화

# Correct:
dct['key'] = lst[index]

# Wrong:
dct ['key'] = lst [index]

• "=" 연산자 사용 후 숫자 또는 문자열 정렬을 위한 최대 공백은 1칸

# Correct:
x = 1
y = 2
long_variable = 3

# Wrong:
x             = 1
y             = 2
long_variable = 3

• 바이너리 연산자 사용 전&후 1칸 공백 사용 (계산해야하는 우선순위가 높은 숫자 또는 변수 사이의 공백은 최소화 되어야한다.)

# 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 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()

# Wrong 1:
if foo == 'blah': do_blah_thing()
# Wrong 2:
if foo == 'blah': do_blah_thing()
for x in lst: total += x
while t < 10: t = delay()
# Wrong 3:
if foo == 'blah': do_blah_thing()
else: do_non_blah_thing()
try: something()
finally: cleanup()
do_one(); do_two(); do_three(long, argument,
                             list, like, this)
if foo == 'blah': one(); two(); three()

• 동일한 줄에 여러개 함수 호출하지 않음

# Correct
do_one()
do_two()
do_three()

# Wrong
do_one(); do_two(); do_three()

주석

• 주석 타입 1

x = x + 1                 # Increment x

• 주석 타입 2

"""Return a foobang
Optional plotz says to frobnicate the bizbaz first.
"""

• 주석 타입 3

"""Return an ex-parrot."""

공식 파이썬 코드 컨벤션 가이드 주소