monoBOT

Hola, estos dias he estado de vacaciones y con algo de tiempo libre para mi Hobby … Python

Bueno pues he estado mirándome los Test y en particular el modulo doctest de Python.
Básicamente me han vendido el tema de los test en los módulos que vas creando y a partir de ahora cuando haga cualquier función intentaré implementar el doctest para que se pueda ver sobre la marcha si hay errores y si los hubiera poderlos encontrar sobre la marcha antes de que se siga enrollando la madeja.

Para empezar explicaré que son los Test en programación, se trata simplemente de probar las funciones/modulos/clases/loquesea con el objeto de correr tu código en una cantidad de escenarios tal que puedas encontrar los errores si los hubiera. El objeto de ello es poder conocer en todo momento que lo que has hecho está bien y funciona.
Esto parece una tontería pero cuando piensas que tu modulo va dentro de una madeja mas o menos enrrollada de funciones variables, y entornos la cosa se puede complicar bastante.

En Python como ellos dicen viene con las pilas cargadas y ya (gente mas lista que nosotros o al menos gente que llego antes) existen modulos que se encargan exactamente de esto de hacer el Test de nuestros códigos.
En particular el modulo doctest hace algo muy inteligente usando un poco de azúcar sintáctica podemos escribir los test en el mismo código con el objeto de que el propio modulo se autochequee y así encontrar los problemas en cuanto se produzcan.

Explicarlo es mas difícil que demostrarlo, aquí va un ejemplo:

pruebas.py

def compLetras(c):
    '''
    @funcionamiento: comprueba que el caracter que pulsamos es una letra o un numero
    @argumentos: un caracter
    @return: bool
 
    @Test
 
    >>> compLetras('c')
    True
    >>> compLetras('D')
    True
    >>> compLetras('1')
    False
 
    Si metemos mas de un caracter obviamente devuelve False 
    porq esta creado para un solo caracter.
    >>> compLetras('Db')
    False
 
    >>> compLetras('12')
    False
 
    Prueba de que un texto largo tiene letras o numeros.
    >>> for c in 'abc123':
    ...     compLetras(c)
    True
    True
    True
    False
    False
    False
    '''
    import string
    if c in string.letters:
        return True
    else:
        return False
 
if __name__ == "__main__":
    import doctest
    doctest.testmod(verbose=True)

como veis esta es una funcion chorra lo que hace es comprobar que un caracter es letra o no y devuelve un booleano.
El chiste esta en que en el propio doc de la funcion podemos ver los test escritos como si de la propia consola de python se tratara, vamos pasando varias alternativas y mostrando lo que se ha de devolver python.
El truco if __name__ == ‘__main__’: le metemos el propio doctest le he puesto el verbose=True para que devuelva algo y no tenga salida silenciosa. Así por ejemplo si hacer nuestro programa a todos los modulos y sus funciones los preparamos para el doctest pues simplemente creamos un fichero bat como este con todos los modulos y podremos comprobar que todo sigue funcionando correctamente!!!

comprobador.bat

python pruebas.py