l0rd-zer0 / motor-types Goto Github PK

Thanks again for the stubs!

There is a slight fundamental difference between typing in pymongo and this package. Namely, many pymongo classes are generic on the document type. See pymongo.MongoClient as the main example. The client is created with the document_class keyword argument which defaults to dict. This allows methods like Collection.find_one to be very specific about their return type (e.g. if the collection belongs to a client where the document class is dict, then the return type of Collection.find_one is dict[str, Any]).

Currently, this package is set up to always return _Document = typing.Mapping[str, typing.Any] (https://github.com/L0RD-ZER0/Motor-Types/blob/8ffaa4fb9c0e9e93ef0425ea761b47d0502b1d87/motor-stubs/core.pyi#L31C1-L31C44). While this behavior is not incorrect per se, it does present a major development experience difference between the two packages (and after all, motor is built to very closely mirror pymongo).

For what it's worth, I never use anything other than dict as the document class in either package and I find the constant need for defining everything to be generic on the document class to be quite cumbersome. Nevertheless, I thought I would create this issue to hopefully spark a discussion around the topic 😄

casual_consistency should be causal_consistency in the arguments to start_session.

https://motor.readthedocs.io/en/stable/api-tornado/cursors.html#motor.motor_tornado.MotorCommandCursor.to_list

Hello,
due to the actual tornado stub being empty, the reference file when using elements like MotorClient and MotorDatabase is to default to not resolving the import.

MyPy will complain, as the language server.

Substituting it with a basic stub does not enforce correct typing, but does not block the issue
This is generated via stubgen, of course this is not a real stub but at least solves the issue temporarily, until a full stub is implemented

Incomplete is better than an empty file, but might hide the fact that this is not implemented, I'm not sure if this was a deliberate implementation decision.

motor_tornado.pyi

from _typeshed import Incomplete
from typing import TypeVar

T = TypeVar('T')
MotorClient: Incomplete
MotorDatabase: Incomplete
MotorCollection: Incomplete
MotorCursor: Incomplete
MotorCommandCursor: Incomplete
MotorChangeStream: Incomplete
MotorGridFSBucket: Incomplete
MotorGridIn: Incomplete
MotorGridOut: Incomplete
MotorGridOutCursor: Incomplete
MotorClientEncryption: Incomplete

The example in the documentation

my_collection.create_index([("mike", pymongo.DESCENDING),
                            "eliot"])

is an exception.

keys can be a list of Union[tuple, str] instead of only a list of Union[Tuple] (_Index).

AsyncIOMotorClient.get_database has a read_preference keyword argument, which is mistyped as read_preferences, causing pyright type errors. According to the Motor docs, the word is singular. Reference:
https://motor.readthedocs.io/en/stable/api-asyncio/asyncio_motor_client.html?highlight=get_database#motor.motor_asyncio.AsyncIOMotorClient.get_database

Thanks for the stubs!

Error in the variable name. You need to use max_commit_time_ms instead of max_commit_time_ns

In stubs

    def start_transaction(
        self,
        read_concern: typing.Optional[pymongo.read_concern.ReadConcern] = None,
        write_concern: typing.Optional[pymongo.write_concern.WriteConcern] = None,
        read_preference: typing.Optional[_ReadPreferences] = None,
        max_commit_time_ns: typing.Optional[int] = None,
    ) -> _MotorTransactionContext: ...

In motor

    def start_transaction(
        self, read_concern=None, write_concern=None, read_preference=None, max_commit_time_ms=None
    ):