[python][basic] 파이썬 코딩 컨벤션 정리

코딩 컨벤션(coding convention)이란?

코딩 컨벤션은 코드를 작성할 때 코드를 읽고 협업하며 관리할 때 효율성을 증진시키기 위해서 어떤 일관된 코딩 스타일을 사전에 약속하는 것이다. 이러한 코딩 스타일 규약은 지키지 않아도 실행 결과에는 영향을 미치지 않는다. 단지 어떤 일관성이 있는 기준을 두어 통일하면 더 나은 품질의 코드를 작성하는데 그리고 협업할 때의 불편함을 줄이는 데에 도움이 되기 때문이다.

코딩 컨벤션은 함께 일하는 팀 단위마다 정하고 사용해도 되지만 일반적으로 같은 언어를 공유하는 공동체에서 제공하는 컨벤션 가이드가 존재한다. (파이썬의 경우 PEP 8)

 

Python Enhance Proposal(PEP)

PEP중에서도 PEP 8이 파이썬 언어의 컨벤션에 대한 제안서이다.

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

PEP 8 -- Style Guide for Python Code

 

한국어 번역 

b.luavis.kr/python/python-convention

Luavis' Dev Story - Python PEP 8

 

 

주요 guide

- 탭이나 공백을 섞어쓰지 말기 (탭 대신 공백 문자만 사용하도록 노력하기)

- 들여쓰기 공백 4칸

-한 줄 최대 79자

-클래스 내의 메소드 정의는 1줄씩 띄어쓰기

- import는 행으로 구분되어 사용하기

-임포트 구문은 항상 파일의 최상단에 위치해야 하며, 모듈의 주석문과 docstring의 바로 다음, 그리고 모듈의 전역 변수와 상수 바로 이전에 위치

- 여백의 문자 사용 피하기 

• 대괄호([])와 소괄호(())안
• 쉼표(,), 쌍점(:)과 쌍반점(;) 앞

- 상수는 대문자로 만들자

- 주석을 쓸 때에는 # 뒤에 공백 문자를 하나 넣자

- 주석과 코드가 매치되지 않는 주석은 달지 않는 것이 낫다

---

일단은 기억하고 싶은 주요 코딩 컨벤션 내용으로 정리하였는데  자세한 내용은 위에 링크에서 확인 가능합니다 ^^