econchick/interrogate

어떤 프로젝트인가요?

핵심 기능

• 01모듈, 클래스, 메서드, 함수의 docstring 커버리지를 보고합니다.
• 02CI에서 사용할 수 있도록 커버리지가 설정 가능한 임계값보다 낮으면 실행을 실패 처리합니다.
• 03요약, 상세, quiet 출력 모드를 제공합니다.
• 04magic method, private 또는 중첩 객체 등 선택한 객체 유형을 제외합니다.
• 05Sphinx 및 Google docstring 스타일을 지원합니다.
• 06shields.io 스타일의 커버리지 배지를 SVG 또는 PNG 형식으로 생성합니다.

활용 사례

• CI 작업이나 pre-commit hook을 통해 새 코드에 docstring 작성을 요구합니다.
• 익숙하지 않은 Python 코드베이스가 얼마나 잘 문서화되어 있는지 평가합니다.
• 프로젝트 README에 문서화 커버리지 배지를 표시합니다.
• 문서 정비 작업 중 파일별 문서화 공백을 추적합니다.

빠른 시작

1. 1

   pip으로 PyPI에서 interrogate를 설치합니다

   pip install interrogate
2. 2

   Python 프로젝트 경로에서 interrogate를 실행해 docstring 커버리지를 확인합니다

   interrogate [PATH]

사용 전 알아둘 점

• !docstring의 존재 여부만 측정하며 품질은 평가하지 않습니다.
• !PNG 배지를 생성하려면 cairo와 같은 추가 시스템 라이브러리가 필요합니다.

포함된 컬렉션

토픽

자주 묻는 질문

interrogate은(는) 무엇인가요?

코드베이스의 함수, 클래스, 메서드, 모듈 중 docstring이 작성된 항목의 비율을 측정하고, CI에 적합한 통과·실패 기준을 적용하는 Python CLI입니다. interrogate는 Python 소스 코드를 스캔해 docstring이 있는 모듈, 클래스, 메서드, 함수와 없는 항목을 보고합니다. 프로젝트, 파일 또는 객체 단위로 커버리지 비율을 제공하므로 코드 문서화가 얼마나 잘되어 있는지, 어느 부분에 공백이 있는지 확인할 수 있습니다.

interrogate은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?

interrogate은(는) MIT 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.

interrogate은(는) 아직 유지보수되고 있나요?

활발히 유지보수 중. interrogate의 마지막 커밋은 2026년 11월 2일입니다.

interrogate은(는) 어디에 사용할 수 있나요?

CI 작업이나 pre-commit hook을 통해 새 코드에 docstring 작성을 요구합니다. 익숙하지 않은 Python 코드베이스가 얼마나 잘 문서화되어 있는지 평가합니다. 프로젝트 README에 문서화 커버리지 배지를 표시합니다. 문서 정비 작업 중 파일별 문서화 공백을 추적합니다.

interrogate는 어떻게 설치하나요?

pip으로 PyPI에서 interrogate를 설치합니다: pip install interrogate Python 프로젝트 경로에서 interrogate를 실행해 docstring 커버리지를 확인합니다: interrogate [PATH]

interrogate은(는) 어디서 받을 수 있나요?

소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/econchick/interrogate