Merge pull request #201 from nzsmith1/pytype

Add support for py.typed file

beanie/__init__.py

@@ -19,7 +19,7 @@
 from beanie.odm.utils.general import init_beanie
 from beanie.odm.documents import Document
 
-__version__ = "1.9.0"
+__version__ = "1.9.1"
 __all__ = [
     # ODM
     "Document",

beanie/odm/operators/find/evaluation.py

@@ -79,7 +79,7 @@ class Sample(Document):
     <https://docs.mongodb.com/manual/reference/operator/query/mod/>
     """
 
-    def __init__(self, field, divisor, remainder):
+    def __init__(self, field, divisor: int, remainder: int):
         self.field = field
         self.divisor = divisor
         self.remainder = remainder
@@ -97,7 +97,12 @@ class RegEx(BaseFindEvaluationOperator):
     <https://docs.mongodb.com/manual/reference/operator/query/regex/>
     """
 
-    def __init__(self, field, pattern, options: Optional[str] = None):
+    def __init__(
+        self,
+        field,
+        pattern: str,
+        options: Optional[str] = None,
+    ):
         self.field = field
         self.pattern = pattern
         self.options = options

beanie/odm/queries/aggregation.py

@@ -11,6 +11,8 @@
 
 from pydantic import BaseModel
 
+from motor.core import AgnosticCommandCursor
+
 from beanie.odm.cache import LRUCache
 from beanie.odm.interfaces.session import SessionMethods
 from beanie.odm.queries.cursor import BaseCursorQuery
@@ -96,7 +98,7 @@ def get_aggregation_pipeline(
         return match_pipeline + self.aggregation_pipeline + projection_pipeline
 
     @property
-    def motor_cursor(self):
+    def motor_cursor(self) -> AgnosticCommandCursor:
         aggregation_pipeline = self.get_aggregation_pipeline()
         return self.document_model.get_motor_collection().aggregate(
             aggregation_pipeline, session=self.session

beanie/odm/queries/find.py

@@ -162,10 +162,7 @@ def delete(
             bulk_writer=bulk_writer,
         ).set_session(session=session)
 
-    def project(
-        self,
-        projection_model,
-    ):
+    def project(self, projection_model):
         """
         Apply projection parameter
         :param projection_model: Optional[Type[BaseModel]] - projection model

beanie/odm/settings/general.py

@@ -1,4 +1,6 @@
 from dataclasses import dataclass
+from typing import Type
+from motor.motor_asyncio import AsyncIOMotorDatabase
 
 from beanie.odm.settings.collection import CollectionSettings
 from beanie.odm.settings.model import ModelSettings
@@ -10,7 +12,7 @@ class DocumentSettings:
     collection_settings: CollectionSettings
 
     @classmethod
-    async def init(cls, database, document_model, allow_index_dropping):
+    async def init(cls, database: AsyncIOMotorDatabase, document_model: Type, allow_index_dropping: bool):
         # Init collection settings
         collection_settings = await CollectionSettings.init(
             database=database,

docs/changelog.md

@@ -2,6 +2,17 @@
 
 Beanie project 
 
+## [1.9.1] - 2022-02-11
+
+### Improvement
+
+- Add support for py.typed file
+
+### Implementation
+
+- Author - [Nicholas Smith](https://github.com/nzsmith1)
+- PR - <https://github.com/roman-right/beanie/pull/201>
+
 ## [1.9.0] - 2022-02-11
 
 ### Breaking Change
@@ -687,4 +698,6 @@ how specific type should be presented in the database
 
 [1.8.13]: https://pypi.org/project/beanie/1.8.13
 
-[1.9.0]: https://pypi.org/project/beanie/1.9.0
+[1.9.0]: https://pypi.org/project/beanie/1.9.0
+
+[1.9.1]: https://pypi.org/project/beanie/1.9.1

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "beanie"
-version = "1.9.0"
+version = "1.9.1"
 description = "Asynchronous Python ODM for MongoDB"
 authors = ["Roman <[email protected]>"]
 license = "Apache-2.0"
@@ -9,6 +9,7 @@ repository = "https://github.com/roman-right/beanie"
 keywords = ["mongodb", "odm", "orm", "pydantic", "mongo", "async", "python"]
 include = [
     "LICENSE",
+    "beanie/py.typed"
 ]
 readme = "README.md"
 

tests/test_beanie.py

@@ -2,4 +2,4 @@
 
 
 def test_version():
-    assert __version__ == "1.9.0"
+    assert __version__ == "1.9.1"