464 lines
21 KiB
Plaintext
464 lines
21 KiB
Plaintext
Metadata-Version: 2.3
|
|
Name: motor
|
|
Version: 3.6.0
|
|
Summary: Non-blocking MongoDB driver for Tornado or asyncio
|
|
Project-URL: Homepage, https://www.mongodb.org
|
|
Project-URL: Documentation, https://motor.readthedocs.io
|
|
Project-URL: Source, https://github.com/mongodb/motor
|
|
Project-URL: Tracker, https://jira.mongodb.org/projects/MOTOR/issues
|
|
Author-email: "A. Jesse Jiryu Davis" <jesse@mongodb.com>
|
|
License: Apache License
|
|
Version 2.0, January 2004
|
|
http://www.apache.org/licenses/
|
|
|
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
|
|
1. Definitions.
|
|
|
|
"License" shall mean the terms and conditions for use, reproduction,
|
|
and distribution as defined by Sections 1 through 9 of this document.
|
|
|
|
"Licensor" shall mean the copyright owner or entity authorized by
|
|
the copyright owner that is granting the License.
|
|
|
|
"Legal Entity" shall mean the union of the acting entity and all
|
|
other entities that control, are controlled by, or are under common
|
|
control with that entity. For the purposes of this definition,
|
|
"control" means (i) the power, direct or indirect, to cause the
|
|
direction or management of such entity, whether by contract or
|
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
|
|
"You" (or "Your") shall mean an individual or Legal Entity
|
|
exercising permissions granted by this License.
|
|
|
|
"Source" form shall mean the preferred form for making modifications,
|
|
including but not limited to software source code, documentation
|
|
source, and configuration files.
|
|
|
|
"Object" form shall mean any form resulting from mechanical
|
|
transformation or translation of a Source form, including but
|
|
not limited to compiled object code, generated documentation,
|
|
and conversions to other media types.
|
|
|
|
"Work" shall mean the work of authorship, whether in Source or
|
|
Object form, made available under the License, as indicated by a
|
|
copyright notice that is included in or attached to the work
|
|
(an example is provided in the Appendix below).
|
|
|
|
"Derivative Works" shall mean any work, whether in Source or Object
|
|
form, that is based on (or derived from) the Work and for which the
|
|
editorial revisions, annotations, elaborations, or other modifications
|
|
represent, as a whole, an original work of authorship. For the purposes
|
|
of this License, Derivative Works shall not include works that remain
|
|
separable from, or merely link (or bind by name) to the interfaces of,
|
|
the Work and Derivative Works thereof.
|
|
|
|
"Contribution" shall mean any work of authorship, including
|
|
the original version of the Work and any modifications or additions
|
|
to that Work or Derivative Works thereof, that is intentionally
|
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
or by an individual or Legal Entity authorized to submit on behalf of
|
|
the copyright owner. For the purposes of this definition, "submitted"
|
|
means any form of electronic, verbal, or written communication sent
|
|
to the Licensor or its representatives, including but not limited to
|
|
communication on electronic mailing lists, source code control systems,
|
|
and issue tracking systems that are managed by, or on behalf of, the
|
|
Licensor for the purpose of discussing and improving the Work, but
|
|
excluding communication that is conspicuously marked or otherwise
|
|
designated in writing by the copyright owner as "Not a Contribution."
|
|
|
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
on behalf of whom a Contribution has been received by Licensor and
|
|
subsequently incorporated within the Work.
|
|
|
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
this License, each Contributor hereby grants to You a perpetual,
|
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
copyright license to reproduce, prepare Derivative Works of,
|
|
publicly display, publicly perform, sublicense, and distribute the
|
|
Work and such Derivative Works in Source or Object form.
|
|
|
|
3. Grant of Patent License. Subject to the terms and conditions of
|
|
this License, each Contributor hereby grants to You a perpetual,
|
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
(except as stated in this section) patent license to make, have made,
|
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
where such license applies only to those patent claims licensable
|
|
by such Contributor that are necessarily infringed by their
|
|
Contribution(s) alone or by combination of their Contribution(s)
|
|
with the Work to which such Contribution(s) was submitted. If You
|
|
institute patent litigation against any entity (including a
|
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
or a Contribution incorporated within the Work constitutes direct
|
|
or contributory patent infringement, then any patent licenses
|
|
granted to You under this License for that Work shall terminate
|
|
as of the date such litigation is filed.
|
|
|
|
4. Redistribution. You may reproduce and distribute copies of the
|
|
Work or Derivative Works thereof in any medium, with or without
|
|
modifications, and in Source or Object form, provided that You
|
|
meet the following conditions:
|
|
|
|
(a) You must give any other recipients of the Work or
|
|
Derivative Works a copy of this License; and
|
|
|
|
(b) You must cause any modified files to carry prominent notices
|
|
stating that You changed the files; and
|
|
|
|
(c) You must retain, in the Source form of any Derivative Works
|
|
that You distribute, all copyright, patent, trademark, and
|
|
attribution notices from the Source form of the Work,
|
|
excluding those notices that do not pertain to any part of
|
|
the Derivative Works; and
|
|
|
|
(d) If the Work includes a "NOTICE" text file as part of its
|
|
distribution, then any Derivative Works that You distribute must
|
|
include a readable copy of the attribution notices contained
|
|
within such NOTICE file, excluding those notices that do not
|
|
pertain to any part of the Derivative Works, in at least one
|
|
of the following places: within a NOTICE text file distributed
|
|
as part of the Derivative Works; within the Source form or
|
|
documentation, if provided along with the Derivative Works; or,
|
|
within a display generated by the Derivative Works, if and
|
|
wherever such third-party notices normally appear. The contents
|
|
of the NOTICE file are for informational purposes only and
|
|
do not modify the License. You may add Your own attribution
|
|
notices within Derivative Works that You distribute, alongside
|
|
or as an addendum to the NOTICE text from the Work, provided
|
|
that such additional attribution notices cannot be construed
|
|
as modifying the License.
|
|
|
|
You may add Your own copyright statement to Your modifications and
|
|
may provide additional or different license terms and conditions
|
|
for use, reproduction, or distribution of Your modifications, or
|
|
for any such Derivative Works as a whole, provided Your use,
|
|
reproduction, and distribution of the Work otherwise complies with
|
|
the conditions stated in this License.
|
|
|
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
any Contribution intentionally submitted for inclusion in the Work
|
|
by You to the Licensor shall be under the terms and conditions of
|
|
this License, without any additional terms or conditions.
|
|
Notwithstanding the above, nothing herein shall supersede or modify
|
|
the terms of any separate license agreement you may have executed
|
|
with Licensor regarding such Contributions.
|
|
|
|
6. Trademarks. This License does not grant permission to use the trade
|
|
names, trademarks, service marks, or product names of the Licensor,
|
|
except as required for reasonable and customary use in describing the
|
|
origin of the Work and reproducing the content of the NOTICE file.
|
|
|
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
agreed to in writing, Licensor provides the Work (and each
|
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
implied, including, without limitation, any warranties or conditions
|
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
appropriateness of using or redistributing the Work and assume any
|
|
risks associated with Your exercise of permissions under this License.
|
|
|
|
8. Limitation of Liability. In no event and under no legal theory,
|
|
whether in tort (including negligence), contract, or otherwise,
|
|
unless required by applicable law (such as deliberate and grossly
|
|
negligent acts) or agreed to in writing, shall any Contributor be
|
|
liable to You for damages, including any direct, indirect, special,
|
|
incidental, or consequential damages of any character arising as a
|
|
result of this License or out of the use or inability to use the
|
|
Work (including but not limited to damages for loss of goodwill,
|
|
work stoppage, computer failure or malfunction, or any and all
|
|
other commercial damages or losses), even if such Contributor
|
|
has been advised of the possibility of such damages.
|
|
|
|
9. Accepting Warranty or Additional Liability. While redistributing
|
|
the Work or Derivative Works thereof, You may choose to offer,
|
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
or other liability obligations and/or rights consistent with this
|
|
License. However, in accepting such obligations, You may act only
|
|
on Your own behalf and on Your sole responsibility, not on behalf
|
|
of any other Contributor, and only if You agree to indemnify,
|
|
defend, and hold each Contributor harmless for any liability
|
|
incurred by, or claims asserted against, such Contributor by reason
|
|
of your accepting any such warranty or additional liability.
|
|
|
|
END OF TERMS AND CONDITIONS
|
|
|
|
APPENDIX: How to apply the Apache License to your work.
|
|
|
|
To apply the Apache License to your work, attach the following
|
|
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
replaced with your own identifying information. (Don't include
|
|
the brackets!) The text should be enclosed in the appropriate
|
|
comment syntax for the file format. We also recommend that a
|
|
file or class name and description of purpose be included on the
|
|
same "printed page" as the copyright notice for easier
|
|
identification within third-party archives.
|
|
|
|
Copyright [yyyy] [name of copyright owner]
|
|
|
|
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.
|
|
License-File: LICENSE
|
|
Keywords: asyncio,bson,gridfs,mongo,mongodb,motor,pymongo,tornado
|
|
Classifier: Development Status :: 5 - Production/Stable
|
|
Classifier: Intended Audience :: Developers
|
|
Classifier: License :: OSI Approved :: Apache Software License
|
|
Classifier: Natural Language :: English
|
|
Classifier: Operating System :: MacOS :: MacOS X
|
|
Classifier: Operating System :: Microsoft :: Windows
|
|
Classifier: Operating System :: Unix
|
|
Classifier: Programming Language :: Python
|
|
Classifier: Programming Language :: Python :: 3
|
|
Classifier: Programming Language :: Python :: 3.8
|
|
Classifier: Programming Language :: Python :: 3.9
|
|
Classifier: Programming Language :: Python :: 3.10
|
|
Classifier: Programming Language :: Python :: 3.11
|
|
Classifier: Programming Language :: Python :: 3.12
|
|
Classifier: Programming Language :: Python :: 3.13
|
|
Classifier: Programming Language :: Python :: Implementation :: CPython
|
|
Classifier: Programming Language :: Python :: Implementation :: PyPy
|
|
Classifier: Typing :: Typed
|
|
Requires-Python: >=3.8
|
|
Requires-Dist: pymongo<4.10,>=4.9
|
|
Provides-Extra: aws
|
|
Requires-Dist: pymongo[aws]<5,>=4.5; extra == 'aws'
|
|
Provides-Extra: docs
|
|
Requires-Dist: aiohttp; extra == 'docs'
|
|
Requires-Dist: furo==2024.8.6; extra == 'docs'
|
|
Requires-Dist: readthedocs-sphinx-search~=0.3; extra == 'docs'
|
|
Requires-Dist: sphinx-rtd-theme<3,>=2; extra == 'docs'
|
|
Requires-Dist: sphinx<8,>=5.3; extra == 'docs'
|
|
Requires-Dist: tornado; extra == 'docs'
|
|
Provides-Extra: encryption
|
|
Requires-Dist: pymongo[encryption]<5,>=4.5; extra == 'encryption'
|
|
Provides-Extra: gssapi
|
|
Requires-Dist: pymongo[gssapi]<5,>=4.5; extra == 'gssapi'
|
|
Provides-Extra: ocsp
|
|
Requires-Dist: pymongo[ocsp]<5,>=4.5; extra == 'ocsp'
|
|
Provides-Extra: snappy
|
|
Requires-Dist: pymongo[snappy]<5,>=4.5; extra == 'snappy'
|
|
Provides-Extra: test
|
|
Requires-Dist: aiohttp>=3.8.7; extra == 'test'
|
|
Requires-Dist: cffi>=1.17.0rc1; (python_version == '3.13') and extra == 'test'
|
|
Requires-Dist: mockupdb; extra == 'test'
|
|
Requires-Dist: pymongo[encryption]<5,>=4.5; extra == 'test'
|
|
Requires-Dist: pytest-asyncio; extra == 'test'
|
|
Requires-Dist: pytest>=7; extra == 'test'
|
|
Requires-Dist: tornado>=5; extra == 'test'
|
|
Provides-Extra: zstd
|
|
Requires-Dist: pymongo[zstd]<5,>=4.5; extra == 'zstd'
|
|
Description-Content-Type: text/markdown
|
|
|
|
# Motor
|
|
|
|
[](https://pypi.org/project/motor)
|
|
[](https://pypi.org/project/motor)
|
|
[](https://pepy.tech/project/motor)
|
|
[](http://motor.readthedocs.io/en/stable/?badge=stable)
|
|
|
|
|
|
|
|
## About
|
|
|
|
Motor is a full-featured, non-blocking [MongoDB](http://mongodb.org/)
|
|
driver for Python [asyncio](https://docs.python.org/3/library/asyncio.html) and
|
|
[Tornado](http://tornadoweb.org/) applications. Motor presents a coroutine-based API
|
|
for non-blocking access to MongoDB.
|
|
|
|
> "We use Motor in high throughput environments, processing tens of
|
|
> thousands of requests per second. It allows us to take full advantage
|
|
> of modern hardware, ensuring we utilise the entire capacity of our
|
|
> purchased CPUs. This helps us be more efficient with computing power,
|
|
> compute spend and minimises the environmental impact of our
|
|
> infrastructure as a result."
|
|
>
|
|
> --*David Mytton, Server Density*
|
|
>
|
|
> "We develop easy-to-use sensors and sensor systems with open source
|
|
> software to ensure every innovator, from school child to laboratory
|
|
> researcher, has the same opportunity to create. We integrate Motor
|
|
> into our software to guarantee massively scalable sensor systems for
|
|
> everyone."
|
|
>
|
|
> --*Ryan Smith, inXus Interactive*
|
|
|
|
## Support / Feedback
|
|
|
|
For issues with, questions about, or feedback for PyMongo, please look
|
|
into our [support channels](https://support.mongodb.com/welcome). Please
|
|
do not email any of the Motor developers directly with issues or
|
|
questions - you're more likely to get an answer on the
|
|
[StackOverflow](https://stackoverflow.com/questions/tagged/mongodb)
|
|
(using a "mongodb" tag).
|
|
|
|
## Bugs / Feature Requests
|
|
|
|
Think you've found a bug? Want to see a new feature in Motor? Please
|
|
open a case in our issue management tool, JIRA:
|
|
|
|
- [Create an account and login](https://jira.mongodb.org).
|
|
- Navigate to [the MOTOR
|
|
project](https://jira.mongodb.org/browse/MOTOR).
|
|
- Click **Create Issue** - Please provide as much information as
|
|
possible about the issue type and how to reproduce it.
|
|
|
|
Bug reports in JIRA for all driver projects (i.e. MOTOR, CSHARP, JAVA)
|
|
and the Core Server (i.e. SERVER) project are **public**.
|
|
|
|
### How To Ask For Help
|
|
|
|
Please include all of the following information when opening an issue:
|
|
|
|
- Detailed steps to reproduce the problem, including full traceback, if
|
|
possible.
|
|
|
|
- The exact python version used, with patch level:
|
|
|
|
```bash
|
|
python -c "import sys; print(sys.version)"
|
|
```
|
|
|
|
- The exact version of Motor used, with patch level:
|
|
|
|
```bash
|
|
python -c "import motor; print(motor.version)"
|
|
```
|
|
|
|
- The exact version of PyMongo used, with patch level:
|
|
|
|
```bash
|
|
python -c "import pymongo; print(pymongo.version); print(pymongo.has_c())"
|
|
```
|
|
|
|
- The exact Tornado version, if you are using Tornado:
|
|
|
|
```bash
|
|
python -c "import tornado; print(tornado.version)"
|
|
```
|
|
|
|
- The operating system and version (e.g. RedHat Enterprise Linux 6.4,
|
|
OSX 10.9.5, ...)
|
|
|
|
### Security Vulnerabilities
|
|
|
|
If you've identified a security vulnerability in a driver or any other
|
|
MongoDB project, please report it according to the [instructions
|
|
here](https://mongodb.com/docs/manual/tutorial/create-a-vulnerability-report).
|
|
|
|
## Installation
|
|
|
|
Motor can be installed with [pip](http://pypi.python.org/pypi/pip):
|
|
|
|
```bash
|
|
pip install motor
|
|
```
|
|
|
|
## Dependencies
|
|
|
|
Motor works in all the environments officially supported by Tornado or
|
|
by asyncio. It requires:
|
|
|
|
- Unix (including macOS) or Windows.
|
|
- [PyMongo](http://pypi.python.org/pypi/pymongo/) >=4.1,<5
|
|
- Python 3.8+
|
|
|
|
Optional dependencies:
|
|
|
|
Motor supports same optional dependencies as PyMongo. Required
|
|
dependencies can be installed along with Motor.
|
|
|
|
GSSAPI authentication requires `gssapi` extra dependency. The correct
|
|
dependency can be installed automatically along with Motor:
|
|
|
|
```bash
|
|
pip install "motor[gssapi]"
|
|
```
|
|
|
|
similarly,
|
|
|
|
MONGODB-AWS authentication requires `aws` extra dependency:
|
|
|
|
```bash
|
|
pip install "motor[aws]"
|
|
```
|
|
|
|
Support for mongodb+srv:// URIs requires `srv` extra dependency:
|
|
|
|
```bash
|
|
pip install "motor[srv]"
|
|
```
|
|
|
|
OCSP requires `ocsp` extra dependency:
|
|
|
|
```bash
|
|
pip install "motor[ocsp]"
|
|
```
|
|
|
|
Wire protocol compression with snappy requires `snappy` extra
|
|
dependency:
|
|
|
|
```bash
|
|
pip install "motor[snappy]"
|
|
```
|
|
|
|
Wire protocol compression with zstandard requires `zstd` extra
|
|
dependency:
|
|
|
|
```bash
|
|
pip install "motor[zstd]"
|
|
```
|
|
|
|
Client-Side Field Level Encryption requires `encryption` extra
|
|
dependency:
|
|
|
|
```bash
|
|
pip install "motor[encryption]"
|
|
```
|
|
|
|
You can install all dependencies automatically with the following
|
|
command:
|
|
|
|
```bash
|
|
pip install "motor[gssapi,aws,ocsp,snappy,srv,zstd,encryption]"
|
|
```
|
|
|
|
See
|
|
[requirements](https://motor.readthedocs.io/en/stable/requirements.html)
|
|
for details about compatibility.
|
|
|
|
## Examples
|
|
|
|
See the [examples on
|
|
ReadTheDocs](https://motor.readthedocs.io/en/stable/examples/index.html).
|
|
|
|
## Documentation
|
|
|
|
Motor's documentation is on
|
|
[ReadTheDocs](https://motor.readthedocs.io/en/stable/).
|
|
|
|
Build the documentation with Python 3.8+. Install
|
|
[sphinx](http://sphinx.pocoo.org/), [Tornado](http://tornadoweb.org/),
|
|
and [aiohttp](https://github.com/aio-libs/aiohttp), and do
|
|
`cd doc; make html`.
|
|
|
|
## Learning Resources
|
|
|
|
- MongoDB Learn - [Python
|
|
courses](https://learn.mongodb.com/catalog?labels=%5B%22Language%22%5D&values=%5B%22Python%22%5D).
|
|
- [Python Articles on Developer
|
|
Center](https://www.mongodb.com/developer/languages/python/).
|
|
|
|
## Testing
|
|
|
|
Run `python setup.py test`. Tests are located in the `test/` directory.
|