Scrivere la tua prima applicazione in Django, parte 7

Questo tutorial inizia dove si è interrotto Tutorial 6. Stiamo proseguendo con l’applicazione web per i questionari e ci concentreremo sul sito generato automaticamente per l’amministrazione di Django che abbiamo esplorato in prima battuta nel Tutorial 2.

Dove trovare aiuto:

Se hai difficoltà a completare questo tutorial, per favore vai alla sezione Getting Help delle FAQ.

Personalizzare il modulo di amministrazione

Registrando il modello Question con admin.site.register(Question), Django è stato in grado di costruire un form di default. Spesso, vorrai personalizzare il modo in cui il form di amministrazione appare e funziona. Lo farai dicendo a Django quali opzioni vuoi quando registrerai l’oggetto.

Vediamo come funziona riordinando i campi nel modulo di modifica. Sostituisci la riga admin.site.register(Question) con:

polls/admin.py

from django.contrib import admin

from .models import Question


class QuestionAdmin(admin.ModelAdmin):
    fields = ["pub_date", "question_text"]


admin.site.register(Question, QuestionAdmin)

Seguirai questo pattern – crea una classe del modello di amministrazione, poi passala come secondo argomento a admin.site.register() – ogni volta che vuoi cambiare le opzioni nel panello di amministrazione del modello.

Questa particolare modifica qui sopra fa sì che la «Data di pubblicazione» venga prima del campo «Domanda»:

Questo non è impressionante con solo due campi, ma per i moduli di amministrazione con dozzine di campi, la scelta di un ordine intuitivo è un dettaglio importante per l’usabilità.

E parlando di moduli con dozzine di campi, potresti voler dividere il modulo in gruppi di campi:

polls/admin.py

from django.contrib import admin

from .models import Question


class QuestionAdmin(admin.ModelAdmin):
    fieldsets = [
        (None, {"fields": ["question_text"]}),
        ("Date information", {"fields": ["pub_date"]}),
    ]


admin.site.register(Question, QuestionAdmin)

Il primo elemento di ogni tupla in fieldsets è il titolo del fieldset. Ecco come il nostro form appare adesso:

Aggiunta di oggetti correlati

OK, abbiamo la nostra pagina di amministrazione del modello Question, ma una Question ha più Choice, e il pannello di amministrazione non mostra le scelte.

Ancora.

Esistono due modi per risolvere questo problema. Il primo è registrare Scelta nell’amministrazione proprio come abbiamo fatto con Domanda:

polls/admin.py

from django.contrib import admin

from .models import Choice, Question

# ...
admin.site.register(Choice)

Ora «Scelte» è un’opzione disponibile nell’amministrazione di Django. Il modulo «Aggiungi scelta» ha questo aspetto:

In quel form, il campo «Question» è un menu a tendina contenente tutte le domande nel database. Django sa che una ForeignKey dovrebbe essere rappresentata nell’admin come una <select>. Nel nostro caso, esiste solo una domanda a questo punto.

Nota anche il link «Aggiungi un’altra domanda» vicino a «Domanda.» Ogni oggetto con una relazione di ForeignKey lo ottiene gratis. Quando farai click su «Aggiungi un’altra domanda», vedrai una finestra di popup con il form «Aggiungi domanda». Se aggiungi una domanda in quella finestra e fai click su «Salva», Django salverà la richiesta sul database e la aggiungerà come scelta selezionata nel form «Aggiungi scelta» che stai guardando.

Ma, onestamente, questo è un modo inefficiente di aggiungere oggetti Choice al sistema. Sarebbe meglio se potessi aggiungere un gruppo di Choices direttamente quando crei l’oggetto Question. Facciamolo.

Rimuovere la chiamata register() per il modello Scelta. Quindi, modifica il codice di registrazione Domanda per leggere:

polls/admin.py

from django.contrib import admin

from .models import Choice, Question


class ChoiceInline(admin.StackedInline):
    model = Choice
    extra = 3


class QuestionAdmin(admin.ModelAdmin):
    fieldsets = [
        (None, {"fields": ["question_text"]}),
        ("Date information", {"fields": ["pub_date"], "classes": ["collapse"]}),
    ]
    inlines = [ChoiceInline]


admin.site.register(Question, QuestionAdmin)

Questo dice a Django: gli oggetti «Choice sono modificati nella pagina di amministrazione del modello Question. Di default, fornisce abbastanza campi per 3 scelte.

Carica la pagina «Aggiungi domanda» per vedere come appare:

Funziona in questo modo: Ci sono tre slot per le relative Choices – come specificato dall” extra – e ogni volta torni alla pagina «Change» per un oggetto che è stato già creato, tu vedi altri ricevi slot.

