todo_backend package

Submodules

todo_backend.app module

todo_backend.app.add_todo(todo: Todo) → Todo

Ajout d’une nouvelle tâche

Args :

todo (Todo) : Les Informations de la tâche (Le champs done est mis à false)

Returns :

Todo : La tâche ajoutée

todo_backend.app.add_user(user: User) → User

Ajout d’un nouvel utilisateur à la base de données

Args :

user (User) : Utilisateur à ajouter

Returns :

User : Nouvel utilisateur ajouté

todo_backend.app.delete_item(todo: Todo)

Supprime une tâche

Parameters:

todo (Todo) – Le TODO et les données associées au Todo sont supprimés

Returns:

None

todo_backend.app.get_todo(user_id: str) → list[Todo]

Récupération des toute les tâches d’un utilisateur

Args :

user_id (str) : Identifiant de l’utilisateur

Returns:

la liste des TODO d’un utilisateur

Return type:

list [Todo]

todo_backend.app.read_user(id: str) → User | None

Récupère l’utilisateur via son identifiant

Args :

id (str) : Id de l’utilisateur

Returns:

L’identifiant correspondant ou None s’il nêxiste pas

Return type:

User

todo_backend.app.replace_item(todo: Todo)

Mise à jour d’un TODO existant

Args :

todo (Todo) : mise à jour de la tâche

Returns :

Todo : le TODO modifé

todo_backend.db module

todo_backend.db.add_todo_item(conn, todo: Todo) → Todo

Ajout d’une nouvelle tâche à la base de données

Parameters:

• conn (psycopg2.extensions.connection) – Connexion à la base de données

• todo (Todo) – pour un nouveua TODO le champ done est mis à false

Returns :

todo_backend.db.add_user(conn, user: User) → User

Ajout d’un nouvel utilisateur à la base de données

Args :

conn (psycopg2.extensions.connection) : Connexion à la base de données user (User) : Le nouvel utilisateur à ajouter

Retruns :

User : Le nouvel utilisateur ajouté à la base de données

todo_backend.db.db_setup(conn)

Initialisation de la base de donneés : suppression et création des tables ‘users’ et ‘todos’

Args :

conn (psycopg2.extensions.connection) : Connexion à la base de données

todo_backend.db.delete_todo_item(conn, todo: Todo)

Supprime un TODO dans la base de données

Args :

conn (psycopg2.extensions.connection) : Connexion à la base de données todo (Todo) : suppresion du TODO

todo_backend.db.get_conn()

crée une connection à la base de données PostgreSQL

Returns:

Connection ouverte à la base de données PostgreSQL

Return type:

psycopg2.extensions.connection

todo_backend.db.get_todo_list(conn, user_id) → list[Todo]

Récupération de la liste de TODOs en fonction de l’identifiant de l’utilisateur

Parameters:

• conn (psycopg2.extensions.connection) – Connexion à la base de données

• user_id – L’identifiant de l’utilisateur

Returns :

list[Todo] : La liste des TODOs de l’utilisateur

todo_backend.db.get_user(conn, user_id) → User

Récupération d’un utilisateur à partir d’un identifiants

Args :

conn (psycopg2.extensions.connection) : Connexion à la base de données user_id : L’identifiant de l’utilisateur

Returns:

L’utilisateur correspond à son id

Return type:

User

todo_backend.db.update_todo_item(conn, todo: Todo) → Todo

Mise à jour d’un TODO dans la base de données

Args :

conn (psycopg2.extensions.connection) : Connexion à la base de données todo (Todo) : Mise à jour de la tâche

Returns :

La tâche mise à jour

todo_backend.model module

class todo_backend.model.Todo(*, id: int | None, task: str, user_id: str | None, done: bool)

Bases: BaseModel

Une tâche associée à un utilisateur

done: bool

id: int | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

task: str

user_id: str | None

class todo_backend.model.User(*, id: str)

Bases: BaseModel

Un utilisateur

Attributes : id (str) : Id unique de l’utilisateur

id: str

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].