Revisando Python Packaging con Pipenv

() translation by (you can also view the original English article)

Resumen

Python es uno de los lenguajes más amigables y poderosos que existen. Es fácil de aprender para los principiantes, pero tiene un gran impacto y se usa ampliamente en diversos dominios, como programación científica, programación de aplicaciones web y DevOps. Pero uno de los puntos más débiles de Python ha sido su soporte para empaquetar aplicaciones complejas y sus dependencias.

Con los años, se han realizado muchos esfuerzos para mejorar la situación. En agosto de 2017, escribí un tutorial sobre el estado del arte en el empaquetado de Python: Cómo escribir, empaquetar y distribuir una biblioteca en Python.

Han pasado solo cuatro meses, y hay un nuevo jugador en la ciudad. Pipenv es ahora la herramienta oficial recomendada para el empaquetado por PyPA (Python Packaging Authority). En este tutorial aprenderá por qué Pipenv mejora significativamente el estado del empaque y el flujo de trabajo de desarrollo general para los desarrolladores de Python y cómo usarlo de manera efectiva.

Flujo de trabajo de Python Dev para humanos

El objetivo de Pipenv es mejorar el flujo de trabajo de desarrollo de los desarrolladores de Python cuando se trata de administrar dependencias y entornos virtuales. Es otra excelente biblioteca del industrioso Kenneth Reitz, conocido principalmente por el paquete de solicitudes (HTTP para humanos), pero escribió algunos otros excelentes paquetes.

¿Necesitamos otra herramienta de embalaje?

¡Sí! Pipenv toma una página de las prácticas modernas de administración de paquetes y las importa al mundo de Python.

Instalando Pipenv

Puede instalar Pipenv con pip install pipenv. Obtendrás un buen resultado con emojis:

1	$ pip install pipenv
2	✨🍰✨

$ curl https://github.com/pypa/pipenv/blob/master/get-pipenv.py | pitón>

~/git > mkdir testpipenv
~/git > cd testpipenv
~/git/testpipenv > pipenv --three

Output:

Creating a virtualenv for this project…
Using /usr/local/bin/python3 to create virtualenv…
⠋Running virtualenv with interpreter /usr/local/bin/python3
Using base prefix '/usr/local/Cellar/python3/3.6.3/Frameworks/Python.framework/Versions/3.6'
New python executable in /Users/gigi.sayfan/.local/share/virtualenvs/testpipenv-0GShD6dy/bin/python3.6
Also creating executable in /Users/gigi.sayfan/.local/share/virtualenvs/testpipenv-0GShD6dy/bin/python
Installing setuptools, pip, wheel...done.

Virtualenv location: /Users/gigi.sayfan/.local/share/virtualenvs/testpipenv-0GShD6dy
Creating a Pipfile for this project…

~/git/testpipenv > pipenv install requests

Output:


Installing requests…
Collecting requests
  Using cached requests-2.18.4-py2.py3-none-any.whl
Collecting idna<2.7,>=2.5 (from requests)
  Using cached idna-2.6-py2.py3-none-any.whl
Collecting chardet<3.1.0,>=3.0.2 (from requests)
  Using cached chardet-3.0.4-py2.py3-none-any.whl
Collecting certifi>=2017.4.17 (from requests)
  Using cached certifi-2017.11.5-py2.py3-none-any.whl
Collecting urllib3<1.23,>=1.21.1 (from requests)
  Using cached urllib3-1.22-py2.py3-none-any.whl
Installing collected packages: idna, chardet, certifi, urllib3, requests
Successfully installed certifi-2017.11.5 chardet-3.0.4 idna-2.6 requests-2.18.4 urllib3-1.22

Adding requests to Pipfile's [packages]…
  PS: You have excellent taste! ✨ 🍰 ✨
Locking [dev-packages] dependencies…
Locking [packages] dependencies…
Updated Pipfile.lock (7b8df8)!

[[source]]

url = "https://pypi.python.org/simple"
verify_ssl = true
name = "pypi"


[dev-packages]



[packages]

requests = "*"


[requires]

python_version = "3.6"

requests = "*". Utiliza TOML como su formato, que es una opción popular en estos días para archivos de configuración (Rust's Cargo, Python's PEP-518). .

