PyCharm(파이참) Python Black 설치 및 설정 및 사용 방법

PyCharm(파이참) Python Black 설치 및 설정 및 사용 방법

 

Black은 파이썬 소프트웨어 재단에서 운영하는 Python Fomatter로,

Python 개발 시 포매팅하는 방법들 중 가장 많이 사용되는 것으로 알고있습니다.

 

PyCharm에서 Black을 사용하여 자동 포매팅을 설정해두면 쉽고 깔끔하게 Python Code를 작성하실 수 있으니
PyCharm에서 Black을 설치 및 설정하는 방법과 사용하는 방법에 대해 알려드리도록 하겠습니다.

 

1. black 패키지 설치

pip install black

먼저 위 명령어를 통해 black 패키지를 설치합니다.

 

2. 설치된 black 경로 확인

# Mac
which black

# Windows
get-command black

위 명령어를 통해 black의 경로를 출력하고, 해당 경로를 복사해둡니다.

 

3. PyCharm에 Black 설정

맥을 기준으로 PyCharm > Settings 를 클릭하거나,

키보드에서 Command(⌘) + ',' 를 누르는 것으로 Settings 창을 엽니다.

 

Settings 창에서 Tools > File Watchers 탭으로 들어갑니다.

File Watchers 탭에서 + 버튼을 클릭하고, <custom> 을 선택합니다.

 

• Name : Black
• File type : Python
• Scope : Project Files
• Program : black 설치 경로 (which black 로 확인)
• Arguments : $FilePath$
• Output paths to refresh : $ProjectFileDir$
• Working directory : $ProjectFileDir$
• Auto-save edited files to trigger the watcher : 체크해제
• Trigger the watcher on external changes : 체크해제
• Trigger the watcher regardless of syntax errors : 체크해제
• Create output file from stdout : 체크해제

위와 같이 설정해주고 OK 버튼 클릭하여 생성합니다.

 

Black이 생성된걸 확인하고 Apply 버튼을 클릭하여 적용을 완료합니다.

 

4. Black 사용 확인

4-1. 파일 저장시 자동 포매팅

파일 저장시 black이 실행되면서 자동 포매팅이 실행됩니다.

4-2. black 명령어 실행 (PyCharm과 관계없이 black 설치만 해도 사용가능함)

# 현재 경로 전체 파일 포매팅
black .

# 원하는 파일 포매팅
black {원파는 파일 경로}

black 명령어를 통해 원하는 경로를 선택하여 포매팅 할 수 있습니다.

이 방법은 PyCharm과 관계 없이 black을 설치했으면 사용 가능합니다!

 

위 예시와 같이 줄바꿈, 홑따옴표에서 쌍따옴표 변경 등이 자동으로 행해집니다.

 

이상으로 PyCharm에서 Black을 설치 및 설정하는 방법과 사용하는 방법에 대한 설명을 마치도록 하겠습니다.

 

 

도움이 되셨다면 공감, 댓글 부탁드립니다!

궁금하신 점이나 요청사항은 언제든지 말씀해주세요!

피드백도 언제나 환영입니다!

 

감사합니다.