PylintC0114, C0115, C0116 missing docstring 비활성화 방법

settings — Mon, 26 Aug 2024 02:46:17 +0900

Missing module docstringPylintC0114:missing-module-docstring

Missing class docstringPylintC0115:missing-class-docstring

Missing function docstringPylintC0116:missing-functiondocstring

Pylint란?

Pylint는 파이썬 스타일 가이드인 PEP 8에서 권장하는 스타일을 따릅니다. Pylint를 사용함으로써 코드를 작성할 때 일관된 스타일을 유지하고 가독성을 향상시킬 수 있습니다. 또한 정적 분석을 통해서 오류를 찾아내는 데 도움을 주고, 코드의 품질을 높이기 위한 다양한 규칙을 제공하며, 코드 작성시 유용한 피드백을 제공합니다.

VScode익스텐션에서 검색해서 설치하시면 사용하실 수 있습니다.

문제 있는 코드:

import sys  # [missing-module-docstring]


def print_python_version():
    print(sys.version)

올바른 코드:

"""Module providing a function printing python version."""

import sys


def print_python_version():
    print(sys.version)

연두색 글자 되어 있는 """ docstring """ 이 부분이 빠졌습니다.

Docstring 비활성화 방법

1. `.pylintrc` 이름으로 파일을 만든다.

2. 아래 코드를 파일 안에 복사 붙여넣기 한다.

[MASTER]
disable=C0114 # missing-module-docstring
disable=C0115 # missing-class-docstring
disable=C0116 # missing-function-docstring

3. vscode를 껏다가 다시 켠다.

그 외 Linter

Flake8, isort, black, Ruff 등이 있습니다.

settings 님의 블로그

PylintC0114, C0115, C0116 missing docstring 비활성화 방법

Pylint란?

Docstring 비활성화 방법

그 외 Linter