Modele

Model to pojedyncze, pełne źródło danych o twoich danych. Zawiera podstawowe pola i zachowania danych, które przechowujesz. Zazwyczaj każdy model odpowiada jednej tabeli w bazie danych.

Podstawy:

  • Każdy model to klasa Pythona, która dziedziczy po django.db.models.Model.
  • Każdy atrybut modelu reprezentuje pole w tabeli.
  • Z tymi rzeczami Django daje ci automatycznie wygenerowane API dostępu do bazy danych; patrz Making queries.

Szybki przykład

Ten przykładowy model definiuję klasę Person, która ma first_name i last_name:

from django.db import models

class Person(models.Model):
    first_name = models.CharField(max_length=30)
    last_name = models.CharField(max_length=30)

first_name i last_name są polami modelu. Każde pole jest podane jako atrybut klasy a każdemu atrybutowi odpowiada kolumna w bazie danych.

Powyższy model Person stworzyłby taką tabelę w bazie danych:

CREATE TABLE myapp_person (
    "id" serial NOT NULL PRIMARY KEY,
    "first_name" varchar(30) NOT NULL,
    "last_name" varchar(30) NOT NULL
);

Kilka technicznych uwag:

  • Nazwa tabeli w sposób automatyczny pochodzi od meta-danych modelu, ale może zostać nadpisana. Więcej szczegółów w artykule Table names.
  • Pole id jest dodawane automatycznie, ale to zachowanie może zostać nadpisane. Patrz Automatyczne pola klucza głównego.
  • SQL CREATE TABLE w tym przykładzie jest sformatowany przy użyciu składni PostgreSQL, ale warto zauważyć, że Django używa SQL-a dostosowanego do backendu bazy danych podanego w twoim pliku ustawień.

Używanie modeli

Kiedy zdefiniowałeś już swoje modele, musisz powiedzieć Django, że chcesz ich użyć. Zrób to edytując swój plik ustawień i dodając do ustawienia INSTALLED_APPS nazwę modułu, który zawiera twoje models.py.

Na przykład jeśli moduły dla twojej aplikacji żyją w module myapp.models (struktura pakietu, która jest stworzona dla aplikacji przez skrypt manage.py startapp), częściowo INSTALLED_APPS powinno wyglądać tak:

INSTALLED_APPS = [
    #...
    'myapp',
    #...
]

Gdy dodajesz nowe aplikacje do INSTALLED_APPS, nie zapomnij uruchomić manage.py migrate, opcjonalnie robiąc wcześniej dla nich migracje przy użyciu manage.py makemigrations.

Pola

Najważniejszą częścią modelu – i jedyną wymaganą jego częścią – jest lista pól w bazie danych, które określa. Pola są określone przez atrybuty klasowe. Uważaj, aby nie wybrać nazw pól, które są w konflikcie z API modeli takich jak clean, save lub delete.

Przykład:

from django.db import models

class Musician(models.Model):
    first_name = models.CharField(max_length=50)
    last_name = models.CharField(max_length=50)
    instrument = models.CharField(max_length=100)

class Album(models.Model):
    artist = models.ForeignKey(Musician, on_delete=models.CASCADE)
    name = models.CharField(max_length=100)
    release_date = models.DateField()
    num_stars = models.IntegerField()

Typy pól

Każde pole twojego modelu powinno być instancją odpowiedniej klasy Field. Django używa typów klas pól, aby określić kilka rzeczy:

  • Rodzaj kolumny, który mówi bazie danych jaki rodzaj danych ma przechowywać (na przykład INTEGER, VARCHAR, TEXT).
  • Domyślny HTML-owy widżet używany przy renderowaniu pola formularza (na przykład <input type="text">, <select>).
  • Minimalne wymagania walidacji, używane w panelu administracyjnym Django i w automatycznie generowanych formularzach.

W Django są tuziny wbudowanych typów pól; pełną ich listę możesz znaleźć w dokumentacji pól modeli. W prosty sposób możesz dopisać swoje własne pola, jeśli te domyślne Django nie wystarczają; patrz Writing custom model fields.

Opcje pól

Każde pole przyjmuje określony zestaw argumentów właściwych dla pola (udokumentowanych w dokumentacji pól modeli). Na przykład CharField (i jego podklasy) wymagają podania argumentu max_length, który określa rozmiar pola VARCHAR w bazie danych używanego do przechowywania danych.

Jest też zestaw wspólnych argumentów dostępnych dla wszystkich typów pól. Wszystkie są opcjonalne. Są w pełni objaśnione w dokumentacji, ale tu umieszczamy szybkie podsumowanie najczęściej używanych:

null
Jeśli ma wartość True, Django będzie przechowywał puste wartości jako NULL w bazie danych. Domyślnie ma wartość False.
blank

Jeśli ma wartość True, pole może być puste. Domyślnie ma wartość False.

Zwróć uwagę, że to co innego niż null. null jest związany czysto z bazą danych, podczas gdy blank jest związany z walidacją. Jeśli pole ma blank=True, walidacja formularza pozwoli na wpis z pustą wartością. Jeśli pole ma blank=False, pole będzie wymagane.

choices

Typ iterowalny (na przykład lista lub krotka) 2-krotek do użycia jako lista wyborów dla tego pola. Jeśli jest podany, domyślnym widżetem pola formularza będzie select box zamiast standardowego pola tekstowego i będzie ograniczał wybory do podanych opcji.

Lista wyborów wygląda w ten sposób:

YEAR_IN_SCHOOL_CHOICES = (
    ('FR', 'Freshman'),
    ('SO', 'Sophomore'),
    ('JR', 'Junior'),
    ('SR', 'Senior'),
    ('GR', 'Graduate'),
)

Pierwszy element każdej krotki jest wartością, która będzie przechowywana w bazie danych. Drugi element jest wyświetlany przez widżet formularza pola.

Mając instancję modelu, dostęp do wartości wyświetlanej z choices można uzyskać korzystając z metody get_FOO_display(). Na przykład:

from django.db import models

class Person(models.Model):
    SHIRT_SIZES = (
        ('S', 'Small'),
        ('M', 'Medium'),
        ('L', 'Large'),
    )
    name = models.CharField(max_length=60)
    shirt_size = models.CharField(max_length=1, choices=SHIRT_SIZES)

>>> p = Person(name="Fred Flintstone", shirt_size="L")
>>> p.save()
>>> p.shirt_size
'L'
>>> p.get_shirt_size_display()
'Large'
default
Domyślna wartość dla pola. Może to być wartość lub obiekt wywoływalny. Jeśli to obiekt wywoływalny, będzie wywoływany za każdym razem, gdy tworzony będzie nowy obiekt.
help_text
Dodatkowe pole „pomocy” do wyświetlenia przy widżecie formularza. Jest pomocne jako dokumentacja nawet jeśli twoje pole nie jest używane w formularzu.
primary_key

Jeśli ma wartość True, to pole jest kluczem głównym dla modelu.

Jeśli nie podasz primary_key=True dla żadnego pola w swoim modelu, Django automatycznie doda IntegerField do trzymania klucza głównego, więc nie musisz ustawiać primary_key=True na żadnym ze swoich pól, jeśli nie chcesz nadpisać domyślnego zachowania dla klucza głównego. Po więcej idź do artykułu Automatyczne pola klucza głównego.

Pole klucza głównego jest tyko do odczytu. Jeśli zmienisz wartość klucza głównego istniejącego obiektu i zapiszesz go, powstanie nowy obiekt obok starego obiektu. Na przykład:

from django.db import models

class Fruit(models.Model):
    name = models.CharField(max_length=100, primary_key=True)

>>> fruit = Fruit.objects.create(name='Apple')
>>> fruit.name = 'Pear'
>>> fruit.save()
>>> Fruit.objects.values_list('name', flat=True)
<QuerySet ['Apple', 'Pear']>
unique
Jeśli ma wartość True, to pole musi być unikalne wewnątrz tabeli.

Powtarzamy, to są tylko krótkie opisy najbardziej powszechnych opcji pól. Pełne szczegóły można odnaleźć w dokumentacji wspólnych opcji pól.

Automatyczne pola klucza głównego

Domyślnie Django daje każdemu modelowi następujące pole:

id = models.AutoField(primary_key=True)

To automatycznie zwiększany klucz główny.

Jeśli chciałbyś określić własny klucz główny, po prostu dodaj primary_key=True w jednym ze swoich pól. Jeśli Django zobaczy, że określiłeś wprost Field.primary_key, nie doda automatycznej kolumny id.

Każdy model wymaga, aby dokładnie jedno pole miało primary_key=True (albo określone wprost albo dodane automatycznie).

Rozwlekłe nazwy pól

Każdy typ pola, za wyjątkiem ForeignKey, ManyToManyField i OneToOneField, przyjmuje opcjonalny pierwszy pozycyjny argument – rozwlekłą nazwę. Jeśli nie jest podana, Django automatycznie ją stworzy używając nazwy artybutu pola, konwertując znaki podkreślenia na spacje.

W tym przykładzie rozwlekłą nazwą jest "person's first name":

first_name = models.CharField("person's first name", max_length=30)

W tym przykładzie rozwlekłą nazwą jest "first name":

first_name = models.CharField(max_length=30)

ForeignKey, ManyToManyField i OneToOneField wymagają, aby pierwszy argument był klasą modelu, więc używaj argumentu nazwanego verbose_name:

poll = models.ForeignKey(
    Poll,
    on_delete=models.CASCADE,
    verbose_name="the related poll",
)
sites = models.ManyToManyField(Site, verbose_name="list of sites")
place = models.OneToOneField(
    Place,
    on_delete=models.CASCADE,
    verbose_name="related place",
)

Konwencja zaleca nie kapitalizowanie pierwszej litery verbose_name. Django automatycznie uczyni pierwszą literę wielką, gdzie będzie tego potrzebował.

Relacje

W sposób oczywisty siła relacyjnych baz danych leży w tabelach będących ze sobą nawzajem w relacjach. Django daje sposoby na określenie trzech najbardziej powszechnych typów relacji w bazach danych: wiele-do-jednego, wiele-do-wielu i jeden-do-jednego.

Many-to-one relationships

Aby określić relację wiele-do-jednego, użyj django.db.models.ForeignKey. Możesz użyć go tak jak każdą inną klasę typu Field: zawierając ją jaką atrybut klasowy swojego modelu.

ForeignKey wymaga argumentu pozycyjnego: klasy, do której model jest w relacji.

Na przykład jeśli model Car ma pole Manufacturer – to znaczy, że Manufacturer robi wiele samochodów, ale każde Car ma tylko jedno Manufacturer – użyj poniższych definicji:

from django.db import models

class Manufacturer(models.Model):
    # ...
    pass

class Car(models.Model):
    manufacturer = models.ForeignKey(Manufacturer, on_delete=models.CASCADE)
    # ...

Możesz też tworzyć relacje rekursywne (obiekt z relacją wiele-do-jednego do samego siebie) i relacje do modeli jeszcze niezdefiniowanych; szczegóły w dokumentacji pól modelu.

Sugerowane, ale nie wymagane, jest aby nazwa pola ForeignKey (manufacturer w przykładzie powyżej) była nazwą modelu, małymi literami. Możesz oczywiście nazwać pole jak tylko chcesz. Na przykład:

class Car(models.Model):
    company_that_makes_it = models.ForeignKey(
        Manufacturer,
        on_delete=models.CASCADE,
    )
    # ...

Zobacz także

Pola ForeignKey przyjmują kilka dodatkowych argumentów, które są objaśnione w dokumentacji pól modelu. Te opcje pomagają określić jak relacja powinna działać; wszystkie są opcjonalne.

Szczegóły na temat dostępu do obiektów w relacji zwrotnej są opisane w Przykład pójścia w relację zwrotną.

