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
Quick Start
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.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e0e4a200595755f9c4485223d040190ed185b9f5245d32203104b5050cceaef3 |
|
MD5 | 3f2c01b66d642854861c3e952998da66 |
|
BLAKE2b-256 | b0a4ca7a48264eb196246cd54dbd874b47819ec1a9054bf2593a1361f080f89e |
Close
Hashes for django_rest_witchcraft-0.2.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fd463c60b067a24cfd7d752fb6b7dfb0a498e7fc0c4abef040acdbde4ad78987 |
|
MD5 | 62cc7df2eabc0f0ccc934c69cc3245d9 |
|
BLAKE2b-256 | 052ec56f701ef486d0d4514149aabfb86595eccdb524b830af526148488e1e00 |