Aller au contenu

Ingestion des données (kadi.market.data_ingestion)

Le module WFPDataBridgesClient gère la connexion à l'API WFP DataBridges (Programme Alimentaire Mondial — VAM) et le cache local des données de prix. Il constitue la couche d'accès aux données du module kadi.market.


Architecture du client

WFPDataBridgesClient
├── get_market_prices()     ← Récupère les prix d'un marché
├── get_commodities()       ← Liste les cultures disponibles
├── get_markets()           ← Liste les marchés disponibles
└── Cache SQLite            ← Stocke les résultats pour l'accès hors-ligne

Initialisation

from kadi.market.data_ingestion import WFPDataBridgesClient

# Le token est lu automatiquement depuis le fichier .env
client = WFPDataBridgesClient()

Via la façade Market (recommandé) :

from kadi.market import Market

marche = Market(lat=9.30, lon=2.08, location="Parakou")
# marche.data_client est un WFPDataBridgesClient prêt à l'emploi

Configuration requise

Ajoutez votre clé API dans le fichier .env à la racine du projet :

WFP_API_Token=votre_cle_api_wfp

Sans clé, le client bascule automatiquement sur le mode simulation :

client = WFPDataBridgesClient()
print(client.token)   # "" si WFP_API_Token est absent du .env

df = client.get_market_prices("cotonou", "maize")
print(df["is_simulated"].iloc[0])  # True — données fictives

Méthodes

get_market_prices(market, crop, days_back)

Récupère les prix historiques pour un marché et une culture. Interroge le cache SQLite en premier ; si les données sont absentes ou périmées, lance un appel à l'API WFP.

df = client.get_market_prices("parakou", "maize", days_back=90)

Stratégie de sélection des données :

Étape Condition Action
1 Cache frais (< 7 jours) Retourne depuis le cache SQLite
2 Token WFP disponible Appel à l'API WFP DataBridges
3 API indisponible ou erreur Génère des données simulées

Retour : pd.DataFrame avec les colonnes date, price, unit, is_simulated, source, confidence_score, fetched_at.


Cache SQLite

Les données récupérées sont persistées dans ~/.kadi/market_prices.db. La durée de vie du cache est configurable dans config.py :

CONFIG["market"]["cache_max_age_jours"] = 7  # défaut : 7 jours

Le module kadi.market._cache expose les fonctions de gestion du cache si vous devez l'interroger directement :

from kadi.market._cache import recuperer_prix, vider_cache

# Vérifier les données en cache pour le maïs à Cotonou
df_cache = recuperer_prix("cotonou", "maize", max_age_jours=30)

# Vider uniquement le cache de Cotonou/maïs
vider_cache("cotonou", "maize")

Endpoints WFP utilisés

Endpoint Usage
/Commodities/List Récupère les IDs officiels des cultures
/Markets/List Récupère les IDs officiels des marchés
/MarketPrices/alldata Historique de prix par marché et culture

WFPDataBridgesClient

Client HTTP pour l'API WFP DataBridges (VAM).

Gère l'authentification, le cache SQLite local, le retry avec backoff exponentiel, et le repli transparent sur des données simulées.

Fonctionnement sans clé API

Si aucun token WFP n'est configuré, le client retourne des données simulées (is_simulated=True, confidence_score=0.1) sans erreur. Cela permet de développer et tester sans accès réseau.

Colonnes toujours présentes dans les DataFrames retournés
  • is_simulated : True si les données sont fictives
  • source : 'wfp-vam', 'ratin', 'scrape-local', ou 'simulated'
  • fetched_at : horodatage ISO de la récupération
  • confidence_score: score 0.0 à 1.0 (source + fraîcheur)
