Fonctions | Variables

# Paquetage db

## Fonctions
def | openDb
| Ouverture de la base de données de l'application, et création si nécessaire.
def | checkVersion
| Vérifie si la base de données reste compatible.
def | knowsId
| dit si une clé USB est déjà connue
def | tattooList
| Renvoie la liste des tatouages connus de la base de données.
def | readStudent
| renvoie l'étudiant qui possède une clé USB
def | readPrefs
| renvoie les préférences de ScolaSync
def | setWd
| définit le nouveau nom du répertoire de travail préféré.
def | writeStudent
| inscrit un étudiant comme propriétaire d'une clé USB
def | writePrefs
| inscrit les préférences
## Variables
dictionary | licence = {}
| database = None
| cursor = None

## Documentation des fonctions

def db.checkVersion | ( |  | major,
|  |  | minor |
| ) |  |  |

Vérifie si la base de données reste compatible.

Un changement de version majeur implique une mise à jour en cas de base de donnée ancienne. Un changmeent de version mineur n'implique pas de changement de structure de la base de données.

Définition à la ligne 57 du fichier db.py.

def db.knowsId | ( |  | stickid,
|  |  | uuid,
|  |  | tattoo |
| ) |  |  |

dit si une clé USB est déjà connue

Paramètres:

  | stickid | un identifiant de baladeur
  | uuid | un identifiant de partition
  | tattoo | un tatouage de partition

Renvoie:
  un booléen vrai si la clé USB est connue, faux sinon

Définition à la ligne 81 du fichier db.py.

def db.openDb | ( |  | ) |

Ouverture de la base de données de l'application, et création si nécessaire.

Renvoie:
  une instance de base de données sqlite3

Définition à la ligne 37 du fichier db.py.

def db.readPrefs | ( |  | ) |

renvoie les préférences de ScolaSync

Renvoie:
  un dictionnaire de préférences

Définition à la ligne 114 du fichier db.py.

def db.readStudent | ( |  | stickid,
|  |  | uuid,
|  |  | tattoo |
| ) |  |  |

renvoie l'étudiant qui possède une clé USB

Renvoie:
  un nom d'étudiant ou None si la clé est inconnue

Définition à la ligne 100 du fichier db.py.

def db.setWd | ( |  | newDir | ) |

définit le nouveau nom du répertoire de travail préféré.

Définition à la ligne 130 du fichier db.py.

def db.tattooList | ( |  | ) |

Renvoie la liste des tatouages connus de la base de données.

Définition à la ligne 90 du fichier db.py.

def db.writePrefs | ( |  | prefs | ) |

inscrit les préférences

Paramètres:

  | prefs | un dictionnaire {"checkable": booléen vrai si on doit afficher des cases à cocher, "workdir" : le répertoire préféré pour les fichiers de travail}

Définition à la ligne 156 du fichier db.py.

def db.writeStudent | ( |  | stickid,
|  |  | uuid,
|  |  | tattoo,
|  |  | student |
| ) |  |  |

inscrit un étudiant comme propriétaire d'une clé USB

Paramètres:

  | student | un nom d'étudiant

Définition à la ligne 140 du fichier db.py.

## Documentation des variables

db.cursor = None

Définition à la ligne 30 du fichier db.py.

db.database = None

Définition à la ligne 29 du fichier db.py.

dictionary db.licence = {}

Définition à la ligne 4 du fichier db.py.