blocks|key|1255029|text|我刚刚检查了Django+Rest+Framework的源代码。您想要的行为在框架中似乎不受支持。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1255030|fields选项必须是一个列表、一个元组或文本__all__。|offset|length|style|CODE|1255031|下面是相关源代码的片段：|1255032|++++ALL_FIELDS+=+'__all__'
++++if+fields+and+fields+!=+ALL_FIELDS+and+not+isinstance(fields,+(list,+tuple)):
++++++++raise+TypeError(
++++++++++++'The+`fields`+option+must+be+a+list+or+tuple+or+"__all__".+'
++++++++++++'Got+%25s.'+%25+type(fields).__name__
++++++++)|code-block|syntax|javascript|1255033|您不能在元组或包含字段的列表中添加“all”。|BOLD|1255034|entityMap^0|0|0|6|N|7|0|0|0|I|3|0^^$0|@$1|2|3|4|5|6|7|T|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|U|8|@$D|V|E|W|F|G]|$D|X|E|Y|F|G]]|9|@]|A|$]]|$1|H|3|I|5|6|7|Z|8|@]|9|@]|A|$]]|$1|J|3|K|5|L|7|10|8|@]|9|@]|A|$M|N]]|$1|O|3|P|5|6|7|11|8|@$D|12|E|13|F|Q]]|9|@]|A|$]]|$1|R|3|-4|5|6|7|14|8|@]|9|@]|A|$]]]|S|$]]

I just checked the source code of Django Rest Framework.
The behaviour you want seems not to be supported in the Framework.

The <code>fields</code> option must be a list, a tuple or the text <code>__all__</code>.

Here is a snippet of the relevant source code:

<pre><code> ALL_FIELDS = '__all__'
 if fields and fields != ALL_FIELDS and not isinstance(fields, (list, tuple)):
 raise TypeError(
 'The `fields` option must be a list or tuple or "__all__". '
 'Got %s.' % type(fields).__name__
 )
</code></pre>

You cannot add 'all' additionally to the tuple or list with fields...

blocks|key|2459626|text|正如@DanEEStart所说，DjangoRestFramework没有一种简单的方法将'all‘值扩展到字段，因为get_field_names方法似乎是设计以那种方式工作的。|type|unstyled|depth|inlineStyleRanges|offset|length|style|BOLD|CODE|entityRanges|data|2459627|但幸运的是，您可以重写此方法以允许一种简单的方法来包含所有字段和关系，而无需枚举大量字段。|2459628|我像这样覆盖这个方法：|2459629|class+ToppingSerializer(serializers.ModelSerializer):

++++class+Meta:
++++++++model+=+Topping
++++++++fields+=+'__all__'
++++++++extra_fields+=+['pizzas']

++++def+get_field_names(self,+declared_fields,+info):
++++++++expanded_fields+=+super(ToppingSerializer,+self).get_field_names(declared_fields,+info)

++++++++if+getattr(self.Meta,+'extra_fields',+None):
++++++++++++return+expanded_fields+%2B+self.Meta.extra_fields
++++++++else:
++++++++++++return+expanded_fields|code-block|syntax|javascript|2459630|请注意，此方法只更改此序列化程序的行为，而extra_fields属性仅适用于此序列化程序类。|2459631|如果您有大量这样的序列化程序，您可以创建一个中间类，将这个get_fields_names方法包含在一个地方，并多次重用它们。有些人是这样的：|2459632|class+CustomSerializer(serializers.HyperlinkedModelSerializer):

++++def+get_field_names(self,+declared_fields,+info):
++++++++expanded_fields+=+super(CustomSerializer,+self).get_field_names(declared_fields,+info)

++++++++if+getattr(self.Meta,+'extra_fields',+None):
++++++++++++return+expanded_fields+%2B+self.Meta.extra_fields
++++++++else:
++++++++++++return+expanded_fields


class+ToppingSerializer(CustomSerializer):

++++class+Meta:
++++++++model+=+Topping
++++++++fields+=+'__all__'
++++++++extra_fields+=+['pizzas']

class+AnotherSerializer(CustomSerializer):

