Tampilan umum berdasarkan kelas siap-pakai¶

Membuat konteks cetakan "friendly"¶

Anda mungkin telah memperhatikan bahwa contoh cetakan daftar penerbit kami menyimpan semua penerbit dalam sebuah variabel bernama object_list. Selagi ini bekerja baik, itu tidak semua yang "friendly" pada cetakan penulis: mereka harus "just know" bahwa mereka sedang berurusan dengan penerbit disini.

Baik, jika anda sedang berurusan dengan sebuah obyek model, ini sudah selesai untuk anda. Ketika anda sedang berurusan dengan sebuah obyek atau queryset, Django dapat mengumpulkan konteks menggunakan versi huruf kecil dari nama kelas model. Ini disediakan sebagai tambahan pada masukan object_list awalan, tetapi mengandung persisnya data sama, yaitu publisher_list.

Jika ini masih tidak kecocokan baik, anda dapat manual menyetel nama dari variabel konteks. Atribut context_object_name pada tampilan umum menentukan variabel konteks untuk digunakan:

# views.py
from django.views.generic import ListView
from books.models import Publisher

class PublisherList(ListView):
    model = Publisher
    context_object_name = 'my_favorite_publishers'

Menyediakan sebuah context_object_name berguna selalu ide bagus. Rekan kerja anda yang merancang cetakan akan berterima kasih.

Menambahkan konteks tambahan¶

Sering anda cukup butuh menghadirkan beberapa informasi tambahan yang disediakan oleh tampilan umum. Sebagai contoh, berpikir dari menunjukkan daftar semua buku pada setiap halaman rincian penerbit. Tampilan umum DetailView menyediakan penerbit ke konteks, tetapi bagaimana kami mendapatkan informasi tambahan di cetakan itu?

Jawabannya adalah untuk mensubkelaskan DetailView dan menyediakan penerapan milik anda sendiri dari metode get_context_data. Penerapan awalan cukup menambahkan obyek sedang ditampilkan pada cetakan, tetapi anda dapat menimpanya untuk mengirim lagi:

from django.views.generic import DetailView
from books.models import Publisher, Book

class PublisherDetail(DetailView):

    model = Publisher

    def get_context_data(self, **kwargs):
        # Call the base implementation first to get a context
        context = super(PublisherDetail, self).get_context_data(**kwargs)
        # Add in a QuerySet of all the books
        context['book_list'] = Book.objects.all()
        return context

Menampilkan subkumpulan dari obyek¶

Sekarang mari kita lebih dekat melihat pada argumen model kami telah sepanjang gunakan. Argumen model, yang menentukan model basisdata yang tampilan akan beroperasi, tersedia pada seua tampilan umum yang beroperasi pada obyek tunggal atau kumpulan dari obyek. Bagaimanapun, argumen model tidak hanya cara untuk menentukan obyek yang tampilan akan beroperasi -- anda dapat juga menentukan daftar dari obyek menggunakan argumen queryset:

from django.views.generic import DetailView
from books.models import Publisher

class PublisherDetail(DetailView):

    context_object_name = 'publisher'
    queryset = Publisher.objects.all()

