hoyeon94 commented 3 years ago

What

기존에 사용하고자 했던 mongoengine을 쓰지 않고 pymongo를 사용하기로 결정함에 따라, 디렉터리 구조를 어떻게 변경할 것인지 논의

Description

flask&pymongo best practice 조사하기
의견 있으면 comment 달기

from datetime import datetime
from bson import ObjectId
from app import db

class BaseDao(object):
    def __init__(self, collection_name):
        self.db = db
        self.collection_name = collection_name

    def insert(self, element):
        element["created"] = datetime.now()
        element["updÍated"] = datetime.now()
        inserted = self.db[self.collection_name].insert_one(element)  # insert data to db
        return str(inserted.inserted_id)

    def find(self, criteria, projection=None, sort=None, limit=0, cursor=False):  # find all from db

        if "_id" in criteria:
            criteria["_id"] = ObjectId(criteria["_id"])

        found = self.db[self.collection_name].find(filter=criteria, projection=projection, limit=limit, sort=sort)

        if cursor:
            return found

        found = list(found)

        for i in range(len(found)):  # to serialize object id need to convert string
            if "_id" in found[i]:
                found[i]["_id"] = str(found[i]["_id"])

        return found

    def find_by_id(self, id):
        found = self.db[self.collection_name].find_one({"_id": ObjectId(id)})

        if found is None:
            return not found

        if "_id" in found:
             found["_id"] = str(found["_id"])

        return found

    def update(self, id, element):
        criteria = {"_id": ObjectId(id)}

        element["updated"] = datetime.now()
        set_obj = {"$set": element}  # update value

        updated = self.db[self.collection_name].update_one(criteria, set_obj)
        if updated.matched_count == 1:
            return "Record Successfully Updated"

    def delete(self, id):
        deleted = self.db[self.collection_name].delete_one({"_id": ObjectId(id)})
        return bool(deleted.deleted_count)

daos/ingredients_dao.py

from app.daos.base_dao import BaseDao

class IngredientsDao(BaseDao):
    def __init__(self):
        BaseDao.__init__(self, "Ingredients")

    def get_user_ingredients(self, user_id):
        self.find(criteria={
            "user_id": user_id
        })

views/refrigerators.py

from flask_restx import Namespace, Resource
from flask import jsonify
from bson.json_util import dumps
from app import db
from daos.ingredients_dao import IngredientsDao

ingredients_dao = IngredientsDao

Refrigerators = Namespace(
    name="Refrigerators",
    description="APIs for refrigerators"
)

@Refrigerators.route('/ingredients')
class Ingredients(Resource):
    def getUserIngredients(self):
        request_user_id = request.parsing("user_id")
        ingredients_dao.get_user_ingredients(request_user_id)
        return jsonify(get_user_ingredients)

hoyeon94 commented 3 years ago

위에 올린 코드를 간략하게 설명하자면, daos/base_dao.BaseDao를 상위클래스로, 각 collection들에 대한 dao들(예를 들어 IngredientsDao 등)을 BaseDao하위클래스로 둡니다. 공통으로 사용하는 db 접근 함수들은 BaseDao에 구현함으로써 중복되는 코드를 최소화하려고 했습니다!

일단 아래와 같이 BaseDao에 crud와 관련된 함수들을 구현하도록 하겠습니다!

insert
find
update
delete

혹시 더 추가하면 좋겠다 싶은 것들은 comment로 남겨주세요!

livlikwav commented 3 years ago

DAO 이대로 빠르게 가셔도 좋을 것 같습니다~

hoyeon94 commented 3 years ago

아래와 같이 dao를 사용하면 좋을 것 같습니다. 확인 부탁드립니다!

구조

base_dao.py

pymongo에 접근하는 함수는 모두 base_dao.py에 선언되어 있습니다.
ingredients_dao.py
ingredients collection에 접근하는 모듈입니다!
이후 collection별로 daos를 생성할 예정입니다(users_dao, recipes_dao 등,,)
BaseDao에 구현되어 있는 pymongo 접근 함수를 상속 받아 사용합니다.
규칙
1. base_dao.py의 함수를 통해서만 pymongo에 접근하도록 합니다!
코드 재사용성을 극도로 높이기 위함,,
일관된 코드를 작성하기 위함,,
BaseDao에 아래와 같이 db 접근 객체를 private으로 선언했기 때문에, BaseDao 외부에서 접근 불가합니다.
```
class BaseDao:
def __init__(self, collection_name):
    self.__db = db
    self.collection_name = collection_name
```

예시

# app/daos/base_dao.py
class BaseDao:
def __init__(self, collection_name):
    self.__db = db
    self.collection_name = collection_name
...
def find_list_by_filter(self, filter: dict={}, projection=None, sort=None, skip: int=0, limit: int=0)-> List[dict]:
    if "_id" in filter:
        filter["_id"] = ObjectId(filter["_id"])

    found = self.__db[self.collection_name].find(filter=filter, projection=projection, skip=skip, limit=limit, sort=sort)

    found = list(found)

    for i in range(len(found)):
        if "_id" in found[i]:
            found[i]["_id"] = str(found[i]["_id"])

    return found
...


# app/daos/ingredients_dao.py
from app.daos.base_dao import BaseDao

class IngredientsDao(BaseDao): def init(self): BaseDao.init(self, "ingredients")

def example_get_all_ingredients(self):
    return self.find_list_by_filter({}) # (O) BaseDao에 구현된 find_list_by_filter 함수를 이용해 db 접근
    return self.__db.find({filter{...}) # (X) 어차피 이렇게 할 수도 없습니다!

2. typehint를 써 주세요!
```python
def find_one_by_id(self, id:str)-> object:
    found = self.__db[self.collection_name].find_one({"_id": ObjectId(id)})

    if found:
        found["_id"] = str(found["_id"])

    return found

모듈 이름 수정 건의해봅니다. base_dao는 현재의 측면에서만 놓고 보았을 때, dao의 기능보다는 pymongo의 api 함수들을 호출하여 한번 더 우리가 편한 이름으로 wrapping해서 쓰이고 있는 개념인지라, base_dao가 아닌 다른 이름을 사용하는게 더 적합하지 않을까 싶습니다.

do168 commented 3 years ago

지난 회의에서 dao 로 용어를 굳히기로 했던 것 아니었나요?. 혹시 변경사항이 있나요?

coloryourlife commented 3 years ago

지난 회의에서 dao 로 용어를 굳히기로 했던 것 아니었나요?. 혹시 변경사항이 있나요?

다른 recipe_dao 이런 것들 말고 base_dao만 얘기하는겁니다! 실질적으로 데이터베이스에 접근하는 코드는 다른 dao에서 작성되고 base_dao에서는 데이터베이스에 접근하는 pymongo 함수와 mapping해주기만 하는 것 같아서요!

hoyeon94 commented 3 years ago

저는 클래스의 기능? 보다는 역할에 초점을 맞춰서 이렇게 네이밍 했습니다,, 떠도는 예제들을 보면 여러개의 클래스가 모두 상속받는 클래스를 base*** 이런식으로 많이 하더라구요,, 혹시 제홍님께서 생각하는 다른 클래스 이름이 있으신가여?

SeoulNative / naengboo

pymongo 사용 방법 논의(dao) #12

What

Description

Related

daos/base_dao.py

daos/ingredients_dao.py

views/refrigerators.py

구조

base_dao.py

ingredients_dao.py

규칙

Related