Tutorial de funciones de Python

Funciones en Python

Las funciones se utilizan en programación para agrupar un conjunto de instrucciones que quieres utilizar repetidamente o que, debido a su complejidad, es mejor que estén contenidas en un subprograma y que se invoquen cuando sea necesario. Eso significa que una función es un fragmento de código escrito para realizar una tarea determinada. Para llevar a cabo esa tarea específica, la función puede necesitar o no varias entradas. Cuando se realiza la tarea, la función puede o no devolver uno o más valores.

En Python hay tres tipos de funciones:

• Funciones integradas, como help() para pedir ayuda, min() para obtener el valor mínimo, print() para imprimir un objeto en el terminal... Tienes un resumen con más funciones de este tipo aquí.
• Funciones definidas por el usuario (UDF), que son funciones que los usuarios crean para que les sirvan de ayuda.
• Funciones anónimas, que también se llaman funciones lambda, porque no se declaran con la palabra clave estándar def.

Funciones frente a métodos

Un método es una función que forma parte de una clase. Accedes a él con una instancia u objeto de la clase. Una función no tiene esta restricción: solo hace referencia a una función independiente. Esto significa que todos los métodos son funciones, pero no todas las funciones son métodos.

Te ponemos un ejemplo en el que primero defines una función plus() y luego una clase Summation con un método sum():

Si ahora quieres invocar el método sum(), que forma parte de la clase Summation, primero tienes que definir una instancia u objeto de esa clase. Así pues, definamos dicho objeto:

Recuerda que esta instanciación no es necesaria cuando quieras invocar la función plus(). Podrías ejecutar plus(1,2) en el fragmento de código de DataCamp Light sin ningún problema.

Parámetros frente a argumentos

Los parámetros son los nombres utilizados para definir una función o un método, y a los que se asignarán los argumentos. Es decir: los argumentos son las cosas que se suministran a cualquier llamada a una función o método, mientras que el código de la función o método hace referencia a los argumentos por sus nombres de parámetro.

Observa el siguiente ejemplo y vuelve a mirar el fragmento anterior de DataCamp Light: pasas dos argumentos al método sum() de la clase Summation, aunque previamente hayas definido tres parámetros, que son self, a y b.

¿Qué ha pasado con self?

El primer argumento de todo método de clase es siempre una referencia a la instancia actual de la clase, que en este caso es Summation. Por convención, este argumento se llama self.

Todo esto significa que en este caso no pasas la referencia a self porque self es el nombre de parámetro de un argumento pasado implícitamente que hace referencia a la instancia con la que se invoca un método. Se inserta implícitamente en la lista de argumentos.

Cómo definir una función: Funciones definidas por el usuario (UDF)

Los cuatro pasos para definir una función en Python son los siguientes:

1. Utiliza la palabra clave def para declarar la función y escribe a continuación el nombre de la función.
2. Añade parámetros a la función: deben estar dentro del paréntesis de la función. Termina la línea con dos puntos.
3. Añade sentencias que deban ejecutar las funciones.
4. Termina tu función con una sentencia de devolución si la función debe producir algún resultado. Sin la sentencia de devolución, tu función devolverá un objeto None.

Por supuesto, tus funciones se harán más complejas a medida que avances: puedes añadirle bucles for, control de flujo y más cosas para hacerlas más precisas.

def hello():
  name = str(input("Enter your name: "))
  if name:
    print ("Hello " + str(name))
  else:
    print("Hello World") 
  return 
  
hello()

En la función anterior, pides al usuario que dé un nombre. Si no se da ningún nombre, la función imprimirá "Hello World". De lo contrario, el usuario obtendrá una respuesta personalizada de "Hello".

Recuerda que también que puedes definir uno o más parámetros de función para tu UDF. Aprenderás más sobre esto cuando abordes la sección Argumentos de las funciones. Además, puedes o no devolver uno o varios valores como resultado de tu función.

