본문 바로가기

프로그래밍 언어/python

파이썬 PEP 8 스타일 가이드라인

파이썬 PEP 8 스타일 가이드라인

파이썬 PEP 8 스타일 가이드는 파이썬 코드를 작성할 때 따라야 하는 베스트 프랙티스와 권장 스타일을 제공합니다. 이 가이드라인을 따르면 코드의 가독성이 향상되고, 다른 개발자들과의 협업이 용이해집니다.

공백

  • 들여쓰기: 4개의 공백을 사용하여 들여쓰기를 합니다. 탭과 공백을 혼합해서 사용하지 않습니다.
  • 라인 끝의 공백: 라인 끝에 불필요한 공백이 없어야 합니다.
  • 줄바꿈: 괄호, 대괄호, 중괄호 내부에서는 추가 공백 없이 줄을 바꿉니다.
  • 함수와 클래스 사이: 클래스 정의 위아래로 두 줄, 함수 정의 위아래로 한 줄의 공백을 둡니다.

명명규약

  • 클래스 이름: CamelCase 형식을 사용합니다.
  • 함수 및 변수 이름: 소문자와 언더스코어(_)를 사용하는 snake_case 형식을 사용합니다.
  • 상수: 모든 글자를 대문자로 하고, 단어 사이에 언더스코어를 사용합니다.
  • 내부적으로 사용하는 이름: 단일 밑줄(_)로 시작하는 이름을 사용합니다.

식과 문

  • 인라인 주석: 코드와 같은 라인에 주석을 작성할 때는, 코드와 주석 사이에 적어도 두 개의 공백을 두어야 합니다.
  • 복잡한 식: 복잡한 식은 여러 줄로 나누어 작성하고, 연산자는 새로운 줄의 시작 부분에 위치해야 합니다.

임포트

  • 임포트 스타일: 각 임포트는 별도의 라인에 있어야 합니다.
  # 권장
  import os
  import sys

  # 비권장
  import sys, os
  • 임포트 순서: 표준 라이브러리 임포트, 관련 외부 라이브러리 임포트, 로컬 애플리케이션/라이브러리 특정 임포트 순으로 구성합니다.

PEP 8 가이드라인은 파이썬 코드 작성의 기본적인 표준입니다. 이를 준수하면 코드의 일

관성과 가독성이 향상되어 효율적인 협업과 유지보수가 가능해집니다. 항상 이 가이드라인을 염두에 두고 코드를 작성하는 것이 좋습니다.