Menentukan model = Publisher` adalah hanya tulisan cepat untuk mengatakan queryset = Publisher.objects.all(). Bagaimanapun, dengan menggunakan queryset untuk menentukan daftar disaring dari obyek anda dapat lebih khususkan tentang obyek yang akan muncul di tampilan (lihat Membuat query untuk informasi lebih tentang obyek QuerySet, dan lihat class-based views reference untuk rincian lengkap).

Untuk mengambil sebuah contoh sederhana, kami mungkin ingin mengurutkan daftar dari buku-buku dari tanggal terbit, dengan pertama paling terbaru:

from django.views.generic import ListView
from books.models import Book

class BookList(ListView):
    queryset = Book.objects.order_by('-publication_date')
    context_object_name = 'book_list'

Itu adalah contoh sederhana cantik, tetapi itu menggambarkan ide sangat bagus. Tentu saja, anda akan biasanya ingin melakukan lebih daripada mengurutkan kembali obyek. Jika anda ingin menghadirkan daftar buku oleh penerbit tertentu, anda dapat menggunakan teknis sama:

from django.views.generic import ListView
from books.models import Book

class AcmeBookList(ListView):

    context_object_name = 'book_list'
    queryset = Book.objects.filter(publisher__name='ACME Publishing')
    template_name = 'books/acme_list.html'

ikan bahwa selama dengan queryset disaring, kami juga menggunakan nama cetakan penyesuaian. Jika kami tidak, tampilan umum akan menggunakan cetakan sama seperti daftar obyek "vanilla", yang mungkin tidak kita inginkan.

Juga perharikan bahwa ini bukan cara sangat elegan dari melakukan buku khusus-penerbit. Jika kami ingin menambah halaman penerbit lain, kami butuh bantuan lain dari baris di URLconf, dan lebih dari sedikit penerbit akan mendapatkan alasan tidak masuk akal. Kami akan berurusan dengan masalah ini di bagian selanjutnya.

Menyaring dinamis¶

Kebutuhan umum lain adalah menyaring kebawah obyek yang diberikan di halaman daftar dengan beberapa kunci di URL. Awalnya kami mengkode-keraskan nama penerbit di URLconf, tetapi apa jika kami ingin menulis sebuah tampilan yang menampilkan semua buku oleh beberapa penerbit berubah-ubah?

Dengan mudah, ListView mempunyai sebuah metode get_queryset() kami dapat timpa. Sebelumnya, itu telah mengembalikan nilai dari atribut queryset, tetapi sekarang kami dapat menambah lebih logika.

Bagian kunci membiat ini bekerja adalah bahwa ketika tampilan berdasarkan-kelas dipanggil, beragam hal-hal berguna disimpan di self; sama halnya permintaan (self.request) ini menyertakan penempatan (self.args) dan argumen (self.kwargs) berdasarkan-nama menurut URLconf.

Disini, kami mempunyai URLconf dengan kelompok ditangkap tunggal:

# urls.py
from django.conf.urls import url
from books.views import PublisherBookList

urlpatterns = [
    url(r'^books/([\w-]+)/$', PublisherBookList.as_view()),
]

Selanjutnya, kami akan menulis tampilan PublisherBookList sendiri:

# views.py
from django.shortcuts import get_object_or_404
from django.views.generic import ListView
from books.models import Book, Publisher

class PublisherBookList(ListView):

    template_name = 'books/books_by_publisher.html'

    def get_queryset(self):
        self.publisher = get_object_or_404(Publisher, name=self.args[0])
        return Book.objects.filter(publisher=self.publisher)

Seperti anda dapat lihat, itu adalah sangat mudah menambah logika lebih pada pemilihan queryset; jika kami ingin, kami dapat menggunakan self.request.user pada penyaring menggunakan pengguna saat ini, atau lebih logika rumit lain.

Kami dapat juga menambahkan penerbit kedalam konteks pada waktu bersamaan, jadi kami dapat menggunakannya di cetakan:

# ...

def get_context_data(self, **kwargs):
    # Call the base implementation first to get a context
    context = super(PublisherBookList, self).get_context_data(**kwargs)
    # Add in the publisher
    context['publisher'] = self.publisher
    return context

Melakukan pekerjaan tambahan¶

Pola umum terakhir kami akan lihat pada melibatkan melakukan beberapa pekerjaan tambahan sebelum atau sesudah memanggil tampilan umum.

Bayangkan kami mempunyai sebuah bidang last_accessed` di model Author` kami yang kami sedang gunakanuntuk menjaga lintas dari waktu terakhir siapapun mencari penulis itu:

# models.py
from django.db import models

class Author(models.Model):
    salutation = models.CharField(max_length=10)
    name = models.CharField(max_length=200)
    email = models.EmailField()
    headshot = models.ImageField(upload_to='author_headshots')
    last_accessed = models.DateTimeField()

Kelas DetailView umum, tentu saja, kami tidak akan mengetahui apapun tentang bidang ini, tetapi sekali lagi kami dapat dengan menudah menulis tampilan penyesuaian untuk menjaga bidang itu terperbaharui.

Pertama, kami butuh menambah rincian seorang penulis sedikit dalam URLconf untuk menunjuk pada tampilan penyesuaian:

from django.conf.urls import url
from books.views import AuthorDetailView

urlpatterns = [
    #...
    url(r'^authors/(?P<pk>[0-9]+)/$', AuthorDetailView.as_view(), name='author-detail'),
]

Kemudian kami akan menulis tampilan baru kami -- get_object adalah metode yang mengambil obyek -- jadi kami cukup menimpanya dan membungkus panggilan:

from django.views.generic import DetailView
from django.utils import timezone
from books.models import Author

class AuthorDetailView(DetailView):

    queryset = Author.objects.all()

    def get_object(self):
        # Call the superclass
        object = super(AuthorDetailView, self).get_object()
        # Record the last accessed date
        object.last_accessed = timezone.now()
        object.save()
        # Return the object
        return object