Pylint - docstring "Missing function or method docstring" 메시지

Pylint는 파이썬 코드의 품질을 향상시키기 위한 도구로, 코드의 구문 오류, 스타일 오류, 잠재적인 버그 등을 검사한다. 이 중 "Missing function or method docstring" 메시지는 함수나 메서드에 docstring이 없음을 나타난다.

docstring이란?

docstring은 함수나 클래스, 모듈의 목적, 사용 방법, 반환값 등을 설명하는 주석이다. docstring을 작성하면 코드의 이해도를 높이고, 다른 개발자가 코드를 이해하고 수정하기 쉽게 할 수 있다.

docstring의 구조

docstring은 세 부분으로 구성된다.

• 개요(summary)

함수나 메서드의 목적을 한 문장으로 요약

• 문서화(documentation

함수나 메서드의 사용 방법, 반환값, 입력값 등을 설명

• 예제(example)

함수나 메서드의 사용 예

docstring의 작성 방법

docstring은 다음과 같은 형식으로 작성한다.

def 함수명(입력값):

    """

    개요

    문서화

    예제

    """

    ...

 

예를 들어, 다음과 같은 함수를 작성했다고 가정해보자.

def add(a, b):
    return a + b

이 함수에 docstring을 작성하면 다음과 같이 작성할 수 있다.

def add(a, b):
    """
    두 수를 더합니다.
    입력값:
        a: 더할 첫 번째 수
        b: 더할 두 번째 수
    반환값:
        a + b

    예제:
    >>> add(1, 2)
    3
    """
    return a + b

 

docstring을 작성하지 않으면

docstring을 작성하지 않으면 Pylint는 다음과 같은 메시지를 출력된다.

[E0202] Missing function or method docstring (missing-function-docstring)

이 메시지를 없애려면 함수나 메서드에 docstring을 작성하면 된다.

docstring을 간단하게 작성하려면

docstring을 작성하기 귀찮다면 '''으로 간단히 주석만 남겨도 Pylint의 메시지를 없앨 수 있다.

def add(a, b):
    '''두 수를 더합니다.'''
    return a + b

 

그러나 이렇게 하면 함수나 메서드의 목적이나 사용 방법이 명확하지 않아 다른 개발자가 코드를 이해하기 어려울 수 있다. 따라서 가능하면 docstring을 작성하는 것이 좋다.