Docstrings

Python intermédiaire pour développeurs et développeuses

Jasmin Ludolf

Senior Data Science Content Developer

Docstrings

Chaîne (bloc de texte) qui décrit une fonction
Aide à comprendre comment utiliser une fonction

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.

Accéder à une docstring

# Accéder à l'information, y compris la 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

Accéder à une docstring

# Accéder seulement à la docstring
print(round

Accéder à une docstring

# Accéder seulement à la docstring
print(round.

Accéder à une docstring

# Accéder seulement à la docstring
print(round.__

Accéder à une docstring

# Accéder seulement à la docstring
print(round.__doc

Accéder à une docstring

# Accéder seulement à la 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__ : attribut « dunder-doc »

Créer une docstring

def average(values):

    # Docstring sur une ligne
    """Trouver la moyenne d'une séquence de valeurs et arrondir à deux décimales."""

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

Accéder à la docstring

# Accéder à notre docstring
print(average.__doc__)

Trouver la moyenne d'une séquence de valeurs et arrondir à deux décimales.

Mettre à jour une docstring

# Mettre à jour la docstring d'une fonction
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.

Docstring multilignes

def average(values):
    """
    Trouver la moyenne d'une séquence de valeurs et arrondir à deux décimales.






    """

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

Docstring multilignes

def average(values):
    """
    Trouver la moyenne d'une séquence de valeurs et arrondir à deux décimales.

    Args:




    """

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

Docstring multilignes

def average(values):
    """
    Trouver la moyenne d'une séquence de valeurs et arrondir à deux décimales.

    Args:
        values (list): Une liste de valeurs numériques.



    """

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

Docstring multilignes

def average(values):
    """
    Trouver la moyenne d'une séquence de valeurs et arrondir à deux décimales.

    Args:
        values (list): Une liste de valeurs numériques.

    Returns:
        rounded_average (float): La moyenne des valeurs, arrondie à deux décimales.
    """

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

Accéder à la docstring

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

Passons à la pratique !

Python intermédiaire pour développeurs et développeuses