Docstrings

Python intermedio para desarrolladores

Jasmin Ludolf

Senior Data Science Content Developer

Docstrings

Cadena (bloque de texto) que describe una función
Ayuda a entender cómo usar una función

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.

Acceder a un docstring

# Accede a la información, incluido el 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

Acceder a un docstring

# Accede solo al docstring
print(round

Acceder a un docstring

# Accede solo al docstring
print(round.

Acceder a un docstring

# Accede solo al docstring
print(round.__

Acceder a un docstring

# Accede solo al docstring
print(round.__doc

Acceder a un docstring

# Accede solo al 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__: atributo "dunder-doc"

Crear un docstring

def average(values):

    # Docstring de una línea
    """Calcula la media de una secuencia y redondea a dos decimales."""

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

Acceder al docstring

# Accede a nuestro docstring
print(average.__doc__)

Calcula la media de una secuencia y redondea a dos decimales.

Actualizar un docstring

# Actualiza el docstring de una función
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 multilínea

def average(values):
    """
    Calcula la media de una secuencia y redondea a dos decimales.






    """

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

Docstring multilínea

def average(values):
    """
    Calcula la media de una secuencia y redondea a dos decimales.

    Args:




    """

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

Docstring multilínea

def average(values):
    """
    Calcula la media de una secuencia y redondea a dos decimales.

    Args:
        values (list): Lista de valores numéricos.



    """

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

Docstring multilínea

def average(values):
    """
    Calcula la media de una secuencia y redondea a dos decimales.

    Args:
        values (list): Lista de valores numéricos.

    Returns:
        rounded_average (float): Media de los valores, redondeada a dos decimales.
    """

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

Acceder al docstring

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

¡Vamos a practicar!

Python intermedio para desarrolladores