Peewee integration with the marshmallow (de)serialization library.
Project description
Marshmallow-Peewee – Peewee integration with the Marshmallow (de)serialization library.
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, errors = 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, errors = 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, errors = 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, errors = UserSchema().load(result)
assert not errors
assert isinstance(result, User)
assert isinstance(result.role, Role)Requirements
python 2.7+,3.4+
Installation
Marshmallow-Peewee should be installed using pip:
pip install Marshmallow-Peewee
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.ModelConverter
# dump_only_pk: Primary key is dump only
# dump_only_pk = TrueBug 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 Marshmallow-Peewee happens at: https://github.com/klen/marshmallow-peewee
Contributors
License
Licensed under a MIT license (See LICENSE)
If you wish to express your appreciation for the project, you are welcome to send a postcard to:
Kirill Klenov pos. Severny 8-3 MO, Istra, 143500 Russia
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-1.0.0.tar.gz.
File metadata
- Download URL: Marshmallow-Peewee-1.0.0.tar.gz
- Upload date:
- Size: 5.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2652bef74c52663ac275c3eaea4b2ab3989768b09facdeec7fed5f70c35e999f |
|
| MD5 | 5719891db7b9324e43b65dbd55e9dd77 |
|
| BLAKE2b-256 | bf204f00dbe2b3675309e8b8da96c9ba0ff09b6fbdfcf278cbad377c1a564182 |
File details
Details for the file Marshmallow_Peewee-1.0.0-py2.py3-none-any.whl.
File metadata
- Download URL: Marshmallow_Peewee-1.0.0-py2.py3-none-any.whl
- Upload date:
- Size: 7.1 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e6ea4cf5b60c507fae05bf5563bb551d72d5778e4b5d4de26563642b76d98b32 |
|
| MD5 | 1f793768002e35d4081d0ae82aa01da3 |
|
| BLAKE2b-256 | 11642575ab3d6899a2fe5fe8dd070bd607a118a25b530531bc09a0afbff01ce8 |
