Peewee ORM integration with the Marshmallow (de)serialization library
Project description
Marshmallow-Peewee
Marshmallow-Peewee -- Peewee ORM integration with the Marshmallow (de)serialization library.
Requirements
- python >= 3.7
Installation
marshmallow-peewee should be installed using pip:
$ pip install marshmallow-peewee
Quickstart
import peewee as pw
class Role(pw.Model):
name = pw.CharField(255, default='user')
class User(pw.Model):
created = pw.DateTimeField(default=dt.datetime.now())
name = pw.CharField(255)
title = pw.CharField(127, null=True)
active = pw.BooleanField(default=True)
rating = pw.IntegerField(default=0)
role = pw.ForeignKeyField(Role)
from marshmallow_peewee import ModelSchema
class UserSchema(ModelSchema):
class Meta:
model = User
role = Role.create()
user = User.create(name='Mike', role=role)
result = UserSchema().dump(user)
print(result)
# {'active': True,
# 'created': '2016-03-29T15:27:18.600034+00:00',
# 'id': 1,
# 'name': 'Mike',
# 'rating': 0,
# 'role': 1,
# 'title': None}
result = UserSchema().load(result)
assert isinstance(result, User)
assert result.name == 'Mike'
from marshmallow_peewee import Related
class UserSchema(ModelSchema):
role = Related()
class Meta:
model = User
result = UserSchema().dump(user)
print(result)
# {'active': True,
# 'created': '2016-03-29T15:30:32.767483+00:00',
# 'id': 1,
# 'name': 'Mike',
# 'rating': 0,
# 'role': {'id': 5, 'name': 'user'},
# 'title': None}
result = UserSchema().load(result)
assert isinstance(result, User)
assert isinstance(result.role, Role)
Usage
import peewee as pw
class Role(pw.Model):
name = pw.CharField(255, default='user')
class User(pw.Model):
created = pw.DateTimeField(default=dt.datetime.now())
name = pw.CharField(255)
title = pw.CharField(127, null=True)
active = pw.BooleanField(default=True)
rating = pw.IntegerField(default=0)
role = pw.ForeignKeyField(Role)
from marshmallow_peewee import ModelSchema
class UserSchema(ModelSchema):
class Meta:
# model: Bind peewee.Model to the Schema
model = User
# model_converter: Use custom model_converter
# model_converter = marshmallow_peewee.DefaultConverter
# dump_only_pk: Primary key is dump only
# dump_only_pk = True
# string_keys: Convert keys to strings
# string_keys = True
# id_keys: serialize (and deserialize) ForeignKey fields with _id suffix
# id_keys = False
You may set global options for marshmallow-peewee:
from marshmallow_peewee import setup
setup(id_keys=True, string_keys=False) # Set options for all schemas
class UserSchema(ModelSchema):
# ...
Customize fields convertion:
from marshmallow_peewee import DefaultConverter
# Customize global
# Serialize boolean as string
DefaultConverter.register(peewee.BooleanField, marshmallow.fields.String)
# Alternative method
@DefaultConverter.register(peewee.BooleanField)
def build_field(field: peewee.Field, opts, **field_params):
return marshmallow.fields.String(**params)
# Customize only for a scheme
class CustomConverter(DefaultConverter):
pass
CustomConverter.register(...)
class CustomSchema(ModelSchema): # may be inherited
class Meta:
model_converter = CustomConverter
Bug tracker
If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/marshmallow-peewee/issues
Contributing
Development of the project happens at: https://github.com/klen/marshmallow-peewee
License
Licensed under a MIT License
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file marshmallow_peewee-4.2.0.tar.gz.
File metadata
- Download URL: marshmallow_peewee-4.2.0.tar.gz
- Upload date:
- Size: 7.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.1 CPython/3.10.6 Linux/5.15.0-1034-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 94feee11a01e00392b78c53fa0f57ff2596d6b4394cf6579c85ae020ad4c2af5 |
|
| MD5 | 1d07a431471be3b5d9182f23ff5026e5 |
|
| BLAKE2b-256 | 4660b67ba9b5857b69e6c64eb5e4303ef234d642f88e2ed8ebb5e0fd4e9dd5c6 |
File details
Details for the file marshmallow_peewee-4.2.0-py3-none-any.whl.
File metadata
- Download URL: marshmallow_peewee-4.2.0-py3-none-any.whl
- Upload date:
- Size: 8.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.1 CPython/3.10.6 Linux/5.15.0-1034-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0f3a9f934c1ad91a37988f46ef1ccf0fe0b42f993e63857ec56fd03d801be09c |
|
| MD5 | a22c8e9183ed32209712efd89a37bf66 |
|
| BLAKE2b-256 | e8aa01bc4b3d002c999d713fcc5991240cf95b5511998af0772e7bd5cf70e21c |
