Pycharm, vim 에 black 세팅하기

black logo

what is black?

• 공식 도큐먼트 : https://black.readthedocs.io/en/stable/
• 파이썬 코드 자동 포맷팅 도구이다. flake8이 단순히 "이거 틀렸어요!"라고 가르쳐 준다면, 이 툴은 알아서 포맷팅을 진행한다.
• 일종의 협업툴이라 볼 수 있다.

install

$ pip install black

---

use this in vim

black <원하는 파일>.py

black $PWD # 현재 폴더 하위의 모든 파이썬 파일에 재귀적으로 black 포맷팅을 적용

---

use this in pycharm

plugin file watcher 다운받기

Preference -> Plugins 에서 FileWatcher를 다운받는다.

black 이 설치된 위치 확인

$ which black

결과 : usr/local/bin/black (이것을 복사해 놓는다.)

pycharm 세팅

Preference -> Tools -> File Watchers -> "+" 버튼 > 커스텀 클릭

후 아래와 같이 설정해준다.

Name: black

File Type: python

Scope: Project Files

Program : usr/local/bin/black (black 설치 경로)

Arguments: $FilePath$

Output paths to refresh: $FilePath$

Working Directory: $ProjectFileDir$

Advanced options

Auto-save edited files to trigger the watcher #체크 해제

Trigger the watcher on external changes #체크

결과

위와 같이 설정을 저장 한뒤, py 파일에서 변경한다음 저장을 해보자.

파일 포맷팅이 자동 변경되는것을 확인할 수 있다.

---

self custom

https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html

---

참고 문헌

http://oniondev.egloos.com/10001296
https://black.readthedocs.io/en/stable/