Γράφοντας το πρώτο σας Django app, μέρος 1

Ο μόνος τρόπος να μάθετε να γράφετε Django apps (εφαρμογές) και γενικά να δουλεύετε με το Django είναι μέσα από παραδείγματα.

Μέσα από αυτόν τον οδηγό, θα φτιάξουμε παρέα μία απλή εφαρμογή (application) ψηφοφορίας (poll app). Κάθε ερώτηση θα απαρτίζεται από ένα σετ απαντήσεων, από τις οποίες ο χρήστης θα μπορεί να επιλέξει μία κάθε φορά.

Η εφαρμογή θα αποτελείται από δύο μέρη:

• Ένα κοινό-δημόσιο site που θα επιτρέπει στους χρήστες να βλέπουν τις διαθέσιμες ψηφοφορίες (γκάλοπ, αν προτιμάτε) και να ψηφίζουν.
• Ένα διαχειριστικό (admin) site το οποίο θα επιτρέπει σε εσάς (που θα είστε ο διαχειριστής) να προσθέτετε νέες, να αλλάζετε ήδη υπάρχουσες αλλά και να διαγράφετε ψηφοφορίες.

Υποθέτουμε ότι έχετε ήδη εγκαταστήσει το Django στον υπολογιστή σας. Μπορείτε να δείτε αν το Django έχει εγκατασταθεί (και αν ναι, ποια έκδοση διαθέτετε) πληκτρολογώντας στην κονσόλα (γραμμή εντολών):

$ python -m django --version

Αν το Django είναι εγκατεστημένο, θα δείτε την έκδοση του. Αν δεν είναι, θα δείτε ένα σφάλμα λέγοντας σας ότι “δεν υπάρχει κάποιο module με το όνομα django” (no module named django).

Αυτός ο οδηγός έχει γραφτεί χρησιμοποιώντας την έκδοση 1.11 του Django και με την Python 3.4 ή μεγαλύτερη. Αν η δική σας έκδοση του Django δεν ταιριάζει με την παρούσα, μπορείτε να ανατρέξετε στον αντίστοιχο οδηγό της δικής σας έκδοσης (κάτω δεξιά επιλέγετε έκδοση), ή να αναβαθμίσετε την εγκατεστημένη σας έκδοση του Django στην τρέχουσα σταθερή έκδοση. Αν χρησιμοποιείτε ακόμη την Python 2.7, θα χρειαστεί να κάνετε μερικές αλλαγές στον κώδικα (όπως φαίνεται στα σχόλια) για να λειτουργήσει όπως πρέπει.

Δείτε See πως να εγκαταστήσετε το Django για συμβουλές απεγκατάστασης τυχόν παλιών εκδόσεων και εγκατάστασης της καινούργιας.

Που να ψάξετε για βοήθεια

Αν δυσκολεύεστε να ακολουθήσετε αυτόν τον οδηγό παρακαλούμε στείλτε ένα μήνυμα στους django-users ή μπορείτε να συμμετέχετε στο κανάλι #django του irc.freenode.net για να μιλήσετε με άλλους Django προγραμματιστές οι οποίοι, ενδεχομένως, να θέλουν να σας βοηθήσουν.

Δημιουργία project

Αν αυτή είναι η πρώτη φορά που χρησιμοποιείτε το Django, θα χρειαστεί να ρυθμίσετε κάποια πράγματα στην αρχή. Θυμηθείτε ότι οι σωστές βάσεις δημιουργούν σταθερά σπίτια. Πιο συγκεκριμένα, θα χρειαστεί να τρέξετε μια Django εντολή η οποία θα δημιουργήσει αυτόματα ένα Django project – το οποίο δεν είναι τίποτε άλλο παρά ένας φάκελος (μια συλλογή από ρυθμίσεις, αν θέλετε) που περιέχει διάφορα αρχεία, όπως ρυθμίσεις της βάσης δεδομένων, διάφορες επιλογές του Django και ρυθμίσεις που αφορούν το application σας. Αν μπερδευτήκατε, μην ανησυχείτε, θα διαλευκανθούν όλα καθώς προχωράμε στον οδηγό.

