본문 바로가기
파이썬

[Python] 파이썬의 코딩 규약 (PEP)

by 책 읽는 개발자_테드 2022. 3. 15.
반응형

파이썬 프로그래밍를 읽고, 정리한 글입니다.

목차

· 코딩 규약이란?

· PEP이란?


코딩 규약이란?


· 코딩 규약(Coding convention)은 소스를 코딩할 때 지켜야 할 서로 간의 약속된 규칙을 정하여 일관성 있게 코딩하는 것이다.

- 코딩 규약의 장점: 일반적으로 좋은 코드은 많은 시행 착오를 겪은 유능한 프로그래머들의 좋은 습관이 배어 있다. 이러한 코딩 습관을 규약으로 만들어 더 좋은 품질의 소스를 작성하는 데 도움을 줄 수 있다.

· 코딩 규약은 코딩 표준 또는 코딩 스타일이라고도 불린다.

· 파이썬에서는 PEP8 이라는 대표적인 코딩 규약 명세서가 존재한다.

 

PEP이란?


· 파이썬은 코딩 규약을 문서로 제시하고 있다. 이것이 바로 PEP(Python Enhance Proposal) 8이다.

- 자세한 내용: https://peps.python.org/pep-0008/

- 숫자 8은 카테고리별 색인 번호에 해당한다.

- 파이썬 코드의 개선을 위해 만들어진 제안서다.

- 새로운 기능이나 구현을 제안하는 표준 트랙, 파이썬의 디자인 이슈나 일반적인 지침, 커뮤니티의 정보에 대한 제안, 파이썬 개발 과정의 개선안을 담고 있다.

 

· 규정 몇 가지를 정리한 표:

종류 설명
들여쓰기 · 들여쓰기는 공백 4칸을 권장한다.
· 한 줄은 최대 79자까지를 추천한다.
· 최상위 함수와 클래스 정의는 2줄씩 띄어 쓴다.
· 클래스 내의 메서드 정의는 1줄씩 띄어 쓴다.
표현식 및 명령문 공백 · 대괄호([])와 소괄호(()) 안, 콤마(,), 콜론(:), 세미콜론(;) 등의 앞에는 공백을 주지 않는다.
· 키워드 인자와 인자의 깁ㄴ값에 =는 붙여 쓴다.
주석 · 불필요한 주석은 최소화하고, 한 줄 주석은 신중히 달도록 한다.
명명 규칙 · 소문자 l, 대문자 I, 대문자 O를 변수명으로 쓰면 다른 문자와 구분하기 곤란해 가독성이 떨어지므로 가급적 사용하지 않는다.
· 모듈명은 간단한 소문자로 구성하며 필요하다면 밑줄로 구분한다.
· C/C++ 확장 모듈은 밑줄로 시작한다.   
· 클래스명은 카멜 표기법(calmel case)으로 작성한다.
· 시스템이 내부적으로 사용하는 객체명에는 앞에 언더바(_)를 붙인다.
· 대소문자 혼용은 흔하게 사용되는 부분에 한하여 예외를 인정한다.
프로그래밍 권장사항 · 코드는 가급적 PyPy, Jython, IronPython 중 어떤 인터프리터를 실행하더라도 문제 없도록 작성되어야 한다.
· None을 비교할 때는 is나 not만 사용한다.

 

반응형

댓글