使用 Marshmallow 模式过滤 sqlalchemy 表更新

Posted 2023-02-24

【中文标题】使用 Marshmallow 模式过滤 sqlalchemy 表更新

【英文标题】：Filter sqlalchemy table update with Marshmallow schema

【发布时间】：2016-01-07 07:22:54

【问题描述】：

我正在 Flask 中开发一个 api，使用 Marshmallow 进行序列化/反序列化/验证，并使用 SQLAlchemy 作为我的 ORM。

在我的更新功能中，我想限制可以更新的字段，例如我现在不希望用户能够更改他们的电子邮件。

为了实现这一点，我设置了一个模式 (UserSchema)，其字段受元组 (UserSchemaTypes.UPDATE_FIELDS) 限制。元组不包括电子邮件。

我遇到的问题是电子邮件是我数据库中用户行的必填字段。

因此，当我使用模式 (users_schema.load(user_json) ) 创建用户模型对象时，会将非法对象添加到 sqlalchemy 会话中。

#schema to validate the posted fields against  
users_schema = UserSchema(only=UserSchemaTypes.UPDATE_FIELDS)
#attempt to deserialize the posted json to a User model object using the schema
user_data = users_schema.load(user_json)
if not user_data.errors:#update data passed validation
   user_update_obj = user_data.data 
   User.update(user_id,vars(user_update_obj))

在我的更新函数本身中，我必须通过 db.session.expunge_all() 从会话中删除这个非法对象，就好像我没有收到 OperationalError 一样。

@staticmethod    
def update(p_id,data):
    db.session.expunge_all()#hack I want to remove
    user = User.query.get(p_id)
    for k, v in data.iteritems():
        setattr(user, k, v)
    db.session.commit()

删除 db.session.expunge_all() 时收到 OperationalError：

OperationalError: (raised as a result of Query-invoked autoflush; consider        
using a session.no_autoflush block if this flush is occurring prematurely) 
(_mysql_exceptions.OperationalError) (1048, "Column 'email' cannot be   null") [SQL: u'INSERT INTO user (email, password, active, phone, current_login_at, last_login_at, current_login_ip, last_login_ip, login_count) VALUES (%s, %s, %s, %s, %s, %s, %s, %s, %s)'] [parameters: (None, None, 1, '0444', None, None, None, None, None)]

有没有更好/更清洁的方法？

【参考方案1】：

来自史蒂文·洛里亚https://github.com/marshmallow-code/marshmallow-sqlalchemy/issues/33#issuecomment-147008000

您可以采取以下几种不同的方法：

选项1：字段参数

from marshmallow import Schema, fields, pre_load

class BaseSchema(Schema):
    @pre_load
    def check_update_fields(self, data)
        non_update_fields = set([
            fname, fobj for fname, obj in self.fields
            if fobj.metadata.get('can_update') is False
        ])
        return 
            key: value for key, value in data.items()
            if key not in non_update_fields
        

class UserSchema(BaseSchema):
    name = fields.Str()
    email = fields.Str(can_update=False)

选项2：类元选项

from marshmallow import Schema, SchemaOpts, fields, pre_load
class BaseSchemaOpts(SchemaOpts):
    def __init__(self, meta):
        super().__init__(meta)
        self.update_fields = getattr(meta, 'update_fields', set())

class BaseSchema(Schema):
    OPTIONS_CLASS = BaseSchemaOpts

    email = fields.Str(can_update=False)

    @pre_load
    def check_update_fields(self, data)
        non_update_fields = set(self.fields) - set(self.opts.update_fields)
        return 
            key: value for key, value in data.items()
            if key not in non_update_fields
        

class UserSchema(BaseSchema):

    name = fields.Str()
    email = fields.Str()

    class Meta:
        update_fields = ('name', )

【参考方案2】：

您的数据库与您的模型不匹配。

您应该同步数据库，因为您更改了模型的某些内容（将 null 电子邮件发送到非 null）。要么删除表并重新同步数据库，要么使用迁移工具修改表以匹配您的模型。