Skip to content

Commit

Permalink
MOTOR-1279 Improve Motor Typing (#269)
Browse files Browse the repository at this point in the history
  • Loading branch information
@blink1073
blink1073 committed Mar 22, 2024
1 parent f4832d9 commit 7bcea04
Show file tree
Hide file tree
Showing 7 changed files with 489 additions and 71 deletions.
9 changes: 4 additions & 5 deletions motor/core.pyi
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ from asyncio import Future
from typing import (
Any,
Callable,
Collection,
Coroutine,
Generic,
Iterable,
Expand All @@ -41,7 +40,7 @@ from pymongo import IndexModel, ReadPreference, WriteConcern
from pymongo.change_stream import ChangeStream
from pymongo.client_options import ClientOptions
from pymongo.client_session import _T, ClientSession, SessionOptions, TransactionOptions
from pymongo.collection import ReturnDocument, _WriteOp # noqa: F401
from pymongo.collection import Collection, ReturnDocument, _WriteOp # noqa: F401
from pymongo.command_cursor import CommandCursor, RawBatchCommandCursor
from pymongo.cursor import Cursor, RawBatchCursor, _Hint, _Sort
from pymongo.database import Database
Expand Down Expand Up @@ -112,15 +111,15 @@ class AgnosticClient(AgnosticBaseProperties[_DocumentType]):
read_preference: Optional[_ServerMode] = None,
write_concern: Optional[WriteConcern] = None,
read_concern: Optional[ReadConcern] = None,
) -> Database[_DocumentType]: ...
) -> AgnosticDatabase[_DocumentType]: ...
def get_default_database(
self,
default: Optional[str] = None,
codec_options: Optional[CodecOptions[_DocumentTypeArg]] = None,
read_preference: Optional[_ServerMode] = None,
write_concern: Optional[WriteConcern] = None,
read_concern: Optional[ReadConcern] = None,
) -> Database[_DocumentType]: ...
) -> AgnosticDatabase[_DocumentType]: ...

HOST: str

