Django Piston:如何从处理程序结果中排除嵌套字段?它甚至可能吗?

时间:2010-02-07 00:26:09

标签: python django django-models django-piston

我正在对我使用django-piston为Django应用程序编写的API进行最后润色。 API能够按请求或IP地址进行搜索,分别是RequestIPAddress个实例。每个请求都可以包含1个或多个与之关联的IPAddress

因此,例如,我有一个API调用,它将显示与活动状态“活动”,“非活动”或“全部”(对于任何一个)匹配的所有IPAddress个对象。每个Request实例所关联的IPAddress均可用IPAddress.request

我遇到的问题是Request.inputter是配置请求的人的User实例的外键。从我为此API调用创建的处理程序返回结果时,将显示User实例中的所有字段,包括password

这很糟糕;我不想要这个。

所以这是我的经纪人:

class SearchByIPStatusHandler(BaseHandler):
    model = IPAddress
    allowed_methods = ('GET',)
    anonymous = AnonymousIPHandler

    def read(self, request, status):
        """
        Returns IP addresses based on activity status.  
        Status: 'active', 'inactive', 'all'

        """
        if status == 'all':
            return self.model.objects.all()
        else:
            active = True if (status=='active') else False
            return self.model.objects.filter(active=active)

以下是/api/show/all/的结果示例:

<response>
  <resource>
    <updated>2010-02-05 17:08:53.651729</updated>
    <expires>2010-02-12 17:08:23</expires>
    <created>2010-02-05 17:08:53.625318</created>
    <nexthop>255.255.255.255</nexthop>
    <netmask>255.255.255.254</netmask>
    <address>2.4.6.80/31</address>
    <active>True</active>
    <id>4</id>
    <request>
      <updated>2010-02-05 17:08:53.382381</updated>
      <created>2010-02-05 17:08:53.382313</created>
      <expires>2010-02-12 17:08:23</expires>
      <incident>20100212-badthings-01</incident>
      <reason>bad things happened</reason>
      <inputter>
        <username>jathan</username>
        <first_name>Jathan</first_name>
        <last_name>McCollum</last_name>
        <is_active>True</is_active>
        <email>email@fake.notreal</email>
        <is_superuser>True</is_superuser>
        <is_staff>True</is_staff>
        <last_login>2010-02-05 18:55:51.877746</last_login>
        <password>[ENCRYPTED STRING I REDACTED]</password>
        <id>1</id>
        <date_joined>2010-01-28 09:56:32</date_joined>
      </inputter>
      <requester>joeuser</requester>
      <active>True</active>
    </request>
  </resource>
</response>

我真正想要的结果是inputter.username,而不是所有其他的东西。我已尝试在处理程序上实现exclude属性的各种迭代无济于事。如果我只是跳过整个请求字段,那就可以了,就像这样:

在处理程序中:

exclude = ('request', )

结果是:

<response>
  <resource>
    <updated>2010-02-05 17:08:53.651729</updated>
    <expires>2010-02-12 17:08:23</expires>
    <created>2010-02-05 17:08:53.625318</created>
    <nexthop>255.255.255.255</nexthop>
    <netmask>255.255.255.254</netmask>
    <address>2.4.6.80/31</address>
    <active>True</active>
    <id>4</id>
  </resource>
</response>

但这些结果也不是我想要的。

所以,最后,我的问题:

如何从处理程序结果中排除嵌套字段?它甚至可能吗?

我尝试了以下各种迭代,所有迭代都没有结果或意外结果:

# try to exclude request.inputter
exclude = ( ('request', ('inputter', ), ) )

# try to exclude request.inputter.password
exclude = ( ('request', ('inputter', ('password', ) ) ) ) 

我认为我误解或误用了在这种情况下完成字段排除的方式,所以对此主题的任何启示都非常感激。

2 个答案:

答案 0 :(得分:3)

您可以尝试使用include而不是exclude吗? E.g。

include = (('request', ('inputter', ('username', 'therestofthefields'))))

我不记得我是否将exclude写成与include一样多才多艺。

此外,django-piston Google小组是我们讨论大多数事情的地方,你可能会在那里提出更多问题。

答案 1 :(得分:3)

您可以通过处理程序的fields =子句指定所需的字段来获得所需的结果。

来自外键的模型字段可以这样指定:

('foreign_model_field', ('nested_field1', 'nested_field2'))

在您的情况下,以下内容应该有效(为简洁起见,您的某些字段已被遗漏):

fields = ('updated', 'expires', 'created', 
    ('request', ('incident', 'reason', ('inputter', ('username',)))))