Python Google-стиль DocString для функции без аргументов - PullRequest
Новая
       32

Python Google-стиль DocString для функции без аргументов

0 голосов
/ 22 марта 2020

Я уже давно использую формат Docstring для Google-Style Python. То, как я обрабатывал функции / методы без аргументов, неожиданно для меня не выглядит правильным. Я немного искал и не мог найти в Интернете ничего, что указывало бы, как справиться с этой ситуацией.

Когда нет возврата, я видел, что None используется, и я в порядке с этим, потому что это технически то, что возвращается . Тем не менее, использование None для аргументов может означать, что на самом деле ожидается единственный аргумент типа: NoneType.

В настоящее время то, что я делал, выглядит примерно так: 

def foo():
    """
    blah blah blah

    Args:
        None
    Returns:
        The number 5
    """
    return 5

Мой вопрос: какой формат я должен использовать вместо этого (я предпочитаю всегда иметь раздел Args)? Или, может быть, мой нынешний подход не так уж плох и является обычной практикой.

Некоторые другие кандидаты (не стесняйтесь предоставить свой, если вы считаете, что есть лучший формат): 

def foo():
    """
    blah blah blah

    Args:

    Returns:
        The number 5
    """
    return 5

def foo():
    """
    blah blah blah

    Args:
        No arguments
    Returns:
        The number 5
    """
    return 5

def foo():
    """
    blah blah blah

    Returns:
        The number 5
    """
    return 5
...