Από κονσόλα τρέξτε την εντολή, cd και τον φάκελο που θα θέλατε να αποθηκευτεί το Django project σας. Μετά τρέξτε την ακόλουθη εντολή:

$ django-admin startproject mysite

Συγχαρητήρια! Μόλις δημιουργήσατε το πρώτο σας Django project. Αυτή η εντολή θα δημιουργήσει αυτόματα (μέσα στον φάκελο που κάνατε cd) ένα φάκελο με το όνομα mysite. Αν δεν δούλεψε, δείτε στα Προβλήματα στην εκτέλεση της εντολής django-admin.

Σημείωση

Θα πρέπει να δώσετε ιδιαίτερη προσοχή στην ονομασία του project σας, προσέχοντας να μην το ονομάσετε με δεσμευμένες λέξεις που χρησιμοποιεί η Python ή το Django. Πιο συγκεκριμένα, θα πρέπει να αποφεύγετε ονομασίες όπως django (κάτι το οποίο θα έρθει σε σύγκρουση με το ίδιο το Django) ή test (το οποίο θα έρθει σε σύγκρουση με το προεγκατεστημένο πακέτο της Python).

Που να αποθηκεύσω το project μου;

Αν στο παρελθόν εργαζόσασταν με PHP (χωρίς τη χρήση κάποιου μοντέρνου framework), τότε μάλλον θα έχετε συνηθίσει να αποθηκεύετε το project σας στον root φάκελο του Web server σας (όπως για παράδειγμα στο /var/www). Με το Django, δεν το κάνετε κατ” αυτό τον τρόπο. Δεν είναι καλή ιδέα να βάλετε οποιοδήποτε κομμάτι του Python κώδικα στο root φάκελο του Web server επειδή αυξάνει την πιθανότητα κάποιοι να μπορούν να δουν τον κώδικα σας μέσω του Web. Αυτό, επίσης, δεν είναι καθόλου καλό όσον αφορά την ασφάλεια (security).

Αντιθέτως, μπορείτε να βάλετε τον κώδικα σας σε κάποιον φάκελο έξω από το root φάκελο του Web server, όπως /home/mycode.

Ας δούμε τώρα τι δημιούργησε η εντολή startproject:

mysite/
    manage.py
    mysite/
        __init__.py
        settings.py
        urls.py
        wsgi.py

Αυτά τα αρχεία είναι:

• Ο φάκελος mysite/ είναι ο root φάκελος του project σας. Το όνομα του δεν ενδιαφέρει το Django. Μπορείτε να το μετονομάσετε όπως θέλετε (είναι το όνομα που δώσατε στην εντολή django-admin startproject).
• manage.py: Αυτό το αρχείο αποτελεί εντολή (κονσόλας) την οποία μπορείτε να χρησιμοποιήσετε (και θα το κάνετε) για να αλληλεπιδράτε με το project σας για διάφορους λόγους (π.χ δημιουργία πινάκων στη database, εκκίνηση του προ-εγκατεστημένου server κλπ). Μπορείτε να διαβάσετε όλες τις λεπτομέρειες σχετικά με το αρχείο manage.py στο django-admin and manage.py.
• Ο εσωτερικός φάκελος mysite/ είναι ένα τυπικό Python package για το project σας. Το όνομα του (έχει σημασία) θα το χρησιμοποιήσετε για να κάνετε import οτιδήποτε σε άλλα Python packages (π.χ import mysite.urls).
• mysite/__init__.py: Ένα κενό αρχείο που λέει στην Python ότι αυτός ο φάκελος θα πρέπει να θεωρηθεί ως Python package. Αν είστε καινούργιος στην Python, διαβάστε περισσότερα σχετικά με τα packages στην επίσημη ιστοσελίδα της Python.
• mysite/settings.py: Ένα αρχείο που κρατά όλες τις ρυθμίσεις/παραμέτρους για αυτό το Django project (είναι η καρδιά ενός project). Το άρθρο Django settings θα σας εξηγήσει όλα όσα χρειάζεστε σχετικά με το πως δουλεύουν οι ρυθμίσεις αυτές.
• mysite/urls.py: Το αρχείο αυτό κρατά τους ορισμούς των URLs για αυτό το project. Με άλλα λόγια είναι ένας «πίνακας περιεχομένων» του Django site σας. Μπορείτε να διαβάστε περισσότερα για τα URLs στο άρθρο URL dispatcher.
• mysite/wsgi.py: Αυτό το αρχείο αποτελεί ένα σημείο εισόδου για τους Web servers οι οποίοι είναι συμβατοί με το WSGI specification. Δείτε περισσότερα στο άρθρο Πως να ανεβάσετε το site σας χρησιμοποιώντας το WSGI για περισσότερες λεπτομέρειες.