Alla fine dei tre slot, troverai un link «Aggiungi un’altra Choice». Se ci clicchi, un nuovo slot viene aggiunto. Se vuoi rimuovere uno slot aggiunto, puoi cliccare sulla X in alto a destra dello slot aggiunto. Questa immagine mostra lo slot aggiunto:

Un piccolo problema. Occupa molto spazio dello schermo mostrare tutti i campi per inserire i relativi oggetti Choice. Per questo motivo, Django offre un modo tabellare per mostrare i relativi oggetti inline. Per usarlo, cambia la dichiarazione ChoiceInline per leggere:

polls/admin.py

class ChoiceInline(admin.TabularInline): ...

Con questa TabularInline (invece di StackedInline), gli oggetti relativi vengono mostrati in un modo più compatto, in un formato tabellare:

Nota che è presente una ulteriore colonna «Cancellare?» che permette di rimuovere le righe aggiunte con il pulsante «Aggiungi un’altra scelta» e le righe che sono già state salvate.

Personalizzazione della lista per la modifica dell’interfaccia di amministrazione

Ora che la pagina di amministrazione del modello Question sembra buona, facciamo qualche modifica alla pagina di «change list» – quella che mostra tutte le domande nel sistema.

Ecco come appare a questo punto:

By default, Django displays the str() of each object. But sometimes it’d be more helpful if we could display individual fields. To do that, use the list_display admin option, which is a list of field names to display, as columns, on the change list page for the object:

polls/admin.py

class QuestionAdmin(admin.ModelAdmin):
    # ...
    list_display = ["question_text", "pub_date"]

Di buona norma, aggiungiamo il metodo was_published_recently() da Tutorial 2:

polls/admin.py

class QuestionAdmin(admin.ModelAdmin):
    # ...
    list_display = ["question_text", "pub_date", "was_published_recently"]

Ora la pagina di elenco delle domande ha questo aspetto:

Puoi fare click sull’intestazione delle colonne per ordinare quei valori – eccetto nel caso di was_published_recently perchè l’ordinamento dell’output di un metodo non è supportato. Nota anche che l’intestazione di colonna per was_published_recently è, di default, il nome del metodo (con gli underscore a rimpiazzare gli spazi), e che ogni linea contiene la rappresentazione in stringa dell’oggetto.

You can improve that by using the display() decorator on that method (extending the polls/models.py file that was created in Tutorial 2), as follows:

polls/models.py

from django.contrib import admin


class Question(models.Model):
    # ...
    @admin.display(
        boolean=True,
        ordering="pub_date",
        description="Published recently?",
    )
    def was_published_recently(self):
        now = timezone.now()
        return now - datetime.timedelta(days=1) <= self.pub_date <= now

Per più informazioni sulle proprietà configurabili attraverso il decoratore, vedi list_display.

Modifica nuovamente il tuo file polls/admin.py e aggiungi un miglioramento alla pagina dell’elenco di modifiche Domanda: i filtri usando list_filter. Aggiungi la seguente riga in QuestionAdmin:

list_filter = ["pub_date"]

Questo aggiunge una sidebar «Filtra» che permette all’utente di filtrare la lista per il campo pub_date:

Il tipo di filtro visualizzato dipende dal tipo di campo su cui stai filtrando. Poiché pub_date è un DateTimeField, Django sa fornire le opzioni di filtro appropriate: «Qualsiasi data», «Oggi», «Ultimi 7 giorni», «Questo mese», «Quest’anno».

Sta venendo su bene. Aggiungiamo alcune funzionalità di ricerca:

search_fields = ["question_text"]

Ciò aggiunge una casella di ricerca all’inizio dell’elenco delle modifiche. Quando qualcuno inserisce i termini di ricerca, Django cercherà nel campo question_text. Puoi utilizzare tutti i campi che desideri – anche se poiché utilizza una query LIKE dietro le quinte, limitare il numero di campi di ricerca a un numero ragionevole renderà più facile per il tuo database fare la ricerca.

Adesso è anche un buon momento per notare che le liste dei cambiamenti ti danno la paginazione gratis. Di default, mostra 100 elementi per pagina. Change list pagination, search boxes, filters, date-hierarchies, e column-header-ordering lavorano tutti assieme come pensi che dovrebbero.

Personalizza l’aspetto dell’amministrazione

Chiaramente, avere «Django administration» nella parte superiore di ogni pagina di amministrazione è ridicolo. È solo testo segnaposto.

Puoi comunque cambiarlo, usando il sistema di template di Django. L’admin di Django è costruita su Django stesso, e dunque le sue interfacce usano il sistema di template di Django.

Personalizzare i template del tuo progetto

Create a templates directory in your djangotutorial directory. Templates can live anywhere on your filesystem that Django can access. (Django runs as whatever user your server runs.) However, keeping your templates within the project is a good convention to follow.

Apri il tuo file delle impostazioni (mysite/settings.py, ricorda) e aggiungi un’opzione DIRS nell’impostazione TEMPLATES:

mysite/settings.py

TEMPLATES = [
    {
        "BACKEND": "django.template.backends.django.DjangoTemplates",
        "DIRS": [BASE_DIR / "templates"],
        "APP_DIRS": True,
        "OPTIONS": {
            "context_processors": [
                "django.template.context_processors.debug",
                "django.template.context_processors.request",
                "django.contrib.auth.context_processors.auth",
                "django.contrib.messages.context_processors.messages",
            ],
        },
    },
]

DIRS è una lista di directory su disco da controllare quando si caricano i template di Django; è un percorso di ricerca.

Organizzazione dei template

Proprio come i file statici, potremmo avere tutti i nostri modelli insieme, in una grande directory di modelli, e funzionerebbe perfettamente. Tuttavia, i modelli che appartengono a una particolare applicazione dovrebbero essere collocati nella directory dei modelli dell’applicazione(es. polls/templates) piuttosto che in quelli del progetto (templates). Discuteremo più in dettaglio nel reusable apps tutorial perché lo facciamo.

Now create a directory called admin inside templates, and copy the template admin/base_site.html from within the default Django admin template directory in the source code of Django itself (django/contrib/admin/templates) into that directory.

Dove sono i file sorgenti di Django?

Se hai difficoltà a trovare dove si trovano i file sorgente di Django sul tuo sistema, esegui il seguente comando:

Linux/macOS

$ python -c "import django; print(django.__path__)"

Windows

...\> py -c "import django; print(django.__path__)"

Quindi, modifica il file e sostituisci {{ site_header|default:_('Django administration') }} (comprese le parentesi graffe) con il nome del tuo sito come meglio credi. Dovresti finire con una sezione di codice tipo:

{% block branding %}
<div id="site-name"><a href="{% url 'admin:index' %}">Polls Administration</a></div>
{% if user.is_anonymous %}
  {% include "admin/color_theme_toggle.html" %}
{% endif %}
{% endblock %}

Usiamo questo approccio per insegnarti come sovrascrivere i modelli. In un progetto reale, probabilmente useresti l’attributo: django.contrib.admin.AdminSite.site_header per realizzare più facilmente questa particolare personalizzazione.

Questo file di template contiene molto testo come {% block branding %} e {{ title }}. I tag {% e {{ sono parte del linguaggio di template di Django. Quando Django mostra admin/base_site.html, questo linguaggio di template sarà valutato per produrre la pagina HTML finale, come abbiamo visto in Tutorial 3.

Nota che qualsiasi template predefinito del pannello di amministrazione di Django può essere sovrascritto. Per sovrascrivere un template, fai la stessa cosa che hai fatto con base_site.html – copialo dalla directory predefinita nella tua directory personalizzata e apporta le modifiche.

Personalizzare i template della tua applicazione

I lettori più attenti chiederanno: Ma se: l’impostazione: DIRS <TEMPLATES-DIRS> era vuota per impostazione predefinita, come ha fatto Django a trovare i modelli di amministrazione predefiniti? La risposta è che, poiché APP_DIRS è impostato su True, Django cerca automaticamente una sottodirectory templates/ all’interno di ogni pacchetto dell’applicazione, da usare come fallback (non dimenticare che django.contrib.admin è un’applicazione).

La nostra applicazione per i sondaggi non è molto complessa e non necessita di modelli di admin personalizzati. Ma se diventasse più sofisticato e richiedesse la modifica dei modelli di amministrazione standard di Django per alcune delle sue funzionalità, sarebbe più sensato modificare i modelli nell’applicazione, piuttosto che quelli nel progetto. In questo modo, potresti includere l’applicazione sondaggi in qualsiasi nuovo progetto e avere la certezza che troverà i modelli personalizzati di cui ha bisogno.

Vedi la documentazione sul caricamento dei template per ulteriori informazioni su come Django trova i suoi template.

Personalizza l’indice dell’amministrazione

In modo simile, potresti voler personalizzare l’aspetto della pagina dell’indice di amministrazione di Django.

Di default, mostra tutte le app in INSTALLED_APPS che sono state registrate con l’applicazione di admin, in ordine alfabetico. Potresti voler apportare modifiche significative al layout. Dopotutto, l’indice è probabilmente la pagina più importante dell’amministratore e dovrebbe essere facile da usare.

Il modello da personalizzare è admin/index.html. (Fai lo stesso di admin/base_site.html nella sezione precedente - copialo dalla directory predefinita alla directory del tuo modello personalizzato). Modifica il file e vedrai che utilizza una variabile di modello chiamata app_list. Quella variabile contiene tutte le app Django installate. Invece di usarlo, puoi codificare link a pagine di amministrazione specifiche degli oggetti nel modo che ritieni migliore.

When you’re comfortable with the admin, read part 8 of this tutorial to learn how to use third-party packages.