Source code in kadi/market/data_ingestion.py
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
class WFPDataBridgesClient:
    """
    Client HTTP pour l'API WFP DataBridges (VAM).

    Gère l'authentification, le cache SQLite local, le retry avec backoff
    exponentiel, et le repli transparent sur des données simulées.

    Fonctionnement sans clé API :
        Si aucun token WFP n'est configuré, le client retourne des données
        simulées (is_simulated=True, confidence_score=0.1) sans erreur.
        Cela permet de développer et tester sans accès réseau.

    Colonnes toujours présentes dans les DataFrames retournés :
        - is_simulated    : True si les données sont fictives
        - source          : 'wfp-vam', 'ratin', 'scrape-local', ou 'simulated'
        - fetched_at      : horodatage ISO de la récupération
        - confidence_score: score 0.0 à 1.0 (source + fraîcheur)
    """

    def __init__(
        self,
        use_local_mirror: bool = False,
        env_file: str = ".env",
        cache_file: str = None,
        retry_attempts: int = RETRY_ATTEMPTS_DEFAULT,
        retry_backoff_sec: float = RETRY_BACKOFF_SEC_DEFAULT,
    ):
        """
        Initialise le client WFP DataBridges.

        Args:
            use_local_mirror (bool): Si True, ignore l'API et retourne
                directement des données simulées. Utile pour les tests.
            env_file (str): Chemin vers le fichier .env contenant le token API.
            cache_file (str, optional): Chemin vers le fichier JSON de cache
                des IDs (commodités et marchés). Par défaut : ~/.kadi/wfp_cache.json.
            retry_attempts (int): Nombre maximum de tentatives par requête HTTP.
            retry_backoff_sec (float): Délai initial en secondes pour le backoff.
        """
        # URL de base de l'API WFP DataBridges
        self.base_url = "https://api.wfp.org/vam-data-bridges/1.3.1"

        # Mode miroir local (bypass de l'API pour les tests)
        self.use_local_mirror = use_local_mirror

        # Paramètres de retry réseau
        self.retry_attempts = retry_attempts
        self.retry_backoff_sec = retry_backoff_sec

        # Chargement du token d'authentification WFP
        self.token = self._charger_token(env_file)

        # Fichier JSON de cache pour les IDs de commodités et marchés
        if cache_file is None:
            from kadi.config import CACHE_DIR
            self.cache_file = str(CACHE_DIR / "wfp_cache.json")
        else:
            self.cache_file = cache_file

        # Cache en mémoire pour les IDs WFP (commodités et marchés)
        self.cache = {"commodities": {}, "markets": {}}
        self._charger_cache_ids()

    def _charger_cache_ids(self):
        """Charge le cache JSON des IDs (commodités et marchés) depuis le disque."""
        if os.path.isfile(self.cache_file):
            try:
                with open(self.cache_file, "r", encoding="utf-8") as f:
                    data = json.load(f)
                    self.cache["commodities"] = data.get("commodities", {})
                    self.cache["markets"] = data.get("markets", {})
            except Exception as e:
                logger.warning(f"Impossible de lire le cache IDs WFP : {e}")

    def _sauvegarder_cache_ids(self):
        """Sauvegarde le cache JSON des IDs sur le disque."""
        try:
            with open(self.cache_file, "w", encoding="utf-8") as f:
                json.dump(self.cache, f, indent=4)
        except Exception as e:
            logger.warning(f"Impossible de sauvegarder le cache IDs WFP : {e}")

    def _charger_token(self, env_file: str) -> str:
        """
        Charge le token WFP depuis les variables d'environnement ou le fichier .env.

        Args:
            env_file (str): Chemin vers le fichier .env.

        Returns:
            str: Le token WFP si trouvé, sinon une chaîne vide.
        """
        # Priorité 1 : variable d'environnement
        token = os.environ.get("WFP_API_Token", os.environ.get("WFP_API_KEY", ""))

        # Priorité 2 : fichier .env
        if not token and os.path.isfile(env_file):
            try:
                with open(env_file, "r", encoding="utf-8") as f:
                    for line in f:
                        line = line.strip()
                        if line and not line.startswith("#"):
                            parts = line.split("=", 1)
                            if len(parts) == 2 and parts[0].strip() in (
                                "WFP_API_Token",
                                "WFP_API_KEY",
                            ):
                                token = parts[1].strip().strip("'\"")
                                break
            except Exception as e:
                logger.warning(f"Erreur lecture du fichier {env_file}: {e}")

        if not token:
            logger.info(
                "Aucun token WFP trouvé. Le client fonctionnera en mode "
                "fallback simulé jusqu'à la configuration de WFP_API_Token."
            )

        return token

    def _recuperer_commodites(self) -> dict:
        """
        Récupère la liste des cultures depuis l'API WFP et la met en cache.

        Returns:
            dict: Mapping {nom_normalise: commodity_id}.
        """
        # Cache en mémoire disponible
        if self.cache["commodities"]:
            return self.cache["commodities"]

        # Sans token, on retourne le fallback directement
        if not self.token:
            return COMMODITY_MAPPING_FALLBACK

        headers = {
            "Authorization": f"Bearer {self.token}",
            "Accept": "application/json",
        }

        for endpoint in (
            f"{self.base_url}/Commodities/List",
            f"{self.base_url}/Commodities",
        ):
            try:
                response = _get_with_retry(
                    endpoint, headers=headers,
                    retry_attempts=self.retry_attempts,
                    retry_backoff_sec=self.retry_backoff_sec,
                )
                if response.status_code == 404:
                    continue
                response.raise_for_status()

                items = response.json().get("items", [])
                mapping = {}
                for item in items:
                    c_id = item.get("commodityID") or item.get("id")
                    c_name = item.get("commodityName") or item.get("name")
                    if c_id and c_name:
                        mapping[c_name.lower().replace(" ", "_")] = c_id

                if mapping:
                    self.cache["commodities"] = mapping
                    self._sauvegarder_cache_ids()
                    return mapping
                break

            except Exception as e:
                logger.warning(
                    f"Impossible de récupérer les Commodities WFP depuis {endpoint}: {e}. "
                    "Utilisation du mapping de secours."
                )
                break

        return COMMODITY_MAPPING_FALLBACK

    def _recuperer_marches(self, country_code: str = "BEN") -> dict:
        """
        Récupère la liste des marchés WFP pour le Bénin.

        Args:
            country_code (str): Code pays ISO3. Fixé à 'BEN' pour le V1.

        Returns:
            dict: Mapping {nom_normalise: market_id}.
        """
        if self.cache["markets"]:
            return self.cache["markets"]

        if not self.token:
            return MARKET_MAPPING_FALLBACK

        headers = {
            "Authorization": f"Bearer {self.token}",
            "Accept": "application/json",
        }

        for endpoint in (
            f"{self.base_url}/Markets/List",
            f"{self.base_url}/Markets",
        ):
            try:
                response = _get_with_retry(
                    endpoint, headers=headers,
                    params={"CountryCode": country_code},
                    retry_attempts=self.retry_attempts,
                    retry_backoff_sec=self.retry_backoff_sec,
                )
                if response.status_code == 404:
                    continue
                response.raise_for_status()

                items = response.json().get("items", [])
                mapping = {}
                for item in items:
                    m_id = item.get("marketID") or item.get("id")
                    m_name = item.get("marketName") or item.get("name")
                    if m_id and m_name:
                        mapping[m_name.lower().replace(" ", "_")] = m_id

                if mapping:
                    self.cache["markets"] = mapping
                    self._sauvegarder_cache_ids()
                    return mapping
                break

            except Exception as e:
                logger.warning(
                    f"Impossible de récupérer les Markets WFP depuis {endpoint}: {e}. "
                    "Utilisation du mapping de secours."
                )
                break

        return MARKET_MAPPING_FALLBACK

    def _get_commodity_id(self, commodity_name: str) -> int:
        """
        Retourne l'identifiant WFP d'une culture par son nom normalisé.

        Args:
            commodity_name (str): Nom normalisé de la culture (ex: 'maize').

        Returns:
            int: L'identifiant WFP, ou 0 si introuvable.
        """
        key = commodity_name.lower().replace(" ", "_")
        mapping = self._recuperer_commodites()
        return mapping.get(key, COMMODITY_MAPPING_FALLBACK.get(key, 0))

    def _get_market_id(self, market_name: str) -> int:
        """
        Retourne l'identifiant WFP d'un marché par son nom normalisé.

        Args:
            market_name (str): Nom normalisé du marché (ex: 'cotonou').

        Returns:
            int: L'identifiant WFP, ou 0 si introuvable.
        """
        key = market_name.lower().replace(" ", "_")
        mapping = self._recuperer_marches()
        return mapping.get(key, MARKET_MAPPING_FALLBACK.get(key, 0))

    def _validate_api_response_items(self, items: list) -> list:
        """
        Valide et nettoie les items bruts retournés par l'API WFP.

        Chaque item doit avoir un prix numérique positif et une date valide.
        Les items invalides sont ignorés avec un avertissement dans les logs.

        Args:
            items (list): Liste de dictionnaires bruts provenant de l'API.

        Returns:
            list: Liste des items valides uniquement.
        """
        items_valides = []

        for i, item in enumerate(items):
            # Vérification du prix
            prix_brut = item.get("ActualPrice") or item.get("price")
            if prix_brut is None:
                logger.debug(f"Item {i} ignoré : prix manquant.")
                continue

            try:
                prix = float(prix_brut)
                if prix < 0:
                    logger.debug(f"Item {i} ignoré : prix négatif ({prix}).")
                    continue
            except (ValueError, TypeError):
                logger.debug(f"Item {i} ignoré : prix non numérique ('{prix_brut}').")
                continue

            # Vérification de la date
            date_brute = item.get("CommodityPriceDate") or item.get("date")
            if not date_brute:
                logger.debug(f"Item {i} ignoré : date manquante.")
                continue

            items_valides.append(item)

        nb_ignores = len(items) - len(items_valides)
        if nb_ignores > 0:
            logger.warning(
                f"{nb_ignores}/{len(items)} items API ignorés "
                "car invalides (prix manquant, négatif, ou date absente)."
            )

        return items_valides

    def get_market_prices(
        self,
        market_name: str,
        commodity: str,
        time_range: tuple = None,
    ) -> pd.DataFrame:
        """
        Récupère les prix historiques pour un marché et une culture.

        Stratégie en cascade (la première source disponible est utilisée) :
        1. Cache SQLite local (~/kadi/market_prices.db) si les données sont fraîches
        2. API WFP DataBridges (si le token WFP_API_Token est configuré)
        3. Données simulées en dernier recours (is_simulated=True)

        Le DataFrame retourné contient toujours ces colonnes standards :
        - ``date``             : datetime de l'observation
        - ``price``            : prix en XOF/kg
        - ``unit``             : unité d'origine ('KG', 'XOF/kg', etc.)
        - ``is_simulated``     : True si les données sont fictives
        - ``source``           : 'wfp-vam', 'cache', 'simulated'
        - ``fetched_at``       : horodatage ISO de la récupération
        - ``confidence_score`` : score 0.0 à 1.0 (source + fraîcheur)

        Args:
            market_name (str): Nom normalisé du marché (ex: 'cotonou').
            commodity (str): Code de la culture (ex: 'maize').
            time_range (tuple, optional): (date_debut, date_fin) en 'YYYY-MM-DD'.

        Returns:
            pd.DataFrame: DataFrame enrichi avec toutes les colonnes standards.
        """
        from kadi.config import CONFIG

        # Durée de vie du cache (en jours) lue depuis la configuration
        max_age_jours = CONFIG.get("market", {}).get("cache_ttl_prices_days", 7)

        # ----------------------------------------------------------------
        # Étape 1 : mode miroir local (pour les tests automatiques)
        # Le mode miroir court-circuite toutes les autres couches.
        # ----------------------------------------------------------------
        if self.use_local_mirror:
            logger.info("Mode miroir local actif : données simulées retournées.")
            return self._generer_donnees_simulees(time_range)

        # ----------------------------------------------------------------
        # Étape 2 : lecture du cache SQLite si les données sont fraîches
        # ----------------------------------------------------------------
        df_cache = recuperer_prix(market_name, commodity, max_age_jours=max_age_jours)
        if df_cache is not None and not df_cache.empty:
            logger.info(
                f"Cache hit pour {market_name}/{commodity} "
                f"({len(df_cache)} lignes)."
            )
            # Calcul et ajout du score de confiance basé sur le cache
            df_cache["confidence_score"] = calculer_score_confiance(
                market_name, commodity, max_age_jours=max_age_jours
            )
            return df_cache

        # ----------------------------------------------------------------
        # Étape 3 : appel à l'API WFP DataBridges
        # ----------------------------------------------------------------
        market_id = self._get_market_id(market_name)
        commodity_id = self._get_commodity_id(commodity)

        # Sans token ou sans IDs valides : fallback simulé
        if market_id == 0 or commodity_id == 0 or not self.token:
            logger.warning(
                "Pas de token WFP ou IDs introuvables. "
                "Données simulées utilisées en remplacement."
            )
            return self._generer_donnees_simulees(time_range)

        headers = {
            "Authorization": f"Bearer {self.token}",
            "Accept": "application/json",
        }
        params = {
            "CountryCode": "BEN",
            "MarketID": market_id,
            "CommodityID": commodity_id,
        }
        if time_range and len(time_range) == 2:
            params["StartDate"] = time_range[0]
            params["EndDate"] = time_range[1]

        try:
            response = _get_with_retry(
                f"{self.base_url}/MarketPrices/alldata",
                headers=headers,
                params=params,
                retry_attempts=self.retry_attempts,
                retry_backoff_sec=self.retry_backoff_sec,
            )
            response.raise_for_status()

            items_bruts = response.json().get("items", [])
            items = self._validate_api_response_items(items_bruts)

            if not items:
                logger.warning(
                    f"Aucune donnée valide de l'API WFP pour {market_name}/{commodity}. "
                    "Données simulées utilisées."
                )
                return self._generer_donnees_simulees(time_range)

            # Construction du DataFrame à partir des items validés
            df = pd.DataFrame(items)

            # Renommage vers le format interne standard
            col_mapping = {
                "CommodityPriceDate": "date",
                "ActualPrice": "price",
                "UnitName": "unit",
            }
            df = df.rename(columns={k: v for k, v in col_mapping.items() if k in df.columns})

            if "date" in df.columns:
                df["date"] = pd.to_datetime(df["date"], errors="coerce")

            # Ajout des colonnes standards
            maintenant = datetime.now(timezone.utc).isoformat()
            df["is_simulated"] = False
            df["source"] = "wfp-vam"
            df["fetched_at"] = maintenant

            # ----------------------------------------------------------------
            # Sauvegarde dans le cache SQLite pour les prochains appels
            # ----------------------------------------------------------------
            try:
                nb = sauvegarder_prix(market_name, commodity, df, source="wfp-vam")
                logger.debug(f"Cache : {nb} nouvelles lignes sauvegardées pour {market_name}/{commodity}.")
            except Exception as e:
                # L'échec du cache ne bloque pas le retour des données
                logger.warning(f"Échec de la sauvegarde dans le cache SQLite : {e}")

            # Ajout du score de confiance
            df["confidence_score"] = calculer_score_confiance(
                market_name, commodity, max_age_jours=max_age_jours
            )

            return df

        except requests.exceptions.RequestException as e:
            logger.error(
                f"Erreur API WFP après {self.retry_attempts} tentatives : {e}. "
                "Données simulées utilisées."
            )
            return self._generer_donnees_simulees(time_range)

    def get_market_functionality_index(self, market_id: str) -> float:
        """
        Retourne l'indice de fonctionnalité d'un marché.

        Note : stub V1. Retourne une valeur fixe en attendant l'intégration
        de données réelles (FEWSNET ou WFP Market Monitor).

        Args:
            market_id (str): L'identifiant du marché.

        Returns:
            float: Indice de fonctionnalité (stub : 7.9 / 10).
        """
        # Stub V1 : valeur en dur, à remplacer par une vraie source
        return 7.9

    def _generer_donnees_simulees(self, time_range: tuple = None) -> pd.DataFrame:
        """
        Génère des données de prix simulées (bruit gaussien) pour le fallback.

        AVERTISSEMENT : ces données sont entièrement fictives. Le champ
        is_simulated=True et confidence_score=0.1 signalent cet état.
        Ne jamais présenter ces données à un utilisateur comme des prix réels.

        Args:
            time_range (tuple, optional): (date_debut, date_fin) en 'YYYY-MM-DD'.
                Si None, génère 365 jours se terminant aujourd'hui.

        Returns:
            pd.DataFrame: DataFrame simulé avec toutes les colonnes standards.
        """
        # Génération de la plage de dates
        if time_range and len(time_range) == 2:
            dates = pd.date_range(start=time_range[0], end=time_range[1], freq="D")
        else:
            dates = pd.date_range(end=pd.Timestamp.today(), periods=365, freq="D")

        nb_jours = len(dates)

        # Prix aléatoires centrés sur 300 XOF/kg (valeur de référence béninoise)
        prix_aleatoires = np.random.normal(loc=300, scale=20, size=nb_jours)

        maintenant = datetime.now(timezone.utc).isoformat()

        df = pd.DataFrame({
            "date": dates,
            "price": prix_aleatoires,
            "unit": "XOF/kg",
            "is_simulated": True,
            "source": "simulated",
            "fetched_at": maintenant,
            "confidence_score": 0.1,
        })

        logger.warning(
            "Données simulées retournées (is_simulated=True, confidence_score=0.1). "
            "Ne pas utiliser pour des décisions commerciales réelles."
        )

        return df