++++class+Meta:
++++++++model+=+Post
++++++++fields+=+'__all__'
++++++++extra_fields+=+['comments']|2459633|entityMap|0|LINK|mutability|MUTABLE|url|https://github.com/tomchristie/django-rest-framework/blob/master/rest_framework/serializers.py#L1019^0|1A|3|1N|F|29|7|0|0|0|0|0|L|C|0|T|G|0|0^^$0|@$1|2|3|4|5|6|7|13|8|@$9|14|A|15|B|C]|$9|16|A|17|B|D]]|E|@$9|18|A|19|1|1A]]|F|$]]|$1|G|3|H|5|6|7|1B|8|@]|E|@]|F|$]]|$1|I|3|J|5|6|7|1C|8|@]|E|@]|F|$]]|$1|K|3|L|5|M|7|1D|8|@]|E|@]|F|$N|O]]|$1|P|3|Q|5|6|7|1E|8|@$9|1F|A|1G|B|D]]|E|@]|F|$]]|$1|R|3|S|5|6|7|1H|8|@$9|1I|A|1J|B|D]]|E|@]|F|$]]|$1|T|3|U|5|M|7|1K|8|@]|E|@]|F|$N|O]]|$1|V|3|-4|5|6|7|1L|8|@]|E|@]|F|$]]]|W|$X|$5|Y|Z|10|F|$11|12]]]]

Like @DanEEStart said, DjangoRestFramework don't have a simple way to extend the 'all' value for fields, because the <code>get_field_names</code> methods seems to be designed <a href="https://github.com/tomchristie/django-rest-framework/blob/master/rest_framework/serializers.py#L1019" rel="noreferrer">to work that way</a>.

But fortunately you can override this method to allow a simple way to include all fields and relations without enumerate a tons of fields.

I override this method like this:

<pre><code>class ToppingSerializer(serializers.ModelSerializer):

 class Meta:
 model = Topping
 fields = '__all__'
 extra_fields = ['pizzas']

 def get_field_names(self, declared_fields, info):
 expanded_fields = super(ToppingSerializer, self).get_field_names(declared_fields, info)

 if getattr(self.Meta, 'extra_fields', None):
 return expanded_fields + self.Meta.extra_fields
 else:
 return expanded_fields
</code></pre>

Note that this method only change the behaviour of this serializer, and the <code>extra_fields</code> attribute only works on this serializer class.

If you have a tons of serializer like this, you can create a intermediate class to include this <code>get_fields_names</code> method in one place and reuse'em many times. Some like this:

<pre><code>class CustomSerializer(serializers.HyperlinkedModelSerializer):

 def get_field_names(self, declared_fields, info):
 expanded_fields = super(CustomSerializer, self).get_field_names(declared_fields, info)

 if getattr(self.Meta, 'extra_fields', None):
 return expanded_fields + self.Meta.extra_fields
 else:
 return expanded_fields


class ToppingSerializer(CustomSerializer):

 class Meta:
 model = Topping
 fields = '__all__'
 extra_fields = ['pizzas']

class AnotherSerializer(CustomSerializer):

 class Meta:
 model = Post
 fields = '__all__'
 extra_fields = ['comments']
</code></pre>

blocks|key|2459684|text|fields="__all__"选项可以手动指定一个附加字段，如下例所示。对于这个问题，这是迄今为止最干净的解决方案。|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|2459685|嵌套关系|BOLD|2459686|http://www.django-rest-framework.org/api-guide/relations/#nested-relationships|2459687|class+TrackSerializer(serializers.ModelSerializer):
++++class+Meta:
++++++++model+=+Track
++++++++fields+=+'__all__'

class+AlbumSerializer(serializers.ModelSerializer):
++++tracks+=+TrackSerializer(many=True,+read_only=True)

++++class+Meta:
++++++++model+=+Album
++++++++fields+=+'__all__'|code-block|syntax|javascript|2459688|我假设这将适用于同一页面上列出的任何其他相关字段选项：http://www.django-rest-framework.org/api-guide/relations/#serializer-relations。|2459689|反向关系实例|2459690|class+TrackSerializer(serializers.ModelSerializer):
++++album+=+AlbumSerializer(source='album_id')