Ο development server

Τώρα που δημιουργήσαμε ένα Django project, θα πρέπει να σιγουρευτούμε ότι λειτουργεί. Από κονσόλα (γραμμή εντολών) μεταβείτε στο root φάκελο του project σας (mysite) και τρέξτε την ακόλουθη εντολή:

$ python manage.py runserver

Θα δείτε την ακόλουθη έξοδο, στη κονσόλα:

Performing system checks...

System check identified no issues (0 silenced).

You have unapplied migrations; your app may not work properly until they are applied.
Run 'python manage.py migrate' to apply them.

Δεκεμβρίου 02, 2017 - 15:50:53
Django version 1.11, using settings 'mysite.settings'
Starting development server at http://127.0.0.1:8000/
Quit the server with CONTROL-C.

Σημείωση

Αγνοήστε την προειδοποίηση (warning) περί unapplied migrations προς το παρόν. Θα ασχοληθούμε με αυτό σε λίγο (αφορά την βάση δεδομένων).

Μόλις εκκινήσατε τον Django development server, ένας ελαφρύς Web server γραμμένος αμιγώς σε Python. Συμπεριλάβαμε αυτή τη λειτουργία στο Django για να βλέπετε και να αναπτύσσετε το project σας γρήγορα, χωρίς να χρειαστεί να ασχολείστε με ρυθμίσεις του production server (όπως ο Apache), μέχρις ότου φθάσετε στο σημείο και ανεβάσετε το site σας στο internet.

Τώρα είναι ένα καλό σημείο να σημειωθεί το εξής: ποτέ μα ποτέ μην χρησιμοποιήσετε αυτό τον server (Django developemnt server) σε παραγωγικό περιβάλλον (production environment). Έχει σχεδιαστεί αποκλειστικά για αναπτυξιακούς λόγους (δηλαδή μόνο για να τρέχει τοπικά στον υπολογιστή σας). Εξάλλου εμείς ασχολούμαστε με τη δημιουργία Web frameworks και όχι Web servers.

Τώρα που ο server τρέχει, επισκεφτείτε τη διεύθυνση http://127.0.0.1:8000/ με τον αγαπημένο σας περιηγητή (firefox, chrome κλπ). Θα δείτε μια σελίδα με ένα μήνυμα καλωσορίσματος από το Django σε ανοιχτά μπλε χρώματα. Συγχαρητήρια, δούλεψε!

Αλλαγή της πόρτας

Από προεπιλογή, η εντολή runserver ξεκινά έναν development server στην εσωτερική διεύθυνση IP που ακούει στην πόρτα 8000.

Αν θελήσετε να αλλάξετε την πόρτα, δεν έχετε παρά να το περάσετε ως όρισμα στην εντολή. Για παράδειγμα, η παρακάτω εντολή ξεκινά τον server στην πόρτα 8080:

$ python manage.py runserver 8080

Αν θέλετε, επίσης, να αλλάξετε και την IP του server, εισάγετε τη νέα IP μαζί με την πόρτα. Για παράδειγμα, αν θέλετε ο server να ακούει σε όλες τις public IPs (χρήσιμο όταν χρησιμοποιείται το Vagrant ή όταν θέλετε να δείξετε τη δουλειά σας σε άλλους υπολογιστές στο δικό σας δίκτυο), χρησιμοποιήστε την ακόλουθη εντολή:

$ python manage.py runserver 0:8000

Το 0 είναι μια συντόμευση του 0.0.0.0. Πλήρης τεκμηρίωση για τον development server μπορεί να βρεθεί στην αναφορά runserver.

Αυτόματη ανανέωση του runserver