__init__

__init__(use_local_mirror: bool = False, env_file: str = '.env', cache_file: str = None, retry_attempts: int = RETRY_ATTEMPTS_DEFAULT, retry_backoff_sec: float = RETRY_BACKOFF_SEC_DEFAULT)

Initialise le client WFP DataBridges.

Parameters:

Name Type Description Default
use_local_mirror bool

Si True, ignore l'API et retourne directement des données simulées. Utile pour les tests.

False
env_file str

Chemin vers le fichier .env contenant le token API.

'.env'
cache_file str

Chemin vers le fichier JSON de cache des IDs (commodités et marchés). Par défaut : ~/.kadi/wfp_cache.json.

None
retry_attempts int

Nombre maximum de tentatives par requête HTTP.

RETRY_ATTEMPTS_DEFAULT
retry_backoff_sec float

Délai initial en secondes pour le backoff.

RETRY_BACKOFF_SEC_DEFAULT
Source code in kadi/market/data_ingestion.py
def __init__(
    self,
    use_local_mirror: bool = False,
    env_file: str = ".env",
    cache_file: str = None,
    retry_attempts: int = RETRY_ATTEMPTS_DEFAULT,
    retry_backoff_sec: float = RETRY_BACKOFF_SEC_DEFAULT,
):
    """
    Initialise le client WFP DataBridges.

    Args:
        use_local_mirror (bool): Si True, ignore l'API et retourne
            directement des données simulées. Utile pour les tests.
        env_file (str): Chemin vers le fichier .env contenant le token API.
        cache_file (str, optional): Chemin vers le fichier JSON de cache
            des IDs (commodités et marchés). Par défaut : ~/.kadi/wfp_cache.json.
        retry_attempts (int): Nombre maximum de tentatives par requête HTTP.
        retry_backoff_sec (float): Délai initial en secondes pour le backoff.
    """
    # URL de base de l'API WFP DataBridges
    self.base_url = "https://api.wfp.org/vam-data-bridges/1.3.1"

    # Mode miroir local (bypass de l'API pour les tests)
    self.use_local_mirror = use_local_mirror

    # Paramètres de retry réseau
    self.retry_attempts = retry_attempts
    self.retry_backoff_sec = retry_backoff_sec

    # Chargement du token d'authentification WFP
    self.token = self._charger_token(env_file)

    # Fichier JSON de cache pour les IDs de commodités et marchés
    if cache_file is None:
        from kadi.config import CACHE_DIR
        self.cache_file = str(CACHE_DIR / "wfp_cache.json")
    else:
        self.cache_file = cache_file

    # Cache en mémoire pour les IDs WFP (commodités et marchés)
    self.cache = {"commodities": {}, "markets": {}}
    self._charger_cache_ids()