{
    "_meta": {
        "hash": {
            "sha256": "33a0ec7c8e3bae6f62dd618f847de92ece20e2bd4efb496927e2524b9c7b8df8"
        },
        "host-environment-markers": {
            "implementation_name": "cpython",
            "implementation_version": "3.6.3",
            "os_name": "posix",
            "platform_machine": "x86_64",
            "platform_python_implementation": "CPython",
            "platform_release": "16.7.0",
            "platform_system": "Darwin",
            "platform_version": "Darwin Kernel Version 16.7.0: Wed Oct  4 00:17:00 PDT 2017; root:xnu-3789.71.6~1/RELEASE_X86_64",
            "python_full_version": "3.6.3",
            "python_version": "3.6",
            "sys_platform": "darwin"
        },
        "pipfile-spec": 6,
        "requires": {
            "python_version": "3.6"
        },
        "sources": [
            {
                "name": "pypi",
                "url": "https://pypi.python.org/simple",
                "verify_ssl": true
            }
        ]
    },
    "default": {
        "certifi": {
            "hashes": [
                "sha256:244be0d93b71e93fc0a0a479862051414d0e00e16435707e5bf5000f92e04694",
                "sha256:5ec74291ca1136b40f0379e1128ff80e866597e4e2c1e755739a913bbc3613c0"
            ],
            "version": "==2017.11.5"
        },
        "chardet": {
            "hashes": [
                "sha256:fc323ffcaeaed0e0a02bf4d117757b98aed530d9ed4531e3e15460124c106691",
                "sha256:84ab92ed1c4d4f16916e05906b6b75a6c0fb5db821cc65e70cbd64a3e2a5eaae"
            ],
            "version": "==3.0.4"
        },
        "idna": {
            "hashes": [
                "sha256:8c7309c718f94b3a625cb648ace320157ad16ff131ae0af362c9f21b80ef6ec4",
                "sha256:2c6a5de3089009e3da7c5dde64a141dbc8551d5b7f6cf4ed7c2568d0cc520a8f"
            ],
            "version": "==2.6"
        },
        "requests": {
            "hashes": [
                "sha256:6a1b267aa90cac58ac3a765d067950e7dbbf75b1da07e895d1f594193a40a38b",
                "sha256:9c443e7324ba5b85070c4a818ade28bfabedf16ea10206da1132edaa6dda237e"
            ],
            "version": "==2.18.4"
        },
        "urllib3": {
            "hashes": [
                "sha256:06330f386d6e4b195fbfc736b297f58c5a892e4440e54d294d7004e3a9bbea1b",
                "sha256:cc44da8e1145637334317feebd728bd869a35285b93cbb4cca2577da7e62db4f"
            ],
            "version": "==1.22"
        }
    },
    "develop": {}

pipenv graphe>

~/git/testpipenv > pipenv graph
requests==2.18.4
  - certifi [required: >=2017.4.17, installed: 2017.11.5]
  - chardet [required: >=3.0.2,<3.1.0, installed: 3.0.4]
  - idna [required: <2.7,>=2.5, installed: 2.6]
  - urllib3 [required: >=1.21.1,<1.23, installed: 1.22]

run y shell. . pipenv shell para comenzar un nuevo shell con tu entorno virtual Python. Aquí se explica cómo usar el comando de shell para iniciar una sesión interactiva de Python que usa el paquete de solicitudes instaladas para obtener una cotización del día de una API REST. El entorno virtual se activa y el lanzamiento de Python usa el intérprete correcto donde las solicitudes están disponibles.e.

~/git/testpipenv > pipenv shell
Spawning environment shell (/bin/bash). Use 'exit' to leave.
source /Users/gigi.sayfan/.local/share/virtualenvs/testpipenv-0GShD6dy/bin/activate
~/git/testpipenv > source /Users/gigi.sayfan/.local/share/virtualenvs/testpipenv-0GShD6dy/bin/activate
(testpipenv-0GShD6dy) ~/git/testpipenv > python
Python 3.6.3 (default, Nov 19 2017, 16:39:12)
[GCC 4.2.1 Compatible Apple LLVM 9.0.0 (clang-900.0.38)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import requests
>>> r = requests.get('https://quotes.rest/qod')
>>> r.ok
True
>>> r.json()
{'success': {'total': 1}, 'contents': {'quotes': [{'quote': 'Hang Out with People Who are Better than You.', 'author': 'Warren Buffett', 'length': None, 'tags': ['getting-better', 'inspire', 'people'], 'category': 'inspire', 'title': 'Inspiring Quote of the day', 'date': '2018-01-03', 'id': None}], 'copyright': '2017-19 theysaidso.com'}}
>>> quote = r.json()['contents']['quotes'][0]['quote']
>>> author = r.json()['contents']['quotes'][0]['author']
>>> print(f'{quote} ~~ {author}')
Hang Out with People Who are Better than You. ~~ Warren Buffett
>>>

pipenv install -r <path/to/requirements.txt>.>. instalar pipenv. Una vez que haya verificado que todo funciona como se esperaba, puede eliminar su archivo requirements.txt.e.

~/git/testpipenv > cat requirements.txt
requests==2.18.4
~/git/testpipenv > pipenv --three
Creating a virtualenv for this project…
Using /usr/local/bin/python3 to create virtualenv…
⠋Running virtualenv with interpreter /usr/local/bin/python3
Using base prefix '/usr/local/Cellar/python3/3.6.3/Frameworks/Python.framework/Versions/3.6'
New python executable in /Users/gigi.sayfan/.local/share/virtualenvs/testpipenv-0GShD6dy/bin/python3.6
Also creating executable in /Users/gigi.sayfan/.local/share/virtualenvs/testpipenv-0GShD6dy/bin/python
Installing setuptools, pip, wheel...done.

Virtualenv location: /Users/gigi.sayfan/.local/share/virtualenvs/testpipenv-0GShD6dy
Requirements.txt found, instead of Pipfile! Converting…
Warning: Your Pipfile now contains pinned versions, if your requirements.txt did.
We recommend updating your Pipfile to specify the "*" version, instead.

1	[packages]
2
3	requests = "==2.18.4"

~/git/testpipenv > pipenv install
Pipfile.lock not found, creating…
Locking [dev-packages] dependencies…
Locking [packages] dependencies…
Updated Pipfile.lock (0b0daf)!
Installing dependencies from Pipfile.lock (0b0daf)…
  🐍   ▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉ 5/5 — 00:00:01
To activate this project's virtualenv, run the following:
 $ pipenv shell
~/git/testpipenv >

Puedes decirle a Pipenv que instale una ruta como editable. Esto es útil cuando depende de los paquetes que está desarrollando y desea depender de su paquete fuente sin instalarlos realmente cada vez que realiza un cambio. En particular, es útil para el directorio actual cuando está trabajando activamente en él. Para hacer eso, use las banderas -e y --dev:gs:

1	> pipenv install '-e .' --dev

Necesita tener un archivo setup.py adecuado.le.
Ya has visto mucho de lo que Pipenv puede hacer por ti. Vamos a profundizar en algunos comandos y opciones adicionales.ns. El comando de instalación pipenv admite varias opciones:ns:

--dev

--system

--ignore-pipfile

--skip-lock

Dependiendo de su flujo de trabajo y preferencias, puede usar una o más de estas opciones en diferentes momentos.es. Para desinstalar una dependencia, escriba: pipenv uninstall<package name> . Por ejemplo:le:

~/git/testpipenv > pipenv uninstall requests
Un-installing requests…
Uninstalling requests-2.18.4:
  Successfully uninstalled requests-2.18.4

Removing requests from Pipfile…
Locking [dev-packages] dependencies…
Locking [packages] dependencies…
Updated Pipfile.lock (625834)!

Tenga en cuenta que no tuve que especificar "requests == 2.8.14" al desinstalar, a pesar de que estaba anclado en el Pipfile.le. Si desea generar una instantánea de sus dependencias actuales (por ejemplo, antes de una versión), use el comando de bloqueo. Esta es la clave para construcciones deterministas y repetibles: pipenv lock --pre.e>. Pipenv es increíble, pero puede limpiar algunos de sus entornos virtuales de vez en cuando. Es tan simple como pipenv --rm.e>. Pipfile.lock aprovecha algunas mejoras de seguridad nuevas y geniales en pip. De forma predeterminada, el Pipfile.lock se generará con los hash sha256 de cada paquete descargado. Esto permitirá que pip garantice que está instalando lo que pretende cuando está en una red comprometida o descargando dependencias de un punto final PyPI que no es de confianza.nt. Además, Pipenv proporciona el comando de verificación, que verifica el cumplimiento con PEP 508: especificación de dependencia para los paquetes de software de Python, así como la seguridad del paquete:ty:

~/git/testpipenv > pipenv check .
Checking PEP 508 requirements…
Passed!
Checking installed package safety…
All good!

Pipenv finalmente lleva el empaque de Python a la vanguardia del desarrollo de software moderno. Se inspira en otros sistemas de gestión de dependencias exitosos como Rust's Cargo y Javascript's Yarn. n. Se casa con entornos virtuales y gestión de paquetes y ofrece una experiencia superior con mensajes informativos hermosos y coloridos, y las mejores prácticas implícitas. Recomiendo encarecidamente que empiece a usar Pipenv para administrar sus proyectos de Python.ts. Además, no dude en ver lo que tenemos disponible para la venta y para estudiar en el Mercado de Envato, y no dude en hacer cualquier pregunta y brindar sus valiosos comentarios utilizando el siguiente feed.ow.