setup.cfg vs pyproject.toml

setup.cfg vs. pyproject.toml

setup.cfg와 pyproject.toml은 Python 프로젝트의 구성과 메타데이터를 정의하는 파일 형식이다.
이 두 파일은 프로젝트 설정, 의존성, 빌드 시스템 등을 관리하는 데 사용되며, 각각의 특징과 용도가 있다.

setup.cfg는 setuptools를 사용하는 전통적인 Python 패키징 시스템의 일부이다.

• 형식: INI 스타일의 설정 파일
• 주요 용도:
  • 프로젝트 메타데이터 정의 (이름, 버전, 설명 등)
  • 의존성 선언
  • 패키지 데이터 및 스크립트 설정
• 특징:
  • setup.py와 함께 사용되어 왔음
  • 정적 메타데이터를 선언적으로 정의하는 데 적합
  • 레거시 도구와의 호환성 유지

pyproject.toml은 PEP 518에서 도입된 새로운 표준 구성 파일이다.

• 형식: TOML (Tom’s Obvious, Minimal Language)
• 주요 용도:
  • 빌드 시스템 요구사항 정의
  • 프로젝트 메타데이터 정의
  • 다양한 개발 도구 설정 (예: Black, Pytest, Mypy 등)
• 특징:
  • 모던한 Python 패키징 시스템의 중심
  • 빌드 격리 지원
  • 다양한 빌드 백엔드 지원 (setuptools, poetry, flit 등)
  • 단일 파일에서 프로젝트 전체 설정 관리 가능

주요 차이점:

1. 표준화: pyproject.toml은 PEP 518, 621 등에 의해 표준화되어 있어 도구 간 호환성이 높다.
2. 유연성: pyproject.toml은 빌드 시스템과 도구 설정을 더 유연하게 관리할 수 있다.
3. 확장성: pyproject.toml은 다양한 도구의 설정을 통합할 수 있어 설정 파일 수를 줄일 수 있다.
4. 현대화: pyproject.toml은 최신 Python 패키징 생태계의 트렌드를 반영하고 있다.
5. 호환성: setup.cfg는 레거시 시스템과의 호환성이 더 좋다.

현재 Python 커뮤니티는 점진적으로 pyproject.toml로 이동하는 추세이지만, 많은 프로젝트들이 여전히 setup.cfg를 사용하고 있다.
새로운 프로젝트를 시작할 때는 pyproject.toml을 사용하는 것이 권장되며, 기존 프로젝트는 필요에 따라 점진적으로 마이그레이션할 수 있다.

설정 파일 비교

setup.cfg 예시

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

# setup.cfg 예시
[metadata]
name = my-project
version = 1.0.0
author = Hong Gil Dong

[options]
packages = find:
install_requires =
    requests>=2.25.0
    pandas>=1.2.0

[tool:pytest]
testpaths = tests
python_files = test_*.py

pyproject.toml 예시

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

# pyproject.toml 예시
[project]
name = "my-project"
version = "1.0.0"
authors = [
    {name = "Hong Gil Dong", email = "gildong@example.com"}
]

[project.dependencies]
requests = ">=2.25.0"
pandas = ">=1.2.0"

[tool.pytest]
testpaths = ["tests"]
python_files = ["test_*.py"]

[build-system]
requires = ["setuptools>=45", "wheel"]
build-backend = "setuptools.build_meta"

참고 및 출처