(How) Can I declare how a field type is to be de-/serialized by Django REST framework?
I'm using a custom field type in a Django project that is based on django.db.models.IntegerField and this type is used for various fields in a model. It is used to store the data as integer in a database while it has a more complex related Python type and string representation. It also implements the methods value_to_string and to_python that are respected when using ./manage.py dumpdata for example.
I also exposed a REST API with DRF where a very generic serializer based on rest_framework.serializers.HyperlinkedModelSerializer with fields configured as __all__ in its Meta object is employed.
When accessing that API a TypeError is thrown in rest_framework.fields.IntegerField.to_representation when it tries to mangle the aforementioned Python type through int.
Now, given that there are de-/serialization routines implemented for that type in question, it's easy to implement a field type (in the DRF meaning, as replacement for the previously mentioned class). But how would I setup a mapping between this field type and the Django ORM's one only once without declaring the (DRF) field type for each affected field? I can't find any hint on that in the serializer fields docs nor in the rest_framework.fields module.
django-rest-framework
asked Nov 20 at 17:37
funky-future
1,30711529
add a comment |
I'm using a custom field type in a Django project that is based on django.db.models.IntegerField and this type is used for various fields in a model. It is used to store the data as integer in a database while it has a more complex related Python type and string representation. It also implements the methods value_to_string and to_python that are respected when using ./manage.py dumpdata for example.
I also exposed a REST API with DRF where a very generic serializer based on rest_framework.serializers.HyperlinkedModelSerializer with fields configured as __all__ in its Meta object is employed.
When accessing that API a TypeError is thrown in rest_framework.fields.IntegerField.to_representation when it tries to mangle the aforementioned Python type through int.
Now, given that there are de-/serialization routines implemented for that type in question, it's easy to implement a field type (in the DRF meaning, as replacement for the previously mentioned class). But how would I setup a mapping between this field type and the Django ORM's one only once without declaring the (DRF) field type for each affected field? I can't find any hint on that in the serializer fields docs nor in the rest_framework.fields module.
django-rest-framework
asked Nov 20 at 17:37
funky-future
1,30711529
add a comment |
I'm using a custom field type in a Django project that is based on django.db.models.IntegerField and this type is used for various fields in a model. It is used to store the data as integer in a database while it has a more complex related Python type and string representation. It also implements the methods value_to_string and to_python that are respected when using ./manage.py dumpdata for example.
I also exposed a REST API with DRF where a very generic serializer based on rest_framework.serializers.HyperlinkedModelSerializer with fields configured as __all__ in its Meta object is employed.
When accessing that API a TypeError is thrown in rest_framework.fields.IntegerField.to_representation when it tries to mangle the aforementioned Python type through int.
Now, given that there are de-/serialization routines implemented for that type in question, it's easy to implement a field type (in the DRF meaning, as replacement for the previously mentioned class). But how would I setup a mapping between this field type and the Django ORM's one only once without declaring the (DRF) field type for each affected field? I can't find any hint on that in the serializer fields docs nor in the rest_framework.fields module.
django-rest-framework
asked Nov 20 at 17:37
funky-future
1,30711529
I'm using a custom field type in a Django project that is based on django.db.models.IntegerField and this type is used for various fields in a model. It is used to store the data as integer in a database while it has a more complex related Python type and string representation. It also implements the methods value_to_string and to_python that are respected when using ./manage.py dumpdata for example.
I also exposed a REST API with DRF where a very generic serializer based on rest_framework.serializers.HyperlinkedModelSerializer with fields configured as __all__ in its Meta object is employed.
When accessing that API a TypeError is thrown in rest_framework.fields.IntegerField.to_representation when it tries to mangle the aforementioned Python type through int.
Now, given that there are de-/serialization routines implemented for that type in question, it's easy to implement a field type (in the DRF meaning, as replacement for the previously mentioned class). But how would I setup a mapping between this field type and the Django ORM's one only once without declaring the (DRF) field type for each affected field? I can't find any hint on that in the serializer fields docs nor in the rest_framework.fields module.
django-rest-framework
django-rest-framework
asked Nov 20 at 17:37
funky-future
1,30711529
asked Nov 20 at 17:37
funky-future
1,30711529
asked Nov 20 at 17:37
funky-future
1,30711529
asked Nov 20 at 17:37
funky-future
1,30711529
asked Nov 20 at 17:37
funky-future
1,30711529
1,30711529
add a comment |
add a comment |
1 Answer
1
active
oldest
votes
You need to create a custom serializer field that corresponds to your model field, and then add that to the mapping that DRF uses for ModelSerializers.
This is how DRF adds the django.contrib.postgres.fields.* mappings as well.
- Creating Custom Serializer Fields
- DRF adding the postgres fields
Something like this:
class MyField(models.IntegerField):
pass
class MyDrfField(Field):
def to_internal_value(...)
def to_representation(...)
ModelSerializer.serializer_field_mapping[MyField] = MyDrfField
answered Nov 22 at 3:35
Andrew Backer
4,73123358
add a comment |
Your Answer
StackExchange.ifUsing("editor", function () {
StackExchange.using("externalEditor", function () {
StackExchange.using("snippets", function () {
StackExchange.snippets.init();
});
});
}, "code-snippets");
StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "1"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);
StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});
function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: true,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: 10,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});
}
});
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53398535%2fhow-can-i-declare-how-a-field-type-is-to-be-de-serialized-by-django-rest-fram%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
1 Answer
1
active
oldest
votes
1 Answer
1
active
oldest
votes
active
oldest
votes
active
oldest
votes
You need to create a custom serializer field that corresponds to your model field, and then add that to the mapping that DRF uses for ModelSerializers.
This is how DRF adds the django.contrib.postgres.fields.* mappings as well.
- Creating Custom Serializer Fields
- DRF adding the postgres fields
Something like this:
class MyField(models.IntegerField):
pass
class MyDrfField(Field):
def to_internal_value(...)
def to_representation(...)
ModelSerializer.serializer_field_mapping[MyField] = MyDrfField
answered Nov 22 at 3:35
Andrew Backer
4,73123358
add a comment |
You need to create a custom serializer field that corresponds to your model field, and then add that to the mapping that DRF uses for ModelSerializers.
This is how DRF adds the django.contrib.postgres.fields.* mappings as well.
- Creating Custom Serializer Fields
- DRF adding the postgres fields
Something like this:
class MyField(models.IntegerField):
pass
class MyDrfField(Field):
def to_internal_value(...)
def to_representation(...)
ModelSerializer.serializer_field_mapping[MyField] = MyDrfField
answered Nov 22 at 3:35
Andrew Backer
4,73123358
add a comment |
You need to create a custom serializer field that corresponds to your model field, and then add that to the mapping that DRF uses for ModelSerializers.
This is how DRF adds the django.contrib.postgres.fields.* mappings as well.
- Creating Custom Serializer Fields
- DRF adding the postgres fields
Something like this:
class MyField(models.IntegerField):
pass
class MyDrfField(Field):
def to_internal_value(...)
def to_representation(...)
ModelSerializer.serializer_field_mapping[MyField] = MyDrfField
answered Nov 22 at 3:35
Andrew Backer
4,73123358
You need to create a custom serializer field that corresponds to your model field, and then add that to the mapping that DRF uses for ModelSerializers.
This is how DRF adds the django.contrib.postgres.fields.* mappings as well.
- Creating Custom Serializer Fields
- DRF adding the postgres fields
Something like this:
class MyField(models.IntegerField):
pass
class MyDrfField(Field):
def to_internal_value(...)
def to_representation(...)
ModelSerializer.serializer_field_mapping[MyField] = MyDrfField
answered Nov 22 at 3:35
Andrew Backer
4,73123358
edited Nov 23 at 4:40
answered Nov 22 at 3:35
Andrew Backer
4,73123358
answered Nov 22 at 3:35
Andrew Backer
4,73123358
answered Nov 22 at 3:35
Andrew Backer
4,73123358
4,73123358
add a comment |
add a comment |
Thanks for contributing an answer to Stack Overflow!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Some of your past answers have not been well-received, and you're in danger of being blocked from answering.
Please pay close attention to the following guidance:
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53398535%2fhow-can-i-declare-how-a-field-type-is-to-be-de-serialized-by-django-rest-fram%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