La return sentencia

Ten en cuenta que, como estás imprimiendo algo en tu UDF hello(), en realidad no necesitas devolverlo. No habrá ninguna diferencia entre la función anterior y esta:

Sin embargo, si quieres seguir trabajando con el resultado de tu función y probar algunas operaciones en él, tendrás que utilizar la sentencia return para devolver realmente un valor, como una cadena, un entero.... Observa el siguiente caso, en el que hello() devuelve una cadena "hello", mientras que la función hello_noreturn() devuelve None:

La segunda función te da un error porque no puedes realizar ninguna operación con None. Obtendrás TypeError, que dice que no puedes hacer la operación de multiplicación para NoneType (None que es el resultado de hello_noreturn()) y int (2).

Consejo Las funciones salen inmediatamente cuando se encuentran con una sentencia return, aunque eso signifique que no devolverán ningún valor:

Otra cosa que merece la pena mencionar cuando trabajas con la sentencia return es el hecho de que puedes utilizarla para devolver varios valores. Para ello, utiliza tuplas.

Recuerda que esta estructura de datos es muy similar a una lista: puede contener varios valores. Sin embargo, las tuplas son inmutables, lo que significa que no puedes modificar ninguna cantidad almacenada en ellas. Las construyes con ayuda de dobles paréntesis (). Puedes descomponer tuplas en varias variables con la ayuda de la coma y el operador de asignación.

Echa un vistazo al siguiente ejemplo para entender cómo puede devolver tu función varios valores:

Observa que la sentencia return return sum, a tendría el mismo resultado que return (sum, a): la primera en realidad incluye sum y a en una tupla.

Cómo invocar una función

En las secciones anteriores ya has visto muchos ejemplos de cómo puedes invocar una función. Invocar una función significa ejecutar la función que has definido, ya sea directamente desde el prompt de Python o a través de otra función (como verás en la sección "Funciones anidadas").

Invoca tu función recién definida hello() simplemente ejecutando hello(), igual que en el fragmento de DataCamp Light que aparece a continuación:

Cómo añadir Docstrings a una función de Python

Otro aspecto esencial de la escritura de funciones en Python: las docstrings. Las Docstrings describen lo que hace tu función, como los cálculos que realiza o los valores que devuelve. Estas descripciones sirven como documentación de tu función para que cualquiera que lea la docstring de tu función entienda lo que hace tu función, sin tener que ver todo el código de la definición de la función.

Las docstrings de las funciones se colocan en la línea inmediatamente posterior a la cabecera de la función y entre comillas triples. Una Docstring apropiada para tu función hello() es ‘Prints “Hello World”’.

def hello():
"""Prints "Hello World".

Returns:
    None
"""
  print("Hello World") 
  return 

Ten en cuenta que las docstrings pueden ser más extensas que la que se da aquí como ejemplo. Si quieres estudiar las docstrings con más detalle, lo mejor es que consultes algunos repositorios de Github de bibliotecas de Python como scikit-learn o pandas, donde encontrarás un montón de ejemplos.

Argumentos de función en Python

Antes has aprendido la diferencia entre parámetros y argumentos. En resumen, los argumentos son las cosas que se suministran a cualquier llamada a una función o método, mientras que el código de la función o método hace referencia a los argumentos por sus nombres de parámetro. Hay cuatro tipos de argumentos que pueden usar las UDF de Python:

• Argumentos por defecto
• Argumentos obligatorios
• Argumentos de palabra clave
• Número variable de argumentos

def double(x):
  return x*2

class Dog:
    """    
    Requires:
    legs - Legs so that the dog can walk.
    color - A color of the fur.
    """

    def __init__(self, legs, color):
        self.legs = legs
        self.color = color
        
    def bark(self):
        bark = "bark" * 2
        return bark

if __name__ == "__main__":
    dog = Dog(4, "brown")
    bark = dog.bark()
    print(bark)