++++class+Meta:
++++++++model+=+Track
++++++++fields+=+'__all__'|2459691|注释:使用DjangRESTFramework3.6.2版本创建的，可能会更改。如果将来的任何变化破坏了上面张贴的任何例子，请添加评论。|2459692|entityMap|0|LINK|mutability|MUTABLE|url|1|http://www.django-rest-framework.org/api-guide/relations/#serializer-relations^0|0|G|0|0|4|0|0|26|0|0|0|R|26|1|0|0|6|0|0|0|X|0^^$0|@$1|2|3|4|5|6|7|16|8|@$9|17|A|18|B|C]]|D|@]|E|$]]|$1|F|3|G|5|6|7|19|8|@$9|1A|A|1B|B|H]]|D|@]|E|$]]|$1|I|3|J|5|6|7|1C|8|@]|D|@$9|1D|A|1E|1|1F]]|E|$]]|$1|K|3|L|5|M|7|1G|8|@]|D|@]|E|$N|O]]|$1|P|3|Q|5|6|7|1H|8|@]|D|@$9|1I|A|1J|1|1K]]|E|$]]|$1|R|3|S|5|6|7|1L|8|@$9|1M|A|1N|B|H]]|D|@]|E|$]]|$1|T|3|U|5|M|7|1O|8|@]|D|@]|E|$N|O]]|$1|V|3|W|5|6|7|1P|8|@$9|1Q|A|1R|B|H]]|D|@]|E|$]]|$1|X|3|-4|5|6|7|1S|8|@]|D|@]|E|$]]]|Y|$Z|$5|10|11|12|E|$13|J]]|14|$5|10|11|12|E|$13|15]]]]

The <code>fields=&quot;__all__&quot;</code> option can work by specifying an additional field manually as per the following examples. This is by far the cleanest solution around for this issue.
Nested Relationships
<a href="http://www.django-rest-framework.org/api-guide/relations/#nested-relationships" rel="noreferrer">http://www.django-rest-framework.org/api-guide/relations/#nested-relationships</a>
<pre><code>class TrackSerializer(serializers.ModelSerializer):
 class Meta:
 model = Track
 fields = '__all__'

class AlbumSerializer(serializers.ModelSerializer):
 tracks = TrackSerializer(many=True, read_only=True)

 class Meta:
 model = Album
 fields = '__all__'
</code></pre>
I would assume this would work for any of the other related field options listed on the same page: <a href="http://www.django-rest-framework.org/api-guide/relations/#serializer-relations" rel="noreferrer">http://www.django-rest-framework.org/api-guide/relations/#serializer-relations</a>
Reverse relation example
<pre><code>class TrackSerializer(serializers.ModelSerializer):
 album = AlbumSerializer(source='album_id')

 class Meta:
 model = Track
 fields = '__all__'
</code></pre>
Note: Created using Django Rest Framework version 3.6.2, subject to change. Please add a comment if any future changes break any examples posted above.

blocks|key|1255071|text|要包含序列化程序中定义的所有字段和其他字段，只需将其称为exclude+=+()|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|1255072|class+ToppingSerializer(serializers.HyperlinkedModelSerializer):
+++pizzas+=+'<>'+#the+extra+attribute+value
++++class+Meta:
++++++++model+=+Topping
++++++++exclude+=+()|code-block|syntax|javascript|1255073|这将列出带有额外参数披萨的所有字段值。|1255074|entityMap^0|S|C|0|0|0^^$0|@$1|2|3|4|5|6|7|O|8|@$9|P|A|Q|B|C]]|D|@]|E|$]]|$1|F|3|G|5|H|7|R|8|@]|D|@]|E|$I|J]]|$1|K|3|L|5|6|7|S|8|@]|D|@]|E|$]]|$1|M|3|-4|5|6|7|T|8|@]|D|@]|E|$]]]|N|$]]

to include all the fields and the other fields defined in your serializer you can just say <code>exclude = ()</code> 