Expand Down Expand Up @@ -578,7 +577,7 @@ class AgnosticCollection(AgnosticBaseProperties[_DocumentType]):
read_preference: Optional[ReadPreference] = None,
write_concern: Optional[WriteConcern] = None,
read_concern: Optional[ReadConcern] = None,
) -> Collection[Mapping[str, Any]]: ...
) -> AgnosticCollection[Mapping[str, Any]]: ...
def list_search_indexes(
self,
name: Optional[str] = None,
Expand Down
245 changes: 227 additions & 18 deletions motor/motor_asyncio.pyi
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
import sys
from typing import Any, Mapping, MutableMapping, Optional, Union

if sys.version_info >= (3, 8):
from typing import TypeAlias
else:
from typing_extensions import TypeAlias
from bson import Code, CodecOptions, Timestamp
from pymongo.client_session import TransactionOptions
from pymongo.cursor import _Hint, _Sort
from pymongo.read_concern import ReadConcern
from pymongo.read_preferences import ReadPreference, _ServerMode
from pymongo.typings import _CollationIn, _DocumentType, _DocumentTypeArg, _Pipeline
from pymongo.write_concern import WriteConcern

from motor import core, motor_gridfs

Expand All @@ -20,30 +23,236 @@ __all__: list[str] = [
"AsyncIOMotorGridOut",
"AsyncIOMotorGridOutCursor",
"AsyncIOMotorClientEncryption",
"AsyncIOMotorLatentCommandCursor",
]

AsyncIOMotorClient: TypeAlias = core.AgnosticClient
class AsyncIOMotorClient(core.AgnosticClient):
def get_database(
self,
name: Optional[str] = None,
codec_options: Optional[CodecOptions[_DocumentTypeArg]] = None,
read_preference: Optional[_ServerMode] = None,
write_concern: Optional[WriteConcern] = None,
read_concern: Optional[ReadConcern] = None,
) -> AsyncIOMotorDatabase[_DocumentType]: ...
def get_default_database(
self,
default: Optional[str] = None,
codec_options: Optional[CodecOptions[_DocumentTypeArg]] = None,
read_preference: Optional[_ServerMode] = None,
write_concern: Optional[WriteConcern] = None,
read_concern: Optional[ReadConcern] = None,
) -> AsyncIOMotorDatabase[_DocumentType]: ...
async def list_databases(
self,
session: Optional[core.AgnosticClientSession] = None,
comment: Optional[Any] = None,
**kwargs: Any,
) -> AsyncIOMotorCommandCursor: ...
async def start_session(
self,
causal_consistency: Optional[bool] = None,
default_transaction_options: Optional[TransactionOptions] = None,
snapshot: Optional[bool] = False,
) -> AsyncIOMotorClientSession: ...
def watch(
self,
pipeline: Optional[_Pipeline] = None,
full_document: Optional[str] = None,
resume_after: Optional[Mapping[str, Any]] = None,
max_await_time_ms: Optional[int] = None,
batch_size: Optional[int] = None,
collation: Optional[_CollationIn] = None,
start_at_operation_time: Optional[Timestamp] = None,
session: Optional[core.AgnosticClientSession] = None,
start_after: Optional[Mapping[str, Any]] = None,
comment: Optional[str] = None,
full_document_before_change: Optional[str] = None,
show_expanded_events: Optional[bool] = None,
) -> AsyncIOMotorChangeStream: ...
def __getattr__(self, name: str) -> AsyncIOMotorDatabase: ...
def __getitem__(self, name: str) -> AsyncIOMotorDatabase: ...

AsyncIOMotorClientSession: TypeAlias = core.AgnosticClientSession
class AsyncIOMotorClientSession(core.AgnosticClientSession):
@property
def client(self) -> AsyncIOMotorClient: ...
async def __aenter__(self) -> AsyncIOMotorClientSession: ...

AsyncIOMotorDatabase: TypeAlias = core.AgnosticDatabase
class AsyncIOMotorDatabase(core.AgnosticDatabase):
async def cursor_command(
self,
command: Union[str, MutableMapping[str, Any]],
value: Any = 1,
read_preference: Optional[_ServerMode] = None,
codec_options: Optional[CodecOptions[core._CodecDocumentType]] = None,
session: Optional[core.AgnosticClientSession] = None,
comment: Optional[Any] = None,
max_await_time_ms: Optional[int] = None,
**kwargs: Any,
) -> AsyncIOMotorCommandCursor: ...
async def create_collection(
self,
name: str,
codec_options: Optional[CodecOptions[_DocumentTypeArg]] = None,
read_preference: Optional[_ServerMode] = None,
write_concern: Optional[WriteConcern] = None,
read_concern: Optional[ReadConcern] = None,
session: Optional[core.AgnosticClientSession] = None,
check_exists: Optional[bool] = True,
**kwargs: Any,
) -> AsyncIOMotorCollection: ...
def get_collection(
self,
name: str,
codec_options: Optional[CodecOptions[_DocumentTypeArg]] = None,
read_preference: Optional[_ServerMode] = None,
write_concern: Optional[WriteConcern] = None,
read_concern: Optional[ReadConcern] = None,
) -> AsyncIOMotorCollection: ...
async def list_collections(
self,
session: Optional[core.AgnosticClientSession] = None,
filter: Optional[Mapping[str, Any]] = None,
comment: Optional[Any] = None,
**kwargs: Any,
) -> AsyncIOMotorCommandCursor: ...
def with_options(
self,
codec_options: Optional[CodecOptions[_DocumentTypeArg]] = None,
read_preference: Optional[_ServerMode] = None,
write_concern: Optional[WriteConcern] = None,
read_concern: Optional[ReadConcern] = None,
) -> AsyncIOMotorDatabase: ...
def aggregate(
self, pipeline: _Pipeline, *args: Any, **kwargs: Any
) -> AsyncIOMotorLatentCommandCursor: ...
def watch(
self,
pipeline: Optional[_Pipeline] = None,
full_document: Optional[str] = None,
resume_after: Optional[Mapping[str, Any]] = None,
max_await_time_ms: Optional[int] = None,
batch_size: Optional[int] = None,
collation: Optional[_CollationIn] = None,
start_at_operation_time: Optional[Timestamp] = None,
session: Optional[core.AgnosticClientSession] = None,
start_after: Optional[Mapping[str, Any]] = None,
comment: Optional[Any] = None,
full_document_before_change: Optional[str] = None,
show_expanded_events: Optional[bool] = None,
) -> AsyncIOMotorChangeStream: ...
@property
def client(self) -> AsyncIOMotorClient: ...
def __getattr__(self, name: str) -> AsyncIOMotorCollection: ...
def __getitem__(self, name: str) -> AsyncIOMotorCollection: ...

AsyncIOMotorCollection: TypeAlias = core.AgnosticCollection
class AsyncIOMotorCollection(core.AgnosticCollection):
def with_options(
self,
codec_options: Optional[CodecOptions] = None,
read_preference: Optional[ReadPreference] = None,
write_concern: Optional[WriteConcern] = None,
read_concern: Optional[ReadConcern] = None,
) -> AsyncIOMotorCollection[Mapping[str, Any]]: ...
def list_search_indexes(
self,
name: Optional[str] = None,
session: Optional[core.AgnosticClientSession] = None,
comment: Optional[Any] = None,
**kwargs: Any,
) -> AsyncIOMotorLatentCommandCursor: ...
def __getattr__(self, name: str) -> AsyncIOMotorCollection: ...
def __getitem__(self, name: str) -> AsyncIOMotorCollection: ...
def find(self, *args: Any, **kwargs: Any) -> AsyncIOMotorCursor: ...
def find_raw_batches(self, *args: Any, **kwargs: Any) -> AsyncIOMotorCursor: ...
def aggregate(
self, pipeline: _Pipeline, *args: Any, **kwargs: Any
) -> AsyncIOMotorCommandCursor: ...
def aggregate_raw_batches(
self, pipeline: _Pipeline, **kwargs: Any
) -> AsyncIOMotorCommandCursor: ...
def list_indexes(
self, session: Optional[core.AgnosticClientSession] = None, **kwargs: Any
) -> AsyncIOMotorLatentCommandCursor: ...

AsyncIOMotorCursor: TypeAlias = core.AgnosticCursor
class AsyncIOMotorLatentCommandCursor(core.AgnosticLatentCommandCursor): ...

AsyncIOMotorCommandCursor: TypeAlias = core.AgnosticCommandCursor
class AsyncIOMotorCursor(core.AgnosticCursor):
def collation(self, collation: Optional[_CollationIn]) -> AsyncIOMotorCursor: ...
def add_option(self, mask: int) -> AsyncIOMotorCursor: ...
def remove_option(self, mask: int) -> AsyncIOMotorCursor: ...
def limit(self, limit: int) -> AsyncIOMotorCursor: ...
def skip(self, skip: int) -> AsyncIOMotorCursor: ...
def max_scan(self, max_scan: Optional[int]) -> AsyncIOMotorCursor: ...
def sort(
self, key_or_list: _Hint, direction: Optional[Union[int, str]] = None
) -> AsyncIOMotorCursor: ...
def hint(self, index: Optional[_Hint]) -> AsyncIOMotorCursor: ...
def where(self, code: Union[str, Code]) -> AsyncIOMotorCursor: ...
def max_await_time_ms(self, max_await_time_ms: Optional[int]) -> AsyncIOMotorCursor: ...
def max_time_ms(self, max_time_ms: Optional[int]) -> AsyncIOMotorCursor: ...
def min(self, spec: _Sort) -> AsyncIOMotorCursor: ...
def max(self, spec: _Sort) -> AsyncIOMotorCursor: ...
def comment(self, comment: Any) -> AsyncIOMotorCursor: ...
def allow_disk_use(self, allow_disk_use: bool) -> AsyncIOMotorCursor: ...
def rewind(self) -> AsyncIOMotorCursor: ...
def clone(self) -> AsyncIOMotorCursor: ...
def __copy__(self) -> AsyncIOMotorCursor: ...
def __deepcopy__(self, memo: Any) -> AsyncIOMotorCursor: ...

AsyncIOMotorLatentCommandCursor: TypeAlias = core.AgnosticLatentCommandCursor
class AsyncIOMotorRawBatchCursor(core.AgnosticRawBatchCursor): ...
class AsyncIOMotorCommandCursor(core.AgnosticCommandCursor): ...
class AsyncIOMotorRawBatchCommandCursor(core.AgnosticRawBatchCommandCursor): ...

AsyncIOMotorChangeStream: TypeAlias = core.AgnosticChangeStream
class AsyncIOMotorChangeStream(core.AgnosticChangeStream):
def __aiter__(self) -> AsyncIOMotorChangeStream: ...
async def __aenter__(self) -> AsyncIOMotorChangeStream: ...

AsyncIOMotorGridFSBucket: TypeAlias = motor_gridfs.AgnosticGridFSBucket
class AsyncIOMotorClientEncryption(core.AgnosticClientEncryption):
async def __aenter__(self) -> AsyncIOMotorClientEncryption: ...
async def get_keys(self) -> AsyncIOMotorCursor: ...
async def create_encrypted_collection(
self,
database: core.AgnosticDatabase,
name: str,
encrypted_fields: Mapping[str, Any],
kms_provider: Optional[str] = None,
master_key: Optional[Mapping[str, Any]] = None,
**kwargs: Any,
) -> tuple[AsyncIOMotorCollection, Mapping[str, Any]]: ...

AsyncIOMotorGridIn: TypeAlias = motor_gridfs.AgnosticGridIn
class AsyncIOMotorGridOutCursor(motor_gridfs.AgnosticGridOutCursor):
def next_object(self) -> AsyncIOMotorGridOutCursor: ...

AsyncIOMotorGridOut: TypeAlias = motor_gridfs.AgnosticGridOut
class AsyncIOMotorGridOut(motor_gridfs.AgnosticGridOut):
def __aiter__(self) -> AsyncIOMotorGridOut: ...

AsyncIOMotorGridOutCursor: TypeAlias = motor_gridfs.AgnosticGridOutCursor
class AsyncIOMotorGridIn(motor_gridfs.AgnosticGridIn):
async def __aenter__(self) -> AsyncIOMotorGridIn: ...

AsyncIOMotorClientEncryption: TypeAlias = core.AgnosticClientEncryption
class AsyncIOMotorGridFSBucket(motor_gridfs.AgnosticGridFSBucket):
async def open_download_stream_by_name(
self,
filename: str,
revision: int = -1,
session: Optional[core.AgnosticClientSession] = None,
) -> AsyncIOMotorGridOut: ...
async def open_download_stream(
self, file_id: Any, session: Optional[core.AgnosticClientSession] = None
) -> AsyncIOMotorGridOut: ...
def open_upload_stream(
self,
filename: str,
chunk_size_bytes: Optional[int] = None,
metadata: Optional[Mapping[str, Any]] = None,
session: Optional[core.AgnosticClientSession] = None,
) -> AsyncIOMotorGridIn: ...
def open_upload_stream_with_id(
self,
file_id: Any,
filename: str,
chunk_size_bytes: Optional[int] = None,
metadata: Optional[Mapping[str, Any]] = None,
session: Optional[core.AgnosticClientSession] = None,
) -> AsyncIOMotorGridIn: ...
def find(self, *args: Any, **kwargs: Any) -> AsyncIOMotorGridOutCursor: ...
8 changes: 4 additions & 4 deletions motor/motor_gridfs.pyi
View file
Original file line number Diff line number Diff line change
Expand Up @@ -127,25 +127,25 @@ class AgnosticGridFSBucket:
) -> None: ...
async def open_download_stream_by_name(
self, filename: str, revision: int = -1, session: Optional[AgnosticClientSession] = None
) -> GridOut: ...
) -> AgnosticGridOut: ...
async def open_download_stream(
self, file_id: Any, session: Optional[AgnosticClientSession] = None
) -> GridOut: ...
) -> AgnosticGridOut: ...
def open_upload_stream(
self,
filename: str,
chunk_size_bytes: Optional[int] = None,
metadata: Optional[Mapping[str, Any]] = None,
session: Optional[AgnosticClientSession] = None,
) -> GridIn: ...
) -> AgnosticGridIn: ...
def open_upload_stream_with_id(
self,
file_id: Any,
filename: str,
chunk_size_bytes: Optional[int] = None,
metadata: Optional[Mapping[str, Any]] = None,
session: Optional[AgnosticClientSession] = None,
) -> GridIn: ...
) -> AgnosticGridIn: ...
async def rename(
self, file_id: Any, new_filename: str, session: Optional[AgnosticClientSession] = None
) -> None: ...
Expand Down

0 comments on commit 7bcea04

Please sign in to comment.