Przykładowy kod znajdziesz w Przykład modelu w relacji wiele-do-jednego.

Many-to-many relationships

Aby zdefiniować relację wiele-do-wielu, użyj ManyToManyField. Używa się jej jak każdy typ klasy Field: dodając jako atrybut klasowy twojego modelu.

ManyToManyField przyjmuje wymagany argument pozycyjny: klasę, z którą model jest związany.

Na przykład, jeśli Pizza ma wiele obiektów Topping – to znaczy, że Topping może być na wielu pizzach i każda Pizza ma wiele składników – tak należy to zareprezentować:

from django.db import models

class Topping(models.Model):
    # ...
    pass

class Pizza(models.Model):
    # ...
    toppings = models.ManyToManyField(Topping)

Tak jak z ForeignKey, możesz też tworzyć relacje rekursywne (obiekt z relacją wiele-do-wielu do samego siebie) i relacje do modeli jeszcze nie zdefiniowanych.

Sugerowane, ale nie wymagane jest, aby nazwa pola ManyToManyField (toppings w przykładzie powyżej) była rzeczownikiem w liczbie mnogiej opisującym zbiór obiektów powiązanego modelu.

Nie ma znaczenia, który model ma ManyToManyField, ale powinieneś umieszczać je tylko w jednym z modeli – nie w obu.

Zazwyczaj instancje ManyToManyField powinny być w obiekcie, który będzie edytowany w formularzu. W powyższym przykładzie toppings są w Pizza (w odróżnieniu od Topping mającego ManyToManyField pizzas ) ponieważ bardziej naturalnym jest myśleć o pizzach mających składniki niż o składnikach będących na wielu pizzach. W sposób, ja jest to przedstawione powyżej, formularz klasy Pizza pozwoliłby użytkownikom wybierać składniki.

Zobacz także

Pełny przykład można znaleźć w artykule Przykład modelu w relacji wiele-do-wielu.

Pola ManyToManyField też przyjmują kilka dodatkowych argumentów, które są objaśnione w dokumentacji pól modelu. Te opcje pomagają określić jak relacja powinna działać; wszystkie są opcjonalne.

Dodatkowe pola w relacjach wiele-do-wielu

Kiedy masz do czynienia tylko z prostymi relacjami wiele-do-wielu takimi jak mieszanie i łączenie pizz i ich składników, standardowe ManyToManyField jest wszystkim, czego ci potrzeba. Jednak czasem możesz potrzebować powiązać dane z relacją pomiędzy dwoma modelami.

Na przykład rozważ przypadek aplikacji śledzącej grupy muzyczne, do których należą muzycy. Pomiędzy osobą a grupami, których jest członkiem, mamy relację wiele-do-wielu, więc mógłbyś użyć ManyToManyField jako reprezentacji tej relacji. Jednakże jest wiele detali związanych z członkostwem, które mógłbyś chcieć zbierać, takich jak data, w której osoba dołączyła do grupy.

Dla takich sytuacji Django pozwala określić model, który będzie użyty do zarządzania relacją wiele-do-wielu. Możesz wtedy umieścić dodatkowe pola w tym pośrednim modelu. Model pośredni jest związany z ManyToManyField przez użycie argumentu through do wskazania na model, który będzie się zachowywał jako pośredni. Dla naszego muzycznego przykładu kod wyglądałby jakoś tak:

from django.db import models

class Person(models.Model):
    name = models.CharField(max_length=128)

    def __str__(self):
        return self.name

class Group(models.Model):
    name = models.CharField(max_length=128)
    members = models.ManyToManyField(Person, through='Membership')

    def __str__(self):
        return self.name

class Membership(models.Model):
    person = models.ForeignKey(Person, on_delete=models.CASCADE)
    group = models.ForeignKey(Group, on_delete=models.CASCADE)
    date_joined = models.DateField()
    invite_reason = models.CharField(max_length=64)

Kiedy ustawiasz model pośredni, wprost określasz klucze obce do modeli, które wchodzą w skład relacji wiele-do-wielu. Ta deklaracja wprost określa jak są związane te dwa modele.

Model pośredni ma kilka ograniczeń:

  • Twój model pośredni musi zawierać jeden i tylko jeden klucz obcy do źródłowego modelu (w naszym przykładzie byłoby to Group), lub musisz podać wprost klucze obce, które Django powinno użyć w relacji używając ManyToManyField.through_fields. Jeśli masz więcej niż jeden klucz obcy i through_fields nie jest podane, zostanie zgłoszony błąd walidacji. Podobne ograniczenie tyczy się klucza obcego na modelu celu relacji (w naszym przykładzie byłoby to ``Person).
  • Dla modelu, który ma relację wiele-do-wielu do samego siebie przez model pośredni, dwa klucze obce do tego samego modelu są dozwolone, ale będą traktowane jako dwie (różne) strony relacji wiele-do-wielu. Tym niemniej jeśli są więcej niż dwa klucze obce, również musisz określić through_fields jak powyżej. W przeciwnym wypadku zostanie zgłoszony błąd walidacji.
  • Określając relację wiele-do-wielu z modelu do niego samego przy pomocy modelu pośredniego, musisz użyć symmetrical=False (patrz dokumentacja pól modelu).

Kiedy już skonfigurowałeś swoje ManyToManyField tak, aby używało twojego modelu pośredniego (w tym przypadku Membership), możesz zacząć dodawać jakieś relacje wiele-do-wielu. Robi się to tworząc instancje modelu pośredniego:

>>> ringo = Person.objects.create(name="Ringo Starr")
>>> paul = Person.objects.create(name="Paul McCartney")
>>> beatles = Group.objects.create(name="The Beatles")
>>> m1 = Membership(person=ringo, group=beatles,
...     date_joined=date(1962, 8, 16),
...     invite_reason="Needed a new drummer.")
>>> m1.save()
>>> beatles.members.all()
<QuerySet [<Person: Ringo Starr>]>
>>> ringo.group_set.all()
<QuerySet [<Group: The Beatles>]>
>>> m2 = Membership.objects.create(person=paul, group=beatles,
...     date_joined=date(1960, 8, 1),
...     invite_reason="Wanted to form a band.")
>>> beatles.members.all()
<QuerySet [<Person: Ringo Starr>, <Person: Paul McCartney>]>