Ο development server ανανεώνεται (reloads) αυτόματα κάθε φορά που αποθηκεύετε ή αλλάζετε κάποιο αρχείο (φυσικά μέσα στο project σας). Με αυτό τον τρόπο δεν χρειάζεται να κάνετε χειροκίνητα το reload του server για να δεχτεί τυχόν αλλαγές που πραγματοποιήθηκαν. Ωστόσο, υπάρχουν περιπτώσεις που ο server δεν ανανεώνεται αυτόματα, όπως στην προσθήκη ή αφαίρεση κάποιου αρχείου. Εκεί πρέπει να γίνει χειροκίνητα η επαναφόρτωση του server.

Δημιουργώντας το app ψηφοφορίας

Τώρα που το περιβάλλον εργασίας σας – το «project» – είναι έτοιμο, μπορείτε να ξεκινήσετε να δημιουργείτε.

Κάθε application που γράφετε στο Django αποτελείται από ένα Python package (ένας φάκελος που περιέχει το αρχείο __init__.py) το οποίο πρέπει να ακολουθεί ορισμένους κανόνες. Για άλλη μια φορά, το Django σας παρέχει την ανάλογη εντολή για να δημιουργήσετε αυτόματα τη δομή αυτού του φακέλου (Python package) ούτως ώστε να επικεντρωθείτε στο να γράψετε κώδικα παρά στο να δημιουργείτε φακέλους και υποφακέλους.

Projects vs. apps

Πολύ πιθανόν μέχρι τώρα να έχετε αναρωτηθεί ποια η διαφορά ανάμεσα σε ένα project και ένα app. Η εφαρμογή (app ή application αν θέλετε) είναι μια Web εφαρμογή που κάνει κάτι – π.χ, ένα σύστημα Weblog, μια database που κρατάει δεδομένα διαθέσιμα προς το ευρύ κοινό, ένα καλάθι από ένα e-shop ή μια απλή εφαρμογή ψηφοφορίας. Το project είναι μια συλλογή από διάφορες επιλογές/παραμέτρους και εφαρμογές για ένα συγκεκριμένο website. Ένα project μπορεί να περιέχει πολλαπλές εφαρμογές. Ομοίως, ένα app μπορεί να εμπεριέχεται σε πολλαπλά projects.

Τα apps σας μπορούν να βρίσκονται οπουδήποτε ορίζει το Python path σας. Σε αυτό τον οδηγό, θα δημιουργήσουμε το app ψηφοφορίας (το φάκελο δηλαδή) στην ίδια θέση που βρίσκεται και το αρχείο manage.py προκειμένου να μπορεί να γίνει imported ως ένα δικό του top-level module, παρά ένα submodule του mysite. Θα καταλάβετε τι εννοούμε με αυτό στη συνέχεια.

Για να δημιουργήσετε το app, σιγουρευτείτε ότι βρίσκεστε στο ίδιο επίπεδο με το αρχείο manage.py και πληκτρολογήστε την εντολή:

$ python manage.py startapp polls

Συγχαρητήρια και πάλι! Μόλις φτιάξατε την πρώτη σας εφαρμογή στο Django. Βέβαια δεν κάνει τίποτα ακόμα αλλά θα φτάσουμε και εκεί. Η εντολή θα δημιουργήσει ένα φάκελο polls, ο οποίος αναπτύσσεται ως εξής:

polls/
    __init__.py
    admin.py
    apps.py
    migrations/
        __init__.py
    models.py
    tests.py
    views.py

Αυτή η δομή θα εσωκλείει ολόκληρη την εφαρμογή μας.

Γράφοντας το πρώτο σας view

Ας γράψουμε το πρώτο μας view. Ανοίξτε το αρχείο polls/views.py και γράψτε τον ακόλουθο Python κώδικα:

polls/views.py

from django.http import HttpResponse


def index(request):
    return HttpResponse("Hello, world. You're at the polls index.")

Αυτή είναι η πιο απλή μορφή view στο Django. Για να καλέσετε το view, θα πρέπει να το συσχετίσουμε με ένα URL - και γι” αυτό θα χρειαστούμε ένα URLconf.

Για τη δημιουργία του URLconf στον φάκελο polls, δημιουργήστε ένα αρχείο με το όνομα urls.py. Ο φάκελος της εφαρμογής σας θα πρέπει να δείχνει έτσι:

polls/
    __init__.py
    admin.py
    apps.py
    migrations/
        __init__.py
    models.py
    tests.py
    urls.py
    views.py

Μέσα στο αρχείο polls/urls.py συμπεριλάβετε τον παρακάτω κώδικα:

polls/urls.py

from django.conf.urls import url

from . import views

urlpatterns = [
    url(r'^$', views.index, name='index'),
]

Το επόμενο βήμα είναι να συσχετίσουμε το URLconf που υπάρχει στο φάκελο mysite του project μας (mysite/mysite/urls.py) με αυτό που υπάρχει στο polls app (mysite/polls/urls.py). Στο αρχείο mysite/urls.py, προσθέστε ένα import για το django.conf.urls.include και προσθέστε τη συνάρτηση include() μέσα στην λίστα urlpatterns. Δηλαδή:

mysite/urls.py

from django.conf.urls import include, url
from django.contrib import admin

urlpatterns = [
    url(r'^polls/', include('polls.urls')),
    url(r'^admin/', admin.site.urls),
]

Η συνάρτηση include() επιτρέπει να αναφερθούμε σε άλλα URLconfs. Σημειώστε ότι τα regular expressions για τη συνάρτηση include() δεν περιέχουν το $ (ταίριασμα του τέλους ενός string) αλλά μία καταληκτική κάθετο (/). Οποτεδήποτε το Django συναντήσει τη συνάρτηση include(), κόβει το κομμάτι (από ολόκληρο το URL που ζητήθηκε) που έχει ταιριάξει μέχρι τώρα και στέλνει το υπόλοιπο στο περιλαμβανόμενο URLconf για περαιτέρω επεξεργασία.

Η ιδέα πίσω από την include() είναι να κάνουμε εύκολη τη σύνδεση και άμεση λειτουργία (plug-and-play) των URLs. Εφόσον οι ψηφοφορίες έχουν το δικό τους URLconf (polls/urls.py), τότε το URL που θα οδηγεί σε αυτές μπορεί να είναι το «/polls/», ή το «/fun_polls/», ή «/content/polls/» ή οτιδήποτε άλλο νομίζετε. Ότι και να χρησιμοποιήσετε το app σας θα λειτουργεί!

Πότε να χρησιμοποιήσετε τη συνάρτηση include()

Θα πρέπει πάντα να χρησιμοποιείτε στην include() όταν θέλετε να περιλάβετε άλλα URL patterns. Το admin.site.urls είναι η μόνη εξαίρεση σε αυτό τον κανόνα.

Βλέπετε διαφορετικό urls.py;

Αν βλέπετε include(admin.site.urls) αντί για admin.site.urls, τότε πιθανόν να χρησιμοποιείτε μια έκδοση του Django διαφορετική από αυτό τον οδηγό. Ίσως θα θέλατε να κοιτάξετε ένα παλαιότερο οδηγό (επιλογή έκδοσης κάτω δεξιά της οθόνης) ή να αναβαθμίσετε το Django στην καινούργια έκδοση.

Τώρα έχετε συνδέσει την index view με το URLconf. Ας επιβεβαιώσουμε ότι όλα λειτουργούν, τρέχοντας τον development server:

$ python manage.py runserver

Επισκεφτείτε την σελίδα http://localhost:8000/polls/ με τον browser σας και θα πρέπει να δείτε το κείμενο «Hello, world. You’re at the polls index.», το οποίο γράψαμε στην index view.

Η συνάρτηση url() δέχεται τέσσερα ορίσματα (arguments), δύο από τα οποία είναι απαραίτητα: το regex και το view, ενώ τα άλλα δύο είναι προαιρετικά: τα kwargs και το name. Σε αυτό το σημείο αξίζει να αναφερθούμε σε καθένα από αυτά τα ορίσματα καθώς είναι πολύ σημαντικά.

url() argument: regex

