En las entradas anteriores de la serie “Creación de paquetes de Python” hemos visto cómo añadir código al paquete, pero no como incluir otros paquetes que podemos necesitar. Por ejemplo, puede ser necesario tener instalado Pandas o scikit-learn. En esta quinta entrada de la serie vamos a ver los pasos para gestionar las dependencias de los paquetes Python e indicar qué librerías externas necesita nuestro código para su correcto funcionamiento. Para ello en primer lugar vamos a ver el archivo de configuración setup.py que creo con la plantilla.
Esta entrada forma parte de la colección “Creación de paquetes de Python” que consta de las siguientes siete entradas:
- Creación de paquetes de Python
- Pruebas unitarias en Python
- Probar en múltiples versiones de Python
- Cobertura de las pruebas unitarias en Python
- Gestionar las dependencias de paquetes Python
- Documentar paquetes de Python
- Distribuir paquetes de Python
El archivo de configuración setup.py
El archivo setup.py incluye la iformación del paquete e indica a las herramientas de instalación de Python cómo empaquetarlo, compilarlo e instalarlo. Tal como indica su extensión es un archivo con código de Python. Por lo que es posible añadir cualquier funcionalidad que sea necesaria. Aunque generalmente solo se va a configurar diferentes opciones.
En la mayoría de los casos, el archivo que crea Cookiecutter no requiere cambios importantes, pero es necesario conocer algunas opciones. En nuestro caso se ha creado el siguiente archivo.
import io
import os
import re
from setuptools import find_packages
from setuptools import setup
def read(filename):
filename = os.path.join(os.path.dirname(__file__), filename)
text_type = type(u"")
with io.open(filename, mode="r", encoding='utf-8') as fd:
return re.sub(text_type(r':[a-z]+:`~?(.*?)`'), text_type(r'``\1``'), fd.read())
setup(
name="pylane",
version="0.1.0",
url="https://github.com/analyticslane/pylane",
license='MIT',
author="Daniel Rodriguez",
description="Paquete creado para el tutorial 'Creación de paquetes de Python'",
long_description=read("README.rst"),
packages=find_packages(exclude=('tests',)),
install_requires=[],
classifiers=[
'Development Status :: 2 - Pre-Alpha',
'License :: OSI Approved :: MIT License',
'Programming Language :: Python',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
],
)Como se puede ver al principio se importan algunas librerías y al final se configuran el paquete mediante la función setup. Pudiendo ver que incluye información como:
- Los datos de paquete como nombre, autor, licencia, etc.
- La lista de paquetes a incluir.
- La lista de dependencias a instalar.
- Información de compatibilidad como las versiones en las que funciona.
Indicar las dependencias
Si necesitamos usar un paquete, como podría ser Pandas, en el código se utiliza como lo haríamos normalmente. Importando las componentes necesarias con import. El problema lo tendríamos si nuestro paquete se ejecuta en un sistema que no tenga esos instalado ya esa librería. Para evitar esto se puede indicar el nombre de los paquetes necesarios como un vector en la opción install_requires de la función setup del archivo setup.py. Así para indicar que se instale pandas tendríamos que indicar
install_requires=[‘pandas’]
Esto hará que al instalar nuestro paquete se instale también Pandas si no se encuentra disponible en ese sistema. Si sabemos que es necesario una versión mínima del paquete, porque la función que usamos no estaba disponible antes, se puede indicar con >=. Por ejemplo, para indicar que es necesario Pandas 0.25.0 tendríamos que escribir pandas>=0.25.0.
También puede darse el caso de que a partir de cierta versión existan problemas de compatibilidad, en tal caso se puede indicar la versión máxima con <. Por ejemplo, si no hemos observado problemas con Pandas 1.0, solamente tenemos que indicar pandas>=0.25,<1.0. Lo que nos limitaría solamente a Pandas 0.25.
Dependencias fuera de PyPi
No todos los paquetes se encuentran en PyPi, por ejemplo, podemos tener paquetes que solamente están en GitHub, como es el caso del este que estamos creado. En tal caso también se puede indicar la URL del repositorio en lugar del nombre del paquete. Por lo que no estamos limitados a los paquetes publicados en PyPi.
Información de compatibilidad
Si queremos indicar en qué versiones de Python y plataformas se puede utilizar el paquete lo podemos hacer mediante la opción classifiers. Siendo estos unos valores estandarizados que se pueden consultar en https://pypi.org/classifiers/.
Conclusiones
En esta entrada hemos visto que es el archivo de configuración setup.py y como usarlo para gestionar las dependencias de paquetes Python. La próxima semana se explicarán los pasos necesarios para documentar el paquete.
Deja una respuesta