W przeciwieństwie do pól wiele-do-wielu, nie możesz używać add(), create() ani set() do tworzenia relacji:

>>> # The following statements will not work
>>> beatles.members.add(john)
>>> beatles.members.create(name="George Harrison")
>>> beatles.members.set([john, paul, ringo, george])

Dlaczego? Nie możesz po prostu stworzyć relacji pomiędzy Person i Group – musisz podać wszystkie szczegóły relacji wymagane przez model Membership. Proste wywołania add, create i przypisania nie dają możliwości określenia tych dodatkowych danych. W efekcie są wyłączone dla relacji wiele-do-wielu, które używają modelu pośredniego. Jedynym sposobem na stworzenie tego typu relacji jest stworzenie instancji modelu pośredniego.

Metoda remove() jest wyłączona z podobnych powodów. Na przykład jeśli własna tabela „through” określona przez model pośredni nie wymusza unikalności na parze (model1, model2), wywołanie remove() nie dostarczałoby wystarczająco informacji, by określić, która instancja modelu pośredniego powinna być usunięta:

>>> Membership.objects.create(person=ringo, group=beatles,
...     date_joined=date(1968, 9, 4),
...     invite_reason="You've been gone for a month and we miss you.")
>>> beatles.members.all()
<QuerySet [<Person: Ringo Starr>, <Person: Paul McCartney>, <Person: Ringo Starr>]>
>>> # This will not work because it cannot tell which membership to remove
>>> beatles.members.remove(ringo)

Natomiast metoda clear() może być używana do usunięcia wszystkich relacji wiele-do-wielu dla instancji:

>>> # Beatles have broken up
>>> beatles.members.clear()
>>> # Note that this deletes the intermediate model instances
>>> Membership.objects.all()
<QuerySet []>

Kiedy już ustanowisz relacje wiele-do-wielu tworząc instancje swojego modelu pośredniego, możesz tworzyć kwerendy. Tak jak z normalnymi relacjami wiele-do-wielu możesz odpytywać używając atrybutów modelu związanego przez relację wiele-do-wielu:

# Find all the groups with a member whose name starts with 'Paul'
>>> Group.objects.filter(members__name__startswith='Paul')
<QuerySet [<Group: The Beatles>]>

Jako że używasz modelu pośredniego, możesz też tworzyć kwerendy z użyciem jego atrybutów:

# Find all the members of the Beatles that joined after 1 Jan 1961
>>> Person.objects.filter(
...     group__name='The Beatles',
...     membership__date_joined__gt=date(1961,1,1))
<QuerySet [<Person: Ringo Starr]>

Jeśli potrzebujesz uzyskać informacje o „członkostwie”, możesz zrobić to bezpośrednio odpytując model Membership:

>>> ringos_membership = Membership.objects.get(group=beatles, person=ringo)
>>> ringos_membership.date_joined
datetime.date(1962, 8, 16)
>>> ringos_membership.invite_reason
'Needed a new drummer.'

Innym sposobem na uzyskanie tej samej informacji jest odpytanie zwrotnej relacji wiele-do-wielu z obiektu Person:

>>> ringos_membership = ringo.membership_set.get(group=beatles)
>>> ringos_membership.date_joined
datetime.date(1962, 8, 16)
>>> ringos_membership.invite_reason
'Needed a new drummer.'

One-to-one relationships

Aby określić relację jeden-do-jednego, użyj OneToOneField. Używa się je jak każdy inny typ Field: dodając je jako atrybut klasowy do swojego modelu.

Najbardziej jest to przydatne na kluczu głównym obiektu, kiedy ten obiekt „rozszerza” inny obiekt w jakiś sposób.

OneToOneField wymaga argumentu pozycyjnego: klasy, z którą model jest związany.

Na przykład gdybyś budował bazę danych „miejsc”, zbudowałbyś w bazie danych całkiem standardowe rzeczy jak adres, numer telefonu itp. Następnie, jeśli chciałbyś nadbudować bazę miejsc bazą restauracji, zamiast powtarzać się i powielać te pola w modelu Restaurant, mógłbyś modelowi Restaurant nadać OneToOneField do Place (ponieważ restauracja „jest” miejscem; tak naprawdę, aby to obsłużyć, typowo użyłbyś dziedziczenia, które tworzy wewnętrzną relację wiele-do-wielu).

Tak jak z ForeignKey, można tworzyć relacje rekursywne i relacje do modeli jeszcze nie zdefiniowanych.

Zobacz także

Obejrzyj pełen przykład w Przykładzie modelu z relacją jeden-do-jednego.

Pola OneToOneField przyjmują też opcjonalny argument parent_link.

Klasy OneToOneField zwykły automatycznie stawać się kluczami głównymi modelu. Tak już się nie dzieje (chociaż możesz ręcznie przekazać argument primary_key, jeśli chcesz). A zatem jest teraz możliwe, aby mieć wiele pól typu OneToOneField w jednym modelu.

Modele w wielu plikach

Mieć relację do pola z innej aplikacji jest całkowicie OK. Aby to zrobić zaimportuj powiązany model na początku pliku, w którym są definicje twoich modeli. Następnie po prostu odwołaj się do klasy innego modelu, gdziekolwiek potrzebujesz. Na przykład:

from django.db import models
from geography.models import ZipCode

class Restaurant(models.Model):
    # ...
    zip_code = models.ForeignKey(
        ZipCode,
        on_delete=models.SET_NULL,
        blank=True,
        null=True,
    )

Ograniczenia nazw pól

