Skip to content

mongodb-labs/pymongo-stubs

Repository files navigation

pymongo-stubs: Experimental stub files for PyMongo

Experimental stub files for PyMongo 3.

pymongo-stubs is NOT an officially supported MongoDB product.

Example

https://raw.githubusercontent.com/mongodb-labs/pymongo-stubs/main/images/screencast.gif

Installation

pymongo-stubs can be installed with pip:

$ python3 -m pip install pymongo-stubs

Installing from source

pymongo-stubs' source code is hosted on Github: mongodb-labs/pymongo-stubs. To install pymongo-stubs from source:

$ git clone git@github.com:mongodb-labs/pymongo-stubs.git
$ python3 -m pip install ./pymongo-stubs

Dependencies

pymongo-stubs is compatible with Python >=3.6 and PyMongo >=3.11,<4.0.

Roadmap

pymongo-stubs adds support for type checking PyMongo 3.X code. This project will not support PyMongo 4. Instead, PyMongo 4 will add inline type annotations (in PYTHON-2432) which removes the need to maintain stub files. This project will reach end-of-life when PYTHON-2432 is completed or when MongoDB drops support for PyMongo 3.X.

Support / Feedback

pymongo-stubs is experimental and is not an officially supported MongoDB product. For questions, discussions, or general technical support, visit the MongoDB Community Forums.

Bugs / Feature Requests

Think you’ve found a bug? Please open a case in our issue management tool, JIRA:

Bug reports in JIRA for all driver projects (i.e. PYTHON, CSHARP, JAVA) and the Core Server (i.e. SERVER) project are public.