当前位置:主页 > python教程 > 详解从Django Rest Framework响应中删除空字段

从Django Rest Framework响应中删除空字段的代码方法

发布:2019-12-07 15:22:51 109


为网友们分享了Django相关的编程文章,网友杨俊远根据主题投稿了本篇教程内容,涉及到Django、Rest、Framework、删除空字段、详解从Django Rest Framework响应中删除空字段相关内容,已被872网友关注,如果对知识点想更进一步了解可以在下方电子资料中获取。

详解从Django Rest Framework响应中删除空字段

我使用django-rest-framework开发了一个API.

我正在使用ModelSerializer返回模型的数据.

models.py

class MetaTags(models.Model):
 title = models.CharField(_('Title'), max_length=255, blank=True, null=True)
 name = models.CharField(_('Name'), max_length=255, blank=True, null=True)

serializer.py

class MetaTagsSerializer(serializers.ModelSerializer):
 class Meta:
  model = MetaTags

响应

{
 "meta": {
  "title": null,
  "name": "XYZ"
 }
}

理想情况下,在API响应中,不应在响应中发送任何不存在的值.

当标题为null时,我希望响应为:

{
 "meta": {
  "name": "XYZ"
 }
}

您可以尝试覆盖to_native函数:

class MetaTagsSerializer(serializers.ModelSerializer):
 class Meta:
  model = MetaTags

 def to_native(self, obj):
  """
  Serialize objects -> primitives.
  """
  ret = self._dict_class()
  ret.fields = self._dict_class()

  for field_name, field in self.fields.items():
   if field.read_only and obj is None:
    continue
   field.initialize(parent=self, field_name=field_name)
   key = self.get_field_key(field_name)
   value = field.field_to_native(obj, field_name)

   # Continue if value is None so that it does not get serialized.
   if value is None:
    continue

   method = getattr(self, 'transform_%s' % field_name, None)
   if callable(method):
    value = method(obj, value)
   if not getattr(field, 'write_only', False):
    ret[key] = value
   ret.fields[key] = self.augment_field(field, field_name, key, value)

  return ret

我基本上从serializers.BaseSerializer复制了基本的to_native函数,并添加了一个值的检查.

更新:

至于DRF 3.0,to_native()被重命名为to_representation(),其实现稍有改变.这是DRF 3.0的代码,它忽略空值和空字符串值:

def to_representation(self, instance):
 """
 Object instance -> Dict of primitive datatypes.
 """
 ret = OrderedDict()
 fields = self._readable_fields

 for field in fields:
  try:
   attribute = field.get_attribute(instance)
  except SkipField:
   continue

  # KEY IS HERE:
  if attribute in [None, '']:
   continue

  # We skip `to_representation` for `None` values so that fields do
  # not have to explicitly deal with that case.
  #
  # For related fields with `use_pk_only_optimization` we need to
  # resolve the pk value.
  check_for_none = attribute.pk if isinstance(attribute, PKOnlyObject) else attribute
  if check_for_none is None:
   ret[field.field_name] = None
  else:
   ret[field.field_name] = field.to_representation(attribute)

 return ret

翻译自:https://stackoverflow.com/questions/27015931/remove-null-fields-from-django-rest-framework-response

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持码农之家。


参考资料

相关文章

  • Django的HttpRequest和HttpResponse对象详解

    发布:2022-12-06

    给大家整理一篇关于Django的教程,这篇文章主要介绍了Django的HttpRequest和HttpResponse对象,分享了相关代码示例,小编觉得还是挺不错的,具有一定借鉴价值,需要的朋友可以参考下


  • 深入了解Django View(视图系统)

    深入了解Django View(视图系统)

    发布:2022-06-19

    给大家整理了关于Django的教程,这篇文章主要介绍了简单了解Django View(视图系统),文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下


  • Django drf使用Django自带的用户系统的注册功能

    发布:2023-04-11

    本文主要介绍了Django drf使用Django自带的用户系统的注册功能,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧


  • django 单表操作实例详解

    发布:2022-10-20

    为网友们分享了关于django的教程,这篇文章主要介绍了django 单表操作实例详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下


  • django创建最简单HTML页面跳转方法

    发布:2022-12-02

    给网友们整理关于django的教程,今天小编就为大家分享一篇django创建最简单HTML页面跳转方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧


  • python django是什么

    python django是什么

    发布:2022-09-23

    给大家整理了关于django的教程,Django是一个开放源代码的Web应用框架,由Python写成。采用了MVT的框架模式,即模型M,视图V和模版T。它最初是被开发来用于管理劳伦斯出版集团旗下的一些以新闻内容为主的网站的,即是CMS(内


  • Django中login_required装饰器的深入介绍

    发布:2022-10-10

    给网友们整理关于Django的教程,这篇文章主要给大家介绍了关于Django中login_required装饰器的使用方法,并给大家进行了实例借鉴,利用@login_required实现Django用户登陆访问限制,文中通过示例代码介绍的非常详细,需要的朋友可


  • python+pycharm+django admin css样式问题解决方案

    python+pycharm+django admin css样式问题解决方案

    发布:2022-12-03

    给大家整理了关于python的教程,最近打算学习一下Python,基础知识有了大概的了解,想上手搞搞东西。我用的python 3.5+pycharm+django 1.11.2在使用Django,打开127.0.0.1:8000/admin时,发现admin模块css样式文件丢失,无法调用 按F12 发现


网友讨论