[Python] Pylint(파이린트) Docstring 비활성화하는 방법

2023-02-15

린트(lint)란

린트(lint) 또는 린터(linter)는 소스 코드를 분석하여 프로그램 오류, 버그, 스타일 오류, 의심스러운 구조체에 표시(flag)를 달아놓기 위한 도구들을 말합니다.

Pylint는 Python 프로그래밍 언어를 위한 정적 코드 분석 도구로 Python 스타일 가이드인 PEP 8에서 권장하는 스타일을 따릅니다.

Pylint는 기본적으로 모든 함수와 메서드에서 docstring이 작성되지 않은 경우 경고 메시지를 표시합니다. 그러나 이 동작을 비활성화할 수 있습니다.

프로젝트 루트 디렉토리에 .pylintrc 파일을 생성하고, 다음과 같은 내용을 추가합니다.

pylint --generate-rcfile > .pylintrc

[pylint]
disable = missing-docstring

위 설정을 추가하면, missing-docstring 경고가 표시되지 않습니다.
.pylintrc 파일을 저장하고 PyLint를 다시 실행하여 해당 경고가 표시되지 않는지 확인합니다.

만약, docstring은 작성하지 않지만 public method와 function에 대해서는 docstring이 필수인 경우, 다음과 같이 public-methods를 추가합니다

[pylint]
disable = missing-docstring

[DESIGN]
# Public methods should have docstrings
public-methods = True

위 설정은 모든 docstring 경고를 비활성화하면서 public method에 대해서만 docstring을 필수화합니다.

추가적인 Pylint 설정 변경은 다음과 같은 링크를 참고해주세요.