Строки документации

Средний уровень Python для разработчиков

Jasmin Ludolf

Senior Data Science Content Developer

Строки документации

Строка (блок текста), описывающая функцию
Помогает понять, как использовать функцию

Help on built-in function round in module builtins:

round(number, ndigits=None)

  Round a number to a given precision in decimal digits.

  The return value is an integer if ndigits is omitted or None. Otherwise 
  the return value has the same type as the number. ndigits may be negative.

Доступ к строке документации

# Access information, including the docstring
print(help(round))

Help on built-in function round in module builtins:

round(number, ndigits=None)
    Round a number to a given precision in decimal digits.

    The return value is an integer if ndigits is omitted or None.  Otherwise
    the return value has the same type as the number.  ndigits may be negative.

None

Доступ к строке документации

# Access only the docstring
print(round

Доступ к строке документации

# Access only the docstring
print(round.

Доступ к строке документации

# Access only the docstring
print(round.__

Доступ к строке документации

# Access only the docstring
print(round.__doc

Доступ к строке документации

# Access only the docstring
print(round.__doc__)

Round a number to a given precision in decimal digits.

The return value is an integer if ndigits is omitted or None.  Otherwise
the return value has the same type as the number.  ndigits may be negative.

.__doc__: атрибут «dunder-doc»

Создание строки документации

def average(values):

    # One-line docstring
    """Find the mean in a sequence of values and round to two decimal places."""

    average_value = sum(values) / len(values)
    rounded_average = round(average_value, 2)
    return rounded_average

Доступ к строке документации

# Access our docstring
print(average.__doc__)

Find the mean in a sequence of values and round to two decimal places.

Обновление строки документации

# Update a function's docstring
average.__doc__ = "Calculate the mean of values in a data structure, rounding the results to 2 digits."


print(help(average))

Help on function average in module __main__:

average(values)
    Calculate the mean of values in a data structure, rounding the results to 2 digits.

Многострочная строка документации

def average(values):
    """
    Find the mean in a sequence of values and round to two decimal places.






    """

    average_value = sum(values) / len(values)
    rounded_average = round(average_value, 2)
    return rounded_average

Многострочная строка документации

def average(values):
    """
    Find the mean in a sequence of values and round to two decimal places.

    Args:




    """

    average_value = sum(values) / len(values)
    rounded_average = round(average_value, 2)
    return rounded_average

Многострочная строка документации

def average(values):
    """
    Find the mean in a sequence of values and round to two decimal places.

    Args:
        values (list): A list of numeric values.



    """

    average_value = sum(values) / len(values)
    rounded_average = round(average_value, 2)
    return rounded_average

Многострочная строка документации

def average(values):
    """
    Find the mean in a sequence of values and round to two decimal places.

    Args:
        values (list): A list of numeric values.

    Returns:
        rounded_average (float): The mean of values, rounded to two decimal places.
    """

    average_value = sum(values) / len(values)
    rounded_average = round(average_value, 2)
    return rounded_average

Доступ к строке документации

# Help
print(help(average))

Help on function average in module __main__:

average(values)
    Find the mean in a sequence of values and round to two decimal places.

        Args:
            values (list): A list of numeric values.

        Returns:
            rounded_average (float): The mean of values, rounded to two decimal places.

Давайте потренируемся!

Средний уровень Python для разработчиков