Python Code style

Python은 특유의 철학 때문에 문법이 엄격한 편이다.

PEP 8(Python Enhancement Proposal 8)이라는 공식 가이드 라인에서 제시된다.

정상 작동과는 별개로 코드의 가독성을 높이기 위해 권장하는 스타일과 규칙을 정의하며, 파이썬 개발자들 사이에서 널리 사용된다.

 

참고로 필수가 아닌 권장이다.!!!

 

https://peps.python.org/pep-0008/

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

 

네이밍 규칙

Python에서는 변수나 클래스 이름을 어떻게 짓든 문제 없이 돌아간다.

하지만 PEP 8 에서는 대한 권장 스타일도 명시하고 있다.

파이썬을 사용하여 코딩할 때에는 가독성을 위해서 이러한 스타일을 지키는 것이 좋다.

 

다음은 네이밍에 대한 스타일 가이드다.

• 스네이크 표현을 사용하지만 특정한 종류에는 파스칼 표현을 사용한다.
• 변수는 소문자로 시작하며, 내부변수는 맨 앞에 _(언더바) 1개로 시작하며, 숨은변수는 __(언더바 2개)로 시작한다.

예)

• attribute_name = 0
• _protected_attribute_name = 0
• __hidden_attribute_name = 0

 

종류	규칙	예시
package	스네이크()
module	스네이크()	import module_name
class	파스칼()	class ClassName()
exception	파스칼
function	스네이크()	def function_name()
constant	대문자 + 언더바	CONSTANT_NAME
variable	스네이크	variable_name
parameter	스네이크	variable_name
local variable	스네이크	variable_name
instance variable	스네이크	variable_name
method	스네이크()	method_name

 

스네이크(snake case)

_(언더바)가 들어있는 표현 방식

 

파스칼(pascal case)

첫 글자와 중간 글자가 대문자인 표현 방식

 

카멜(camel case)

첫 글자는 소문자이고 중간 글자가 대문자인 표현 방식

 

케밥(kebob case)

중간에 -(하이픈)이 들어 있는 표현 방식

 

문법 규칙

• 한 줄은 79글자로 제한하기
• import는 파일의 맨 위에 적고 내장 모듈, 제3자 모듈, 직접 만든 모듈 순서로 불러들이기
• 인스턴스 메서드의 첫 인자는 self로 쓰고, 클래스 메서드의 첫 인자는 cls로 쓰기
• 할당 연산자(=)의 앞뒤로 공백 넣기

 

이외에도

• 들여쓰기: 4 스페이스를 사용.
• 코드 라인 길이: 최대 79자를 넘지 않도록 함.
• 함수와 클래스 정의: 각각의 정의 위에 빈 줄을 두어 코드의 가독성을 높임.
• 변수와 함수명: 소문자와 밑줄 (_)을 사용하여 가독성을 높임.
• 상수: 모두 대문자를 사용하여 식별.
• 주석: 코드의 의도를 명확히 설명하고, 불필요한 주석은 피함.

 

다양하다.