Enregistrer

Projet Agenda CLI (2/6) — données, pathlib et JSON

Chemin du fichier agenda, pathlib.Path, lecture et écriture atomique, encodage UTF-8 ; 12 exercices.

Illustration : arborescence de dossiers lumineux d'où pendent de petites pages de calendrier, au-dessus d'un ordinateur portable

Illustration générée par IA

Réponse directe (novembre 2026) — Stockez les événements dans ~/.agenda/agenda.json avec pathlib.Path, encoding="utf-8" et une écriture atomique (fichier temporaire puis replace) pour éviter un JSON corrompu si le script s’arrête en plein enregistrement.

Après le cahier des charges, ce chapitre isole le module storage du projet agenda CLI : chemins, lecture et écriture JSON fiables. Suite prévue : partie 3 — modèle et POO.

Le module storage isole tout ce qui touche au disque : où se trouve le fichier, comment le lire et l’écrire. On utilise pathlib.Path pour composer les chemins (Path.home() / ".agenda" / "agenda.json") et json.load / json.dump avec encoding="utf-8". Pour éviter un fichier corrompu si le processus meurt en pleine écriture, une stratégie simple est d’écrire dans un fichier temporaire dans le même répertoire puis Path.replace (atomique sur le même volume en général).

Contrat du module storage

  • load_events(path: Path) -> dict : si le fichier n’existe pas, retourner {"events": []} (ou structure équivalente documentée).
  • save_events(path: Path, data: dict) -> None : sérialiser avec indent=2 pour un diff Git lisible.
  • Créer les répertoires parents avec path.parent.mkdir(parents=True, exist_ok=True) avant écriture.

Exercices (12)

Exercice 1 — Écris l’expression Path.home() / ".agenda" / "agenda.json". Simple

Afficher la solution
from pathlib import Path
p = Path.home() / ".agenda" / "agenda.json"

Exercice 2 — Charge un JSON avec json.loads depuis une chaîne '{"events":[]}'. Simple

Afficher la solution
import json
data = json.loads('{"events":[]}')

Exercice 3 — Pourquoi ensure_ascii=False dans json.dump pour le français ? Simple

Afficher la solution
# Préserve les caractères Unicode lisibles au lieu d'échapper en \uXXXX.

Exercice 4 — Gère JSONDecodeError lors du chargement : message utilisateur et sortie non zéro en CLI (schéma). Intermédiaire

Afficher la solution
try:
    ...
except json.JSONDecodeError as e:
    print("Fichier JSON invalide:", e)
    sys.exit(1)

Exercice 5 — Utilise tempfile.NamedTemporaryFile ou mkstemp à côté du fichier cible pour écriture puis replace. Intermédiaire

Afficher la solution
# Écrire dans tmp dans le même dossier ; Path(tmp).replace(cible) pour atomicité.

Exercice 6 — Teste load_events avec un tmp_path pytest et fichier absent. Intermédiaire

Afficher la solution
def test_load_missing(tmp_path):
    p = tmp_path / "x.json"
    assert load_events(p) == {"events": []}

Exercice 7 — Différence read_text vs open + json.load. Simple

Afficher la solution
# read_text charge tout en str ; json.load attend un fichier ouvert en texte.

Exercice 8 — Valide que la racine chargée contient bien la clé events de type list. Intermédiaire

Afficher la solution
if not isinstance(data.get("events"), list):
    raise ValueError("Format invalide")

Exercice 9 — Variable d’environnement AGENDA_FILE pour surcharger le chemin par défaut. Difficile

Afficher la solution
import os
from pathlib import Path
def data_path() -> Path:
    return Path(os.environ.get("AGENDA_FILE", Path.home() / ".agenda" / "agenda.json"))

Exercice 10 — Path.resolve() avant comparaison de chemins — cas d’usage. Difficile

Afficher la solution
# Normaliser .. et symlinks pour savoir si deux chemins pointent au même fichier.

Exercice 11 — chmod ou permissions : pourquoi le fichier dans ~/.agenda peut poser question en multi-utilisateur ? Difficile

Afficher la solution
Sur machine partagée, prévoir droits 600 (Unix) — hors scope v1 mais à noter.

Exercice 12 — Écrit un test : sauvegarde puis rechargement donne les mêmes données (égalité profonde). Intermédiaire

Afficher la solution
def test_roundtrip(tmp_path):
    d = {"events": [{"id": "1", "title": "A", "start": "2026-01-01T12:00:00", "duration_minutes": None, "note": ""}]}
    p = tmp_path / "a.json"
    save_events(p, d)
    assert load_events(p) == d

FAQ

Pourquoi Path.replace plutôt qu’écraser directement le fichier ?
Si le processus est tué pendant l’écriture, un remplacement direct peut laisser un JSON tronqué. Écrire dans un fichier temporaire du même dossier puis replace limite ce risque (opération atomique sur le même volume).

Où ranger le fichier par défaut ?
Path.home() / ".agenda" / "agenda.json" convient à un usage personnel ; ./data/agenda.json facilite les tests et le partage du dépôt — documentez le choix dans le README.

Faut-il indent=2 dans json.dump ?
Oui pour un fichier lisible à la main et des diffs Git clairs ; en production à très gros volume on pourrait compacter, ce qui n’est pas le cas ici.

Suite

Modèle métier et classes

Amazon (partenaire)

À lire aussi

Cette page vous a-t-elle été utile ?

Une question sur cet article ou besoin d'un conseil ? Posez-la ici

Vous hésitez entre deux modèles ou vous avez besoin d'aide sur un montage ? Écrivez-nous, nous vous répondons rapidement par e-mail.