Información general

Esta guía ofrece información y algunas prácticas recomendadas sobre la migración de checks entre Python 2 y 3. Utiliza la herramienta Custom Check Compatibility de Datadog para comprobar si tus checks personalizados son compatibles con Python 3 o si es necesario migrarlos.

Esta guía se centra en mantener la compatibilidad con versiones anteriores con el fin de asegurar la flexibilidad necesaria para permitir que el código se ejecute en diferentes versiones del Agent.

Editores y herramientas

Pylint

Pylint dispone de una serie de funciones que te ayudarán a verificar si tus checks personalizados son compatibles con Python 3.

Instalación

Para comenzar, instala Pylint mediante pip en Python 2:

$ python2 -m pip install pylint

Sustituye python2 en el comando anterior si la ruta a tu intérprete de Python 2 es diferente.

Uso

Ejecuta el comando pylint para comprobar que tu check o integración personalizados se ejecuten en Python 3. Reemplaza CHECK por una ruta válida a una carpeta de módulos o paquetes de Python:

$ python2 -m pylint -sn --py3k CHECK

Por ejemplo:

$ python2 -m pylint -sn --py3k ~/dev/my-check.py
************* Module my-check
E:  4, 4: print statement used (print-statement)
W:  7,22: Calling a dict.iter*() method (dict-iter-method)
W:  9, 8: division w/o __future__ statement (old-division)

Después de solucionar las incompatibilidades, el comando no devolverá nada:

$ python2 -m pylint -sn --py3k ~/dev/my-check.py
$ 

Aunque pylint detecta cualquier problema que pueda impedir que el intérprete de Python 3 ejecute el código, no puede comprobar la validez lógica. Si realizas algún cambio en el código, recuerda ejecutar el check y validar la salida.

2to3

2to3 convierte el código de Python 2 a código de Python 3. Si tienes un check personalizado foo.py, ejecuta 2to3:

$ 2to3 foo.py

Al ejecutar 2to3, se imprime una diferencia con respecto al archivo fuente original. Para obtener más información sobre 2to3, consulta la documentación oficial sobre 2to3.

Editores

La mayoría de entornos de desarrollo integrado y editores modernos ofrecen la función avanzada de linting de manera automática. Comprueba que se dirijan a un ejecutable de Python 3. De este modo, cuando abras un archivo legacy basado únicamente en Python 2, cualquier error o advertencia de linting aparecerá en el lateral como una marca de color en PyCharm o como un cuadro cuya parte inferior se pueda clicar en Visual Studio Code.

Migración de Python

Importaciones de paquetes

Con Python 3, para uniformar el espacio de nombres de los paquetes Datadog, todos los recursos se encuentran dentro del subpaquete base. Por ejemplo:

from datadog_checks.checks import AgentCheck

se convierte en

from datadog_checks.base.checks import AgentCheck

Six

Six es una biblioteca de compatibilidad de Python 2 y 3 pensada para hacer posible que los desarrolladores envíen código de Python que funcione tanto en Python 2 como en Python 3. En algunos de los ejemplos siguientes, se utiliza Six para hacer que el código legacy de Python 2 sea compatible con Python 3.

Métodos de diccionario

En Python 3, no están disponibles los métodos dict.iterkeys(), dict.iteritems() y dict.itervalues().

Además, en Python 3, los métodos dict.keys(), dict.items(), dict.values() devuelven iteradores. Por lo tanto, si es necesario modificar el diccionario durante la iteración, primero hay que hacer una copia. Para obtener las claves/elementos/valores de un diccionario en forma de lista:

El método dict.has_key() está obsoleto en Python 2 y se ha eliminado en Python 3. En su lugar, utiliza el operador in.

Cambios en la biblioteca estándar

Python 3 cuenta con una biblioteca estándar reestructurada, en la que se han cambiado de nombre o desplazado varios módulos y funciones. La función de importar módulos trasladados mediante six.moves es compatible con ambas versiones de Python.

