[컴][파이썬] formatter Black

pep / formatter / python pretty formatter / yapf

Black

CPython 을 만드는 python 조직에서 만들었다.

• GitHub - psf/black: The uncompromising Python code formatter
• Black Playground
• Łukasz Langa - Life Is Better Painted Black, or: How to Stop Worrying and Embrace Auto-Formatting - YouTube

installation

pip3 install balck

run

black ~/p/prog.py

The Black code style

• black/the_black_code_style.md at master · psf/black · GitHub

black 이 code 를 어떤 스타일로 바꾸는지 알 수 있다. 이 글 에 따르면, 기존의 다른 formatter 와는 다르게 black 은 스타일을 자기가 원하는대로 변경할 수 없다고 한다.

pyproject.toml Black configuration file

기본적으로 설정파일을 사용할 필요는 없다. 다만 --include , --exclude 등을 이용해서 원하지 않은 패턴등을 추가하거나, 뺄 수 있다.

• pyproject.toml — Black 19.10b1.dev0+g6bedb5c.d20191029 documentation

[tool.black]
line-length = 88

--verbose 를 이용하면, 어느 .toml 을 사용하는지 확인할 수 있다.

black --verbose  ~/a/prog/python/gigas/gigas/lib/net.py

pyproject.toml

pyproject.toml 은 python project 의 build system requirements 를 저장하기 위한 configuration file 이다.

• PEP 518 -- Specifying Minimum Build System Requirements for Python Projects | Python.org

pre-commit

git 에 commit 하기 전에 black 을 한번 실행하게 할 수 있다. 자세한 내용은 아래 링크를 참고하자.

• Automate Python workflow using pre-commits: black and flake8