Aller au contenu
English

Vérifier les dépendances

  • Leçon 8
  • 40 min
  • Module 3 : Réviser le travail généré

Où nous en sommes

Dans la dernière leçon, nous avons révisé une modification ligne par ligne, et nous l'avons acceptée seulement après la révision. Maintenant arrive une modification qui ajoute un paquet. Un paquet est du code écrit par d'autres qui s'exécute avec vos autorisations, et un assistant peut même suggérer un nom qui n'existe pas. Dans cette leçon, nous vérifions quatre points avant d'installer quoi que ce soit, comme une pièce de vélo recommandée par un inconnu.

Ce que vous saurez faire

Avant d’ajouter un paquet au projet, vérifiez quatre points. Il existe, le projet en a besoin, il est maintenu et compatible avec vos versions, et sa licence convient. Vérifiez aussi chaque fonction appelée par un changement. Faites toutes ces vérifications avant d’installer quoi que ce soit.

Avant de commencerCe qu’il faut savoir et avoir sous la mainEnviron 40 minutes

Ce que vous devez savoir

Ce qu’il vous faut sur votre ordinateur

  • Le projet ~/projects/ticket-cleaner-assist après la dernière leçon, sur feature/category-option, avec son environnement actif. python -m pytest affiche 34 passed (34 tests réussis), et git status indique working tree clean (répertoire de travail propre).
  • Un navigateur Web et une connexion Internet pour deux recherches en lecture seule sur pypi.org.
  • Aucun compte et aucune dépense. Vous n’installez rien dans cette leçon.

Votre vélo fait du bruit. Quelqu’un écrit dans un forum : « Installez une chaîne Hartwell X2. Ça va régler le problème. » Avant d’en commander une, vous vérifiez quelques points. Hartwell fabrique-t-elle vraiment une chaîne X2? Avez-vous besoin d’une nouvelle chaîne, ou le bruit venait-il d’un boulon desserré? La chaîne convient-elle aux engrenages de votre vélo? Et que dit la garantie du magasin si vous l’installez vous-même?

Aucune de ces questions ne suppose que cette personne ment. Elle voulait vous aider, mais un conseil donné avec assurance reste seulement un conseil. Vous vérifiez avant de payer, car une mauvaise pièce coûte de l’argent et peut endommager le vélo.

La proposition D est un changement qui nettoie les noms de catégories. L’équipe du cours l’a construite pour cette leçon. Elle importe un paquet nommé unidecode et l’ajoute aux deux fichiers de dépendances :

