PYTHON-3074 Add documentation for type hints #906
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ShaneHarvey
requested changes
Mar 26, 2022
| except TypeError: | ||
| if hasattr(value, "__origin__"): | ||
| is_mapping = issubclass(value.__origin__, abc.MutableMapping) | ||
| if not is_mapping and not issubclass(value, RawBSONDocument): |
There was a problem hiding this comment.
Should we add a proper test for this fix?
| Client Document Type | ||
| -------------------- | ||
|
|
||
| :class:`~pymongo.mongo_client.MongoClient` is generic on the document type used to decode BSON documents. |
There was a problem hiding this comment.
We should mention that Client/Database/Collection are all generic too. For instance the TypedDict Movie example would probably make more sense at the collection level:
>>> from pymongo.collection import Collection
...
>>> client: MongoClient[Dict[str, Any]] = MongoClient()
>>> collection: Collection[Movie] = client.test.movies
ShaneHarvey
requested changes
Mar 28, 2022
test/test_mypy.py
Outdated
| @@ -309,6 +309,9 @@ def test_son_document_type(self) -> None: | |||
| assert retreived is not None | |||
| retreived["a"] = 1 | |||
|
|
|||
| def test_son_document_type_runtime(self) -> None: | |||
| client = MongoClient(document_class=SON[str, Any]) | |||
There was a problem hiding this comment.
Add connect=False to avoid starting threads.
ShaneHarvey
approved these changes
Mar 28, 2022
juliusgeo
reviewed
Mar 29, 2022
doc/examples/type_hints.rst
Outdated
|
|
||
| As of version 4.1, PyMongo ships with `type hints`_. | ||
|
|
||
| With type hints, Python type checkers can easily find bugs before they reveal themselves in your code. If your IDE is configured to use type hints, |
There was a problem hiding this comment.
Maybe put a link here for how to configure type hints in popular IDEs?
juliusgeo
pushed a commit
to juliusgeo/mongo-python-driver
that referenced
this pull request
Apr 7, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.