Overview
Esta página describe los cambios que debe realizar en su aplicación al actualizar a una nueva versión de PyMongo.
Importante
Esta guía solo incluye cambios disruptivos en PyMongo de versiones posteriores a la v4.0. Si se actualiza desde PyMongo v2 o v3, consulte la Guía de migración de PyMongo 4.
Antes de actualizar, realiza las siguientes acciones:
Asegúrese de que la nueva versión de PyMongo sea compatible con las versiones de MongoDB Server a las que se conecta su aplicación y con la versión de Python en la que se ejecuta su aplicación. Para obtener información sobre la compatibilidad de versiones, consulta la página de Compatibilidad.
Resuelva cualquier cambio disruptivo entre la versión del driver que utiliza su aplicación y la versión de actualización planificada en la sección Cambios disruptivos.
Tip
Para minimizar el número de cambios que tu aplicación requiere al actualizar las versiones del controlador en el futuro, utiliza el Stable API.
Mostrar advertencias de obsolescencia
Cuando utilices una funcionalidad obsoleta de PyMongo, el driver generará un
DeprecationWarning. Por defecto, el intérprete de Python silencia estas advertencias. Para imprimirlos en stderr, inicia Python con las opciones -Wd.
El siguiente ejemplo ejecuta insert.py, una aplicación de Python que llama a un método obsoleto. El intérprete muestra un DeprecationWarning porque Python se inició con las opciones -Wd.
$ python3 -Wd insert.py insert.py:4: DeprecationWarning: insert is deprecated. Use insert_one or insert_many instead. client.test.test.insert({})
Para tratar los mensajes de DeprecationWarning como excepciones, inicie Python con las opciones -We en su lugar, como se muestra en el siguiente ejemplo:
$ python3 -We insert.py Traceback (most recent call last): File "insert.py", line 4, in <module> client.test.test.insert({}) File "/home/durin/work/mongo-python-driver/pymongo/collection.py", line 2906, in insert "instead.", DeprecationWarning, stacklevel=2) DeprecationWarning: insert is deprecated. Use insert_one or insert_many instead.
Tip
Para obtener más información sobre los avisos del intérprete y la opción -W, consulta la siguiente documentación de Python:
cambio disruptivo
Un cambio disruptivo es un cambio en una convención o comportamiento que empieza a partir de una versión específica del driver. Este tipo de cambios puede evitar que tu aplicación funcione correctamente si no se abordan antes de actualizar el controlador.
Los cambios disruptivos en esta sección se categorizan según la versión del driver que los ha introducido. Al actualizar las versiones del driver, debes abordar todos los cambios disruptivos entre la versión actual y la versión de actualización.
Ejemplo
Actualización desde la versión 4.0
Si estás actualizando PyMongo de la v4.0 a la v4.7, atiende todos los cambios disruptivos listados para las versiones 4.1 a 4.7, si los hay.
Versión 4.14 cambio disruptivo
Descarta el soporte para el MongoDB Server v4.0. La versión mínima compatible de MongoDB Server es ahora la v4.2.
Cuando codificas un objeto
bson.binary.BinaryVector, el valor del campo de metadatospaddingdebe cumplir con las siguientes condiciones:Si el subtipo binario es
PACKED_BIT, el valor debe estar entre 0 y 7 (inclusive).Si no, el valor debe ser 0.
Si no se cumplen las condiciones anteriores, PyMongo genera un
ValueError.El parámetro
optionspara el métodouri_parser.parse_uri()es del tipodict. Anteriormente, este parámetro era del tipo_CaseInsensitiveDictionary.
Versión 4.11 cambio disruptivo
Descarta el soporte para el MongoDB Server v3.6. La versión mínima compatible de MongoDB Server es ahora la v4.0.
Se desaprueba el soporte para MongoDB Server v4.0. De acuerdo con los Cronogramas del ciclo de vida del software de MongoDB, una próxima versión menor de PyMongo aumentará la versión mínima de MongoDB Server de 4.0 a 4.2.
Descarta el soporte para el Python v3.8. A versão mínima do Python suportada agora é v3.9.
Se elimina el soporte para PyPy v3.9. La versión mínima de PyPy compatible es ahora la v3.10.
Deja de soportar el mecanismo de autenticación
MONGODB-CR. Para obtener más información sobre autenticación, consulta la guía de Mecanismos de Autenticación.
Versión 4.9 cambio disruptivo
Debe utilizar
pymongocryptv1.10 o posterior para usar Cifrado en el lado del cliente a nivel de campo (CSFLE) en su aplicación.
Cambios disruptivos en la versión 4.8
Debido a que PyMongo v4.8 utiliza
hatchcomo su sistema de compilación backend, ya no puedes compilar el driver usando el archivosetup.py. En su lugar, debe instalar PyMongo usando pip. Para instalaciones editables, debe utilizar pip v21.3 o una versión posterior.
Cambios disruptivos en la versión 4.7
Todas las incidencias del tipo de colección
SONen todas las clases internas y comandos se han cambiado adict.La propiedad
options.pool_options.metadataahora es de tipodict, noSON. El siguiente ejemplo de código muestra las diferencias en la forma en que estos formatos almacenan datos:
# Before (SON) from pymongo import MongoClient client = MongoClient() client.options.pool_options.metadata SON([('driver', SON([('name', 'PyMongo'), ('version', '4.7.0.dev0')])), ('os', SON([('type', 'Darwin'), ('name', 'Darwin'), ('architecture', 'arm64'), ('version', '14.3')])), ('platform', 'CPython 3.11.6.final.0')]) # After (dict) client.options.pool_options.metadata {'driver': {'name': 'PyMongo', 'version': '4.7.0.dev0'}, 'os': {'type': 'Darwin', 'name': 'Darwin', 'architecture': 'arm64', 'version': '14.3'}, 'platform': 'CPython 3.11.6.final.0'}
Para convertir un objeto de dict de una sola capa en un objeto de SON, pasa el objeto de dict al constructor de SON, tal como se muestra en el siguiente ejemplo:
data_as_dict = client.options.pool_options.metadata SON(data_as_dict) SON([('driver', {'name': 'PyMongo', 'version': '4.7.0.dev0'}), ('os', {'type': 'Darwin', 'name': 'Darwin', 'architecture': 'arm64', 'version': '14.3'}), ('platform', 'CPython 3.11.6.final.0')])
Si el objeto dict tiene varias capas, debes convertir los valores uno a la vez, como se muestra en el siguiente ejemplo:
def dict_to_SON(data_as_dict: dict[Any, Any]): data_as_SON = SON() for key, value in data_as_dict.items(): data_as_SON[key] = dict_to_SON(value) if isinstance(value, dict) else value return data_as_SON >>> dict_to_SON(data_as_dict) SON([('driver', SON([('name', 'PyMongo'), ('version', '4.7.0.dev0')])), ('os', SON([('type', 'Darwin'), ('name', 'Darwin'), ('architecture', 'arm64'), ('version', '14.3')])), ('platform', 'CPython 3.11.6.final.0')])
Cambios disruptivos en la versión 4.2
Para mejorar el soporte de la herramienta Pyright , la clase
ClientSessionya no utiliza tipado genérico.Se requiere pymongocrypt v1.3.0 o posterior para el cifrado a nivel de campo del lado del cliente (CSFLE).
Los paquetes bson, pymongo y gridfs ahora utilizan la variable
__all__para declarar sus APIs públicas. Si tu aplicación contiene una instrucciónfrom bson import *, asegúrese de que siga importando las APIs necesarias.El método
estimated_document_count()siempre utiliza el comando count. Este comando no está disponible en la API estable en las versiones 5.0.0 de MongoDB até 5.0.8. Si usas el métodoestimated_document_count()con la Stable API, debes actualizar a MongoDB Server v5.0.9 o posterior, o configurar la opciónpymongo.server_api.ServerApi.strictenFalse.