Django daje tylko dwa ograniczenia na nazwy pól modelu:

  1. Pole nie może być zarezerwowanym słowem Pythona, ponieważ to mogłoby się skończyć błędem składni Pythona. Na przykład:

    class Example(models.Model):
    pass = models.IntegerField() # 'pass' is a reserved word!

  2. Pole nie może zawierać więcej niż jednego znaku podkreślenia z rzędu z powodu sposobu, w jaki działa składnia lookupu w kwerendach. Na przykład:

    class Example(models.Model):
    foo__bar = models.IntegerField() # 'foo__bar' has two underscores!

Bądź co bądź te ograniczenia można obejść, ponieważ nazwa pola nie musi koniecznie zgadzać się z nazwą kolumny w twojej bazie danych. Sprawdź opcję db_column.

Zarezerwowane słowa SQL takie jak join, where i ``select` są dozwolone jako nazwy pola modelu, ponieważ Django escape’uje wszystkie nazwy tabel i kolumn w bazie danych w każdej podstawowej kwerendzie SQL. Używa składni cudzysłowów twojego konkretnego silnika bazy danych.

Własne typy pól

Jeśli żadne z istniejących pól modelu nie może sprostać twoim oczekiwaniom lub jeśli chcesz skorzystać jakichś mniej powszechnych typach kolumn bazy danych, możesz stworzyć swoją własną klasę pola. W pełni opisane tworzenie własnych pól jest opisane w Writing custom model fields.

Opcje Meta

Określ metadane swojego modelu używając wewnętrznego class Meta, w ten sposób:

from django.db import models

class Ox(models.Model):
    horn_length = models.IntegerField()

    class Meta:
        ordering = ["horn_length"]
        verbose_name_plural = "oxen"

Metadanymi modelu jest „wszystko, co nie jest polem”, tak jak opcje porządku (ordering), nazwa tabeli w bazie danych (db_table) lub pojedyncze i mnogie nazwy do czytelne dla człowieka (verbose_name i verbose_name_plural). Żadne z nich nie jest wymagane a dodawanie class Meta do modelu jest całkowicie opcjonalne.

Pełną listę wszystkich możliwych opcji Meta możesz znaleźć w dokumentacji opcji modelu.

Atrybuty modelu

objects
Najważniejszym atrybutem modelu jest Manager. To interfejs, przez który operacje kwerend bazy danych są przekazywane modelom Django i jest używany do pobierania instancji z bazy danych. Jeśli nie jest określony własny Manager, jego domyślną nazwą jest objects. Do menadżerów dostęp można uzyskać tylko przez klasy modeli, nie przez instancje modeli.

Metody modelu

Określaj własne metody w modelu, aby dodać własną funkcjonalność do swoich obiektów „na poziomie wiersza”. Podczas gdy metody klasy Manager są przeznaczone do robienia rzeczy „na całej tabeli”, metody modelu powinny działaś na poszczególnej instancji modelu.

To cenna technika na trzymanie logiki biznesowej w jednym miejscu – model.

Na przykład ten model ma kilka własnych metod:

from django.db import models

class Person(models.Model):
    first_name = models.CharField(max_length=50)
    last_name = models.CharField(max_length=50)
    birth_date = models.DateField()

    def baby_boomer_status(self):
        "Returns the person's baby-boomer status."
        import datetime
        if self.birth_date < datetime.date(1945, 8, 1):
            return "Pre-boomer"
        elif self.birth_date < datetime.date(1965, 1, 1):
            return "Baby boomer"
        else:
            return "Post-boomer"

    @property
    def full_name(self):
        "Returns the person's full name."
        return '%s %s' % (self.first_name, self.last_name)

Ostatnia metoda w tym przykładzie to property.

Dokumentacja instancji modelu zawiera pełną listę metod automatycznie dawanych każdemu modelowi. Możesz nadpisać większość z nich – patrz nadpisywanie predefiniowanych metod modelu poniżej – ale jest kilka, które prawie zawsze będziesz chciał określić:

__str__()

„Magiczna metoda” Pythona, która zwraca reprezentację w ciągu znaków dowolnego obiektu. Tego używać będzie Python i Django, kiedykolwiek na instancji modelu wymusimy wyświetlenie jako prosty ciąg znaków. W szczególności dzieje się to, kiedy wyświetlamy obiekt w interaktywnej konsoli lub w panelu administracyjnym.

Zawsze będziesz chciał określić tę metodę; domyślna jest zupełnie nie pomocna.

get_absolute_url()

Mówi Django jak wyliczać URL dla obiektu. Django używa go w swoim interfejsie admina i za każdym razem, gdy potrzebuje ustalić URL dla obiektu.

Każdy obiekt, który ma URL, który określa go jednoznacznie, powinien mieć zdefiniowaną tę metodę.

Nadpisywanie predefiniowanych metod modelu

Jest jeszcze jeden zbiór metod modelu, który zawiera zestaw zachowań bazodanowych, które będziesz chciał zmieniać. W szczególności będziesz często chciał zmieniać sposób, w jaki działają save() i delete().

Możesz nadpisać te metody (i każdą inną metodę modelu), aby zmienić ich zachowanie.

Klasycznym przypadkiem użycia dla nadpisania wbudowanych metod jest jeśli chcesz, by coś się działo za każdym razem, gdy zapisujesz obiekt. Na przykład (patrz save() po dokumentację parametrów, które akceptuje):

from django.db import models

class Blog(models.Model):
    name = models.CharField(max_length=100)
    tagline = models.TextField()

    def save(self, *args, **kwargs):
        do_something()
        super().save(*args, **kwargs)  # Call the "real" save() method.
        do_something_else()

Możesz też zapobiec zapisaniu:

from django.db import models

class Blog(models.Model):
    name = models.CharField(max_length=100)
    tagline = models.TextField()

    def save(self, *args, **kwargs):
        if self.name == "Yoko Ono's blog":
            return # Yoko shall never have her own blog!
        else:
            super().save(*args, **kwargs)  # Call the "real" save() method.

Ważne jest, by pamiętać, aby wywoływać metody nadklasy – to ten fragment z super().save(*args, **kwargs) – aby na pewno zapisać obiekt do bazy danych. Jeśli zapomnisz wywołać metodę nadklasy, nie wykona się domyślne działanie i baza danych nie zostanie dotknięta.

Ważne jest też, abyś przekazał argumenty, które mogą zostać przekazane do metody modelu – to robi kawałek *args, **kwargs. Django będzie od czasu do czasu rozszerzało możliwości wbudowanych metod modelu dodając nowe argumenty. Używając *args, **kwargs w definicjach swoich metod masz gwarancję, że twój kod będzie automatycznie wspierał te argumenty, gdy zostaną dodane.

Nadpisane metody modelu nie są wołane przy operacjach zbiorczych

Zwróć uwagę, że metoda delete() obiektu niekoniecznie jest wywoływana, gdy usuwa się obiekty zbiorczo przy użyciu QuerySetu lub w rezultacie usuwania kaskadowego. Aby mieć pewność, że twoja własna logika usuwania się wykona, możesz użyć sygnałów pre_delete i/lub post_delete.

Niestety nie ma obejścia przy zbiorczym tworzeniu i aktualizacji obiektów, jako że żadna z metod save(), pre_save, and post_save nie są wywoływane.

Wykonywanie własnego SQL-a

Innym powszechnym wzorcem jest pisanie własnych zapytań SQL w metodach modeli i metodach modułowych. Więcej szczegółów na temat używania surowego SQL-a znajdziesz w dokumentacji na temat używania surowego SQL-a.

Dziedziczenie modeli

Dziedziczenie modeli w Django działa prawie identycznie do sposobu, w jaki normalne dziedziczenie klas działa w Pythonie, ale podstawy z początku strony wciąż nas obowiązują. To znaczy, że klasa bazowa powinna dziedziczyć po django.db.models.Model.

Jedyna decyzja, którą musisz podjąć, to czy chcesz, aby modele-rodzice były modelami na swoich własnych prawach (ze swoimi własnymi tabelami w bazie danych), czy rodzice mają być tylko posiadaczami wspólnych informacji, które będą widoczne jedynie przez modele potomne.

Są trzy style dziedziczenia, które są możliwe w Django.

  1. Często będziesz potrzebował klasy-rodzica tylko do trzymania informacji, których nie chcesz wpisywać dla każdego modelu potomnego. Ta klasa nie będzie nigdy używana osobno, więc Abstrakcyjne klasy bazowe są tym, czego szukasz.
  2. Jeśli dziedziczysz po istniejącym modelu (być może czymś z całkowicie innej aplikacji) i chcesz, aby każdy model miał swoją własną tabelę w bazie danych, Dziedziczenie wielotabelowe jest właściwą drogą.
  3. Ostatecznie jeśli chcesz zmienić zachowanie modelu tylko na poziomie Pythona, bez zmiany pól modelu w żaden sposób, możesz użyć Proxy models.

Abstrakcyjne klasy bazowe

Abstrakcyjne modele bazowe przydają się, gdy chcesz umieścić jakieś wspólne informacje w kilku innych modelach. Piszesz swoją klasę bazową i umieszczasz abstract=True w klasie Meta. Ten model w konsekwencji nie będzie używany do stworzenia żadnej tabeli w bazie danych. Zamiast tego, gdy zostanie użyty jako klasa bazowa dla innych modeli, jego pola zostaną dodane do tabel klasy potomnej.

Przykład:

from django.db import models

class CommonInfo(models.Model):
    name = models.CharField(max_length=100)
    age = models.PositiveIntegerField()

    class Meta:
        abstract = True

class Student(CommonInfo):
    home_group = models.CharField(max_length=5)

Model Student będzie miał trzy pola: name, age i home_group. Model CommonInfo nie może być używany jako normalny model Django, jako że jest abstrakcyjną klasą bazową. Nie generuje tabeli w bazie danych ani nie ma menadżera i nie może być zinstancjonowany ani bezpośrednio zapisany.

Pola odziedziczone z abstrakcyjnych klas bazowych mogą być nadpisane innym polem lub wartością, lub usunięte przy użyciu None.

W wielu użyciach ten typ dziedziczenia modelu będzie dokładnie tym, czego chcesz. Dostarcza on sposobu na wydzielenie wspólnych informacji na poziomie Pythona, wciąż tworząc tylko jedną tabelę na model potomny na poziomie bazy danych.

Dziedziczenie Meta

Gdy tworzona jest abstrakcyjna klasa bazowa, Django udostępnia każdą wewnętrzną klasę Meta, którą zadeklarujesz w bazowej klasie, jako atrybut. Jeśli klasa potomna nie deklaruje swojej własnej klasy Meta, odziedziczy :ref:Meta <meta-options>` rodzica. Jeśli potomek chce rozszerzyć klasę Meta rodzica, może po nim dziedziczyć. Na przykład:

