Fastapi

Chapter 1-3 Python 코드 포매터 Black 설치 및 설정 가이드

Chansman 2025. 5. 23. 10:24

🧹 Python 코드 포매터 Black 설치 및 설정 가이드

🧾 Black이란?

  • Black은 **Python 코드 자동 정렬 도구(formatter)**입니다.
  • 수십 명이 협업하는 실무 환경에서 일관된 코드 스타일을 유지하도록 도와주는 중요한 도구입니다.
  • 작성한 코드를 PEP 8 및 자체 포맷 기준에 맞게 자동으로 정리해줍니다.

🔗 공식 깃허브: https://github.com/psf/black

⚙️ 설치 방법

poetry add --group=dev black==24.10.0
  • 개발 환경 전용으로 --group=dev 옵션을 사용
  • 설치 후 pyproject.toml에 자동 등록됨

▶️ Black 실행 방법

  1. 프로젝트 루트 디렉터리에서 실행:
poetry run black .
  1. 포매팅 예시
print("Life is Toooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo Short")

실행하면 자동으로 줄바꿈되어 가독성 있게 포맷됩니다.

🛠️ Black 설정 (pyproject.toml)

[tool.black]
line-length = 120
  • [tool.black]은 섹션 단위로 설정을 지정합니다.
  • line-length = 120 : 줄 바꿈 기준을 120자로 설정 (요즘 모니터 기준 최적화)

📘 공식문서: https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#configuration-via-a-file

🧑‍💻 PyCharm 연동 팁

  • PyCharm의 Code Style 설정에서 Hard wrap at 120으로 지정하면, IDE 상에서도 동일한 라인 길이 기준으로 줄바꿈이 적용됩니다.

🔁 Recap

  • ✅ black은 협업 시 코드 스타일을 통일시켜주는 필수 도구입니다.
  • ✅ poetry를 이용해 손쉽게 설치 및 그룹별 관리 가능
  • ✅ pyproject.toml 하나로 다양한 설정 통합 가능
  • ✅ line-length 기본값을 120자로 설정해 가독성을 높일 수 있음
  • ✅ 설치 후에는 꼭 git commit을 잊지 말고 기록하세요 🙂