Funciones en Python

En Python, una función es un bloque de código que se puede reutilizar para llevar a cabo una tarea específica. Las funciones nos permiten dividir nuestro código en partes más pequeñas y manejables, lo que facilita su mantenimiento y reutilización.

Definición de funciones

Para definir una función en Python, utilizamos la palabra clave def seguida del nombre de la función y dos puntos (:). Luego, escribimos el código de la función indentado con cuatro espacios o un tabulador.

A continuación, se muestra un ejemplo de cómo definir una función simple que imprime un mensaje:

def saludar():
    print("¡Hola, bienvenido al curso de Python 3!")

Llamando a una función

Después de definir una función, podemos llamarla en cualquier parte de nuestro programa utilizando su nombre, seguido de paréntesis.

saludar()

Al llamar a esta función, se imprimirá el mensaje ¡Hola, bienvenido al curso de Python 3!

Documentación de funciones

Es una buena práctica documentar nuestras funciones para que otros desarrolladores (o incluso nosotros en el futuro) puedan comprender cómo utilizarlas correctamente. Python proporciona una forma de agregar documentación a nuestras funciones utilizando las docstrings.

Las docstrings son cadenas de caracteres que aparecen como el primer elemento del cuerpo de una función, y su objetivo es describir brevemente la funcionalidad de la función. Se recomienda utilizar comillas triples para envolver las docstrings, ya que nos permiten escribir varias líneas de texto.

A continuación, se muestra un ejemplo de cómo documentar una función:

def suma(a, b):
    """
    Esta función recibe dos números como argumentos y devuelve su suma.
    """
    return a + b

Pruebas unitarias

Las pruebas unitarias son una forma efectiva de verificar que nuestras funciones funcionen como se espera. En Python, podemos utilizar el módulo unittest para escribir y ejecutar pruebas unitarias.

A continuación, se muestran cuatro ejemplos de funciones con sus respectivas pruebas unitarias y el resultado esperado:

Ejemplo 1: sumar dos números

def sumar(a, b):
    return a + b
import unittest
class TestSumar(unittest.TestCase):
    def test_sumar(self):
        self.assertEqual(sumar(2, 3), 5)
        self.assertEqual(sumar(10, 5), 15)
if __name__ == '__main__':
    unittest.main()

Resultado esperado:

..
----------------------------------------------------------------------
Ran 2 tests in 0.001s
OK

Ejemplo 2: calcular el área de un triángulo

def calcular_area(base, altura):
    return (base * altura) / 2
import unittest
class TestCalcularArea(unittest.TestCase):
    def test_calcular_area(self):
        self.assertEqual(calcular_area(5, 4), 10)
        self.assertEqual(calcular_area(10, 8), 40)
if __name__ == '__main__':
    unittest.main()

Resultado esperado:

..
----------------------------------------------------------------------
Ran 2 tests in 0.001s
OK

Ejemplo 3: verificar si un número es par

def es_par(numero):
    return numero % 2 == 0
import unittest
class TestEsPar(unittest.TestCase):
    def test_es_par(self):
        self.assertTrue(es_par(4))
        self.assertFalse(es_par(7))
if __name__ == '__main__':
    unittest.main()

Resultado esperado:

..
----------------------------------------------------------------------
Ran 2 tests in 0.001s
OK

Ejemplo 4: calcular el factorial de un número

def factorial(numero):
    if numero == 0 or numero == 1:
        return 1
    else:
        return numero * factorial(numero - 1)
import unittest
class TestFactorial(unittest.TestCase):
    def test_factorial(self):
        self.assertEqual(factorial(5), 120)
        self.assertEqual(factorial(0), 1)
if __name__ == '__main__':
    unittest.main()

Resultado esperado:

..
----------------------------------------------------------------------
Ran 2 tests in 0.001s
OK

Buenas prácticas

Es importante seguir buenas prácticas al escribir funciones en Python para mantener un código limpio y legible. Algunas de estas prácticas incluyen:

• Utilizar nombres descriptivos para las funciones.
• Añadir comentarios que expliquen el propósito de la función y la funcionalidad clave.
• Evitar funciones demasiado largas y dividirlas en funciones más pequeñas si es necesario.
• No repetir código y utilizar funciones para reutilizar código en lugar de copiarlo y pegarlo.
• Ser consistente con el estilo de código y seguir las convenciones de codificación de Python (por ejemplo, PEP 8).

Código limpio

Escribir un código limpio es fundamental para un buen desarrollo en Python. Algunas recomendaciones para lograrlo son:

• Utilizar nombres de variables y funciones descriptivos y significativos.
• Mantener una indentación consistente para mejorar la legibilidad.
• Evitar líneas de código demasiado largas y dividirlas si es necesario.
• Utilizar comentarios para explicar partes más complejas o confusas del código.
• Eliminar código muerto o comentarios innecesarios.
• Seguir las convenciones de estilo y guías de estilo de Python.

Con estas prácticas a seguir, podremos escribir funciones en Python de manera más compacta, legible y mantenible.

¡Sigue practicando y mejorando tus habilidades en Python!