Relations un-à-un

Pour définir une relation un-à-un, utilisez OneToOneField.

Dans cet exemple, un objet Place peut être un Restaurant dans certains cas :

from django.db import models

class Place(models.Model):
    name = models.CharField(max_length=50)
    address = models.CharField(max_length=80)

    def __str__(self):              # __unicode__ on Python 2
        return "%s the place" % self.name

class Restaurant(models.Model):
    place = models.OneToOneField(Place, primary_key=True)
    serves_hot_dogs = models.BooleanField(default=False)
    serves_pizza = models.BooleanField(default=False)

    def __str__(self):              # __unicode__ on Python 2
        return "%s the restaurant" % self.place.name

class Waiter(models.Model):
    restaurant = models.ForeignKey(Restaurant)
    name = models.CharField(max_length=50)

    def __str__(self):              # __unicode__ on Python 2
        return "%s the waiter at %s" % (self.name, self.restaurant)

Dans ce qui suit, vous trouverez des exemples d’opérations pouvant être effectuées en utilisant les possibilités de l’API Python.

Créez quelques objets Places:

>>> p1 = Place(name='Demon Dogs', address='944 W. Fullerton')
>>> p1.save()
>>> p2 = Place(name='Ace Hardware', address='1013 N. Ashland')
>>> p2.save()

Créez un Restaurant. Passez l’identifiant de l’objet « parent » comme clé primaire de cet objet :

>>> r = Restaurant(place=p1, serves_hot_dogs=True, serves_pizza=False)
>>> r.save()

Un Restaurant a accès à son objet Place:

>>> r.place
<Place: Demon Dogs the place>

Un objet Place peut accéder à son objet Restaurant, s’il existe :

>>> p1.restaurant
<Restaurant: Demon Dogs the restaurant>

p2 ne possède pas d’objet Restaurant associé :

>>> from django.core.exceptions import ObjectDoesNotExist
>>> try:
>>>     p2.restaurant
>>> except ObjectDoesNotExist:
>>>     print("There is no restaurant here.")
There is no restaurant here.

Vous pouvez aussi utiliser hasattr pour éviter de devoir intercepter une exception :

>>> hasattr(p2, 'restaurant')
False

Définissez l’objet Place en utilisant la notation d’assignation. Comme place est la clé primaire de Restaurant, l’enregistrement crée un nouvel objet Restaurant:

>>> r.place = p2
>>> r.save()
>>> p2.restaurant
<Restaurant: Ace Hardware the restaurant>
>>> r.place
<Place: Ace Hardware the place>

Redéfinissez place en utilisant l’assignation dans la direction inverse :

>>> p1.restaurant = r
>>> p1.restaurant
<Restaurant: Demon Dogs the restaurant>

Notez que vous devez enregistrer un objet avant de pouvoir l’attribuer à une relation un-à-un. Par exemple, la création d’un Restaurant avec une instance Place non enregistrée produit une erreur ValueError:

>>> p3 = Place(name='Demon Dogs', address='944 W. Fullerton')
>>> Restaurant.objects.create(place=p3, serves_hot_dogs=True, serves_pizza=False)
Traceback (most recent call last):
...
ValueError: save() prohibited to prevent data loss due to unsaved related object 'place'.

Changed in Django 1.8.4:

Précédemment, l’enregistrement d’un objet avec des objets liés non enregistrés ne produisait pas d’erreur et pouvait aboutir à des pertes de données silencieuses. Dans les versions 1.8-1.8.3, des instances de modèles non enregistrées ne pouvaient plus être attribuées à des champs de liaison, mais cette restriction a été levée pour permettre une utilisation facilitée de modèles uniquement en mémoire.

Restaurant.objects.all() renvoie uniquement les objets Restaurant, pas les objets Places. Notez qu’il y a maintenant deux restaurants, « Ace Hardware » ayant été créé lors de l’instruction r.place = p2:

>>> Restaurant.objects.all()
[<Restaurant: Demon Dogs the restaurant>, <Restaurant: Ace Hardware the restaurant>]

Place.objects.all() renvoie tous les objets Place, qu’ils aient un objet Restaurant ou non :

>>> Place.objects.order_by('name')
[<Place: Ace Hardware the place>, <Place: Demon Dogs the place>]

Vous pouvez interroger les modèles en utilisant les recherches traversant les relations:

>>> Restaurant.objects.get(place=p1)
<Restaurant: Demon Dogs the restaurant>
>>> Restaurant.objects.get(place__pk=1)
<Restaurant: Demon Dogs the restaurant>
>>> Restaurant.objects.filter(place__name__startswith="Demon")
[<Restaurant: Demon Dogs the restaurant>]
>>> Restaurant.objects.exclude(place__address__contains="Ashland")
[<Restaurant: Demon Dogs the restaurant>]

Ceci fonctionne évidemment aussi dans le sens inverse :

>>> Place.objects.get(pk=1)
<Place: Demon Dogs the place>
>>> Place.objects.get(restaurant__place=p1)
<Place: Demon Dogs the place>
>>> Place.objects.get(restaurant=r)
<Place: Demon Dogs the place>
>>> Place.objects.get(restaurant__place__name__startswith="Demon")
<Place: Demon Dogs the place>

Ajoutez un objet Waiter à un Restaurant:

>>> w = r.waiter_set.create(name='Joe')
>>> w.save()
>>> w
<Waiter: Joe the waiter at Demon Dogs the restaurant>

Interrogez les objets Waiter:

>>> Waiter.objects.filter(restaurant__place=p1)
[<Waiter: Joe the waiter at Demon Dogs the restaurant>]
>>> Waiter.objects.filter(restaurant__place__name__startswith="Demon")
[<Waiter: Joe the waiter at Demon Dogs the restaurant>]