SQLAlchemy specific things for django-rest-framework
Project description
Django REST Witchcraft
SQLAlchemy specific things for django-rest-framework
Installation
pip install django-rest-witchcraft
Example
First up, lets define some simple models:
engine = create_engine('sqlite:///:memory:', echo=True)
session = scoped_session(sessionmaker(bind=engine))
Base = declarative_base()
Base.query = session.query_property()
Base.metadata.create_all(engine)
class Group(Base):
__tablename__ = 'groups'
id = Column(Integer(), primary_key=True)
name = Column(String())
class User(Base):
__tablename__ = 'users'
id = Column(Integer(), primary_key=True)
name = Column(String())
fullname = Column(String())
password = Column(String())
_group_id = Column('group_id', Integer(), ForeignKey('groups.id'))
group = relationship(Group, backref='users')
class Address(Base):
__tablename__ = 'addresses'
id = Column(Integer(), primary_key=True)
email_addresss = Column(String(), nullable=False)
_user_id = Column(Integer(), ForeignKey('users.id'))
user = relationship(User, backref='addresses')
Nothing fancy here, we have a User class that can belong to a Group instance and has many Address instances
Second, lets define a serializer for User with all the fields:
class UserSerializer(serializers.ModelSerializer):
class Meta:
model = User
session = session
fields = '__all__'
This will create the following serializer for us:
>>> serializer = UserSerializer() >>> serializer UserSerializer(): id = IntegerField(allow_null=False, help_text=None, label='Id', required=True) name = CharField(allow_null=True, help_text=None, label='Name', max_length=None, required=False) fullname = CharField(allow_null=True, help_text=None, label='Fullname', max_length=None, required=False) password = CharField(allow_null=True, help_text=None, label='Password', max_length=None, required=False) group = GroupSerializer(is_nested=True, required=False): name = CharField(allow_null=True, help_text=None, label='Name', max_length=None, required=False) id = IntegerField(allow_null=False, help_text=None, label='Id', required=False) addresses = AddressSerializer(many=True, required=False): id = IntegerField(allow_null=False, help_text=None, label='Id', required=False) email_addresss = CharField(allow_null=False, help_text=None, label='Email_addresss', max_length=None, required=True) url = UriField(read_only=True)
This serializer can handle nested create, update or partial update operations.
Project details
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
Close
Hashes for django-rest-witchcraft-0.0.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d41e67bf16f54a1352d3fa4270fc33fa0273a2859988afd2403b70bfd154f6e7 |
|
MD5 | 08452e4398723d7daacf0c5e29701cac |
|
BLAKE2b-256 | 1ca17fdbdf8f32b2ae9d5827006f58a361ca03704540945c165a786fc41c58db |
Close
Hashes for django_rest_witchcraft-0.0.6-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e54c80ff2100f84ee8b76297ec58d42a480f8edde4f13c8620daae24592f0c8c |
|
MD5 | 25b2cce567a7351a701f76e90628a1de |
|
BLAKE2b-256 | 3b9b49e2fafbf57fa77cb10c15f535dd3211b76cf08ec877715ca7ea25875a00 |