PYTHON-5377 - Update assets to align with GA release of Async PyMongo (#334)
This commit is contained in:
parent
83f735ad45
commit
f6a70b8c3c
@ -7,6 +7,11 @@
|
||||
|
||||

|
||||
|
||||
> [!WARNING]
|
||||
> Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
> We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
> To learn more, see the migration guide: https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/.
|
||||
|
||||
## About
|
||||
|
||||
Motor is a full-featured, non-blocking [MongoDB](http://mongodb.org/)
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
:mod:`motor.aiohttp` - Integrate Motor with the aiohttp web framework
|
||||
=====================================================================
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
.. currentmodule:: motor.aiohttp
|
||||
|
||||
.. automodule:: motor.aiohttp
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
asyncio GridFS Classes
|
||||
======================
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
.. currentmodule:: motor.motor_asyncio
|
||||
|
||||
Store blobs of data in `GridFS <http://dochub.mongodb.org/core/gridfs>`_.
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
:class:`~motor.motor_asyncio.AsyncIOMotorChangeStream`
|
||||
======================================================
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
.. currentmodule:: motor.motor_asyncio
|
||||
|
||||
.. autoclass:: AsyncIOMotorChangeStream
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
:class:`~motor.motor_asyncio.AsyncIOMotorClient` -- Connection to MongoDB
|
||||
=========================================================================
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
.. autoclass:: motor.motor_asyncio.AsyncIOMotorClient
|
||||
:members:
|
||||
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
:class:`~motor.motor_asyncio.AsyncIOMotorClientEncryption`
|
||||
==========================================================
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
.. currentmodule:: motor.motor_asyncio
|
||||
|
||||
.. autoclass:: AsyncIOMotorClientEncryption
|
||||
|
||||
@ -1,5 +1,9 @@
|
||||
:class:`~motor.motor_asyncio.AsyncIOMotorClientSession` -- Sequence of operations
|
||||
=================================================================================
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
.. autoclass:: motor.motor_asyncio.AsyncIOMotorClientSession
|
||||
:members:
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
:class:`~motor.motor_asyncio.AsyncIOMotorCollection`
|
||||
====================================================
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
.. currentmodule:: motor.motor_asyncio
|
||||
|
||||
.. autoclass:: AsyncIOMotorCollection
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
:class:`~motor.motor_asyncio.AsyncIOMotorDatabase`
|
||||
==================================================
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
.. currentmodule:: motor.motor_asyncio
|
||||
|
||||
.. autoclass:: AsyncIOMotorDatabase
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
:class:`~motor.motor_asyncio.AsyncIOMotorCursor`
|
||||
================================================
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
.. currentmodule:: motor.motor_asyncio
|
||||
|
||||
.. autoclass:: AsyncIOMotorCursor
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
Motor asyncio API
|
||||
=================
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
.. toctree::
|
||||
|
||||
asyncio_motor_client
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
:class:`~motor.motor_tornado.MotorCursor`
|
||||
=========================================
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
.. currentmodule:: motor.motor_tornado
|
||||
|
||||
.. autoclass:: MotorCursor
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
Motor GridFS Classes
|
||||
====================
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
.. currentmodule:: motor.motor_tornado
|
||||
|
||||
Store blobs of data in `GridFS <http://dochub.mongodb.org/core/gridfs>`_.
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
Motor Tornado API
|
||||
=================
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
.. toctree::
|
||||
|
||||
motor_client
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
:class:`~motor.motor_tornado.MotorChangeStream`
|
||||
===============================================
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
.. currentmodule:: motor.motor_tornado
|
||||
|
||||
.. autoclass:: MotorChangeStream
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
:class:`~motor.motor_tornado.MotorClient` -- Connection to MongoDB
|
||||
==================================================================
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
.. currentmodule:: motor.motor_tornado
|
||||
|
||||
.. autoclass:: MotorClient
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
:class:`~motor.motor_tornado.MotorClientEncryption`
|
||||
===================================================
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
.. currentmodule:: motor.motor_tornado
|
||||
|
||||
.. autoclass:: MotorClientEncryption
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
:class:`~motor.motor_tornado.MotorClientSession` -- Sequence of operations
|
||||
==========================================================================
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
.. currentmodule:: motor.motor_tornado
|
||||
|
||||
.. autoclass:: motor.motor_tornado.MotorClientSession
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
:class:`~motor.motor_tornado.MotorCollection`
|
||||
=============================================
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
.. currentmodule:: motor.motor_tornado
|
||||
|
||||
.. autoclass:: MotorCollection
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
:class:`~motor.motor_tornado.MotorDatabase`
|
||||
===========================================
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
.. currentmodule:: motor.motor_tornado
|
||||
|
||||
.. autoclass:: MotorDatabase
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
:mod:`motor.web` - Integrate Motor with the Tornado web framework
|
||||
=================================================================
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
.. currentmodule:: motor.web
|
||||
|
||||
.. automodule:: motor.web
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
Changelog
|
||||
=========
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
|
||||
.. currentmodule:: motor.motor_tornado
|
||||
|
||||
Motor 3.7.0
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
Configuration
|
||||
=============
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
|
||||
TLS Protocol Version
|
||||
''''''''''''''''''''
|
||||
|
||||
|
||||
@ -2,6 +2,11 @@
|
||||
Developer Guide
|
||||
===============
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
|
||||
Some explanations for those who would like to contribute to Motor development.
|
||||
|
||||
Compatibility
|
||||
|
||||
@ -4,6 +4,10 @@
|
||||
Differences between Motor and PyMongo
|
||||
=====================================
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
.. important:: This page describes using Motor with Tornado. Beginning in
|
||||
version 0.5 Motor can also integrate with asyncio instead of Tornado.
|
||||
|
||||
|
||||
@ -4,6 +4,11 @@ Motor Features
|
||||
|
||||
.. currentmodule:: motor.motor_tornado
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
|
||||
Non-Blocking
|
||||
============
|
||||
Motor is an asynchronous driver for MongoDB. It can be used from Tornado_ or
|
||||
|
||||
@ -4,6 +4,10 @@ Motor: Asynchronous Python driver for MongoDB
|
||||
.. image:: _static/motor.png
|
||||
:align: center
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
About
|
||||
-----
|
||||
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
Installation
|
||||
============
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
|
||||
Install Motor from PyPI_ with pip_::
|
||||
|
||||
$ python3 -m pip install motor
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
Motor 2.0 Migration Guide
|
||||
=========================
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
|
||||
.. currentmodule:: motor.motor_tornado
|
||||
|
||||
Motor 2.0 brings a number of changes to Motor 1.0's API. The major version is
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
Motor 3.0 Migration Guide
|
||||
=========================
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
|
||||
.. currentmodule:: motor.motor_tornado
|
||||
|
||||
Motor 3.0 brings a number of changes to Motor 2.0's API. The major version is
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
Requirements
|
||||
============
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
|
||||
The current version of Motor requires:
|
||||
|
||||
* CPython 3.9 and later.
|
||||
|
||||
@ -3,6 +3,11 @@
|
||||
Tutorial: Using Motor With :mod:`asyncio`
|
||||
=========================================
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
|
||||
.. These setups are redundant because I can't figure out how to make doctest
|
||||
run a common setup *before* the setup for the two groups. A "testsetup:: *"
|
||||
is the obvious answer, but it's run *after* group-specific setup.
|
||||
@ -454,8 +459,7 @@ to an :class:`aiohttp.web.Application`:
|
||||
:start-after: main-start
|
||||
:end-before: main-end
|
||||
|
||||
.. warning::
|
||||
It is a common mistake to create a new client object for every request; this comes at a dire performance cost.
|
||||
.. warning:: It is a common mistake to create a new client object for every request; this comes at a dire performance cost.
|
||||
Create the client when your application starts and reuse that one client for the lifetime of the process.
|
||||
You can maintain the client by storing a database handle from the client on your application object, as shown in this example.
|
||||
|
||||
|
||||
@ -3,6 +3,11 @@
|
||||
Tutorial: Using Motor With Tornado
|
||||
==================================
|
||||
|
||||
.. warning:: Motor will be deprecated on May 14th, 2026, one year after the production release of the PyMongo Async driver.
|
||||
We strongly recommend that Motor users migrate to the PyMongo Async driver while Motor is still supported.
|
||||
To learn more, see `the migration guide <https://www.mongodb.com/docs/languages/python/pymongo-driver/current/reference/migration/>`_.
|
||||
|
||||
|
||||
.. These setups are redundant because I can't figure out how to make doctest
|
||||
run a common setup *before* the setup for the two groups. A "testsetup:: *"
|
||||
is the obvious answer, but it's run *after* group-specific setup.
|
||||
@ -152,8 +157,7 @@ makes it available to request handlers::
|
||||
def get(self):
|
||||
db = self.settings['db']
|
||||
|
||||
.. warning::
|
||||
It is a common mistake to create a new client object for every
|
||||
.. warning:: It is a common mistake to create a new client object for every
|
||||
request; **this comes at a dire performance cost**. Create the client
|
||||
when your application starts and reuse that one client for the lifetime
|
||||
of the process, as shown in these examples.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user