mongodb/mongo-python-driver
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'master' of github.com:mongodb/mongo-python-driver

Browse Source
This commit is contained in:
Steven Silvester 2025-08-14 12:11:11 -05:00
commit e334c4fe95
No known key found for this signature in database
GPG Key ID: B1BF5EC3A8B32F91
11 changed files with 138 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/workflows/codeql.yml vendored
View File

@ -46,7 +46,7 @@ jobs:
# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@76621b61decf072c1cee8dd1ce2d2a82d33c17ed # v3
uses: github/codeql-action/init@51f77329afa6477de8c49fc9c7046c15b9a4e79d # v3
with:
languages: ${{ matrix.language }}
build-mode: ${{ matrix.build-mode }}
@ -63,6 +63,6 @@ jobs:
pip install -e .
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@76621b61decf072c1cee8dd1ce2d2a82d33c17ed # v3
uses: github/codeql-action/analyze@51f77329afa6477de8c49fc9c7046c15b9a4e79d # v3
with:
category: "/language:${{matrix.language}}"

2
.github/workflows/dist.yml vendored
View File

@ -142,7 +142,7 @@ jobs:
name: Download Wheels
steps:
- name: Download all workflow run artifacts
uses: actions/download-artifact@v5
uses: actions/download-artifact@v4
- name: Flatten directory
working-directory: .
run: |

2
.github/workflows/release-python.yml vendored
View File

@ -76,7 +76,7 @@ jobs:
id-token: write
steps:
- name: Download all the dists
uses: actions/download-artifact@v5
uses: actions/download-artifact@v4
with:
name: all-dist-${{ github.run_id }}
path: dist/

2
.github/workflows/test-python.yml vendored
View File

@ -195,7 +195,7 @@ jobs:
timeout-minutes: 20
steps:
- name: Download sdist
uses: actions/download-artifact@v5
uses: actions/download-artifact@v4
- name: Unpack SDist
shell: bash
run: |

2
.github/workflows/zizmor.yml vendored
View File

@ -18,4 +18,4 @@ jobs:
with:
persist-credentials: false
- name: Run zizmor 🌈
uses: zizmorcore/zizmor-action@c17832b972c15fd5f3d5065a7e16ad761a0a10d2
uses: zizmorcore/zizmor-action@383d31df2eb66a2f42db98c9654bdc73231f3e3a

36
pymongo/asynchronous/collection.py
View File

