refactor : refacto mongo to to_mongo

Author: PierroD

fastapi_crudrouter_mongodb/__init__.py

@@ -12,6 +12,6 @@
     "CRUDLookup",
 ]
 
-__version__ = "0.0.5"
+__version__ = "0.0.7"
 __author__ = "Pierre DUVEAU"
 __credits__ = ["Pierre DUVEAU", "Adam Watkins"]

fastapi_crudrouter_mongodb/core/models/mongo_model.py

@@ -1,6 +1,8 @@
 from bson import ObjectId
 from pydantic import BaseModel
 
+from fastapi_crudrouter_mongodb.core.utils.deprecated_util import deprecated
+
 
 class MongoModel(BaseModel):
 
@@ -16,6 +18,7 @@ def from_mongo(cls, data: dict):
         mid = data.pop('_id', None)
         return cls(**dict(data, id=mid))
 
+    @deprecated("use new method 'to_mongo' instead")
     def mongo(self, add_id: bool = False, **kwargs):
         exclude_none = kwargs.pop('exclude_none', True)
         by_alias = kwargs.pop('by_alias', True)
@@ -32,6 +35,29 @@ def mongo(self, add_id: bool = False, **kwargs):
         if '_id' not in parsed and 'id' not in parsed and add_id:
             parsed['_id'] = ObjectId()
         return parsed
+    
+    def to_mongo(self, add_id: bool = False, exclude_default: bool = False, by_alias: bool = False, **kwargs):
+        exclude_unset = kwargs.pop('exclude_unset', True)
+        exclude_default = kwargs.pop('exclude_default', True)
+        by_alias = kwargs.pop('by_alias', True)
+
+        parsed = self.dict(
+            exclude_unset=exclude_unset,
+            exclude_defaults=exclude_default,
+            by_alias=by_alias,
+            **kwargs,
+        )
+
+        # Mongo uses `_id` as default key. We should stick to that as well.
+        if '_id' not in parsed and 'id' in parsed:
+            parsed['_id'] = parsed.pop('id')
+        if '_id' not in parsed and 'id' not in parsed and add_id:
+            parsed['_id'] = ObjectId()
+        return parsed
+
+    def convert_to(self, model: BaseModel):
+        """Convert the current model into another model. """
+        return model(**self.dict())
 
     def __init__(self, **pydict):
         super().__init__(**pydict)

fastapi_crudrouter_mongodb/core/router/CRUDRouterRepository.py

@@ -55,7 +55,7 @@ async def create_one(db, model: MongoModel, collection_name, data: MongoModel):
     :return: The created document.
     :rtype: dict
     """
-    response = await db[collection_name].insert_one(data.mongo())
+    response = await db[collection_name].insert_one(data.to_mongo())
     response = await db[collection_name].find_one({"_id": response.inserted_id})
     return model.from_mongo(response)
 
@@ -77,7 +77,7 @@ async def replace_one(db, model: MongoModel, collection_name, id: str, data: Mon
     :return: The replaced document.
     :rtype: dict
     """
-    response = await db[collection_name].replace_one({"_id": ObjectId(id)}, data.mongo())
+    response = await db[collection_name].replace_one({"_id": ObjectId(id)}, data.to_mongo())
     response = await db[collection_name].find_one({"_id": response.upserted_id if response.upserted_id is not None else ObjectId(id)})
     return model.from_mongo(response)
 
@@ -99,7 +99,7 @@ async def update_one(db, model: MongoModel, collection_name, id: str, data: Mong
     :return: The updated document.
     :rtype: dict
     """
-    response = await db[collection_name].update_one({"_id": ObjectId(id)}, {"$set": data.mongo()})
+    response = await db[collection_name].update_one({"_id": ObjectId(id)}, {"$set": data.to_mongo()})
     response = await db[collection_name].find_one({"_id": response.upserted_id if response.upserted_id is not None else ObjectId(id)})
     return model.from_mongo(response)
 

fastapi_crudrouter_mongodb/core/router/embed/CRUDEmbedRouterRepository.py

@@ -68,7 +68,7 @@ async def create_one(db, id: str, parent_collection_name: str, embed_name: str,
     """
     Create a new document in the database
     """
-    document_mongo = data.mongo(add_id=True)
+    document_mongo = data.to_mongo(add_id=True)
     document = await db[parent_collection_name].update_one(
         {'_id': ObjectId(id)},
         {'$push': {embed_name: document_mongo}}
@@ -81,7 +81,7 @@ async def update_one(db, id: str, embed_id: str, parent_collection_name: str, em
     """
     Update a document in the database
     """
-    document_mongo = data.mongo(add_id=False)
+    document_mongo = data.to_mongo(add_id=False)
     document = await db[parent_collection_name].update_one(
         {'_id': ObjectId(id), f'{embed_name}._id': ObjectId(embed_id)},
         {'$set': {f'{embed_name}.$': document_mongo}}

fastapi_crudrouter_mongodb/core/router/lookup/CRUDLookupRouterRepository.py

@@ -1,4 +1,5 @@
 from bson import ObjectId
+
 from ...models.mongo_model import MongoModel
 
 
@@ -47,7 +48,7 @@ async def get_one(db, collection_name: str, id: str, lookup_id: str, foreign_fie
                     'path': f'${collection_name}',
                     'preserveNullAndEmptyArrays': True,
                 }
-            },
+            }
         ]
     )
     models = []
@@ -61,23 +62,23 @@ async def create_one(db, collection_name: str, id: str, data, foreign_field: str
     Create one document in the database with a lookup
     """
     print(data)
-    response = await db[collection_name].insert_one(data.mongo())
+    response = await db[collection_name].insert_one(data.to_mongo())
     return await get_one(db, collection_name, id, response.inserted_id, foreign_field, local_field, parent_collection_name, parent_model)
 
 
 async def replace_one(db, collection_name: str, id: str, lookup_id: str, data, foreign_field: str, local_field: str, parent_collection_name: str, parent_model: MongoModel) -> MongoModel:
     """
     Update one document in the database with a lookup
     """
-    response = await db[collection_name].replace_one({"_id": ObjectId(lookup_id)}, data.mongo())
+    response = await db[collection_name].replace_one({"_id": ObjectId(lookup_id)}, data.to_mongo())
     return await get_one(db, collection_name, id, lookup_id, foreign_field, local_field, parent_collection_name, parent_model)
 
 
 async def update_one(db, collection_name: str, id: str, lookup_id: str, data, foreign_field: str, local_field: str, parent_collection_name: str, parent_model: MongoModel) -> MongoModel:
     """
     Update one document in the database with a lookup
     """
-    response = await db[collection_name].update_one({"_id": ObjectId(lookup_id)}, {"$set": data.mongo()})
+    response = await db[collection_name].update_one({"_id": ObjectId(lookup_id)}, {"$set": data.to_mongo()})
     return await get_one(db, collection_name, id, lookup_id, foreign_field, local_field, parent_collection_name, parent_model)