Installation
pip install -e git+https://github.com/night-crawler/drf-metadata.git@#egg=drf-metadata
Models
class Author(models.Model):
name = models.CharField(max_length=255)
birth = models.DateField('birth date')
def __str__(self):
return self.name
class Publisher(models.Model):
name = models.CharField(max_length=255)
state = models.PositiveSmallIntegerField(
'publisher state',
choices=(
(0, 'Active'),
(1, 'Disabled')
),
default=1
)
def __str__(self):
return self.name
class Book(models.Model):
title = models.CharField(max_length=255)
authors = models.ManyToManyField(Author)
publisher = models.ForeignKey(Publisher)
Usage
from drf_metadata.meta import MetaData, AbstractField, CustomMetadata
class BookMetadata(MetaData):
model = Book
serializers = {
'publisher': PublisherSerializer
}
update_fields = {
'authors': {
'omg': {'lol': 1}
}
}
# skip serialization (don't include model instances to choice field)
dataset_urls = {
'authors': '/author/',
'publisher': '/publisher/',
}
# custom queryset for instance (self has `obj` if you need to filter qs)
def get_authors_queryset(self, field):
return Author.objects.filter(name='author0')
# use custom serializer for field instance(s)
def get_authors_serializer(self, field):
# self.request, self.view, self.obj are available in MetaData instance
return AuthorSerializer
# update field bundle with runtime values
def update_authors_field_meta(field, obj):
return {'new': 1, 'obj': str(obj)}
# use own serializer
def get_publisher_field_meta(field, obj):
return {'new': 1, 'obj': str(obj)}
Usage with django-rest-framework
# or redefine OPTIONS handler
class BookViewSet(viewsets.ReadOnlyModelViewSet):
@list_route()
def describe_book(self, request):
md = metadata.BookMetadata().determine_metadata(request, self)
return Response(md)
Sample response
{
"title": "book", "description": "description",
"fields": [
{
"type": "CharField", "max_length": 255,
"name": "title",
"verbose_name": "title",
"help_text": "", "blank": false, "null": false, "editable": true, "required": true},
{
"type": "ForeignKey",
"name": "publisher", "verbose_name": "publisher", "help_text": "",
"blank": false, "null": false, "editable": true, "required": true,
"data": [
{"id": 47, "name": "pub0"},
{"id": 48, "name": "pub1"},
{"id": 49, "name": "pub2"}
]
},
{
"type": "ManyToManyField",
"name": "authors", "verbose_name": "authors", "help_text": "",
"blank": false, "null": false, "editable": true, "required": true,
"data": [
{"id": 37, "name": "author0"},
{"id": 38, "name": "author1"},
{"id": 39, "name": "author2"}
]
}
]
}
Non-model MetaData
class ImpersonateMetadata(CustomMetadata):
title = 'View site as another user'
action_name = 'Impersonate'
fields = (
AbstractField(type='ForeignKey',
name='user_id',
verbose_name='User',
data='/data/',
required=True),
)
# method fields
def get_superfield(self, request):
return {
'name': 'hero',
'super': True
}
def get_lol(self, request):
return {
'name': 'lol',
'super': False
}
# update field `user_id`
def get_field_user_id(self, field_name, request):
return {
'lol': 1
}
Metadata
Release files for drf-metadata 0.1.12
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| drf-metadata-0.1.12.tar.gz | 10.0 kB | Without provenance | Details for drf-metadata-0.1.12.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| drf_metadata-0.1.12-py3-none-any.whl | Python 3 | none | any | Details for drf_metadata-0.1.12-py3-none-any.whl |
Total release size: 24.4 kB
Release files / drf-metadata-0.1.12.tar.gz
| Download URL | drf-metadata-0.1.12.tar.gz |
|---|---|
| Size | 10.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
dfcd4b0760972be360c012fb7fccd900026be0c752f87ba2a326d1164e62b7e9
|
|
BLAKE2b-256 checksum How to use checksums |
16b80fe7d0046fd9e6c10715ed9cdb55778fc705bd448d5820312b78cbf1c512
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / drf_metadata-0.1.12-py3-none-any.whl
| Download URL | drf_metadata-0.1.12-py3-none-any.whl |
|---|---|
| Size | 14.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c3146350e73f69046406a8049b4eb984e384a74eab6be04920a5042b29e57da3
|
|
BLAKE2b-256 checksum How to use checksums |
d65267b560912a97cb2c3cc9585d559771233fc408833fad4d3054582a994a39
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for drf-metadata 0.1.12
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.