This repository has been archived on 2022-03-31. You can view files and clone it, but cannot push or open issues or pull requests.
GesMag/doc/README.md
2021-11-19 18:55:26 +01:00

3.5 KiB
Raw Blame History


description: | API documentation for modules: GesMag, GesMag.db, GesMag.main, GesMag.users.

lang: en

classoption: oneside geometry: margin=1in papersize: a4

linkcolor: blue links-as-notes: true ...

Namespace GesMag

Sub-modules

Module GesMag.db

Classes

Class BaseDeDonnees

class BaseDeDonnees(
    urlBaseDeDonnee: str
)

Gère la base de donnée.

Methods

Method affichageResultat
def affichageResultat(
    self,
    curseur: sqlite3.Cursor
) > list

Affiche le résultat d'une requête.

Method creerConnexion
def creerConnexion(
    self,
    path: str
)

Connexion à une base de donnée SQLite.

Method fichierExiste
def fichierExiste(
    self,
    path: str
) > bool

Vérifie qu'un fichier existe.

Method requete
def requete(
    self,
    requete: str,
    valeurs=None
)

Envois une requête vers la base de données.

Module GesMag.main

Functions

Function dimensionsFenetre

def dimensionsFenetre(
    fenetre,
    taille: tuple
)

Permet de définir une fenetre centrer sur l'écran

Classes

Class GesMag

class GesMag

Programme de Gestion d'une caise de magasin.

Methods

Method connexion
def connexion(
    self,
    utilisateur: str,
    motDePasse: str
)

Gère la connexion aux différentes interfaces de l'application.

Method demarrer
def demarrer(
    self
) > None

Lance le programme GesMag.

Method motDePasseCorrect
def motDePasseCorrect(
    self,
    motDPasse: str
) > tuple

Détermine si un mot de passe suit la politique du programme ou non.

Module GesMag.users

Classes

Class Utilisateurs

class Utilisateurs

Gère une table "utilisateurs" pour une base de donnée donné.

Ancestors (in MRO)

Methods

Method ajoutUtilisateurs
def ajoutUtilisateurs(
    self,
    pseudo: str,
    passe: str,
    metier: int,
    nom: str,
    prenom: str,
    naissance: str,
    adresse: str,
    postal: str
) > list

Ajoute un utilisateur et retourne l'ID de ce dernier.

Method creationTable
def creationTable(
    self
) > None

Créer la table qui stocker les utilisateurs.

Method listUtilisateurs
def listUtilisateurs(
    self
) > list

Retourne la liste des nom d'utilisateurs.

Method suppressionUtilisateurs
def suppressionUtilisateurs(
    self,
    pseudo: str
) > None

Supprime un utilisateur.

Method verificationIdentifiants
def verificationIdentifiants(
    self,
    pseudo: str,
    motDePasse: str
) > bool

Renvoie vrai ou faux si les identifiants données sont bons.


Generated by pdoc 0.10.0 (https://pdoc3.github.io).