Administra paquetes de Python

En esta página, se describe cómo agregar, ver y borrar paquetes y versiones de paquetes de Python.

Antes de comenzar

1. Instala e initialize de Google Cloud CLI.

   Se requiere la versión 354.0.0 de Google Cloud CLI o una más reciente para ejecutar comandos en los repositorios de Python. Puedes verificar la versión con el siguiente comando:

   gcloud version
   

2. Si el repositorio de destino no existe, crea un nuevo repositorio de paquetes de Python.

3. Verifica que Python 3 esté instalado. Si deseas obtener instrucciones de instalación, consulta el instructivo para configurar Python de Google Cloud.

4. (Opcional) Configura valores predeterminados para los comandos de gcloud.

5. Si usas la autenticación de llavero de claves con credenciales de gcloud, accede a Google Cloud CLI con tu cuenta de usuario o servicio.

Funciones obligatorias

A fin de obtener los permisos que necesitas para administrar paquetes, pídele a tu administrador que te otorgue los siguientes roles de IAM en el repositorio:

• Ver paquetes o archivos en paquetes: Lector de Artifact Registry (roles/artifactregistry.reader)
• Descarga o instala paquetes: Lector de Artifact Registry (roles/artifactregistry.reader)
• Agrega paquetes a un repositorio: Escritor de Artifact Registry (roles/artifactregistry.writer)
• Borrar paquetes: Administrador del repositorio de Artifact Registry (roles/artifactregistry.repoAdmin)

Si quieres obtener más información para otorgar funciones, consulta Administra el acceso.

Es posible que también puedas obtener los permisos necesarios mediante funciones personalizadas, o bien otras funciones predefinidas.

Agrega paquetes

Modos de repositorio: Estándar

Cuando compilas un proyecto de Python, los archivos de distribución se guardan en un subdirectorio dist de tu proyecto. Luego, puedes usar Twine para cargar paquetes en un repositorio estándar.

Te recomendamos las siguientes prácticas recomendadas para tus paquetes:

• Usa nombres únicos para tus paquetes privados de modo que no coincidan con los nombres de paquetes en pypi.org, en especial si tu configuración de pip incluye varios índices de paquetes.
• Usa la especificación del identificador de versión en PEP 440 para los números de versión de tus paquetes. De forma predeterminada, pip solo instala versiones estables. Usa la especificación del identificador de versión para distinguir las versiones estables de las previas al lanzamiento y para analizar los requisitos de la versión que se instalará.

Para agregar un paquete, haz lo siguiente:

1. Instala Twine.

   pip install twine
   

2. Cambia al directorio de tu proyecto de Python.

