Utilisez des dossiers Python dans les chemins de recherche Visual Studio

  • Article

Dans un programme Python typique, la variable d’environnement PYTHONPATH (ou IRONPYTHONPATH, et ainsi de suite) fournit le chemin de recherche par défaut pour les fichiers de module. Les instructions from <name> import... ou import <name> indiquent à Python de rechercher les emplacements spécifiques pour les fichiers correspondant au <name> spécifié. Les emplacements sont recherchés dans l’ordre suivant :

  1. Modules intégrés à Python
  2. Le dossier contenant le code Python en cours d’exécution
  3. Le « chemin de recherche des modules » tel que défini par la variable d’environnement applicable (Pour plus d’informations, veuillez consulter Le chemin de recherche des modules et Variables d’environnement dans la documentation de base de Python.)

Visual Studio ignore la variable d’environnement de chemin de recherche, même lorsque la variable est définie pour l’ensemble du système. La raison en est que l’utilisation de la variable pose des questions auxquelles il n’est pas facile de répondre, telles que :

  • Les modules référencés s’attendent-ils à une installation de Python 2.7, Python 3.6 ou une autre version ?
  • Les fichiers trouvés dans la variable d’environnement de chemin de recherche doivent-ils remplacer les modules de la bibliothèque standard ?
  • Est-ce qu’un comportement de remplacement est attendu et pris en compte, ou l’action pourrait-elle être malveillante ?

Pour aider les développeurs, Visual Studio propose un moyen de spécifier directement les chemins de recherche dans les environnements Python et les projets. Le code que vous exécutez ou déboguez dans Visual Studio reçoit des chemins de recherche à partir de la variable d’environnement PYTHONPATH et de la variable équivalente. En ajoutant des chemins de recherche, Visual Studio inspecte les bibliothèques aux emplacements spécifiés et construit des bases de données IntelliSense pour les bibliothèques au besoin. (Dans Visual Studio 2017 version 15.5 et antérieures, la construction de la base de données peut prendre du temps en fonction du nombre de bibliothèques).

Prérequis

  • Visual Studio. Pour installer le produit, suivez les étapes décrites dans Installer Visual Studio.

  • Dossiers Python que vous souhaitez ajouter à vos chemins de recherche.

Ajouter des dossiers Python aux chemins de recherche

Suivez ces étapes pour ajouter un dossier Python aux chemins de recherche de Visual Studio :

  1. Dans l’Explorateur de solutions, développez le nœud de votre projet Python, faites un clic droit sur Chemins de recherche, et sélectionnez Ajouter un dossier au chemin de recherche :

    Capture d’écran montrant comment accéder à la commande Ajouter un dossier au chemin de recherche sur les chemins de recherche d’un projet Python dans Explorateur de solutions.

  2. Dans la boîte de dialogue, naviguez jusqu’à l’emplacement du dossier que vous souhaitez ajouter aux chemins de recherche reconnus.

  3. Sélectionnez le dossier, puis choisissez Sélectionner le dossier.

Une fois les dossiers ajoutés aux chemins de recherche, Visual Studio utilise ces chemins pour tout environnement associé au projet.

Remarque

Si votre environnement est basé sur Python 3 et que vous tentez d’ajouter un chemin de recherche vers des modules Python 2.7, vous pouvez rencontrer des erreurs.

Ajouter des fichiers zip et egg aux chemins de recherche

Vous pouvez ajouter des fichiers avec une extension .zip ou .egg à vos chemins de recherche avec l’option Ajouter une archive Zip au chemin de recherche. À l’instar des dossiers, le contenu de ces fichiers est analysé et mis à disposition d’IntelliSense.

Contenu connexe