@ -1776,6 +1776,15 @@ class AsyncCollection(common.BaseObject, Generic[_DocumentType]):
improper type. Returns an instance of
:class:`~pymongo.asynchronous.cursor.AsyncCursor` corresponding to this query.
Cursors are closed automatically when they are exhausted (the last batch of data is retrieved from the database).
If a cursor is not exhausted, it will be closed automatically upon garbage collection, which leaves resources open but unused for a potentially long period of time.
To avoid this, best practice is to call :meth:`AsyncCursor.close` when the cursor is no longer needed,
or use the cursor in a with statement::
async with collection.find() as cursor:
async for doc in cursor:
print(doc)
The :meth:`find` method obeys the :attr:`read_preference` of
this :class:`AsyncCollection`.
@ -2503,6 +2512,15 @@ class AsyncCollection(common.BaseObject, Generic[_DocumentType]):
...
SON([('v', 2), ('key', SON([('_id', 1)])), ('name', '_id_')])
Cursors are closed automatically when they are exhausted (the last batch of data is retrieved from the database).
If a cursor is not exhausted, it will be closed automatically upon garbage collection, which leaves resources open but unused for a potentially long period of time.
To avoid this, best practice is to call :meth:`AsyncCursor.close` when the cursor is no longer needed,
or use the cursor in a with statement::
async with await collection.list_indexes() as cursor:
async for index in cursor:
print(index)
:param session: a
:class:`~pymongo.asynchronous.client_session.AsyncClientSession`.
:param comment: A user-provided comment to attach to this
@ -2620,6 +2638,15 @@ class AsyncCollection(common.BaseObject, Generic[_DocumentType]):
) -> AsyncCommandCursor[Mapping[str, Any]]:
"""Return a cursor over search indexes for the current collection.
Cursors are closed automatically when they are exhausted (the last batch of data is retrieved from the database).
If a cursor is not exhausted, it will be closed automatically upon garbage collection, which leaves resources open but unused for a potentially long period of time.
To avoid this, best practice is to call :meth:`AsyncCursor.close` when the cursor is no longer needed,
or use the cursor in a with statement::
async with await collection.list_search_indexes() as cursor:
async for index in cursor:
print(index)
:param name: If given, the name of the index to search
for. Only indexes with matching index names will be returned.
If not given, all search indexes for the current collection
@ -2922,6 +2949,15 @@ class AsyncCollection(common.BaseObject, Generic[_DocumentType]):
.. note:: The :attr:`~pymongo.asynchronous.collection.AsyncCollection.write_concern` of
this collection is automatically applied to this operation.
Cursors are closed automatically when they are exhausted (the last batch of data is retrieved from the database).
If a cursor is not exhausted, it will be closed automatically upon garbage collection, which leaves resources open but unused for a potentially long period of time.
To avoid this, best practice is to call :meth:`AsyncCursor.close` when the cursor is no longer needed,
or use the cursor in a with statement::
async with await collection.aggregate() as cursor:
async for operation in cursor:
print(operation)
:param pipeline: a list of aggregation pipeline stages
:param session: a
:class:`~pymongo.asynchronous.client_session.AsyncClientSession`.

18
pymongo/asynchronous/database.py
View File

@ -643,8 +643,8 @@ class AsyncDatabase(common.BaseObject, Generic[_DocumentType]):
.. code-block:: python
# Lists all operations currently running on the server.
with client.admin.aggregate([{"$currentOp": {}}]) as cursor:
for operation in cursor:
async with await client.admin.aggregate([{"$currentOp": {}}]) as cursor:
async for operation in cursor:
print(operation)
The :meth:`aggregate` method obeys the :attr:`read_preference` of this
@ -652,6 +652,11 @@ class AsyncDatabase(common.BaseObject, Generic[_DocumentType]):
which case :attr:`~pymongo.read_preferences.ReadPreference.PRIMARY`
is used.
Cursors are closed automatically when they are exhausted (the last batch of data is retrieved from the database).
If a cursor is not exhausted, it will be closed automatically upon garbage collection, which leaves resources open but unused for a potentially long period of time.
To avoid this, best practice is to call :meth:`AsyncCursor.close` when the cursor is no longer needed,
or use the cursor in a with statement.
.. note:: This method does not support the 'explain' option. Please
use :meth:`~pymongo.asynchronous.database.AsyncDatabase.command` instead.
@ -1154,6 +1159,15 @@ class AsyncDatabase(common.BaseObject, Generic[_DocumentType]):
) -> AsyncCommandCursor[MutableMapping[str, Any]]:
"""Get a cursor over the collections of this database.
Cursors are closed automatically when they are exhausted (the last batch of data is retrieved from the database).
If a cursor is not exhausted, it will be closed automatically upon garbage collection, which leaves resources open but unused for a potentially long period of time.
To avoid this, best practice is to call :meth:`AsyncCursor.close` when the cursor is no longer needed,
or use the cursor in a with statement::
async with await database.list_collections() as cursor:
async for collection in cursor:
print(collection)
:param session: a
:class:`~pymongo.asynchronous.client_session.AsyncClientSession`.
:param filter: A query document to filter the list of

15
pymongo/asynchronous/mongo_client.py
View File