Ο όρος «regex» αναφέρεται συνήθως ως αρκτικόλεξο του «regular expression», το οποίο είναι ένα είδους συντακτικό για ταίριασμα χαρακτήρων μέσα σε strings ή στην προκειμένη περίπτωση για ταίριασμα url μοτίβων (url patterns). Το Django ξεκινά να διαβάζει με τη σειρά όλα τα regexes ξεκινώντας από το πρώτο, συγκρίνοντας το ζητούμενο URL (π.χ ο χρήστης έβαλε στη γραμμή διευθύνσεων το http://www.example.com/info/contact) με κάθε regular expression μέχρι να βρει ένα που να ταιριάζει.

Σημειώστε ότι αυτά τα regular expressions δεν ψάχνουν σε GET ή POST παραμέτρους ή στο domain name. Για παράδειγμα, για ένα request στο https://www.example.com/myapp/, το URLconf θα κοιτάξει στο myapp/. Για ένα request στο https://www.example.com/myapp/?page=3, το URLconf θα κοιτάξει, επίσης, στο myapp/.

Αν χρειάζεστε βοήθεια με τα regular expressions, δείτε το άρθρο στο Wikipedia και το εγχειρίδιο (documentation) στο module re της Python. Επίσης, το βιβλίο των εκδόσεων O’Reilly με τον τίτλο «Mastering Regular Expressions» από τον Jeffrey Friedl είναι κάτι παραπάνω από φανταστικό. Στην πράξη, ωστόσο, δεν χρειάζεται να είστε ειδήμων στις regular expressions, καθώς το πιο συνήθες πράγμα που θα κάνετε είναι να αιχμαλωτίζετε απλά μοτίβα. Στην πραγματικότητα, οι πολύπλοκες regexes μπορούν να επιδράσουν αρνητικά στην επίδοση του ψαξίματος για το αντίστοιχο URL. Οπότε, το πιο πιθανό είναι ότι δεν θα χρειαστείτε όλη τη δύναμη των regexes.

Για το τέλος, μια σημείωση σχετικά με την επίδοση: αυτά τα regular expressions μεταγλωττίζονται (compiled) την πρώτη φορά που το URLconf module φορτώνεται. Αυτό τα καθιστά εξαιρετικά γρήγορα από άποψη ταχύτητας (εφόσον τα μοτίβα δεν είναι περίπλοκα, όπως αναφέρθηκε παραπάνω).

url() argument: view

Όταν το Django βρει καποιο regular expression που να ταιριάζει με το ζητούμενο URL, καλεί την εκάστοτε δηλωμένη view συνάρτηση, με ένα HttpRequest object ως πρώτο όρισμα και τυχόν “αιχμάλωτες” τιμές από τα regular expressions ως τα υπόλοιπα ορίσματα. Αν τα regexes χρησιμοποιούν απλά captures, τότε οι τιμές περνούν ως positional arguments. Αν, από την άλλη, χρησιμοποιούν named captures, τότε οι τιμές περνούν ως keyword arguments. Θα δώσουμε ένα παράδειγμα αυτού σε επόμενο οδηγό.

url() argument: kwargs

Επίσης, στο Django view μπορούν να περαστούν, προαιρετικά και αυθαίρετα keyword arguments. Σε αυτό τον οδηγό δεν θα χρησιμοποιήσουμε αυτή τη δυνατότητα.

url() argument: name

Υπάρχει επίσης το πολύ δυνατό χαρακτηριστικό του Django, με το οποίο μπορείτε να ονομάσετε τα URL σας και να αναφέρεστε σε αυτά μόνο με το όνομα τους παρά με την διεύθυνση τους. Αυτό, θα το χρησιμοποιείτε συνέχεια στα templates σας (π.χ μέσα σε ένα <a href> HTML tag). Με αυτό τον τρόπο μπορείτε να αλλάζετε τις διευθύνσεις των URL πειράζοντας μόνο ένα αρχείο (urls.py) παρά να ψάχνετε σε άλλα μέρη (π.χ στα template σας) για να ανανεώσετε το URL (αφού, αλλιώς θα είχατε γράψει ολόκληρη τη διεύθυνση URL).

Όταν αισθανθείτε άνετα με αυτό τον οδηγό και με τη λειτουργία της Web request-Web response διαδικασίας μπορείτε να συνεχίσετε στο δεύτερο μέρος αυτού του οδηγού για να εργαστείτε με τη βάση δεδομένων.