Docstrings

Entwicklung mit Python für Fortgeschrittene

Jasmin Ludolf

Senior Data Science Content Developer

Docstrings

Zeichenkette (Textblock), die eine Funktion beschreibt
Hilft den Nutzenden, die Verwendung einer Funktion zu verstehen.

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.

Auf eine Docstring zugreifen

# 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

Auf eine Docstring zugreifen

# Access only the docstring
print(round

Auf eine Docstring zugreifen

# Access only the docstring
print(round.

Auf eine Docstring zugreifen

# Access only the docstring
print(round.__

Auf eine Docstring zugreifen

# Access only the docstring
print(round.__doc

Auf eine Docstring zugreifen

# 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“-Attribut

Erstellen eines Docstring

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

Zugriff auf den Docstring

# Access our docstring
print(average.__doc__)

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

Einen Docstring aktualisieren

# 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.

Mehrzeilige Docstrings

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

Mehrzeilige Docstrings

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

Mehrzeilige Docstrings

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

Mehrzeilige Docstrings

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

Zugriff auf den Docstring

# 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.

Lass uns üben!

Entwicklung mit Python für Fortgeschrittene