add: nullable field support (sbdchd#16)

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mongo-types"
-version = "0.7.7"
+version = "0.8.0"
 description = "Type stubs for mongoengine w/ basic support for bson and pymongo"
 repository = "https://github.com/sbdchd/mongo-types"
 readme = "README.md"

typings/mongoengine/base.pyi

@@ -1,4 +1,4 @@
-from typing import Any, Dict, List, Optional, Tuple, Type, TypeVar
+from typing import Any, Callable, Dict, List, Optional, Tuple, Type, TypeVar, Union
 
 from bson import SON
 
@@ -25,4 +25,20 @@ class BaseDocument:
     ) -> U: ...
 
 class BaseField:
-    pass
+    def __new__(
+        cls,
+        db_field: str = ...,
+        name: Optional[str] = ...,
+        required: bool = ...,
+        default: Union[Any, None, Callable[[], Any]] = ...,
+        primary_key: bool = ...,
+        choices: Optional[List[Any]] = ...,
+        null: bool = ...,
+        verbose_name: Optional[str] = ...,
+        help_text: Optional[str] = ...,
+    ) -> BaseField: ...
+    def __set__(self, instance: Any, value: Any) -> None: ...
+    def __get__(self, instance: Any, owner: Any) -> Any: ...
+    def validate(self, value: Any, clean: bool = ...) -> None: ...
+
+class ComplexBaseField(BaseField): ...

typings/mongoengine/document.pyi

@@ -21,7 +21,7 @@ class Document(BaseDocument):
     _meta: _UnderMetaDict
     _fields: Dict[str, Any]
 
-    pk = StringField()
+    pk = StringField(required=True)
     @classmethod
     def _get_collection(cls) -> Collection: ...
     # NOTE(sbdchd): if we are willing to change all Document.objects.filter()
@@ -67,7 +67,7 @@ class Document(BaseDocument):
 class EmbeddedDocument(BaseDocument):
     _fields: Dict[str, Any]
     _meta: _UnderMetaDict
-    def __init__(self, *args: Any, **kwargs: Any) -> None: ...
+    def __new__(cls, *args: Any, **kwargs: Any) -> EmbeddedDocument: ...
     def save(self) -> None: ...
     def __contains__(self, key: str) -> bool: ...
     def __getitem__(self, key: str) -> Any: ...