docformatter

문서 포맷터

암호
독스트링
GitHub
파이파이

PEP 257을 따르도록 독스트링의 형식을 지정합니다.

특징

docformatter PEP 257 규칙의 하위 집합을 따르도록 독스트링의 형식을 자동으로 지정합니다. 다음은 PEP 257에서 인용된 관련 항목입니다.

• 일관성을 위해 항상 독스트링 주위에 삼중 큰따옴표를 사용하십시오.
• 문자열이 한 줄에 들어가더라도 삼중 따옴표가 사용됩니다.
• 여러 줄 독스트링은 한 줄 독스트링과 마찬가지로 요약 줄, 빈 줄, 더 자세한 설명으로 구성됩니다.
• 전체 독스트링이 한 줄에 맞지 않는 한, 닫는 따옴표만 한 줄에 배치하세요.

docformatter PEP 8 규칙 중 일부도 처리합니다.

• 상당한 후행 공백에 의존하는 문자열 리터럴을 작성하지 마세요. 이러한 후행 공백은 시각적으로 구별할 수 없으며 일부 편집자(또는 최근에는 reindent.py)가 이를 잘라냅니다.

docformatter --black 옵션을 전달하면 black 과 호환되는 독스트링의 형식을 지정합니다.

docformatter Epytext 또는 Sphinx 스타일을 사용하는 필드 목록 형식을 지정합니다.

read-the-docs의 전체 문서를 참조하세요. 특히 PEP 257 및 기타 요구 사항에 대한 자세한 내용은 요구 사항 섹션을 참조하세요.

설치

핍에서:

 $ pip install --upgrade docformatter

또는 pyproject.toml을 사용하여 docformatter를 구성하고 Python < 3.11을 사용하는 경우:

 $ pip install --upgrade docformatter[tomli]

Python >=3.11에서는 표준 라이브러리의 tomllib 사용됩니다.

또는 릴리스 후보(또는 다른 태그)를 사용하려는 경우:

 $ pip install git+https://github.com/PyCQA/docformatter.git@

여기서 는 설치하려는 릴리스 후보 태그입니다. 릴리스 후보 태그는 v1.6.0-rc1 형식을 갖습니다. 릴리스 후보는 Github 릴리스로도 제공됩니다.

예

실행 후:

 $ docformatter --in-place example.py

이 코드

 """   Here are some examples.

    This module docstring should be dedented."""


def launch_rocket ():
    """Launch
the
rocket. Go colonize space."""


def factorial ( x ):
    '''

    Return x factorial.

    This uses math.factorial.

    '''
    import math
    return math . factorial ( x )


def print_factorial ( x ):
    """Print x factorial"""
    print ( factorial ( x ))


def main ():
    """Main
    function"""
    print_factorial ( 5 )
    if factorial ( 10 ):
        launch_rocket ()

이것으로 포맷됩니다

 """Here are some examples.

This module docstring should be dedented.
"""


def launch_rocket ():
    """Launch the rocket.

    Go colonize space.
    """


def factorial ( x ):
    """Return x factorial.

    This uses math.factorial.
    """
    import math
    return math . factorial ( x )


def print_factorial ( x ):
    """Print x factorial."""
    print ( factorial ( x ))


def main ():
    """Main function."""
    print_factorial ( 5 )
    if factorial ( 10 ):
        launch_rocket ()

마케팅

docformatter를 사용하시나요? 어떤 스타일의 독스트링을 사용하시나요? 프로젝트의 README 에 배지를 추가하고 모두에게 알리세요.

 .. 이미지:: https://img.shields.io/badge/%20formatter-docformatter-fedcba.svg
    :대상: https://github.com/PyCQA/docformatter

.. 이미지:: https://img.shields.io/badge/%20style-sphinx-0a507a.svg
    :대상: https://www.sphinx-doc.org/en/master/usage/index.html

.. 이미지:: https://img.shields.io/badge/%20style-numpy-459db9.svg
    :대상: https://numpydoc.readthedocs.io/en/latest/format.html

.. 이미지:: https://img.shields.io/badge/%20style-google-3666d6.svg
    :대상: https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings

문제

버그와 패치는 GitHub 페이지에서 보고할 수 있습니다.