added sentinel value to allow None values in id to be passed in models internal methods (thus in pymongo)

Author: Lev Rubel

HISTORY.rst

@@ -2,6 +2,13 @@
 History
 =======
 
+0.2.5
+--------
+
+Bugfix:
+
+* Added sentinel value to allow None values in "id" field to be passed to Model internal methods
+
 0.2.4
 --------
 

docs/fastapi_contrib.rst

@@ -55,6 +55,14 @@ fastapi\_contrib.permissions module
  :undoc-members:
  :show-inheritance:
 
+fastapi\_contrib.routes module
+------------------------------
+
+.. automodule:: fastapi_contrib.routes
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
 
 Module contents
 ---------------

fastapi_contrib/db/client.py

@@ -4,7 +4,7 @@
 from pymongo.cursor import Cursor
 from pymongo.results import InsertOneResult, DeleteResult, UpdateResult
 
-from fastapi_contrib.db.models import MongoDBModel
+from fastapi_contrib.db.models import MongoDBModel, notset
 from fastapi_contrib.common.utils import get_current_app, get_timezone
 
 
@@ -50,8 +50,8 @@ async def insert(
  async def count(
  self, model: MongoDBModel, session: ClientSession = None, **kwargs
  ) -> int:
- _id = kwargs.pop("id", None)
- if _id is not None:
+ _id = kwargs.pop("id", notset)
+ if _id != notset:
  kwargs["_id"] = _id
 
  collection_name = model.get_db_collection()
@@ -62,8 +62,8 @@ async def count(
  async def delete(
  self, model: MongoDBModel, session: ClientSession = None, **kwargs
  ) -> DeleteResult:
- _id = kwargs.pop("id", None)
- if _id is not None:
+ _id = kwargs.pop("id", notset)
+ if _id != notset:
  kwargs["_id"] = _id
 
  collection_name = model.get_db_collection()
@@ -78,8 +78,8 @@ async def update_one(
  session: ClientSession = None,
  **kwargs
  ) -> UpdateResult:
- _id = filter_kwargs.pop("id", None)
- if _id is not None:
+ _id = filter_kwargs.pop("id", notset)
+ if _id != notset:
  filter_kwargs["_id"] = _id
 
  collection_name = model.get_db_collection()
@@ -96,8 +96,8 @@ async def update_many(
  session: ClientSession = None,
  **kwargs
  ) -> UpdateResult:
- _id = filter_kwargs.pop("id", None)
- if _id is not None:
+ _id = filter_kwargs.pop("id", notset)
+ if _id != notset:
  filter_kwargs["_id"] = _id
 
  collection_name = model.get_db_collection()
@@ -110,8 +110,8 @@ async def update_many(
  async def get(
  self, model: MongoDBModel, session: ClientSession = None, **kwargs
  ) -> dict:
- _id = kwargs.pop("id", None)
- if _id is not None:
+ _id = kwargs.pop("id", notset)
+ if _id != notset:
  kwargs["_id"] = _id
 
  collection_name = model.get_db_collection()
@@ -128,8 +128,8 @@ def list(
  _sort: list = None,
  **kwargs
  ) -> Cursor:
- _id = kwargs.pop("id", None)
- if _id is not None:
+ _id = kwargs.pop("id", notset)
+ if _id != notset:
  kwargs["_id"] = _id
 
  collection_name = model.get_db_collection()

fastapi_contrib/db/models.py

@@ -1,5 +1,3 @@
-import copy
-
 from datetime import datetime
 from typing import List, Optional
 
@@ -10,6 +8,13 @@
 from fastapi_contrib.db.utils import get_db_client, get_next_id
 
 
+class NotSet(object):
+ ...
+
+
+notset = NotSet()
+
+
 class MongoDBModel(BaseModel):
  """
  Base Model to use for any information saving in MongoDB.