[Python] 코딩 스타일 정립 & 포매팅 자동화

파이썬에서 효과적인 코딩 스타일을 유지하는 것은 중요합니다. 이를 위해 포매팅 도구인 블랙(Black)을 사용하는 방법을 소개합니다.

블랙 설치 방법

블랙은 파이썬 코드를 자동으로 깔끔하게 포매팅해주는 도구입니다. 설치 방법은 다음과 같습니다.

- Windows:

python -m pip install --user black

가상 환경에 설치할 경우 --user 옵션을 제외하고 설치합니다.

- Mac or Linux:

python3 -m pip install --user black

 

블랙 사용법

블랙을 사용하여 특정 파이썬 파일을 포매팅하는 방법은 간단합니다. 아래 명령어를 사용하세요:

python -m black [적용할 파일].py

또한 vscode에서 기본 포매터로 black을 설정하면, 코드를 저장하거나 실행할 때, 자동으로 포매팅을 해주니 참고하시길 바랍니다.

 

코딩 스타일 규칙

좋은 코딩 스타일을 유지하는 것은 중요합니다. 아래는 몇 가지 기본적인 규칙입니다.

• 가로 간격:
  • 연산자와 식별자 사이에는 공백 한 칸을 둡니다.
    • 예: blanks = blanks[:i] + secretWord[i] + blanks[i + 1:]
  • 구분자 뒤에는 공백 한 칸을 둡니다.
    • 예: def spam(eggs, bacon, ham):
  • 마침표의 앞뒤에는 공백을 넣지 않습니다.
    • 예: 'Hello, World'.upper()
  • 함수, 메소드, 컨테이너 이름 뒤에는 공백을 넣지 않습니다.
    • 예: print('Hello, World!')
  • 여는 괄호 뒤와 닫는 괄호 앞에는 공백을 넣지 않습니다.
    • 예: def spam(eggs, bacon, ham):
  • 코드행 끝의 주석 앞에는 공백 2칸을 둡니다.
    • 예: print('Hello, World!') # 인사말 출력
• 세로 간격:
  • 함수나 클래스는 두 줄의 빈 행을 두어 구분합니다.
  • 클래스 내의 메소드는 빈 행 한 줄로 구분합니다.

모듈 Import 규칙

모듈을 import할 때는 한 줄에 하나씩 나열하는 것이 가독성에 좋습니다.

이러한 규칙을 따르면, 코드의 일관성과 가독성이 향상되며, 팀 프로젝트에서 협업하는 데도 큰 도움이 됩니다. 블랙을 사용하면 이러한 규칙을 쉽게 따를 수 있으며, 코드 스타일을 자동으로 관리할 수 있습니다.