Conteúdo do curso Lição 25 de 250 · Funções
Funções

Docstrings e Type Hints

Dois pequenos toques transformam uma function funcional em uma profissional: uma docstring e type hints.

A docstring é um literal de string colocado como a primeira linha do corpo da função. Ele explica o que a função faz. Ferramentas e help() leem isso, e o Python o armazena em function.__doc__:

def add(a, b):
    """Return the sum of a and b."""
    return a + b

print(add.__doc__)   # Return the sum of a and b.

Aspas triplas permitem que uma docstring ocupe várias linhas, o que é útil para explicações mais longas.

Type hints anotam quais tipos os parâmetros e o valor de retorno devem ser. Você escreve name: type para cada parâmetro e -> type para o retorno:

def add(a: int, b: int) -> int:
    """Return the sum of a and b."""
    return a + b

Hints não forçam nada em tempo de execução. O Python não vai te impedir de passar uma string. Eles são documentações que editores e verificadores usam para pegar erros cedo, e eles tornam suas assinaturas autoexplicativas. Tipos comuns de hint incluem int, float, str e bool.

A partir de agora, escreva funções com ambos: uma docstring clara e type hints honestos.

Sua vez

Defina uma função multiply com type hints def multiply(a: int, b: int) -> int: e uma docstring (sua primeira linha) lendo exatamente Return the product of a and b.. O corpo deve return a * b.

Viu um problema nesta lição? Reporte-o · Pergunte sobre esta lição

Este exercício abre em breve

Termine a lição anterior para que esta seja desbloqueada. O curso inteiro é gratuito, não precisa de conta, e você pode ler esta lição agora mesmo.