Django: Dapatkan sebuah objek dari DB, atau 'Tidak Ada' jika tidak ada yang cocok

Apakah ada fungsi Django yang akan membiarkan saya mendapatkan objek dari database, atau None jika tidak ada yang cocok?

Saat ini saya menggunakan sesuatu seperti:

foo = Foo.objects.filter(bar=baz)
foo = len(foo) > 0 and foo.get() or None

Tapi itu tidak terlalu jelas, dan berantakan untuk dimiliki di mana-mana.

Dalam Django 1.6 Anda dapat menggunakan first()metode Queryset. Ini mengembalikan objek pertama yang cocok dengan queryset, atau None jika tidak ada objek yang cocok.

Pemakaian:

p = Article.objects.order_by('title', 'pub_date').first()

Ada dua cara untuk melakukan ini;

try:
    foo = Foo.objects.get(bar=baz)
except model.DoesNotExist:
    foo = None

Atau Anda bisa menggunakan pembungkus:

def get_or_none(model, *args, **kwargs):
    try:
        return model.objects.get(*args, **kwargs)
    except model.DoesNotExist:
        return None

Sebut saja seperti ini

foo = get_or_none(Foo, baz=bar)

Untuk menambahkan beberapa kode contoh ke jawaban sorki (saya akan menambahkan ini sebagai komentar, tetapi ini adalah posting pertama saya, dan saya tidak memiliki cukup reputasi untuk meninggalkan komentar), saya menerapkan manajer kustom get_or_none seperti ini:

from django.db import models

class GetOrNoneManager(models.Manager):
    """Adds get_or_none method to objects
    """
    def get_or_none(self, **kwargs):
        try:
            return self.get(**kwargs)
        except self.model.DoesNotExist:
            return None

class Person(models.Model):
    name = models.CharField(max_length=255)
    objects = GetOrNoneManager()

Dan sekarang saya bisa melakukan ini:

bob_or_none = Person.objects.get_or_none(name='Bob')

Anda juga dapat mencoba menggunakan django mengganggu (ini memiliki fungsi lain yang berguna!)

instal dengan:

pip install django-annoying

from annoying.functions import get_object_or_None
get_object_or_None(Foo, bar=baz)

Berikan Foo manajer kustomnya . Ini cukup mudah - cukup letakkan kode Anda ke dalam fungsi di pengelola khusus, setel pengelola khusus dalam model Anda dan panggil dengan Foo.objects.your_new_func(...).

Jika Anda memerlukan fungsi generik (untuk menggunakannya pada model apa pun tidak hanya dengan custom manager) tulis sendiri dan letakkan di suatu tempat di jalur python Anda dan impor, tidak berantakan lagi.

Baik melakukannya melalui manajer atau fungsi generik, Anda mungkin juga ingin menangkap 'MultipleObjectsReturned' dalam pernyataan TRY, karena fungsi get () akan menaikkannya jika kwarg Anda mengambil lebih dari satu objek.

Membangun dari fungsi generik:

def get_unique_or_none(model, *args, **kwargs):
    try:
        return model.objects.get(*args, **kwargs)
    except (model.DoesNotExist, model.MultipleObjectsReturned), err:
        return None

dan di manajer:

class GetUniqueOrNoneManager(models.Manager):
    """Adds get_unique_or_none method to objects
    """
    def get_unique_or_none(self, *args, **kwargs):
        try:
            return self.get(*args, **kwargs)
        except (self.model.DoesNotExist, self.model.MultipleObjectsReturned), err:
            return None

Berikut adalah variasi pada fungsi helper yang memungkinkan Anda untuk meneruskan sebuah QuerySetinstance secara opsional , jika Anda ingin mendapatkan objek unik (jika ada) dari queryset selain allqueryset objek model (misalnya dari subset item anak milik a contoh induk):

def get_unique_or_none(model, queryset=None, *args, **kwargs):
    """
        Performs the query on the specified `queryset`
        (defaulting to the `all` queryset of the `model`'s default manager)
        and returns the unique object matching the given
        keyword arguments.  Returns `None` if no match is found.
        Throws a `model.MultipleObjectsReturned` exception
        if more than one match is found.
    """
    if queryset is None:
        queryset = model.objects.all()
    try:
        return queryset.get(*args, **kwargs)
    except model.DoesNotExist:
        return None

Ini dapat digunakan dengan dua cara, misalnya:

1. obj = get_unique_or_none(Model, *args, **kwargs) seperti yang telah dibahas sebelumnya
2. obj = get_unique_or_none(Model, parent.children, *args, **kwargs)

Saya pikir dalam banyak kasus Anda hanya dapat menggunakan:

foo, created = Foo.objects.get_or_create(bar=baz)

Hanya jika tidak penting bahwa entri baru akan ditambahkan dalam tabel Foo (kolom lain akan memiliki nilai Tidak Ada / default)