3. Sube los archivos de distribución al repositorio desde el subdirectorio dist del proyecto. Ejecuta el siguiente comando:

   twine upload dist/*
   

   Puedes especificar un repositorio en particular con la marca --repository-url.

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

Nota: De forma predeterminada, Twine no muestra mensajes de error detallados. Si encuentras un error, vuelve a ejecutar el comando Twine con la marca --verbose para obtener un mensaje más detallado. Consulta Solución de problemas para paquetes de Python a fin de obtener información sobre algunos códigos de error comunes.

Visualiza paquetes y versiones

Modos de repositorio: Estándar, remoto

Para ver los paquetes y sus versiones con Google Cloud Console o gcloud, sigue estos pasos:

Consola

1. Abre la página Repositorios en la consola de Google Cloud.

   Abrir la página Repositorios

2. En la lista de repositorios, haz clic en el repositorio correspondiente.

   En la página Paquetes, se enumeran los paquetes del repositorio.

3. Haz clic en un paquete para ver las versiones de este.

gcloud

Para enumerar los paquetes en un repositorio, ejecuta el siguiente comando:

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

¿Por dónde

• REPOSITORY es el nombre del repositorio. Si configuraste un repositorio predeterminado, puedes omitir esta marca para usarlo.
• LOCATION es una ubicación regional o multirregional. Usa esta marca para ver los repositorios en una ubicación específica. Si configuraste una ubicación predeterminada, puedes omitir esta marca para usarla.

Para ver las versiones de un paquete, ejecuta el siguiente comando:

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

Donde

• PACKAGE es el ID del paquete o el identificador completamente calificado del paquete.
• REPOSITORY es el nombre del repositorio. Si configuraste un repositorio predeterminado, puedes omitir esta marca para usarlo.
• LOCATION es una ubicación regional o multirregional. Usa esta marca para ver los repositorios en una ubicación específica. Si configuraste una ubicación predeterminada, puedes omitir esta marca para usarla.

Para los repositorios remotos, la lista que se muestra debe incluir todas las dependencias directas y transitivas.

Cómo mostrar una lista de archivos

Modos de repositorio: Estándar, remoto

Puedes enumerar archivos en un repositorio, archivos en todas las versiones de un paquete específico o archivos en una versión específica de un paquete.

En todos los comandos siguientes, puedes agregar la marca --limit al comando para configurar una cantidad máxima de archivos que se mostrarán.

Para enumerar todos los archivos en el proyecto, el repositorio y la ubicación predeterminados cuando se configuran los valores predeterminados, haz lo siguiente:

gcloud artifacts files list

Para mostrar una lista de archivos en un proyecto, un repositorio y una ubicación especificados, ejecuta el siguiente comando:

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

Si quieres generar una lista de archivos para todas las versiones de un paquete específico, haz lo siguiente:

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

Para hacer una lista de los archivos de una versión específica del paquete:

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

Reemplaza los siguientes valores:

• LOCATION es la ubicación regional o multirregional del repositorio.
• PROJECT es el ID del proyecto de Google Cloud. Si el ID de tu proyecto contiene dos puntos (:), consulta Proyectos con alcance de dominio.
• REPOSITORY es el nombre del repositorio en el que se almacena la imagen.
• PACKAGE es el nombre del paquete.
• VERSION es la versión del paquete.

Ejemplos

Ten en cuenta la siguiente información del paquete:

• Proyecto: my-project
• Repositorio: my-repo
• Ubicación del repositorio: us-central1
• Paquete: my-app

Con el siguiente comando, se enumeran todos los archivos del repositorio my-repo en la ubicación us-central1 dentro del proyecto predeterminado:

gcloud artifacts files list \
    --location=us-central1 \
    --repository=my-repo

Con el siguiente comando, se enumeran los archivos de la versión 1.0 del paquete.

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

Instala paquetes

Modos de repositorio: estándar, remoto, virtual

Usa el comando pip para instalar paquetes.

Para instalar la última versión estable de un paquete, ejecuta el siguiente comando:

pip install PACKAGE

En los repositorios estándar, debes descargar un paquete directamente desde el repositorio.

Para un repositorio remoto, descarga una copia almacenada en caché del paquete y sus dependencias. Si no existe una copia almacenada en caché, el repositorio remoto descarga el paquete de la fuente ascendente y lo almacena en caché antes de entregártelo. Para verificar si el repositorio remoto recuperó los paquetes de la fuente ascendente, observa la lista de paquetes en el repositorio.

En el caso de un repositorio virtual, Artifact Registry busca el paquete solicitado en los repositorios ascendentes.

• Los repositorios remotos upstream descargarán y almacenarán en caché el paquete solicitado si no existe una copia almacenada en caché. Los repositorios virtuales solo entregan paquetes solicitados, no los almacenan.
• Si solicitas una versión que está disponible en más de un repositorio upstream, Artifact Registry elige un repositorio upstream para usar en función de la configuración de prioridad establecida para el repositorio virtual.

Por ejemplo, considera un repositorio virtual con la siguiente configuración de prioridad para repositorios upstream:

• main-repo: Se estableció la prioridad en 100
• secondary-repo1: La prioridad se estableció en 80.
• secondary-repo2: La prioridad se estableció en 80.
• test-repo: La prioridad se estableció en 20.

main-repo tiene el valor de prioridad más alto, por lo que el repositorio virtual siempre lo busca primero.

secondary-repo1 y secondary-repo2 tienen la prioridad establecida en 80. Si un paquete solicitado no está disponible en main-repo, Artifact Registry busca en estos repositorios a continuación. Como ambos tienen el mismo valor de prioridad, Artifact Registry puede optar por entregar un paquete de cualquiera de los repositorios si la versión está disponible en ambos.

test-repo tiene el valor de prioridad más bajo y entregará un artefacto almacenado si ninguno de los otros repositorios upstream lo tiene.

Información adicional

De forma predeterminada, pip instala versiones estables de un paquete e ignora las versiones previas al lanzamiento. PEP 440 define la especificación del identificador de la versión de Python que los usuarios de pip deben analizar los números de versión, incluidas las versiones previas al lanzamiento.

Para incluir versiones previas al lanzamiento cuando pip busque un paquete para instalar, usa la marca --pre en tu comando.

pip install --pre PACKAGE

Para indicar una versión o un rango de versiones obligatorios, incluye un especificador de requisitos. Puedes incluir el requisito de versión directamente en tu comando o usar un archivo de requisitos.

Por ejemplo, este comando especifica que la versión mínima de my-package es la versión de desarrollo 1.0.dev0.

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

Las versiones estables se consideran más recientes que las previas al lanzamiento, por lo que, si la versión 1.0 está en el repositorio, pip elegirá la versión 1.0 en lugar de una previa al lanzamiento.

Si no especificas un repositorio, tu configuración de pip en pip.conf determina cómo pip busca el paquete.

• Si configuraste el repositorio de Artifact Registry con el parámetro de configuración index-url y no hay otros índices de paquetes configurados, pip solo busca el paquete en el repositorio de Artifact Registry.
• Si usas un repositorio virtual, Artifact Registry usa las prioridades configuradas en la política ascendente para elegir un paquete cuando varios repositorios ascendentes tengan la versión solicitada. Si dos repositorios con el paquete tienen la misma prioridad, Artifact Registry los entrega desde cualquiera de ellos.
• Si configuraste pip con el parámetro de configuración extra-index-url o si configuraste varios índices de paquetes, pip busca en pypi.org y cualquier otro índice de paquetes configurado y elige la versión más reciente del paquete.

Puedes anular la configuración index-url o extra-index-url en el archivo de requisitos. También puedes usar marcas para esta configuración en tu comando de pip. Por ejemplo, este comando anula index-url con un repositorio de Artifact Registry.

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

Para obtener más información sobre la instalación de paquetes, consulta la documentación sobre paquetes de Python.

Nota: De forma predeterminada, pip no muestra mensajes de error detallados. Si encuentras un error, vuelve a ejecutar el comando con las marcas -v o -vv para obtener un resultado más detallado. Consulta Solución de problemas para paquetes de Python a fin de obtener más información.

Borra paquetes y versiones

Modos de repositorio: Estándar, remoto

Puedes borrar un paquete y todas sus versiones o borrar una versión específica.

• Una vez que borres un paquete, no podrás deshacer la acción.
• En el caso de los repositorios remotos, solo se borra la copia almacenada en caché del paquete. La fuente ascendente no se ve afectada. Si borras un paquete almacenado en caché, Artifact Registry lo descargará y volverá a almacenar en caché la próxima vez que el repositorio reciba una solicitud para la misma versión del paquete.

Antes de borrar un paquete o una versión de un paquete, verifica que se haya comunicado o abordado cualquier dependencia importante en este.

Para borrar un paquete, haz lo siguiente:

Consola

1. Abre la página Repositorios en la consola de Google Cloud.

   Abrir la página Repositorios

2. En la lista de repositorios, haz clic en el repositorio correspondiente.

   En la página Paquetes, se enumeran los paquetes del repositorio.

3. Selecciona el paquete que quieres borrar.

4. Haz clic en BORRAR.

5. En el cuadro de diálogo de confirmación, haz clic en BORRAR.

gcloud

Ejecuta el siguiente comando:

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

¿Por dónde

• PACKAGE es el nombre del paquete en el repositorio.
• REPOSITORY es el nombre del repositorio. Si configuraste un repositorio predeterminado, puedes omitir esta marca para usarlo.
• LOCATION es una ubicación regional o multirregional. Usa esta marca para ver los repositorios en una ubicación específica. Si configuraste una ubicación predeterminada, puedes omitir esta marca para usarla.
• --async se muestra de inmediato, sin necesidad de esperar a que se complete la operación en curso.

Para borrar versiones de un paquete, haz lo siguiente:

Consola

1. Abre la página Repositorios en la consola de Google Cloud.

   Abrir la página Repositorios

2. En la lista de repositorios, haz clic en el repositorio correspondiente.

   En la página Paquetes, se enumeran los paquetes del repositorio.

3. Haz clic en un paquete para ver sus versiones.

4. Selecciona las versiones que deseas borrar.

5. Haz clic en BORRAR.

6. En el cuadro de diálogo de confirmación, haz clic en BORRAR.

gcloud

Ejecuta el siguiente comando:

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

¿Por dónde

• PACKAGE es el nombre del paquete en el repositorio.
• REPOSITORY es el nombre del repositorio. Si configuraste un repositorio predeterminado, puedes omitir esta marca para usarlo.
• LOCATION es una ubicación regional o multirregional. Usa esta marca para ver los repositorios en una ubicación específica. Si configuraste una ubicación predeterminada, puedes omitir esta marca para usarla.
• --async se muestra de inmediato, sin necesidad de esperar a que se complete la operación en curso.

¿Qué sigue?

• Obtén más información para administrar paquetes de Java.
• Obtén más información para administrar paquetes de Node.js
• Aprende a administrar imágenes de contenedor