cantinaUtils 0.0.6

The Utils package for Cantina

CantinaUtils

Le module python utilitaire de Cantina

Documentation

cantinaUtils.Database

Database.exec:

Arguments :

body: (str) Le corps de la requête SQL.
args: (list) Les différents arguments utilisé dans l'argument body.

Cette fonction sert à executer une requête SQL, qui modifie la base de données (INSERT, UPDATE, DROP...)
La fonction ne renvoie rien.

Database.select:

Arguments :

body: (str) Le corps de la requête SQL.
args: (list) Les différents arguments utilisé dans l'argument body.
number_of_data: (int) Le nombre de ligne renvoyé par la fonction. Par défaut ou si précisé, number_of_data=0 précise que la fonction doit renvoyé tout ce qu'elle trouve.

Cette fonction sert à executer une requête SQL, qui lis la base de données (SELECT)
La fonction retourne des informations sous forme d'un tableau.

cantinaUtils.email_utils

send_verification_email:

Arguments :

database: (class) Argument qui permet d'avoir accès à la base de données depuis la fonction.

Cette fonction sert à envoyer un mail, avec un code unique, afin de vérifier l'adresse email de l'utilisateur.
La fonction ne retourne pas d'informations mais peux retourner des erreurs.

Erreurs:

error1: Cette erreur annonce que la configuration pour l'utilisation d'un serveur SMTP n'existe pas ou est incomplète.
error2: Cette erreur annonce que la sujet ou le contenu de l'email n'est pas défini dans la base de données.

cantinaUtils.verify_login

verify_login:

Arguments:

database: (class) Argument qui permet d'avoir accès à la base de données depuis la fonction.

Cette fonction sert à savoir si un utilisateur toute les conditions sont réunis pour dire si un utilisateur est connecté.
La fonction renvoie True si l'utilisateurs est connecté et False si il ne l'est pas. La fonction peux renvoyer desactivated si les conditions sont réunis mais que le compte à été désactivé par un administrateur.

verify_A2F:

Arguments:

database: (class) Argument qui permet d'avoir accès à la base de données depuis la fonction.

Cette fonction sert à savoir si le code d'A2F fournis dans le champ a2f-code dans la page de connection est correspondant avec celui générer par notre système.
La fonction renvoie True si le code est correspondant ou False si il ne correspont pas