有没有办法检查相关对象是否已经被获取?

bas*_*kum 3 python django django-queryset django-select-related

我希望能够使用select_related或检查是否已获取相关对象prefetch_related,以便可以相应地序列化数据。这是一个例子:

class Address(models.Model):
    street = models.CharField(max_length=100)
    zip = models.CharField(max_length=10)

class Person(models.Model):
    name = models.CharField(max_length=20)
    address = models.ForeignKey(Address)

def serialize_address(address):
    return {
        "id": address.id,
        "street": address.street,
        "zip": address.zip
    }

def serialize_person(person):
    result = {
        "id": person.id,
        "name": person.name
    }
    if is_fetched(person.address):
        result["address"] = serialize_address(person.address)
    else:
        result["address"] = None

######

person_a = Person.objects.select_related("address").get(id=1)
person_b = Person.objects.get(id=2)

serialize_person(person_a) #should be object with id, name and address
serialize_person(person_b) #should be object with only id and name
Run Code Online (Sandbox Code Playgroud)

在此示例中,该功能is_fetched正是我要寻找的。我想确定person对象是否已经具有解析地址,并且只有在具有解析地址的情况下,也应该对其进行序列化。但是,如果没有,则不应再执行任何数据库查询。

那么有没有办法在Django中实现呢?

vis*_*ell 12

Django 2.0 开始,您可以通过以下方式轻松检查所有获取的关系:

obj._state.fields_cache
Run Code Online (Sandbox Code Playgroud)

ModelStateFieldsCacheDescriptor 负责存储您的缓存关系。

>>> Person.objects.first()._state.fields_cache
{}
>>> Person.objects.select_related('address').first()._state.fields_cache
{'address': <Address: Your Address>}
Run Code Online (Sandbox Code Playgroud)

  • 感谢您的回答,我创建了一个 Django 票证来查看此属性是否应被视为公共或私有(https://code.djangoproject.com/ticket/31803) (2认同)

Dan*_*man 8

如果address已获取该关系,则Person对象将具有一个称为的填充属性_address_cache。您可以检查一下。

def is_fetched(obj, relation_name):
    cache_name = '_{}_cache'.format(relation_name)
    return getattr(obj, cache_name, False)
Run Code Online (Sandbox Code Playgroud)

注意,您需要使用对象和关系名称来调用它:

is_fetched(person, 'address')
Run Code Online (Sandbox Code Playgroud)

因为这样做person.address会立即触发提取。

编辑反向关系或多对多关系只能通过prefetch_related; 获取。填充单个属性,_prefetched_objects_cache这是列表的字典,其中键是相关模型的名称。例如,如果您这样做:

addresses = Address.objects.prefetch_related('person_set')
Run Code Online (Sandbox Code Playgroud)

那么其中的每个项目addresses都会有一个_prefetched_objects_cache包含"person'密钥的字典。

注意,这两个都是单下划线属性,这意味着它们是私有API的一部分;您可以自由使用它们,但Django也可以在将来的版本中自由更改它们。


Ste*_* D. 6

根据上面 @jaap3 的评论中链接的票证上的评论,对于Django 3+ (也许 2+?)执行此操作的推荐方法是在模型字段上使用未记录的is_cached方法,该方法来自此内部 mixin

>>> person1 = Person.objects.first()
>>> Person.address.is_cached(person1)
False

>>> person2 = Person.objects.select_related('address').last()
>>> Person.address.is_cached(person2)
True
Run Code Online (Sandbox Code Playgroud)