get_market_prices

get_market_prices(market_name: str, commodity: str, time_range: tuple = None) -> pd.DataFrame

Récupère les prix historiques pour un marché et une culture.

Stratégie en cascade (la première source disponible est utilisée) : 1. Cache SQLite local (~/kadi/market_prices.db) si les données sont fraîches 2. API WFP DataBridges (si le token WFP_API_Token est configuré) 3. Données simulées en dernier recours (is_simulated=True)

Le DataFrame retourné contient toujours ces colonnes standards : - date : datetime de l'observation - price : prix en XOF/kg - unit : unité d'origine ('KG', 'XOF/kg', etc.) - is_simulated : True si les données sont fictives - source : 'wfp-vam', 'cache', 'simulated' - fetched_at : horodatage ISO de la récupération - confidence_score : score 0.0 à 1.0 (source + fraîcheur)

Parameters:

Name Type Description Default
market_name str

Nom normalisé du marché (ex: 'cotonou').

required
commodity str

Code de la culture (ex: 'maize').

required
time_range tuple

(date_debut, date_fin) en 'YYYY-MM-DD'.

None

Returns:

Type Description
DataFrame

pd.DataFrame: DataFrame enrichi avec toutes les colonnes standards.

Source code in kadi/market/data_ingestion.py
def get_market_prices(
    self,
    market_name: str,
    commodity: str,
    time_range: tuple = None,
) -> pd.DataFrame:
    """
    Récupère les prix historiques pour un marché et une culture.

    Stratégie en cascade (la première source disponible est utilisée) :
    1. Cache SQLite local (~/kadi/market_prices.db) si les données sont fraîches
    2. API WFP DataBridges (si le token WFP_API_Token est configuré)
    3. Données simulées en dernier recours (is_simulated=True)

    Le DataFrame retourné contient toujours ces colonnes standards :
    - ``date``             : datetime de l'observation
    - ``price``            : prix en XOF/kg
    - ``unit``             : unité d'origine ('KG', 'XOF/kg', etc.)
    - ``is_simulated``     : True si les données sont fictives
    - ``source``           : 'wfp-vam', 'cache', 'simulated'
    - ``fetched_at``       : horodatage ISO de la récupération
    - ``confidence_score`` : score 0.0 à 1.0 (source + fraîcheur)

    Args:
        market_name (str): Nom normalisé du marché (ex: 'cotonou').
        commodity (str): Code de la culture (ex: 'maize').
        time_range (tuple, optional): (date_debut, date_fin) en 'YYYY-MM-DD'.

    Returns:
        pd.DataFrame: DataFrame enrichi avec toutes les colonnes standards.
    """
    from kadi.config import CONFIG

    # Durée de vie du cache (en jours) lue depuis la configuration
    max_age_jours = CONFIG.get("market", {}).get("cache_ttl_prices_days", 7)

    # ----------------------------------------------------------------
    # Étape 1 : mode miroir local (pour les tests automatiques)
    # Le mode miroir court-circuite toutes les autres couches.
    # ----------------------------------------------------------------
    if self.use_local_mirror:
        logger.info("Mode miroir local actif : données simulées retournées.")
        return self._generer_donnees_simulees(time_range)

    # ----------------------------------------------------------------
    # Étape 2 : lecture du cache SQLite si les données sont fraîches
    # ----------------------------------------------------------------
    df_cache = recuperer_prix(market_name, commodity, max_age_jours=max_age_jours)
    if df_cache is not None and not df_cache.empty:
        logger.info(
            f"Cache hit pour {market_name}/{commodity} "
            f"({len(df_cache)} lignes)."
        )
        # Calcul et ajout du score de confiance basé sur le cache
        df_cache["confidence_score"] = calculer_score_confiance(
            market_name, commodity, max_age_jours=max_age_jours
        )
        return df_cache

    # ----------------------------------------------------------------
    # Étape 3 : appel à l'API WFP DataBridges
    # ----------------------------------------------------------------
    market_id = self._get_market_id(market_name)
    commodity_id = self._get_commodity_id(commodity)

    # Sans token ou sans IDs valides : fallback simulé
    if market_id == 0 or commodity_id == 0 or not self.token:
        logger.warning(
            "Pas de token WFP ou IDs introuvables. "
            "Données simulées utilisées en remplacement."
        )
        return self._generer_donnees_simulees(time_range)

    headers = {
        "Authorization": f"Bearer {self.token}",
        "Accept": "application/json",
    }
    params = {
        "CountryCode": "BEN",
        "MarketID": market_id,
        "CommodityID": commodity_id,
    }
    if time_range and len(time_range) == 2:
        params["StartDate"] = time_range[0]
        params["EndDate"] = time_range[1]

    try:
        response = _get_with_retry(
            f"{self.base_url}/MarketPrices/alldata",
            headers=headers,
            params=params,
            retry_attempts=self.retry_attempts,
            retry_backoff_sec=self.retry_backoff_sec,
        )
        response.raise_for_status()

        items_bruts = response.json().get("items", [])
        items = self._validate_api_response_items(items_bruts)

        if not items:
            logger.warning(
                f"Aucune donnée valide de l'API WFP pour {market_name}/{commodity}. "
                "Données simulées utilisées."
            )
            return self._generer_donnees_simulees(time_range)

        # Construction du DataFrame à partir des items validés
        df = pd.DataFrame(items)

        # Renommage vers le format interne standard
        col_mapping = {
            "CommodityPriceDate": "date",
            "ActualPrice": "price",
            "UnitName": "unit",
        }
        df = df.rename(columns={k: v for k, v in col_mapping.items() if k in df.columns})

        if "date" in df.columns:
            df["date"] = pd.to_datetime(df["date"], errors="coerce")

        # Ajout des colonnes standards
        maintenant = datetime.now(timezone.utc).isoformat()
        df["is_simulated"] = False
        df["source"] = "wfp-vam"
        df["fetched_at"] = maintenant

        # ----------------------------------------------------------------
        # Sauvegarde dans le cache SQLite pour les prochains appels
        # ----------------------------------------------------------------
        try:
            nb = sauvegarder_prix(market_name, commodity, df, source="wfp-vam")
            logger.debug(f"Cache : {nb} nouvelles lignes sauvegardées pour {market_name}/{commodity}.")
        except Exception as e:
            # L'échec du cache ne bloque pas le retour des données
            logger.warning(f"Échec de la sauvegarde dans le cache SQLite : {e}")

        # Ajout du score de confiance
        df["confidence_score"] = calculer_score_confiance(
            market_name, commodity, max_age_jours=max_age_jours
        )

        return df

    except requests.exceptions.RequestException as e:
        logger.error(
            f"Erreur API WFP après {self.retry_attempts} tentatives : {e}. "
            "Données simulées utilisées."
        )
        return self._generer_donnees_simulees(time_range)

get_market_functionality_index

get_market_functionality_index(market_id: str) -> float

Retourne l'indice de fonctionnalité d'un marché.

Note : stub V1. Retourne une valeur fixe en attendant l'intégration de données réelles (FEWSNET ou WFP Market Monitor).

Parameters:

Name Type Description Default
market_id str

L'identifiant du marché.

required

Returns:

Name Type Description
float float

Indice de fonctionnalité (stub : 7.9 / 10).

Source code in kadi/market/data_ingestion.py
def get_market_functionality_index(self, market_id: str) -> float:
    """
    Retourne l'indice de fonctionnalité d'un marché.

    Note : stub V1. Retourne une valeur fixe en attendant l'intégration
    de données réelles (FEWSNET ou WFP Market Monitor).

    Args:
        market_id (str): L'identifiant du marché.

    Returns:
        float: Indice de fonctionnalité (stub : 7.9 / 10).
    """
    # Stub V1 : valeur en dur, à remplacer par une vraie source
    return 7.9