Gérer les packages Python

Cette page décrit comment ajouter, afficher et supprimer des packages Python et des versions de packages.

Avant de commencer

  1. Installez et initialisez la Google Cloud CLI.

    Vous devez disposer de la version 354.0.0 ou ultérieure de Google Cloud CLI pour exécuter des commandes pour les dépôts Python. Vous pouvez vérifier la version avec la commande suivante:

    gcloud version

  2. Si le dépôt cible n'existe pas, créez un dépôt de paquets Python.

  3. Vérifiez que Python 3 est installé. Pour obtenir des instructions d'installation, consultez leGoogle Cloud tutoriel de configuration de Python.

  4. (Facultatif) Configurez des valeurs par défaut pour les commandes gcloud.

  5. Si vous utilisez l'authentification par trousseau avec des identifiants gcloud, connectez-vous à Google Cloud CLI avec votre compte utilisateur ou votre compte de service.

Rôles requis

Pour obtenir les autorisations nécessaires pour gérer les packages, demandez à votre administrateur de vous accorder les rôles IAM suivants sur le dépôt:

Pour en savoir plus sur l'attribution de rôles, consultez la page Gérer l'accès aux projets, aux dossiers et aux organisations.

Vous pouvez également obtenir les autorisations requises via des rôles personnalisés ou d'autres rôles prédéfinis.

Ajouter des packages

Modes de dépôt: standard

Lorsque vous créez un projet Python, les fichiers de distribution sont enregistrés dans un sous-répertoire dist de votre projet. Vous pouvez ensuite utiliser Twine pour importer des packages dans un dépôt standard.

Nous vous recommandons de suivre les bonnes pratiques suivantes pour vos packages:

  • Utilisez des noms uniques pour vos packages privés afin qu'ils ne correspondent pas aux noms de package sur pypi.org, en particulier si votre configuration pip inclut plusieurs index de packages.
  • Utilisez la spécification de l'identifiant de version dans le PEP 440 pour vos numéros de version de package. Par défaut, pip n'installe que les versions stables. Il utilise la spécification de l'identifiant de version pour distinguer les versions stables des versions préliminaires et pour analyser les exigences de la version à installer.

