Skip to content

PYTHON-5238 - Add async GridFS API docs #2235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions doc/api/gridfs/asynchronous/grid_file.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
:mod:`grid_file` -- Async tools for representing files stored in GridFS
=======================================================================

.. automodule:: gridfs.asynchronous.grid_file
:synopsis: Async tools for representing files stored in GridFS

.. autoclass:: AsyncGridIn
:members:

.. autoattribute:: _id

.. autoclass:: AsyncGridOut
:members:

.. autoattribute:: _id
.. automethod:: __aiter__

.. autoclass:: AsyncGridOutCursor
:members:
18 changes: 18 additions & 0 deletions doc/api/gridfs/asynchronous/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
:mod:`gridfs async` -- Async tools for working with GridFS
==========================================================

.. warning:: This API is currently in beta, meaning the classes, methods,
and behaviors described within may change before the full release.
If you come across any bugs during your use of this API,
please file a Jira ticket in the "Python Driver" project at https://jira.mongodb.org/browse/PYTHON.

.. automodule:: gridfs.asynchronous
:synopsis: Async tools for working with GridFS
:members: AsyncGridFS, AsyncGridFSBucket

Sub-modules:

.. toctree::
:maxdepth: 2

grid_file
3 changes: 2 additions & 1 deletion doc/api/gridfs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
Sub-modules:

.. toctree::
:maxdepth: 2
:maxdepth: 3

asynchronous/index
errors
grid_file
42 changes: 42 additions & 0 deletions gridfs/asynchronous/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Copyright 2009-present MongoDB, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""GridFS is a specification for storing large objects in Mongo.

The :mod:`gridfs` package is an implementation of GridFS on top of
:mod:`pymongo`, exposing a file-like interface.

.. seealso:: The MongoDB documentation on `gridfs <https://dochub.mongodb.org/core/gridfs>`_.
"""
from __future__ import annotations

from gridfs.asynchronous.grid_file import (
AsyncGridFS,
AsyncGridFSBucket,
AsyncGridIn,
AsyncGridOut,
AsyncGridOutCursor,
)
from gridfs.errors import NoFile
from gridfs.grid_file_shared import DEFAULT_CHUNK_SIZE

__all__ = [
"AsyncGridFS",
"AsyncGridFSBucket",
"NoFile",
"DEFAULT_CHUNK_SIZE",
"AsyncGridIn",
"AsyncGridOut",
"AsyncGridOutCursor",
]
Loading