How to set black formatter in vscode

Justin
3 min readMar 4, 2021

--

파이썬에서 black formatter 셋팅하는 방법을 소개한다.

이 글에서는 아래 두가지를 소개합니다.

  1. black을 설치하고
  2. vscode에서 몇가지 설정을 변경한다.

이런건 설명하지 않습니다.

  1. autopep8, black, flake8, yapf 중에서 왜 black을 사용하는지
  2. black이 어떤 특징을 갖는 formatter인지

black 설치하기

파이썬 환경 설정도 여러가지가 있어서 각자 맞는 방법으로 설치합니다. 보통 아래와 같이 설치하면 잘 될거에요.

pip install black

저는 poetry를 사용하고 있어서 아래와 같이 추가했습니다.

poetry add black

vscode 설정하기

black을 설치했다면 사용해봐야겠죠.

불편해요

이미지와 같이 포맷이 문제있는 코드가 있는데요 black을 써서 포맷을 정리할 수 있어요.

black [파일명]

명령어를 입력하면 해당 파일이 black의 기본 설정을 토대로 포맷을 정리해줍니다.

포맷팅 적용된 파일

하지만! 코드를 작성할 때 마다 black [파일명] 명령어를 치는건 쉽지 않죠… 결국 이런 번거로운 작업들이 계속되면 규칙을 안지키기 마련입니다!

그래서 더 쉽게 할 수 있도록 몇가지 설정을 해볼게요

vscode에서 Code -> Preferences -> Settings 로 가주세요.

그리고 formatting provider 로 검색해서 black으로 변경해주세요.

그리고 파일을 저장할 때 마다 자동으로 formatting이 적용되도록 format on save 기능을 활성화 해주세요

이렇게 하면 저장할 때 마다 깔끔한 코드를 유지할 수 있습니다!

추가옵션

사용자마다 옵션이 다르므로 입맛에 맞게 설정할 수 있다.

여기에서 black option을 확인 할 수 있다. https://github.com/psf/black#command-line-options

나는 한줄에 최대 150글자까지 허용하는 옵션만 추가했다.

Reference

--

--