Consulta la documentación sobre Six para ver la lista de módulos renombrados. Nota: Los módulos urllib, urllib2 y urlparse se han reorganizado por completo.

Unicode

Python 2 trata igual el texto Unicode y los datos codificados en binario, e intenta efectuar automáticamente la conversión entre bytes y cadenas. Este procedimiento funcionará si todos los caracteres son ASCII, pero provocará comportamientos inesperados cuando encuentre caracteres que no sean ASCII.

Los datos de texto son puntos de código Unicode; para almacenarlos o transmitirlos, es necesario codificarlos con .encode(encoding). Los datos binarios son puntos de código codificados representados como una secuencia de bytes que deben volver a descodificarse como texto con .decode(encoding). Al leer texto de un archivo, la función open del paquete io resulta de gran utilidad porque los datos leídos ya están descodificados en Unicode:

from io import open

f = open('textfile.txt', encoding='utf-8')
contents = f.read()  # contents will be decoded to unicode using 'utf-8'; these are not bytes!

Para obtener más información, consulta la presentación de Ned Batchelder: Pragmatic Unicode.

Print

En Python 3, print se trata explícitamente como una función; para convertir print en una función sin importar la versión de Python que tengas, introduce from __future__ import print_function al principio de cualquier archivo que utilice la antigua sentencia print y añade paréntesis para invocar la función.

División entera

En Python 2, el operador / realiza la división euclídea de números enteros.

Python 2

>> 5/2
2

En Python 3, el operador / realiza la división real (sin resto), mientras que el operador // realiza la división euclídea.

Python 3

>> 5/2
2.5
>> 5//2
2

Para reproducir el mismo comportamiento que en Python 3 sin importar la versión de Python que tengas, introduce from __future__ import division en la parte superior de cualquier archivo que utilice la división y usa // para obtener en números enteros los resultados de la división.

Redondeo

En Python 2, la biblioteca estándar redondea los números aritméticamente (hacia arriba si el número llega al 5). En cambio, Python 3 redondea los números en función del número par más cercano.

Python 2

>> round(2.5)
3
>> round(3.5)
4

Python 3

>> round(2.5)
2
>> round(3.5)
4

Datadog ofrece la función de utilidad round_value en datadog_checks_base. Esta función permite replicar el comportamiento de Python 2 tanto en Python 2 como en Python 3.

Excepciones

Python 3 cuenta con una sintaxis diferente para “except” y “raise”.

Importaciones relativas

En Python 3, las importaciones relativas deben hacerse explícitamente y, para ello, se utiliza un punto (.).

Imaginemos que tu paquete está estructurado del siguiente modo:

mypackage/
    __init__.py
    math.py
    foo.py

Supongamos también que math.py cuenta con una función llamada gcd (que contiene matices distintos de la función gcd del módulo math de la biblioteca estándar) y quieres utilizar la función gcd de tu paquete local, no la de la biblioteca estándar.

En Python 2, si estás dentro de un paquete, los módulos propios de ese paquete tienen prioridad sobre los módulos globales. Al usar from math import gcd, se importa la función gcd de mypackage/math.py.

En Python 3, los formatos de importación que no comienzan por . se interpretan como importaciones absolutas. Al utilizar from math import gcd, se importa la función gcd de la biblioteca estándar.

O, para que resulte más fácil de leer:

Iteradores

Varias funciones de Python 2 que devuelven listas también devuelven iteradores en Python 3. Por ejemplo, map, filter y zip.

La solución más sencilla para preservar el comportamiento de Python 2 es incluir estas funciones con una invocación a list:

La función xrange se elimina en Python 3; en su lugar, la función range devuelve un objeto iterable range. Importa range con from six.moves import range.

Utiliza la función integrada next en lugar de invocar el método next. Por ejemplo, reescribe iterator.next() como next(iterator).

Leer más

Más enlaces, artículos y documentación útiles:

Actualizar el Agent a la versión 7DOCUMENTACIÓN Uso de Python 3 con el Datadog Agent v6DOCUMENTACIÓN