@ -202,6 +202,12 @@ class AsyncMongoClient(common.BaseObject, Generic[_DocumentType]):
exception (recognizing that the operation failed) and then continue to
execute.
Best practice is to call :meth:`AsyncMongoClient.close` when the client is no longer needed,
or use the client in a with statement::
async with AsyncMongoClient(url) as client:
# Use client here.
The `host` parameter can be a full `mongodb URI
<https://dochub.mongodb.org/core/connections>`_, in addition to
a simple hostname. It can also be a list of hostnames but no more
@ -2345,6 +2351,15 @@ class AsyncMongoClient(common.BaseObject, Generic[_DocumentType]):
) -> AsyncCommandCursor[dict[str, Any]]:
"""Get a cursor over the databases of the connected server.
Cursors are closed automatically when they are exhausted (the last batch of data is retrieved from the database).
If a cursor is not exhausted, it will be closed automatically upon garbage collection, which leaves resources open but unused for a potentially long period of time.
To avoid this, best practice is to call :meth:`AsyncCursor.close` when the cursor is no longer needed,
or use the cursor in a with statement::
async with await client.list_databases() as cursor:
async for database in cursor:
print(database)
:param session: a
:class:`~pymongo.asynchronous.client_session.AsyncClientSession`.
:param comment: A user-provided comment to attach to this

36
pymongo/synchronous/collection.py
View File

@ -1775,6 +1775,15 @@ class Collection(common.BaseObject, Generic[_DocumentType]):
improper type. Returns an instance of
:class:`~pymongo.cursor.Cursor` corresponding to this query.
Cursors are closed automatically when they are exhausted (the last batch of data is retrieved from the database).
If a cursor is not exhausted, it will be closed automatically upon garbage collection, which leaves resources open but unused for a potentially long period of time.
To avoid this, best practice is to call :meth:`Cursor.close` when the cursor is no longer needed,
or use the cursor in a with statement::
with collection.find() as cursor:
for doc in cursor:
print(doc)
The :meth:`find` method obeys the :attr:`read_preference` of
this :class:`Collection`.
@ -2500,6 +2509,15 @@ class Collection(common.BaseObject, Generic[_DocumentType]):
...
SON([('v', 2), ('key', SON([('_id', 1)])), ('name', '_id_')])
Cursors are closed automatically when they are exhausted (the last batch of data is retrieved from the database).
If a cursor is not exhausted, it will be closed automatically upon garbage collection, which leaves resources open but unused for a potentially long period of time.
To avoid this, best practice is to call :meth:`Cursor.close` when the cursor is no longer needed,
or use the cursor in a with statement::
with collection.list_indexes() as cursor:
for index in cursor:
print(index)
:param session: a
:class:`~pymongo.client_session.ClientSession`.
:param comment: A user-provided comment to attach to this
@ -2617,6 +2635,15 @@ class Collection(common.BaseObject, Generic[_DocumentType]):
) -> CommandCursor[Mapping[str, Any]]:
"""Return a cursor over search indexes for the current collection.
Cursors are closed automatically when they are exhausted (the last batch of data is retrieved from the database).
If a cursor is not exhausted, it will be closed automatically upon garbage collection, which leaves resources open but unused for a potentially long period of time.
To avoid this, best practice is to call :meth:`Cursor.close` when the cursor is no longer needed,
or use the cursor in a with statement::
with collection.list_search_indexes() as cursor:
for index in cursor:
print(index)
:param name: If given, the name of the index to search
for. Only indexes with matching index names will be returned.
If not given, all search indexes for the current collection
@ -2915,6 +2942,15 @@ class Collection(common.BaseObject, Generic[_DocumentType]):
.. note:: The :attr:`~pymongo.collection.Collection.write_concern` of
this collection is automatically applied to this operation.
Cursors are closed automatically when they are exhausted (the last batch of data is retrieved from the database).
If a cursor is not exhausted, it will be closed automatically upon garbage collection, which leaves resources open but unused for a potentially long period of time.
To avoid this, best practice is to call :meth:`Cursor.close` when the cursor is no longer needed,
or use the cursor in a with statement::
with collection.aggregate() as cursor:
for operation in cursor:
print(operation)
:param pipeline: a list of aggregation pipeline stages
:param session: a
:class:`~pymongo.client_session.ClientSession`.

14
pymongo/synchronous/database.py
View File

@ -652,6 +652,11 @@ class Database(common.BaseObject, Generic[_DocumentType]):
which case :attr:`~pymongo.read_preferences.ReadPreference.PRIMARY`
is used.
Cursors are closed automatically when they are exhausted (the last batch of data is retrieved from the database).
If a cursor is not exhausted, it will be closed automatically upon garbage collection, which leaves resources open but unused for a potentially long period of time.
To avoid this, best practice is to call :meth:`Cursor.close` when the cursor is no longer needed,
or use the cursor in a with statement.
.. note:: This method does not support the 'explain' option. Please
use :meth:`~pymongo.database.Database.command` instead.
@ -1148,6 +1153,15 @@ class Database(common.BaseObject, Generic[_DocumentType]):
) -> CommandCursor[MutableMapping[str, Any]]:
"""Get a cursor over the collections of this database.
Cursors are closed automatically when they are exhausted (the last batch of data is retrieved from the database).
If a cursor is not exhausted, it will be closed automatically upon garbage collection, which leaves resources open but unused for a potentially long period of time.
To avoid this, best practice is to call :meth:`Cursor.close` when the cursor is no longer needed,
or use the cursor in a with statement::
with database.list_collections() as cursor:
for collection in cursor:
print(collection)
:param session: a
:class:`~pymongo.client_session.ClientSession`.
:param filter: A query document to filter the list of

15
pymongo/synchronous/mongo_client.py
View File

@ -199,6 +199,12 @@ class MongoClient(common.BaseObject, Generic[_DocumentType]):
exception (recognizing that the operation failed) and then continue to
execute.
Best practice is to call :meth:`MongoClient.close` when the client is no longer needed,
or use the client in a with statement::
with MongoClient(url) as client:
# Use client here.
The `host` parameter can be a full `mongodb URI
<https://dochub.mongodb.org/core/connections>`_, in addition to
a simple hostname. It can also be a list of hostnames but no more
@ -2335,6 +2341,15 @@ class MongoClient(common.BaseObject, Generic[_DocumentType]):
) -> CommandCursor[dict[str, Any]]:
"""Get a cursor over the databases of the connected server.
Cursors are closed automatically when they are exhausted (the last batch of data is retrieved from the database).
If a cursor is not exhausted, it will be closed automatically upon garbage collection, which leaves resources open but unused for a potentially long period of time.
To avoid this, best practice is to call :meth:`Cursor.close` when the cursor is no longer needed,
or use the cursor in a with statement::
with client.list_databases() as cursor:
for database in cursor:
print(database)
:param session: a
:class:`~pymongo.client_session.ClientSession`.
:param comment: A user-provided comment to attach to this