from django.db import models

class CommonInfo(models.Model):
    # ...
    class Meta:
        abstract = True
        ordering = ['name']

class Student(CommonInfo):
    # ...
    class Meta(CommonInfo.Meta):
        db_table = 'student_info'

Django dostosowuje jedną rzecz w klasie Meta abstrakcyjnej klasy bazowej: przed zainstalowaniem atrybutu Meta ustawia abstract=False. To powoduje, że dzieci abstrakcyjnych klas bazowych nie staną się automatycznie same klasami abstrakcyjnymi. Oczywiście możesz stworzyć abstrakcyjną klasę bazową, która dziedziczy z innej abstrakcyjnej klasy bazowej. Musisz tylko pamiętać, aby wprost ustawić abstract=True za każdym razem.

Niektórych atrybutów nie ma sensu umieszczać w klasie Meta abstrakcyjnej klasy bazowej. Na przykład umieszczenie db_table oznaczałoby, że wszystkie potomne klasy (te, które nie określą swojego własnego Meta) używałyby tej samej tabeli bazodanowej, a jest prawie pewne, że tego nie chcesz.

Dziedziczenie wielotabelowe

Drugim typem dziedziczenia modeli wspieranym przez Django jest kiedy każdy model w hierarchii jest sam z siebie modelem. Każdy model ma swoją własną tabelę w bazie danych i można na nim wykonywać zapytania i tworzyć go osobno. Relacja dziedziczenia wprowadza powiązania pomiędzy modelem potomnym i każdym z jego rodziców (przez automatycznie tworzone OneToOneField). Na przykład:

from django.db import models

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

class Restaurant(Place):
    serves_hot_dogs = models.BooleanField(default=False)
    serves_pizza = models.BooleanField(default=False)

Wszystkie pola modelu Place będą też dostępne w Restaurant, chociaż dane będą przechowywane w innej tabeli bazy danych. Więc obie rzeczy są możliwe:

>>> Place.objects.filter(name="Bob's Cafe")
>>> Restaurant.objects.filter(name="Bob's Cafe")

Jeśli masz Place, które jest też Restaurant, możesz przejść z obiektu Place do obiektu Restaurant używając nazwy modelu małymi literami:

>>> p = Place.objects.get(id=12)
# If p is a Restaurant object, this will give the child class:
>>> p.restaurant
<Restaurant: ...>

Gdyby p w powyższym przykładzie nie było Restaurant (zostało stworzone bezpośrednio jako obiekt Place lub było rodzicem jakiejś innej klasy), odwołanie się do p.restaurant zgłosiłoby wyjątek Restaurant.DoesNotExist.

Automatycznie stworzone OneToOneField w Restaurant, które łączy nas z Place wygląda tak:

place_ptr = models.OneToOneField(
    Place, on_delete=models.CASCADE,
    parent_link=True,
)

Możesz nadpisać to pole deklarując własne OneToOneField z parent_link=True w Restaurant.

Meta i dziedziczenie wielotabelowe

W sytuacji dziedziczenia wielotabelowego, nie ma sensu, aby klasa potomna dziedziczyła z klasy Meta swojego rodzica. Wszystkie opcje Meta są już zaaplikowane do klasy rodzica i ponowne ich aplikowanie prowadziłoby normalnie do sprzecznego zachowania (w przeciwieństwie do przypadku abstrakcyjnej klasy bazowej, gdzie klasa bazowa nie istnieje na swoich własnych prawach).

Więc model potomny nie ma dostępu dla klasy Meta rodzica. Jednakże jest kilka ograniczonych przypadków, gdzie dziecko dziedziczy zachowanie z rodzica: jeśli dziecko nie podaje atrybutu ordering lub get_latest_by, odziedziczy je po rodzicu.

Jeśli rodzic ma określony porządek i nie chcesz, aby dziecko miało jakikolwiek naturalny porządek, możesz wyraźnie go wyłączyć:

class ChildModel(ParentModel):
    # ...
    class Meta:
        # Remove parent's ordering effect
        ordering = []

Dziedziczenie i relacje zwrotne

Ponieważ dziedziczenie wielotabelowe używa domyślnego OneToOneField by połączyć dziecko z rodzicem, możliwe jest przejście z rodzica „w dół” do dziecka, jak w powyższym przykładzie. To pole używa nazwy, która jest domyślną wartością related_name dla relacji ForeignKey i ManyToManyField. Jeśli umieszczasz te typy relacji w podklasie modelu rodzica, musisz podać wartość atrybutu related_name w każdym takim polu. Jeśli zapomnisz, Django zgłosi błąd walidacji.

Na przykład używając znów powyższej klasy Place, stwórzmy inną podklasę z ManyToManyField:

class Supplier(Place):
    customers = models.ManyToManyField(Place)

Wynikiem jest błąd:

Reverse query name for 'Supplier.customers' clashes with reverse query
name for 'Supplier.place_ptr'.

HINT: Add or change a related_name argument to the definition for
'Supplier.customers' or 'Supplier.place_ptr'.

Dodanie related_name do pola customers w ten sposób rozwiązałoby problem: models.ManyToManyField(Place, related_name='provider').

Proxy models

When using multi-table inheritance, a new database table is created for each subclass of a model. This is usually the desired behavior, since the subclass needs a place to store any additional data fields that are not present on the base class. Sometimes, however, you only want to change the Python behavior of a model – perhaps to change the default manager, or add a new method.

This is what proxy model inheritance is for: creating a proxy for the original model. You can create, delete and update instances of the proxy model and all the data will be saved as if you were using the original (non-proxied) model. The difference is that you can change things like the default model ordering or the default manager in the proxy, without having to alter the original.

Proxy models are declared like normal models. You tell Django that it’s a proxy model by setting the proxy attribute of the Meta class to True.

For example, suppose you want to add a method to the Person model. You can do it like this:

from django.db import models

class Person(models.Model):
    first_name = models.CharField(max_length=30)
    last_name = models.CharField(max_length=30)

class MyPerson(Person):
    class Meta:
        proxy = True

    def do_something(self):
        # ...
        pass

The MyPerson class operates on the same database table as its parent Person class. In particular, any new instances of Person will also be accessible through MyPerson, and vice-versa:

>>> p = Person.objects.create(first_name="foobar")
>>> MyPerson.objects.get(first_name="foobar")
<MyPerson: foobar>

You could also use a proxy model to define a different default ordering on a model. You might not always want to order the Person model, but regularly order by the last_name attribute when you use the proxy. This is easy:

class OrderedPerson(Person):
    class Meta:
        ordering = ["last_name"]
        proxy = True

Now normal Person queries will be unordered and OrderedPerson queries will be ordered by last_name.

Proxy models inherit Meta attributes in the same way as regular models.

QuerySets still return the model that was requested

