Pycharm에 Black (포매터)formatter 적용하기

파이썬을 사용할때 협업 및 코드 작성시 정해진 규칙으로 작성하기 위해선 Black 블랙은 필수다.

적용 방법을 알아보자

 

1. black 설치하기

터미널에서  pip install black 작성

 

2. black 위치 확인하기

터미널에서 $ where black, which black 치면 위치 확인 가능, 보통 가상환경 사용시 가상환경 폴더 스크립트 안에 있음

 

3. Pycharm File Watch 플러그인 설치

Pycharm 상단 File -> settings 클릭 -> Plugins 에서 File Watch 설치 -> Pycharm 재실행 

 

4. Pycharm File Watch 세팅

Pycharm 상단 File -> settings 클릭 -> Tools -> File Watchers 클릭 

 

+ 클릭 후 custom 선택

Name : 칸에 원하는 이름을 적고 (ex: Black)

Program : 여기 칸에 black 스크립트 경로를 작성해 준다 ( ex : 경로/venv/bin/black) 

Arguments : $FilePath$

Output paths to refresh : $FilePath$

Working directory : $ProjectFileDir$

 

$$ 사용하는 칸은 파이참에서 지원하는 명령어 라고 생각하면 편하다

 

Auto-save edited files to trigger the watcher 칸은 체크 해제하면 된다

(이건 취향차이 필자는 저장할때 마다 적용되게 하기 위한 설정)

 

5. Pycharm black 사용법

수동저장 -> black 적용 (저장키를 입력할때마다 black이 적용되게 할것이다.)

 

수정저장 사용 안 할시 black 명령어를 작동해야 한다.

------

수동저장 세팅할때 

File -> settings -> Apperance & Behavior -> System Settings 

위에 이미지 대로 설정하면 된다.

settings -> Editor -> General -> Editor Tabs 에 들어간 후

 

Mark modified(*) 부분을 체크한다.

-> 코드 수정 후 저장 안하면 * 표시가 나와서 저장안됀 코드를 확인하기 용이하다

마지막으로 settings -> Tools -> Actions on Save 에 들어간후

 

위에 이미지대로 설정하면 된다.

File Watcher가 없을시 플러그인에서 설치하면 된다.