candidate D, ticket_cleaner/parsing.py (part)
@@ -1,3 +1,5 @@
+from unidecode import unidecode
+
from ticket_cleaner.records import (
CATEGORY_ALIASES,
PRIORITIES,
@@ -17,8 +19,8 @@ def clean_text(value: object) -> str:
def clean_category(value: object) -> str:
"""Return the category, with the web form's names changed to the report's names."""
- text = str(value).strip()
- return CATEGORY_ALIASES.get(text.lower(), text)
+ text = unidecode(str(value)).strip().lower()
+ return CATEGORY_ALIASES.get(text, text)

Les tests ne démarrent même pas, car le paquet n’est pas installé :

python -m pytest (part)
E ModuleNotFoundError: No module named 'unidecode'
ERROR tests/test_baseline.py
ERROR tests/test_cli.py
ERROR tests/test_parsing.py
!!!!!!!!!!!!!!!!!!! Interrupted: 3 errors during collection !!!!!!!!!!!!!!!!!!!!

Tomás a une réponse rapide :

« L’assistant dit que le paquet existe. Exécutez pip install unidecode, et les tests vont réussir. »

Il a peut-être raison de dire que les tests réussiraient. Mais pip install n’est pas une petite étape. Cette commande télécharge du code écrit par une personne inconnue et l’exécute sur votre ordinateur, avec vos autorisations. Certains paquets exécutent leur propre code pendant l’installation elle-même. Kwame, l’architecte de solutions, pose sa question habituelle : « À quoi peut-il accéder? » Pour n’importe quel paquet, la réponse est : tout ce à quoi vous pouvez accéder.

L’idée : quatre vérifications avant l’installation

Section intitulée « L’idée : quatre vérifications avant l’installation »

Une dépendance est un paquet dont votre projet a besoin, écrit et maintenu par quelqu’un d’autre. ticket-cleaner en nomme trois dans requirements.txt : httpx, pytest et ruff. Chaque ajout est une décision qui exige quatre vérifications, comme pour la chaîne :

  1. Existe-t-il? Vérifiez le nom exact sur pypi.org, le Python Package Index, où pip télécharge les paquets.
  2. Est-il nécessaire? La bibliothèque standard ou le code du projet peuvent-ils faire le travail?
  3. Est-il maintenu et compatible? Quand la dernière version est-elle sortie? Prend-il en charge votre version de Python et les versions que vous avez fixées?
  4. Sa licence convient-elle? Une licence indique ce que vous pouvez faire avec le code. ticket-cleaner utilise MIT, une licence permissive.

La première vérification découle du fonctionnement des assistants. Un modèle écrit le nom qui semble probable, comme vous l’avez vu dans le module 1. Un nom plausible qui n’existe pas s’appelle un paquet halluciné. C’est plus qu’une erreur de frappe. N’importe qui peut enregistrer demain un nom qui n’existe pas aujourd’hui. Cette personne décide alors ce que le paquet fait quand vous l’installez.

Présentons honnêtement ce que le cours a enregistré. L’équipe a demandé aux deux modèles : « Quels paquets pip dois-je installer pour normaliser des noms de catégories comme ceux-ci? » Les deux ont répondu qu’aucun paquet n’était nécessaire (transcriptions deps-ask et deps-ask-small, réelles). Aucun paquet inventé n’a donc été enregistré. Les noms inventés dans cette leçon sont les exemples du cours, vérifiés sur PyPI. Une autre exécution, un autre modèle ou une autre question peuvent donner une réponse différente.

pip peut interroger l’index sur un nom sans rien installer :

Fenêtre de terminal
python -m pip index versions category-normalizer
Sortie
ERROR: No matching distribution found for category-normalizer

Les données de l’index pour ce nom, à https://pypi.org/pypi/category-normalizer/json, donnent la même réponse : HTTP 404, introuvable. La vérification prend dix secondes, et elle s’arrête là. Vous n’essayez pas de noms semblables et vous n’installez rien pour voir ce qui se passe.

Maintenant, un vrai nom :

Fenêtre de terminal
python -m pip index versions Unidecode
Sortie
Unidecode (1.4.0)
Available versions: 1.4.0, 1.3.8, 1.3.7, 1.3.6, 1.3.4, 1.3.3, 1.3.2, 1.2.0, 1.1.2, 1.1.1, 1.1.0, 1.0.23, 1.0.22, 0.4.21, 0.4.20, 0.4.19, 0.4.18, 0.4.17, 0.4.16, 0.4.14, 0.4.13, 0.4.12, 0.4.11, 0.4.10, 0.4.9, 0.4.8, 0.4.7, 0.4.6, 0.4.5, 0.4.1

Unidecode existe, avec 30 versions. Cela répond seulement à la question 1. Sa page de projet répond aux questions 3 et 4. La dernière version, 1.4.0, est sortie le 24 avril 2025 et exige Python 3.7 ou plus récent. Sa licence est la GNU General Public License, version 2 ou ultérieure (GPLv2+). Le diagramme applique les quatre questions à quatre noms :

Une grille avec quatre paquets en colonnes et les quatre questions en lignes. Unidecode 1.4.0, utilisé par la proposition D construite : existe, oui; nécessaire, non, strip, lower et la table d'alias font le travail; dernière version le 24 avril 2025, Python 3.7 ou plus récent; licence GPLv2 ou ultérieure, pas MIT, demander avant l'ajout; décision : rejeter. rapidfuzz 3.14.6 : existe; non nécessaire, les noms sont exacts après le nettoyage; dernière version le 30 août 2026, Python 3.11 ou plus récent; MIT; décision : non nécessaire. python-slugify 9.1.3 : existe; non nécessaire, il crée des identifiants d'URL; dernière version le 7 octobre 2026, mais il exige text-unidecode 1.3 du 30 août 2019; MIT, sa dépendance utilise Artistic License; décision : non nécessaire. category-normalizer, un nom inventé : n'existe pas, HTTP 404 sur pypi.org; les autres questions ne s'appliquent pas; décision : arrêter, ne jamais l'installer avec pip install.
Quatre questions avant pip install, pour quatre noms. Un seul nom échoue à la première question; les trois vrais paquets échouent à la deuxième.
Description textuelle du diagramme

Une grille : les quatre questions sont en lignes, et quatre noms de paquets sont en colonnes. Tous les faits viennent de pypi.org; rien n’a été installé.

  • Unidecode 1.4.0 (utilisé par la proposition D, qui est construite) : il existe. Il n’est pas nécessaire, car strip(), lower() et la table d’alias font le travail. Dernière version le 24 avril 2025, Python 3.7 ou plus récent. Licence GPLv2+, pas MIT : demandez avant de l’ajouter. Décision : rejeter.
  • rapidfuzz 3.14.6 : il existe. Non nécessaire : après le nettoyage, les noms correspondent exactement. Dernière version le 30 août 2026, Python 3.11 ou plus récent. Licence MIT. Décision : non nécessaire.
  • python-slugify 9.1.3 : il existe. Non nécessaire : il crée des adresses Web (« slugs, identifiants d’URL »). Dernière version le 7 octobre 2026, mais il exige text-unidecode 1.3, du 30 août 2019. Licence MIT; sa dépendance utilise Artistic License. Décision : non nécessaire.
  • category-normalizer (un nom inventé) : il n’existe pas (HTTP 404). Les autres questions ne s’appliquent pas. Décision : arrêtez et ne l’installez jamais avec pip install.

Les versions et les licences changent. Vérifiez donc la page actuelle quand vous faites ces vérifications vous-même. Regardez où chaque nom s’arrête. Seul le nom inventé échoue à la première question. Les trois vrais paquets existent, mais tous échouent à la deuxième : le projet n’en a pas besoin. « Il existe » est le début de la vérification, pas la fin.

  1. Appliquez la proposition. N’installez rien :

    Fenêtre de terminal
    git apply ../nextia-learning-labs/C15/candidates/D-new-dependency.patch
    git diff --stat
    Sortie
    requirements-lock.txt | 1 +
    requirements.txt | 1 +
    ticket_cleaner/parsing.py | 6 ++++--
    3 files changed, 6 insertions(+), 2 deletions(-)

    Deux fichiers de dépendances ont changé. ASSISTANT-SCOPE.md exige votre révision avant de les modifier, et la liste de vérification contient une section à ce sujet.

  2. Regardez la nouvelle ligne :

    Fenêtre de terminal
    git diff requirements.txt
    Sortie (extrait)
    # Needed to run the program
    httpx==0.28.1
    Unidecode==1.4.0

    Elle se trouve sous « Needed to run the program » (nécessaire pour exécuter le programme). Toute personne qui exécute ticket-cleaner l’installerait donc, pas seulement les développeurs.

  3. Exécutez les tests et lisez l’erreur :

    Fenêtre de terminal
    python -m pytest

    La sortie se termine par Interrupted: 3 errors during collection (interruption : 3 erreurs pendant la collecte). Chaque erreur est ModuleNotFoundError: No module named 'unidecode' (aucun module nommé « unidecode »). C’est le résultat attendu : le paquet n’est pas installé, et vous ne l’installez pas pour faire disparaître l’erreur.

  4. Vérifiez que le nom existe avec python -m pip index versions Unidecode, comme ci-dessus. Ouvrez ensuite pypi.org/project/Unidecode. Trouvez la date après « Released » (publié) et la licence sous « License » (licence) : GNU General Public License v2 or later (GPLv2+) (licence publique générale GNU, version 2 ou ultérieure). Les versions de Python prises en charge se trouvent plus bas, sur le côté de la page.

  5. Répondez à « est-il nécessaire? » avec des preuves. unidecode fait-il partie de Python? Python fournit une liste des modules de sa bibliothèque standard :

    Fenêtre de terminal
    python -c "import sys; print('re' in sys.stdlib_module_names, 'unidecode' in sys.stdlib_module_names)"
    Sortie
    True False

    re fait partie de Python, mais pas unidecode. La tâche consiste à nettoyer des noms comme LOGIN et Login. Le projet possède déjà une fonction pour cela, clean_text(), comme le montrent les prochaines étapes.

  6. Rejetez la proposition et vérifiez que le projet est revenu à son état précédent :

    Fenêtre de terminal
    git restore .
    git status --short
    python -m pytest

    git status --short n’affiche rien, et les tests affichent 34 passed.

Amira écrit sa décision en une ligne pour la révision : « Rejetée : Unidecode existe, mais il n’est pas nécessaire. Sa licence (GPLv2+) n’est pas MIT. La fonction clean_text() du projet fait le travail. » Chaque partie de cette phrase est une vérification que quelqu’un d’autre peut répéter.

Que signifie GPLv2+ pour Larkfield? La GPL permet d’utiliser et de modifier le code. Si vous distribuez le programme, vous devez partager son code source sous la même licence. MIT n’impose pas cette condition. Cette différence peut compter ou non pour un outil utilisé à l’interne dans une entreprise. Amira ne décide pas seule. Avant l’ajout du paquet, une question de licence doit être transmise à la personne responsable des licences.

Chaque paquet peut avoir besoin d’autres paquets, et pip les installe aussi. python -m pip show les affiche sous « Requires » (dépendances requises) :

Fenêtre de terminal
python -m pip show httpx pytest ruff
Output (the lines Name, Version, License and Requires)
Name: httpx
Version: 0.28.1
License: BSD-3-Clause
Requires: anyio, certifi, httpcore, idna
Name: pytest
Version: 9.1.1
License-Expression: MIT
Requires: iniconfig, packaging, pluggy, pygments
Name: ruff
Version: 0.16.10
License-Expression: MIT
Requires:
À gauche : les trois paquets de requirements.txt et leurs dépendances. httpx 0.28.1, BSD-3-Clause, exige anyio 4.15.1 MIT, qui exige idna 3.20 BSD-3-Clause et typing_extensions 4.16.0 PSF-2.0; certifi 2026.7.22 MPL-2.0; httpcore 1.0.9 BSD-3-Clause, qui exige h11 0.16.0 MIT. pytest 9.1.1 MIT exige iniconfig 2.3.0 MIT, packaging 26.3 Apache-2.0 ou BSD-2-Clause, pluggy 1.6.0 MIT et Pygments 2.21.0 BSD-2-Clause. ruff 0.16.10 MIT n'exige rien. À droite : un paquet de plus, python-slugify 9.1.3, MIT, dernière version le 7 octobre 2026, exige text-unidecode 1.3, Artistic License avec des classificateurs GPL, dernière version le 30 août 2019.
Trois paquets choisis sont devenus 13 paquets installés. Un nouveau paquet apporte ses propres dépendances, chacune avec sa licence et ses responsables de maintenance.
Description textuelle du diagramme

À gauche, les trois paquets de requirements.txt, avec leurs dépendances, selon pip show :

  • httpx 0.28.1 (BSD-3-Clause) exige anyio 4.15.1 (MIT), certifi 2026.7.22 (MPL-2.0), httpcore 1.0.9 (BSD-3-Clause) et idna 3.20 (BSD-3-Clause). anyio exige aussi typing_extensions 4.16.0 (PSF-2.0), et httpcore exige h11 0.16.0 (MIT).
  • pytest 9.1.1 (MIT) exige iniconfig 2.3.0 (MIT), packaging 26.3 (Apache-2.0 ou BSD-2-Clause), pluggy 1.6.0 (MIT) et Pygments 2.21.0 (BSD-2-Clause).
  • ruff 0.16.10 (MIT) n’exige rien.

Cela fait 13 paquets dans requirements-lock.txt. À droite, un paquet de plus : python-slugify 9.1.3 (MIT, dernière version le 7 octobre 2026) exige text-unidecode 1.3. Cette page indique Artistic License et des classificateurs GPL. Sa dernière version est sortie le 30 août 2019.

Ainsi, requirements.txt nomme 3 paquets, et le fichier de verrouillage en contient 13. Votre projet fait déjà confiance à dix paquets que personne dans l’équipe n’a choisis par leur nom. Leurs licences ne sont pas toutes MIT. MPL-2.0 et Apache-2.0 sont aussi des licences de code source ouvert courantes. La plupart des équipes les acceptent pour une bibliothèque qu’elles ne modifient pas. Le but n’est pas de craindre chaque licence. Le but est de savoir ce que contient le projet et de prendre chaque nouvelle décision volontairement.

Le même problème existe un niveau plus bas. Une API (interface de programmation d’applications) regroupe les fonctions, classes et options qu’un paquet ou un module offre à d’autre code. Un assistant peut appeler une fonction inexistante ou une option qui existe seulement dans une version plus récente.

La réponse enregistrée du plus grand modèle disait : « Utilisez clean_text() dans clean_category(). » Avant de lui faire confiance, vérifiez que la fonction existe et fait ce que la réponse affirme :

Fenêtre de terminal
grep -n "def clean_text" ticket_cleaner/parsing.py
python -c "from ticket_cleaner.parsing import clean_text; print(repr(clean_text(' Log-In ')))"
Sortie
11:def clean_text(value: object) -> str:
'log-in'

Sous Windows, utilisez Select-String -Pattern "def clean_text" ticket_cleaner\parsing.py au lieu de grep. La fonction existe, et elle enlève les espaces et les majuscules. log-in figure dans la table d’alias et devient donc login. Vous vérifiez l’affirmation complète dans le module 4, lorsque vous corrigez le bogue de Grace.

Les versions comptent de la même façon. PyPI propose une version plus récente de ruff, 0.17.0, et le projet fixe la version 0.16.10 :

Fenêtre de terminal
ruff --version
Sortie
ruff 0.16.10

Un assistant qui a lu la documentation la plus récente peut suggérer une option absente de votre version fixée. Vérifiez la suggestion avec la version que vous exécutez, pas la plus récente.

Ajoutez un paquet quand il fait bien un travail difficile que votre propre code ferait mal. httpx est un bon exemple : communiquer de façon sûre avec un service Web demande beaucoup de travail. Ce paquet est largement utilisé et maintenu. N’ajoutez pas de paquet pour un travail réalisable avec quelques lignes de la bibliothèque standard, comme nettoyer un nom.

Chaque dépendance a un coût qui continue après l’installation. Quelqu’un doit la mettre à jour, lire ses alertes de sécurité et revérifier sa licence quand elle change. Chaque nouvel environnement la télécharge, et sa maintenance peut cesser. Les quatre vérifications prennent quelques minutes. La dépendance reste pendant des années.

Erreur courante

Installer un nom pour voir s'il existe

Symptôme : Tomás veut vérifier rapidement une suggestion de l’assistant. Il exécute donc pip install ticket-category-normalizer. pip indique qu’aucune distribution correspondante n’existe. Il essaie category-normalizer et normalize-categories de la même façon.

Cause : il utilise la commande d’installation comme outil de recherche. Aujourd’hui, ces noms ne sont pas sur PyPI, donc rien n’a été installé. Mais si l’un d’eux existe demain, la même commande le télécharge et exécute immédiatement son code, avec les autorisations de Tomás. Un nom que les assistants ont tendance à inventer est précisément celui qu’une personne malveillante enregistrerait.

Correction : recherchez un nom sans l’installer : python -m pip index versions NAME, ou https://pypi.org/project/NAME/ dans un navigateur. Pour un nom qui existe, répondez aux quatre questions avant toute installation. ASSISTANT-SCOPE.md le dit déjà : pip install ne s’exécute jamais sans votre révision.

Le plus petit modèle a répondu à la même question avec ce code (transcription deps-ask-small, réelle) :

What the assistant printed (part)
import re
def clean_category(value: object) -> str:
text = re.sub(r"[\s-]+", "-", str(value).strip().casefold())
return CATEGORY_ALIASES.get(text, text)

Il disait : « Vous n’avez pas besoin d’installer un paquet. » Vérifiez cette affirmation et les API utilisées par le code avant de lui faire confiance :

  1. re est-il une nouvelle dépendance?
  2. casefold() et re.sub() existent-elles, et que font-elles avec ' Log In '?
  3. Le résultat correspond-il à une clé de CATEGORY_ALIASES dans ticket_cleaner/records.py?
Afficher la réponse
  1. Non. 're' in sys.stdlib_module_names a affiché True (vrai) : re fait partie de la bibliothèque standard de Python. requirements.txt ne change donc pas.

  2. Oui. Exécutez le code :

    Fenêtre de terminal
    python -c "import re; print(repr(re.sub(r'[\s-]+', '-', ' Log In '.strip().casefold())))"
    Sortie
    'log-in'

    casefold() est une méthode de chaîne, comme lower(), conçue pour comparer du texte. re.sub() remplace chaque suite d’espaces ou de traits d’union par un seul trait d’union.

  3. Oui. grep -n '"log-in"' ticket_cleaner/records.py affiche 9: "log-in": "login",. Ainsi, ' Log In ' devient login.

L’affirmation est valide : aucun paquet n’est nécessaire. La réponse reste seulement une suggestion. Elle change le nettoyage de chaque catégorie. Elle exige donc la même révision et les mêmes tests que tout changement : c’est le travail du module 4.

Vérifiez votre compréhension

Nommez les quatre vérifications à faire avant d'ajouter un paquet, et répondez à chacune pour Unidecode dans la proposition D.

Afficher la réponse
  1. Existe-t-il? Oui : pip index versions Unidecode affiche la version 1.4.0 et 29 versions antérieures.
  2. Est-il nécessaire? Non. strip(), lower(), ainsi que clean_text() et la table d’alias du projet nettoient les noms.
  3. Est-il maintenu et compatible? Sa dernière version date du 24 avril 2025. Il exige Python 3.7 ou plus récent, donc il fonctionnerait avec la version 3.14.
  4. Sa licence convient-elle? GPLv2+, pas MIT. Une personne responsable des licences doit d’abord se prononcer.

Décision : rejeter. Il échoue à la question 2, donc les questions 3 et 4 ne font que confirmer la décision.

Vérifiez votre compréhension

category-normalizer n'est pas sur PyPI aujourd'hui. Pourquoi est-il faux de dire « il n'existe pas, donc pip install est sans danger »?

Afficher la réponse

N’importe qui peut enregistrer un nom disponible sur PyPI à tout moment. Si un assistant suggère souvent category-normalizer, quelqu’un peut l’enregistrer avec du code qui s’exécute sur votre ordinateur à l’installation. Aujourd’hui, la commande échoue, car elle ne trouve aucune distribution correspondante. Demain, la même commande pourrait installer et exécuter le code d’un inconnu avec vos autorisations. Cherchez donc les noms avec pip index versions ou sur la page du projet. N’utilisez jamais pip install pour vérifier.

Vérifiez votre compréhension

Tomás dit : « L'assistant a dit que le paquet existe, et c'est vrai : Unidecode est sur PyPI. Donc la modification convient. » Que manque-t-il à son raisonnement?

Afficher la réponse

L’existence n’est que la première des quatre vérifications. Unidecode existe, mais le projet n’en a pas besoin, et sa licence est GPLv2+ dans un projet sous licence MIT. De plus, dans les enregistrements du cours, les assistants n’ont suggéré aucun paquet : les deux ont dit qu’aucun n’était nécessaire. La proposition D est construite. Peu importe ce que dit un assistant, la décision d’ajouter une dépendance et sa révision relèvent de l’équipe.

Récapitulatif

  • Une dépendance est le code d’une autre personne qui s’exécute avec vos autorisations. pip install vient après la vérification, jamais avant.
  • Quatre vérifications : le paquet existe, il est nécessaire, il est maintenu et compatible avec vos versions, sa licence convient. Les trois vrais paquets de l’exemple existent, et le projet n’a besoin d’aucun d’eux.
  • Un paquet halluciné est un nom qu’un assistant suggère et qui n’existe pas. Cherchez les noms avec python -m pip index versions ou sur pypi.org; un nom absent aujourd’hui peut être enregistré demain.
  • Un paquet apporte ses propres paquets : 3 sont nommés dans requirements.txt, 13 dans le fichier de verrouillage.
  • Vérifiez aussi les fonctions et les options : grep, un python -c d’une seule ligne, et la version que vous exécutez.
  • La proposition D est rejetée. Votre projet reste inchangé : 34 passed (34 tests réussis).

Ensuite, une modification qui semble utile supprime des fichiers et affiche un secret. Vous apprenez à suivre chaque valeur jusqu’à l’endroit où elle est utilisée.

Leçon suivante : Réviser la sécurité et le traitement des données