December 10, 2024

Pycharm Study 006

Pycharm Study 006

파이썬 코드 포맷터 BLACK을 사용하자

파이썬에는 PEP8(Python Enhancement Proposal #8) 이라는 코드 스타일 가이드가 있습니다.
코딩 작성 기준이라고 하면 쉬울듯 합니다. 표준화된 스타일을 통해 코드의 가독성을 높이고 상호간의 코드를 교환해도 이해하기 쉽게 만들어 줍니다.

  • 들여쓰기: 4개의 공백을 사용합니다. 탭은 사용하지 않습니다.
  • 줄 길이: 한 줄은 최대 79자까지 작성합니다.
  • 공백: 연산자 양쪽에 공백을 하나씩 넣고, 쉼표 뒤에는 공백을 하나 넣습니다.
  • 함수와 클래스 이름: 소문자로 시작하고, 여러 단어는 언더스코어로 연결합니다.
  • 변수 이름: 함수와 클래스 이름과 유사하게 작성합니다.
  • 상수: 대문자로 작성하고, 여러 단어는 언더스코어로 연결합니다.
  • 주석: 한 줄 주석은 #으로 시작하고, 여러 줄 주석은 """로 감쌉니다.
  • 정렬: 괄호, 중괄호, 대괄호 등의 요소를 수직으로 정렬한다.

위의 내용은 PEP8의 핵심 네용입니다. 이러한 것을 외워서 사용하려면 시간도 걸리지만 지키지 못할 경우도 있습니다. 이러한 문제를 쉽게 처리해 주는 것이 '블랙 black'이라는 패키지입니다.

black 패키지는 터미널에서 'pip install black'을 입력하여 설치하거나, 파이참 메뉴에서 설치할 수 있습니다.

black_pycharm

black 패키지는 'PEP8'의 스타일로 변경해 줍니다. 자세한 내용은 https://black.readthedocs.io/en/stable/ 의 문서를 참조하면 됩니다.

black을 적용하는 방법은 터미널에서 'black <파일이름>'으로 실행하면 됩니다. 파이참의 메뉴를 이용하는 경우 'File > Settings > Tools > External Tools'로 이동하여 '+'를 눌러 black 을 추가해줍니다.

black_tools

위와 같이 등록한 후 현재 작업중이 화면에서 'Tools > External Tools > Black' 을 선택하면 현재 작업중인 파일의 코드에 코딩 스타일이 적용됩니다.

https://github.com/psf/black
https://black.readthedocs.io/en/stable/
https://plugins.jetbrains.com/plugin/14321-blackconnect
https://github.com/lensvol/intellij-blackconnect