Docstrings y Type Hints
Dos pequeños detalles convierten una función que funciona en una profesional: un docstring y las anotaciones de tipo.
Un docstring es una cadena literal colocada como primerísima línea del cuerpo de la función. Explica lo que hace la función. Las herramientas y help() lo leen, y Python lo guarda en 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.Las comillas triples permiten que un docstring ocupe varias líneas, algo útil para explicaciones más largas.
Las anotaciones de tipo indican qué tipos se esperan para los parámetros y para el valor de retorno. Escribes name: type para cada parámetro y -> type para el retorno:
def add(a: int, b: int) -> int:
"""Return the sum of a and b."""
return a + bLas anotaciones no obligan a nada durante la ejecución. Python no te impedirá pasar una cadena. Son documentación que los editores y los verificadores usan para detectar errores pronto, y hacen que tus firmas se expliquen solas. Entre los tipos más comunes están int, float, str y bool.
A partir de aquí, escribe las funciones con las dos cosas: un docstring claro y anotaciones de tipo honestas.
Define una función multiply con anotaciones de tipo def multiply(a: int, b: int) -> int: y un docstring (su primera línea) que diga exactamente Return the product of a and b.. El cuerpo debe return a * b.
¿Has visto un problema en esta lección? Avísanos · Preguntar sobre esta lección
Este ejercicio se abre pronto
Termina la lección anterior y esta se desbloquea. Todo el curso es gratis, no hace falta cuenta, y puedes leer esta lección ahora mismo.
Este navegador está bloqueando las cookies de learn.floati.life, así que las lecciones que terminaste aquí no se pueden abrir en orden. Permite las cookies de este sitio y recarga.