Docstrings

Python intermediário para desenvolvedores

Jasmin Ludolf

Senior Data Science Content Developer

Docstrings

String (bloco de texto) que descreve uma função
Ajuda a entender como usar a função

Help on built-in function round in module builtins:

round(number, ndigits=None)

  Arredonda um número para a precisão dada em dígitos decimais.

  O retorno é um inteiro se ndigits for omitido ou None. Caso contrário,
  o retorno tem o mesmo tipo do número. ndigits pode ser negativo.

Acessando uma docstring

# Acesse informações, incluindo a 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

Acessando uma docstring

# Acesse só a docstring
print(round

Acessando uma docstring

# Acesse só a docstring
print(round.

Acessando uma docstring

# Acesse só a docstring
print(round.__

Acessando uma docstring

# Acesse só a docstring
print(round.__doc

Acessando uma docstring

# Acesse só a docstring
print(round.__doc__)

Arredonda um número para a precisão dada em dígitos decimais.

O retorno é um inteiro se ndigits for omitido ou None. Caso contrário,
o retorno tem o mesmo tipo do número. ndigits pode ser negativo.

.__doc__: atributo "dunder-doc"

Criando uma docstring

def average(values):

    # Docstring de uma linha
    """Calcula a média de uma sequência e arredonda para duas casas decimais."""

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

Acessando a docstring

# Acesse nossa docstring
print(average.__doc__)

Calcula a média de uma sequência e arredonda para duas casas decimais.

Atualizando uma docstring

# Atualize a docstring de uma função
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 multilinha

def average(values):
    """
    Calcula a média de uma sequência e arredonda para duas casas decimais.






    """

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

Docstring multilinha

def average(values):
    """
    Calcula a média de uma sequência e arredonda para duas casas decimais.

    Args:




    """

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

Docstring multilinha

def average(values):
    """
    Calcula a média de uma sequência e arredonda para duas casas decimais.

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



    """

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

Docstring multilinha

def average(values):
    """
    Calcula a média de uma sequência e arredonda para duas casas decimais.

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

    Returns:
        rounded_average (float): A média, arredondada para duas casas decimais.
    """

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

Acessando a docstring

# Ajuda
print(help(average))

Help on function average in module __main__:

average(values)
    Calcula a média de uma sequência e arredonda para duas casas decimais.

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

        Returns:
            rounded_average (float): A média, arredondada para duas casas decimais.

Vamos praticar!

Python intermediário para desenvolvedores