Pour ajouter un package :

  1. Installez Twine.

    pip install twine

  2. Accédez au répertoire de votre projet Python.

  3. Importez les fichiers de distribution dans le dépôt à partir du sous-répertoire dist du projet. Exécutez la commande suivante :

    twine upload dist/*

    Vous pouvez spécifier un dépôt particulier avec l'option --repository-url.

    twine upload --repository-url https://LOCATION-python.pkg.dev/PROJECT/REPOSITORY/ dist/*

Afficher des packages et des versions

Modes de dépôt: standard, distant

Pour afficher les packages et les versions de package à l'aide de la console Google Cloud ou de gcloud:

Console

  1. Ouvrez la page Dépôts de la console Google Cloud.

    Ouvrir la page "Dépôts"

  2. Dans la liste des dépôts, cliquez sur le dépôt approprié.

    La page Packages répertorie les packages du dépôt.

  3. Cliquez sur un package pour afficher ses versions.

gcloud

Pour répertorier les packages d'un dépôt, exécutez la commande suivante :

gcloud artifacts packages list [--repository=REPOSITORY] [--location=LOCATION]

Remplacez les éléments suivants :

  • REPOSITORY est le nom du dépôt. Si vous avez configuré un dépôt par défaut, vous pouvez omettre cet indicateur pour utiliser le dépôt par défaut.
  • LOCATION est l'emplacement régional ou multirégional du dépôt. Si vous avez configuré un emplacement par défaut, vous pouvez omettre cet indicateur pour utiliser la valeur par défaut.

Pour afficher les versions d'un package, exécutez la commande suivante :

gcloud artifacts versions list --package=PACKAGE \
    [--repository=REPOSITORY] [--location=LOCATION]

Remplacez les éléments suivants :

  • PACKAGE est l'ID du package ou l'identifiant complet du package.
  • REPOSITORY est le nom du dépôt. Si vous avez configuré un dépôt par défaut, vous pouvez omettre cet indicateur pour utiliser le dépôt par défaut.
  • LOCATION est l'emplacement régional ou multirégional du dépôt. Utilisez cette option pour afficher les dépôts dans un emplacement spécifique. Si vous avez configuré un emplacement par défaut, vous pouvez omettre cette option pour utiliser la valeur par défaut.

Pour les dépôts distants, la liste renvoyée doit inclure toutes les dépendances directes et transitives.

Répertorier les fichiers

Modes de dépôt: standard, distant

Vous pouvez lister les fichiers d'un dépôt, les fichiers de toutes les versions d'un package spécifié ou les fichiers d'une version spécifique d'un package.

Pour toutes les commandes suivantes, vous pouvez définir un nombre maximal de fichiers à renvoyer en ajoutant l'indicateur --limit à la commande.

Pour répertorier tous les fichiers dans le projet, le dépôt et l'emplacement par défaut lorsque les valeurs par défaut sont configurées:

gcloud artifacts files list

Pour répertorier les fichiers d'un projet, d'un dépôt et d'un emplacement spécifiés, exécutez la commande suivante:

gcloud artifacts files list \
    --project=PROJECT \
    --repository=REPOSITORY \
    --location=LOCATION

Pour lister les fichiers de toutes les versions d'un package spécifique:

gcloud artifacts files list \
    --project=PROJECT \
    --repository=REPOSITORY \
    --location=LOCATION \
    --package=PACKAGE

Pour lister les fichiers d'une version de package spécifique:

gcloud artifacts files list \
    --project=PROJECT \
    --repository=REPOSITORY \
    --location=LOCATION \
    --package=PACKAGE \
    --version=VERSION

Remplacez les valeurs suivantes :

  • LOCATION: emplacement régional ou multirégional du dépôt.
  • PROJECT: votre Google Cloud ID de projet. Si l'ID de votre projet contient un signe deux-points (:), consultez la section Projets à l'échelle du domaine.
  • REPOSITORY: nom du dépôt où l'image est stockée.
  • PACKAGE: nom du package.
  • VERSION: version du package.

Examples

Prenons l'exemple des informations suivantes sur un package:

  • Projet : my-project
  • Dépôt: my-repo
  • Emplacement du dépôt : us-west1
  • Package: my-app

La commande suivante répertorie tous les fichiers du dépôt my-repo à l'emplacement us-west1 dans le projet par défaut:

gcloud artifacts files list \
    --location=us-west1 \
    --repository=my-repo
La commande suivante liste les fichiers de la version 1.0 du package.

gcloud artifacts files list \
    --project=my-project \
    --location=us-west1 \
    --repository=my-repo \
    --package=my-app \
    --version=1.0

Installer des packages

Modes de dépôt: standard, distant, virtuel

Utilisez la commande pip pour installer des packages.

Pour installer la dernière version stable d'un package, exécutez la commande suivante:

pip install PACKAGE

Pour les dépôts standards, vous téléchargez un paquet directement à partir du dépôt.

Pour un dépôt distant, vous téléchargez une copie mise en cache du package et de ses dépendances. Si aucune copie mise en cache n'existe, le dépôt distant télécharge le package à partir de la source en amont et le met en cache avant de vous le fournir. Vous pouvez vérifier que le dépôt distant a récupéré les paquets à partir de la source en amont en consultant la liste des paquets dans le dépôt.

Pour un dépôt virtuel, Artifact Registry recherche le package demandé dans les dépôts en amont.

  • Les dépôts distants en amont téléchargent et mettent en cache le package demandé si aucune copie mise en cache n'existe. Les dépôts virtuels ne diffusent que les packages demandés, ils ne les stockent pas.
  • Si vous demandez une version disponible dans plusieurs dépôts en amont, Artifact Registry choisit un dépôt en amont à utiliser en fonction des paramètres de priorité configurés pour le dépôt virtuel.

Prenons l'exemple d'un dépôt virtuel avec les paramètres de priorité suivants pour les dépôts en amont:

  • main-repo: priorité définie sur 100
  • secondary-repo1: priorité définie sur 80.
  • secondary-repo2: priorité définie sur 80.
  • test-repo: priorité définie sur 20.

main-repo a la valeur de priorité la plus élevée. Le dépôt virtuel le recherche donc toujours en premier.

La priorité de secondary-repo1 et de secondary-repo2 est définie sur 80. Si un package demandé n'est pas disponible dans main-repo, Artifact Registry recherche ensuite dans ces dépôts. Comme ils ont tous les deux la même valeur de priorité, Artifact Registry peut choisir de diffuser un package à partir de l'un ou l'autre des dépôts si la version est disponible dans les deux.

test-repo a la valeur de priorité la plus basse et servira un artefact stocké si aucun des autres dépôts en amont ne l'a pas.

Informations supplémentaires

Par défaut, pip installe les versions stables d'un paquet et ignore les versions préliminaires. PEP 440 définit la spécification de l'identifiant de version Python qui permet aux utilisateurs de pip d'analyser les numéros de version, y compris les versions préliminaires.

Pour inclure les versions préliminaires lorsque pip recherche un package à installer, ajoutez l'indicateur --pre à votre commande.

pip install --pre PACKAGE

Pour spécifier une version ou une plage de versions requises, incluez un spécificateur de conditions requises. Vous pouvez inclure la version requise directement dans votre commande ou utiliser un fichier de conditions requises.

Par exemple, cette commande spécifie que la version minimale de my-package est la version de développement 1.0.dev0.

pip install --pre my-package>=1.0.dev0

Les versions stables sont considérées comme plus récentes que les versions préliminaires. Par conséquent, si la version 1.0 est dans le dépôt, pip choisira la version 1.0 plutôt qu'une version préliminaire.

Si vous ne spécifiez pas de dépôt, votre configuration pip dans pip.conf détermine la façon dont pip recherche le package.

  • Si vous avez configuré le dépôt Artifact Registry avec le paramètre index-url et qu'aucun autre indice de paquet n'est configuré, pip ne recherche que le paquet dans votre dépôt Artifact Registry.
  • Si vous utilisez un dépôt virtuel, Artifact Registry utilise les priorités configurées dans la règle en amont pour choisir un package lorsque plusieurs dépôts en amont disposent de la version de package demandée. Si deux dépôts contenant le package ont la même priorité, Artifact Registry le diffuse à partir de l'un ou l'autre.
  • Si vous avez configuré pip avec le paramètre extra-index-url ou si vous avez configuré plusieurs index de paquets, pip recherche pypi.org et tous les autres index de paquets configurés, puis choisit la dernière version du paquet.

Vous pouvez remplacer les paramètres index-url ou extra-index-url dans votre fichier d'exigences. Vous pouvez également utiliser des options pour ces paramètres dans votre commande pip. Par exemple, cette commande remplace index-url par un dépôt Artifact Registry.

pip install --index-url https://us-east1-python.pkg.dev/my-project/python-repo/simple/ my-package

Pour en savoir plus sur l'installation de packages, consultez la documentation sur le packaging Python.

Supprimer des packages et des versions

Modes de dépôt: standard, distant

Vous pouvez supprimer un package et toutes ses versions, ou supprimer une version spécifique.

  • Une fois qu'un package a été supprimé, vous ne pouvez pas annuler l'action.
  • Pour les dépôts distants, seule la copie mise en cache du package est supprimée. La source en amont n'est pas affectée. Si vous supprimez un package mis en cache, Artifact Registry le téléchargera et le mettra à nouveau en cache la prochaine fois que le dépôt recevra une requête pour la même version du package.

Avant de supprimer un package ou une version de package, vérifiez que vous avez communiqué ou résolu toute dépendance importante associée.

Pour supprimer un package, procédez comme suit :

Console

  1. Ouvrez la page Dépôts de la console Google Cloud.

    Ouvrir la page "Dépôts"

  2. Dans la liste des dépôts, cliquez sur le dépôt approprié.

    La page Packages répertorie les packages du dépôt.

  3. Sélectionnez le package que vous souhaitez supprimer.

  4. Cliquez sur SUPPRIMER.

  5. Dans la boîte de dialogue de confirmation, cliquez sur SUPPRIMER.

gcloud

Exécutez la commande ci-dessous.

gcloud artifacts packages delete PACKAGE \
    [--repository=REPOSITORY] [--location=LOCATION] [--async]

Remplacez les éléments suivants :

  • PACKAGE est le nom du package dans le dépôt.
  • REPOSITORY est le nom du dépôt. Si vous avez configuré un dépôt par défaut, vous pouvez omettre cet indicateur pour utiliser le dépôt par défaut.
  • LOCATION est l'emplacement régional ou multirégional du dépôt. Utilisez cette option pour afficher les dépôts dans un emplacement spécifique. Si vous avez configuré un emplacement par défaut, vous pouvez omettre cette option pour utiliser la valeur par défaut.

L'option --async permet à la commande de renvoyer immédiatement une réponse, sans attendre la fin de l'opération en cours.

Pour supprimer des versions d'un package, procédez comme suit :

Console

  1. Ouvrez la page Dépôts de la console Google Cloud.

    Ouvrir la page "Dépôts"

  2. Dans la liste des dépôts, cliquez sur le dépôt approprié.

    La page Packages répertorie les packages du dépôt.

  3. Cliquez sur un package pour afficher ses versions.

  4. Sélectionnez les versions que vous souhaitez supprimer.

  5. Cliquez sur SUPPRIMER.

  6. Dans la boîte de dialogue de confirmation, cliquez sur SUPPRIMER.

gcloud

Exécutez la commande ci-dessous.

gcloud artifacts versions delete VERSION \
    --package=PACKAGE \
    [--repository=REPOSITORY] [--location=LOCATION] \
    [--async]

Remplacez les éléments suivants :

  • VERSION correspond au nom de la version à supprimer.
  • PACKAGE est le nom du package dans le dépôt.
  • REPOSITORY est le nom du dépôt. Si vous avez configuré un dépôt par défaut, vous pouvez omettre cet indicateur pour utiliser le dépôt par défaut.
  • LOCATION est l'emplacement régional ou multirégional du dépôt. Utilisez cette option pour afficher les dépôts dans un emplacement spécifique. Si vous avez configuré un emplacement par défaut, vous pouvez omettre cette option pour utiliser la valeur par défaut.

L'option --async permet à la commande de renvoyer immédiatement une réponse, sans attendre la fin de l'opération en cours.

Étape suivante