<pre><code>class ToppingSerializer(serializers.HyperlinkedModelSerializer):
 pizzas = '&lt;&gt;' #the extra attribute value
 class Meta:
 model = Topping
 exclude = ()
</code></pre>

This will list all the field values with the extra argument pizzas

blocks|key|1706039|text|嗨，我可以通过使用元API实现预期的结果，这似乎是从Django+1.11开始提供的。所以在我的序列化程序中，我做到了：|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|1706040|model+=+MyModel
fields+=+[field.name+for+field+in+model._meta.fields]
fields.append('any_other_field')|code-block|syntax|javascript|1706041|在编程中，总是有很多方法可以实现同样的结果，但是上面的这个方法对我来说真的很管用。|1706042|干杯!|1706043|entityMap|0|LINK|mutability|MUTABLE|url|https://docs.djangoproject.com/en/2.0/ref/models/meta/^0|9|4|0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|U|8|@]|9|@$A|V|B|W|1|X]]|C|$]]|$1|D|3|E|5|F|7|Y|8|@]|9|@]|C|$G|H]]|$1|I|3|J|5|6|7|Z|8|@]|9|@]|C|$]]|$1|K|3|L|5|6|7|10|8|@]|9|@]|C|$]]|$1|M|3|-4|5|6|7|11|8|@]|9|@]|C|$]]]|N|$O|$5|P|Q|R|C|$S|T]]]]

Hi I could achieve the expected result by using <a href="https://docs.djangoproject.com/en/2.0/ref/models/meta/" rel="noreferrer">Django's _meta API</a> , which seems to be available since Django 1.11. So in my serializer I did:

<pre><code>model = MyModel
fields = [field.name for field in model._meta.fields]
fields.append('any_other_field')
</code></pre>

In programming there's always many ways to achieve the same result, but this one above, has really worked for me.

Cheers!

blocks|key|1706057|text|我就是这样做的，更容易|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1706058|class+OperativeForm(forms.ModelForm):
++++class+Meta:
++++++++model+=+Operative
++++++++fields+=+'__all__'
++++++++exclude+=+('name','objective',)
++++++++widgets+=+{'__all__':'required'}|code-block|syntax|javascript|1706059|entityMap^0|0|0^^$0|@$1|2|3|4|5|6|7|I|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|J|8|@]|9|@]|A|$E|F]]|$1|G|3|-4|5|6|7|K|8|@]|9|@]|A|$]]]|H|$]]

This is how i did it, much more easier

<pre class="lang-py prettyprint-override"><code>class OperativeForm(forms.ModelForm):
 class Meta:
 model = Operative
 fields = '__all__'
 exclude = ('name','objective',)
 widgets = {'__all__':'required'}
</code></pre>

blocks|key|2459827|text|如果您基本上只是在序列化对象中添加额外的信息，则根本不需要更改字段部分。若要添加字段，请执行以下操作：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|2459828|class+MySerializer(serializers.ModelSerializer):
+++...
+++new_field+=+serializers.SerializerMethodField('new_field_method')

+++def+new_field_method(self,+modelPointer_):
++++++return+"MY+VALUE"|code-block|syntax|javascript|2459829|那么你还可以用|2459830|class+Meta:
+++fields+=+'__all__'|2459831|entityMap^0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|M|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|N|8|@]|9|@]|A|$E|F]]|$1|G|3|H|5|6|7|O|8|@]|9|@]|A|$]]|$1|I|3|J|5|D|7|P|8|@]|9|@]|A|$E|F]]|$1|K|3|-4|5|6|7|Q|8|@]|9|@]|A|$]]]|L|$]]

If you are trying to basically just add extra piece of information into the serialized object, you don't need to change the fields part at all. To add a field you do:

<pre><code>class MySerializer(serializers.ModelSerializer):
 ...
 new_field = serializers.SerializerMethodField('new_field_method')

 def new_field_method(self, modelPointer_):
 return "MY VALUE"
</code></pre>

Then you can still use 

<pre><code>class Meta:
 fields = '__all__'
</code></pre>

