13

根据官方 Marshmallow 文档，建议声明一个 Schema，然后有一个单独的类来接收加载的数据，如下所示：

class UserSchema(Schema):
    name = fields.Str()
    email = fields.Email()
    created_at = fields.DateTime()

    @post_load
    def make_user(self, data):
        return User(**data)

但是，我的User课程看起来像这样：

class User:
    def __init__(name, email, created_at):
        self.name = name
        self.email = email
        self.created_at = created_at

这似乎是在不必要地重复自己，我真的不喜欢再写三遍属性名称。但是，我确实喜欢 IDE 自动完成和对定义明确的结构进行静态类型检查。

那么，是否有根据棉花糖模式加载序列化数据而不定义另一个类的最佳实践？

4

3 回答 3

5

对于普通的 Python 类，没有一种开箱即用的方式来为模式定义类而不重复字段名称。

例如，如果您使用 SQLAlchemy，您可以直接从模型中定义模式marshmallow_sqlalchemy.ModelSchema：

from marshmallow_sqlalchemy import ModelSchema
from my_alchemy_models import User

class UserSchema(ModelSchema):
    class Meta:
        model = User

这同样适用于使用flask_marshmallow.sqla.ModelSchema.

在普通 Python 类的情况下，您可以定义一次字段并将其用于模式和模型/类：

USER_FIELDS = ('name', 'email', 'created_at')

class User:
    def __init__(self, name, email, created_at):
        for field in USER_FIELDS:
            setattr(self, field, locals()[field])

class UserSchema(Schema):
    class Meta:
        fields = USER_FIELDS

    @post_load
    def make_user(self, data):
        return User(**data)
于 2017-08-23T06:30:24.817 回答
2

您必须创建这两个类，但好消息是在大多数情况下您不必多次输入属性名称。我发现的一件事是，如果您使用 Flask、SQLAlchemy 和 Marshmallow，如果您在 Column 定义中定义了一些验证属性，Marshmallow Schema 将自动获取这些以及其中提供的验证。例如：

import (your-database-object-from-flask-init) as db
import (your-marshmallow-object-from-flask-init) as val

class User(db.Model):
  name = db.Column(db.String(length=40), nullable=False)
  email = db.Column(db.String(length=100))
  created_at = db.Column(db.DateTime)

class UserSchema(val.ModelSchema):
  class Meta:
    model = User

在此示例中，如果您将数据字典放入 UserSchema().load(data) 中，如果在此示例中名称不存在或名称长度超过 40 个字符，您将看到错误，或者电子邮件超过 100 个字符。除此之外的任何自定义验证，您仍然必须在您的架构中进行编码。

如果您将模型类创建为另一个模型类的扩展，它也可以工作，并继承其属性。例如，如果您希望每个类都具有创建/修改的信息，您可以将这些属性放在父模型类中，并且子模型将继承这些属性及其验证参数。Marshmallow 不允许您的父模型具有模式，因此我没有有关自定义验证的信息。

我知道您可能已经完成了您的项目，但我希望这对遇到此问题的其他开发人员有所帮助。

相关点子列表：Flask (1.0.2) flask-marshmallow (0.9.0) Flask-SQLAlchemy (2.3.2) marshmallow (2.18.0) marshmallow-sqlalchemy (0.15.0) SQLAlchemy (1.2.16)

于 2019-01-22T18:17:12.297 回答
2

除非您需要反序列化为特定类或需要自定义序列化逻辑，否则您可以简单地执行此操作（改编自https://kimsereylam.com/python/2019/10/25/serialization-with-marshmallow.html）：

from marshmallow import Schema, fields
from datetime import datetime

class UserSchema(Schema):
    name = fields.Str(required=True)
    email = fields.Email()
    created_at = fields.DateTime()

schema = UserSchema()
data = { "name": "Some Guy", "email": "sguy@google.com": datetime.now() }
user = schema.load(data)

您还可以在您的类中创建一个函数，该函数创建一个带有验证规则的 dict，尽管它仍然是多余的，但它允许您将所有内容保留在模型类中：

class User:
    def __init__(name, email, created_at):
        self.name = name
        self.email = email
        self.created_at = created_at

        @classmethod
        def Schema(cls):
            return {"name": fields.Str(), "email": fields.Email(), "created_at": fields.DateTime()}

UserSchema = Schema.from_dict(User.Schema)

如果您需要强类型和完整的验证功能，请考虑 flask-pydantic 或 marshmallow-dataclass。

marshmallow-dataclass 提供了许多与 marshmallow 类似的验证功能。不过它有点束缚你的手。它没有对自定义字段/多态性的内置支持（必须改用 marshmallow-union），并且似乎不能很好地与 flask-marshmallow 和 marshmallow-sqlalchemy 等堆栈包一起使用。 https://pypi.org/project/marshmallow-dataclass/

from typing import ClassVar, Type
from marshmallow_dataclass import dataclasses
from marshmallow import Schema, field, validate


@dataclass
class Person:
    name: str = field(metadata=dict(load_only=True))
    height: float = field(metadata=dict(validate=validate.Range(min=0)))
    Schema: ClassVar[Type[Schema]] = Schema


Person.Schema().dump(Person('Bob', 2.0))
# => {'height': 2.0}

从验证的角度来看，flask-pydantic 不太优雅，但提供了许多相同的功能，并且验证内置在类中。请注意，像 min/max 这样的简单验证比 marshmallow 更尴尬。就个人而言，我更喜欢将视图/api 逻辑排除在课堂之外。https://pypi.org/project/Flask-Pydantic/

from typing import Optional
from flask import Flask, request
from pydantic import BaseModel

from flask_pydantic import validate

app = Flask("flask_pydantic_app")

class QueryModel(BaseModel):
  age: int

class ResponseModel(BaseModel):
  id: int
  age: int
  name: str
  nickname: Optional[str]

# Example 1: query parameters only
@app.route("/", methods=["GET"])
@validate()
def get(query:QueryModel):
  age = query.age
  return ResponseModel(
    age=age,
    id=0, name="abc", nickname="123"
    )
于 2021-03-22T21:11:05.203 回答