Marshmallow 开源项目教程

Marshmallow 开源项目教程

marshmallowA lightweight library for converting complex objects to and from simple Python datatypes.项目地址:https://gitcode.com/gh_mirrors/ma/marshmallow

项目介绍

Marshmallow 是一个用于将复杂数据类型（如对象）与简单数据类型（如字典、JSON 和 XML）之间进行转换的 Python 库。它主要用于序列化和反序列化数据，以及数据验证。Marshmallow 的设计目标是简单、灵活且易于扩展，适用于各种 Web 开发框架和数据处理场景。

项目快速启动

安装

首先，你需要安装 Marshmallow。你可以使用 pip 进行安装：

pip install marshmallow

基本使用

以下是一个简单的示例，展示了如何定义一个 Schema 并使用它来序列化和反序列化数据：

from marshmallow import Schema, fields

# 定义一个简单的 Schema
class UserSchema(Schema):
    name = fields.Str()
    email = fields.Email()
    created_at = fields.DateTime()

# 创建一个 User 对象
user = {
    'name': 'John Doe',
    'email': 'john.doe@example.com',
    'created_at': '2023-01-01T00:00:00'
}

# 序列化数据
schema = UserSchema()
result = schema.dump(user)
print(result)  # 输出: {'name': 'John Doe', 'email': 'john.doe@example.com', 'created_at': '2023-01-01T00:00:00'}

# 反序列化数据
data = {
    'name': 'Jane Doe',
    'email': 'jane.doe@example.com',
    'created_at': '2023-01-02T00:00:00'
}
result = schema.load(data)
print(result)  # 输出: {'name': 'Jane Doe', 'email': 'jane.doe@example.com', 'created_at': datetime.datetime(2023, 1, 2, 0, 0)}

应用案例和最佳实践

数据验证

Marshmallow 提供了强大的数据验证功能。你可以在 Schema 中定义验证规则，确保输入数据符合预期格式：

from marshmallow import Schema, fields, validate

class UserSchema(Schema):
    name = fields.Str(required=True, validate=validate.Length(min=1, max=100))
    email = fields.Email(required=True)
    age = fields.Int(validate=validate.Range(min=18, max=100))

# 验证数据
data = {
    'name': 'John Doe',
    'email': 'john.doe@example.com',
    'age': 15
}

schema = UserSchema()
errors = schema.validate(data)
print(errors)  # 输出: {'age': ['Must be greater than or equal to 18.']}

嵌套对象

Marshmallow 支持嵌套对象的序列化和反序列化。你可以定义嵌套的 Schema 来处理复杂的数据结构：

class AddressSchema(Schema):
    street = fields.Str()
    city = fields.Str()
    state = fields.Str()
    zip_code = fields.Str()

class UserSchema(Schema):
    name = fields.Str()
    email = fields.Email()
    address = fields.Nested(AddressSchema)

# 嵌套对象示例
user = {
    'name': 'John Doe',
    'email': 'john.doe@example.com',
    'address': {
        'street': '123 Main St',
        'city': 'Anytown',
        'state': 'CA',
        'zip_code': '12345'
    }
}

schema = UserSchema()
result = schema.dump(user)
print(result)  # 输出: {'name': 'John Doe', 'email': 'john.doe@example.com', 'address': {'street': '123 Main St', 'city': 'Anytown', 'state': 'CA', 'zip_code': '12345'}}

典型生态项目

Marshmallow 可以与多个

marshmallowA lightweight library for converting complex objects to and from simple Python datatypes.项目地址:https://gitcode.com/gh_mirrors/ma/marshmallow