blocks|key|2459833|text|建立在@Wand的精彩答案之上：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|2459834|def+build_fields(mdl,extra=[],exclude=[]):
++++fields+=+[field.name+for+field+in+mdl._meta.fields+if+field.name+not+in+exclude]
++++fields+%2B=+extra
++++return+fields|code-block|syntax|javascript|2459835|用法：|2459836|model+=+User
fields+=+build_fields(model,+['snippets'],+['password'])|2459837|将返回用户模型中的所有字段，并带有相关的字段段，而不带密码字段。|2459838|entityMap^0|0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|O|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|P|8|@]|9|@]|A|$E|F]]|$1|G|3|H|5|6|7|Q|8|@]|9|@]|A|$]]|$1|I|3|J|5|D|7|R|8|@]|9|@]|A|$E|F]]|$1|K|3|L|5|6|7|S|8|@]|9|@]|A|$]]|$1|M|3|-4|5|6|7|T|8|@]|9|@]|A|$]]]|N|$]]

Building on top of @Wand's wonderful answer:
<pre><code>def build_fields(mdl,extra=[],exclude=[]):
 fields = [field.name for field in mdl._meta.fields if field.name not in exclude]
 fields += extra
 return fields
</code></pre>
Usage:
<pre><code>model = User
fields = build_fields(model, ['snippets'], ['password'])
</code></pre>
Will return all fields from the User model, with the related field snippets, without the password field.

I have two models, one with M2M relation and a related name. I want to include all fields in the serializer and the related field.

models.py:

<pre><code>class Pizza(models.Model):
 name = models.CharField(max_length=50, unique=True)
 toppings = models.ManyToManyField(Topping, null=True, blank=True, related_name='pizzas')

class Topping(models.Model):
 name = models.CharField(max_length=50, unique=True)
 price = models.IntegerField(default=0)
</code></pre>

serializer.py:

<pre><code>class ToppingSerializer(serializers.ModelSerializer):
 class Meta:
 model = Topping
 fields = '__all__' 
</code></pre>

This works but it doesn't include the related field.

<pre><code> fields = ['name', 'price', 'pizzas'] 
</code></pre>

This works exactly as I want, but what happens when Toppings model has a lot of fields. I want to do something like :

<pre><code>fields = ['__all__', 'pizzas']
</code></pre>

This syntax results in an error saying:

<blockquote>
 Field name <code>__all__</code> is not valid for model
</blockquote>

Is there a way to achieve the wanted behavior? Or the fields must be typed manually when using a related name ?

Django Rest framework, how to include '__all__' fields and a related field in ModelSerializer ?

翻译质量差，导致语言生硬或混乱。

没有提供实际的解决方法或示例。

解答不清晰，无法理解或解决问题。

页面排版不美观，阅读体验差。

文章

问答

视频

学习中心

腾讯云实验室

直播

竞赛

腾讯云代码分析专区

腾讯iOA零信任安全管理系统专区

腾讯云架构师技术同盟交流圈

腾讯云数据库专区

腾讯云顾问专区

腾讯云原生专区

腾讯混元专区

腾讯云TCE专区

腾讯云Lighthouse专区

腾讯云HAI专区

腾讯云Edgeone专区

腾讯云存储专区

腾讯云智能专区

腾讯轻联专区 

腾讯云开发专区

TAPD专区

腾讯轻量云游戏服专区

腾讯云最具价值专家

腾讯云架构师技术同盟

腾讯云创作之星

腾讯云开发者先锋

腾讯云代码助手

云原生构建

TAPD 敏捷项目管理

Cloud Studio

SDK中心

API中心

命令行工具

涵盖代码开发、场景应用、自动测试全流程，助你从零构建专属AI助手

一站式MCP教程库，解锁AI应用新玩法

我有两个模型，一个有M2M关系和一个相关的名称。我希望在序列化程序和相关字段中包括所有字段。models.py：class Pizza(models.Model):    name = models.CharField(max_length=50, unique=True)    toppings = models.M...

问Django Rest框架，如何在ModelSerializer中包含“ModelSerializer”字段和相关字段？
EN

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问Django Rest框架，如何在ModelSerializer中包含“ModelSerializer”字段和相关字段？EN