There is no way to have Django return, say, a MyPerson object whenever you query for Person objects. A queryset for Person objects will return those types of objects. The whole point of proxy objects is that code relying on the original Person will use those and your own code can use the extensions you included (that no other code is relying on anyway). It is not a way to replace the Person (or any other) model everywhere with something of your own creation.

Base class restrictions

A proxy model must inherit from exactly one non-abstract model class. You can’t inherit from multiple non-abstract models as the proxy model doesn’t provide any connection between the rows in the different database tables. A proxy model can inherit from any number of abstract model classes, providing they do not define any model fields. A proxy model may also inherit from any number of proxy models that share a common non-abstract parent class.

Proxy model managers

If you don’t specify any model managers on a proxy model, it inherits the managers from its model parents. If you define a manager on the proxy model, it will become the default, although any managers defined on the parent classes will still be available.

Continuing our example from above, you could change the default manager used when you query the Person model like this:

from django.db import models

class NewManager(models.Manager):
    # ...
    pass

class MyPerson(Person):
    objects = NewManager()

    class Meta:
        proxy = True

If you wanted to add a new manager to the Proxy, without replacing the existing default, you can use the techniques described in the custom manager documentation: create a base class containing the new managers and inherit that after the primary base class:

# Create an abstract class for the new manager.
class ExtraManagers(models.Model):
    secondary = NewManager()

    class Meta:
        abstract = True

class MyPerson(Person, ExtraManagers):
    class Meta:
        proxy = True

You probably won’t need to do this very often, but, when you do, it’s possible.

Differences between proxy inheritance and unmanaged models

Proxy model inheritance might look fairly similar to creating an unmanaged model, using the managed attribute on a model’s Meta class.

With careful setting of Meta.db_table you could create an unmanaged model that shadows an existing model and adds Python methods to it. However, that would be very repetitive and fragile as you need to keep both copies synchronized if you make any changes.

On the other hand, proxy models are intended to behave exactly like the model they are proxying for. They are always in sync with the parent model since they directly inherit its fields and managers.

The general rules are:

  1. If you are mirroring an existing model or database table and don’t want all the original database table columns, use Meta.managed=False. That option is normally useful for modeling database views and tables not under the control of Django.
  2. If you are wanting to change the Python-only behavior of a model, but keep all the same fields as in the original, use Meta.proxy=True. This sets things up so that the proxy model is an exact copy of the storage structure of the original model when data is saved.

Multiple inheritance

Just as with Python’s subclassing, it’s possible for a Django model to inherit from multiple parent models. Keep in mind that normal Python name resolution rules apply. The first base class that a particular name (e.g. Meta) appears in will be the one that is used; for example, this means that if multiple parents contain a Meta class, only the first one is going to be used, and all others will be ignored.

Generally, you won’t need to inherit from multiple parents. The main use-case where this is useful is for „mix-in” classes: adding a particular extra field or method to every class that inherits the mix-in. Try to keep your inheritance hierarchies as simple and straightforward as possible so that you won’t have to struggle to work out where a particular piece of information is coming from.

Note that inheriting from multiple models that have a common id primary key field will raise an error. To properly use multiple inheritance, you can use an explicit AutoField in the base models:

class Article(models.Model):
    article_id = models.AutoField(primary_key=True)
    ...

class Book(models.Model):
    book_id = models.AutoField(primary_key=True)
    ...

class BookReview(Book, Article):
    pass

Or use a common ancestor to hold the AutoField. This requires using an explicit OneToOneField from each parent model to the common ancestor to avoid a clash between the fields that are automatically generated and inherited by the child:

class Piece(models.Model):
    pass

class Article(Piece):
    article_piece = models.OneToOneField(Piece, on_delete=models.CASCADE, parent_link=True)
    ...

class Book(Piece):
    book_piece = models.OneToOneField(Piece, on_delete=models.CASCADE, parent_link=True)
    ...

class BookReview(Book, Article):
    pass

Field name „hiding” is not permitted

In normal Python class inheritance, it is permissible for a child class to override any attribute from the parent class. In Django, this isn’t usually permitted for model fields. If a non-abstract model base class has a field called author, you can’t create another model field or define an attribute called author in any class that inherits from that base class.

This restriction doesn’t apply to model fields inherited from an abstract model. Such fields may be overridden with another field or value, or be removed by setting field_name = None.

Ostrzeżenie

Model managers are inherited from abstract base classes. Overriding an inherited field which is referenced by an inherited Manager may cause subtle bugs. See custom managers and model inheritance.

Informacja

Some fields define extra attributes on the model, e.g. a ForeignKey defines an extra attribute with _id appended to the field name, as well as related_name and related_query_name on the foreign model.

These extra attributes cannot be overridden unless the field that defines it is changed or removed so that it no longer defines the extra attribute.

Overriding fields in a parent model leads to difficulties in areas such as initializing new instances (specifying which field is being initialized in Model.__init__) and serialization. These are features which normal Python class inheritance doesn’t have to deal with in quite the same way, so the difference between Django model inheritance and Python class inheritance isn’t arbitrary.

This restriction only applies to attributes which are Field instances. Normal Python attributes can be overridden if you wish. It also only applies to the name of the attribute as Python sees it: if you are manually specifying the database column name, you can have the same column name appearing in both a child and an ancestor model for multi-table inheritance (they are columns in two different database tables).

Django will raise a FieldError if you override any model field in any ancestor model.

Organizing models in a package

The manage.py startapp command creates an application structure that includes a models.py file. If you have many models, organizing them in separate files may be useful.

To do so, create a models package. Remove models.py and create a myapp/models/ directory with an __init__.py file and the files to store your models. You must import the models in the __init__.py file.

For example, if you had organic.py and synthetic.py in the models directory:

myapp/models/__init__.py
from .organic import Person
from .synthetic import Robot

Explicitly importing each model rather than using from .models import * has the advantages of not cluttering the namespace, making code more readable, and keeping code analysis tools useful.

Zobacz także

The Models Reference
Covers all the model related APIs including model fields, related objects, and QuerySet.
Back to Top