Page History

...

$ cd my_project

STEP 1. Create an application

In order to create an app, you will need "manage.py" created by Django. Once you verify it, you can create "online poll" app by running below command.

...

So above directory will be your base camp for "online poll" application.

STEP 2. Creating a first view

Let us open views.py and add some codes like below.

...

If you face an error like below, you should check if your python is properly installed and django is running on virtual environment like I mentioned at "How do I setup Django development environment on Mac?" or not.

STEP 3. Database setup

If everything goes fine, now is time for us to setup a database where can store poll results. Let us do it step by step.

1. Open up settings.py on your project, and you can see the default database settings like below
   
   

   Code Block
   title settings.py
   # Database # https://docs.djangoproject.com/en/2.1/ref/settings/#databases DATABASES = { 'default': { 'ENGINE': 'django.db.backends.sqlite3', 'NAME': os.path.join(BASE_DIR, 'db.sqlite3'), } }

   If you want to use mysql instead of sqlite3, you can use it by replacing as "django.db.backends.mysql". For oracle, it will be "django.db.backends.oracle". 
   If you are not using SQLite as your database, additional settings such as USER, PASSWORD, and HOST must be added. For more details, see the reference documentation for DATABASES.
   

   Expand
   Example) Code Block language py title settings.py DATABASES = { 'default': { 'ENGINE': 'django.db.backends.postgresql', 'USER': 'mydatabaseuser', 'NAME': 'mydatabase', 'TEST': { 'NAME': 'mytestdatabase', }, }, }

   
   Once you set all your requirements, you should run following command.

   Code Block
   python manage.py migrate

   
   

2. Creating models for online poll.

   In our simple poll app, we’ll create two models: Question and Choice. A Question has a question and a publication date. A Choice has two fields: the text of the choice and a vote tally. Each Choice is associated with a Question.

   These concepts are represented by simple Python classes. Edit the polls/models.py file so it looks like this:

   Code Block
   title polls/models.py
   from django.db import models # Create your models here. class Question(models.Model): question_text = models.CharField(max_length=200) pub_date = models.DateTimeField('date published') def __str__(self): return self.question_text class Choice(models.Model): question = models.ForeignKey(Question, on_delete=models.CASCADE) choice_text = models.CharField(max_length=200) votes = models.IntegerField(default=0) def __str__(self): return self.choice_text

   If you see above, it looks like a table schema when we create a table in database. I won't elaborate the detail about above for this time.
   
   

3. Activating models
   Even though we have created an app at the moment, but actually we can't say "polls" are correctly integrated with the project. In django, we should make some additional action to make it happen.
   To include the app in our project, we need to add a reference to its configuration class in the INSTALLED_APPS setting. The PollsConfig class is in the polls/apps.py file,

   Code Block
   language py title polls/apps.py
   from django.apps import AppConfig class PollsConfig(AppConfig): name = 'polls'

   
   so its dotted path is 'polls.apps.PollsConfig'. Edit the <your project folder>/settings.py file and add that dotted path to the INSTALLED_APPS setting. It’ll look like this:

   Code Block
   title <your project folder>/settings.py
   INSTALLED_APPS = [ 'polls.apps.PollsConfig', 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', ]

   Note that 'polls.apps.PollsConfig' is added on top of 'django.contrib.admin'.

   Now Django knows to include the polls app. Let’s run another command:

   Code Block
   python manage.py makemigrations polls

   As a result, you should see similar to the following

   Code Block
   Migrations for 'polls': polls/migrations/0001_initial.py - Create model Choice - Create model Question - Add field question to choice

   By running makemigrations, you’re telling Django that you’ve made some changes to your models (in this case, you’ve made new ones) and that you’d like the changes to be stored as a migration.

   Migrations are how Django stores changes to your models (and thus your database schema) - they’re just files on disk. You can read the migration for your new model if you like; it’s the file polls/migrations/0001_initial.py. Don’t worry, you’re not expected to read them every time Django makes one, but they’re designed to be human-editable in case you want to manually tweak how Django changes things.

   There’s a command that will run the migrations for you and manage your database schema automatically - that’s called migrate, and we’ll come to it in a moment - but first, let’s see what SQL that migration would run. The sqlmigrate command takes migration names and returns their SQL:

   Code Block
   python manage.py sqlmigrate polls 0001

   As a result, you should see similar to the following

   Code Block
   language sql
   BEGIN; -- -- Create model Choice -- CREATE TABLE "polls_choice" ("id" integer NOT NULL PRIMARY KEY AUTOINCREMENT, "choice_text" varchar(200) NOT NULL, "votes" integer NOT NULL); -- -- Create model Question -- CREATE TABLE "polls_question" ("id" integer NOT NULL PRIMARY KEY AUTOINCREMENT, "question_text" varchar(200) NOT NULL, "pub_date" datetime NOT NULL); -- -- Add field question to choice -- ALTER TABLE "polls_choice" RENAME TO "polls_choice__old"; CREATE TABLE "polls_choice" ("id" integer NOT NULL PRIMARY KEY AUTOINCREMENT, "choice_text" varchar(200) NOT NULL, "votes" integer NOT NULL, "question_id" integer NOT NULL REFERENCES "polls_question" ("id") DEFERRABLE INITIALLY DEFERRED); INSERT INTO "polls_choice" ("id", "choice_text", "votes", "question_id") SELECT "id", "choice_text", "votes", NULL FROM "polls_choice__old"; DROP TABLE "polls_choice__old"; CREATE INDEX "polls_choice_question_id_c5b4b260" ON "polls_choice" ("question_id"); COMMIT;

   Now, run migrate again to create those model tables in your database:

   Code Block
   python manage.py migrate

   You will see following similar results if everything goes fine.

   Code Block
   Operations to perform: Apply all migrations: admin, auth, contenttypes, polls, sessions Running migrations: Applying polls.0001_initial... OK

   
   

   Info
   But for now, remember the three-step guide to making model changes: Change your models (in models.py). Run python manage.py makemigrations to create migrations for those changes Run python manage.py migrate to apply those changes to the database.

   
   

4. Playing with the API
   Now, let’s hop into the interactive Python shell and play around with the free API Django gives you. To invoke the Python shell, use this command:

   Code Block
   python manage.py shell

   Once you’re in the shell, explore the database API:

   Code Block

   >>> from polls.models import Choice, Question >>> Question.objects.all() <QuerySet []> >>> from django.utils import timezone >>> q = Question(question_text="What's new?", pub_date=timezone.now()) >>> q.save() >>> q.id 1 >>> q.question_text "What's new?" >>> q.pub_date datetime.datetime(2018, 11, 10, 5, 29, 23, 419109, tzinfo=<UTC>) >>> q.question_text = "What's up?" >>> q.save() >>> Question.objects.all() <QuerySet [<Question: Question object (1)>]>

   If everything is okay, you will see the same result except q.pub_date, because that will be based on your current timezone.
   In addition, let us add more features in polls/models.py like below
   
   

   Code Block
   title polls/modes.py
   import datetime from django.db import models from django.utils import timezone # Create your models here. class Question(models.Model): question_text = models.CharField(max_length=200) pub_date = models.DateTimeField('date published') def __str__(self): return self.question_text def was_published_recently(self): return self.pub_date >= timezone.now() - datetime.timedelta(days=1) class Choice(models.Model): question = models.ForeignKey(Question, on_delete=models.CASCADE) choice_text = models.CharField(max_length=200) votes = models.IntegerField(default=0) def __str__(self): return self.choice_text

   Note that we imported datetime and timezone from django.utils to implement three additional functions on Question and Choice.
   Save these changes and start a new Python interactive shell by running python manage.py shell again:

   Code Block

   >>> from polls.models import Choice, Question >>> Question.objects.all() <QuerySet [<Question: What's up?>]> >>> Question.objects.filter(id=1) <QuerySet [<Question: What's up?>]> >>> Question.objects.filter(question_text__startswith='What') <QuerySet [<Question: What's up?>]> >>> from django.utils import timezone >>> current_year = timezone.now().year >>> Question.objects.get(pub_date__year=current_year) <Question: What's up?> >>> Question.objects.get(id=2) Traceback (most recent call last): File "<console>", line 1, in <module> File "/Users/..../env/lib/python3.7/site-packages/django/db/models/manager.py", line 82, in manager_method return getattr(self.get_queryset(), name)(*args, **kwargs) File "/Users/..../env/lib/python3.7/site-packages/django/db/models/query.py", line 399, in get self.model._meta.object_name polls.models.Question.DoesNotExist: Question matching query does not exist. >>> Question.objects.get(pk=1) <Question: What's up?> >>> q = Question.objects.get(pk=1) >>> q.was_published_recently() True >>> q = Question.objects.get(pk=1) >>> q.choice_set.all() <QuerySet []> >>> q.choice_set.create(choice_text='Not much', votes=0) <Choice: Not much> >>> q.choice_set.create(choice_text='The sky', votes=0) <Choice: The sky> >>> c = q.choice_set.create(choice_text='Just hacking again', votes=0) >>> c.question <Question: What's up?> >>> q.choice_set.all() <QuerySet [<Choice: Not much>, <Choice: The sky>, <Choice: Just hacking again>]> >>> q.choice_set.count() 3 >>> Choice.objects.filter(question__pub_date__year=current_year) <QuerySet [<Choice: Not much>, <Choice: The sky>, <Choice: Just hacking again>]> >>> c = q.choice_set.filter(choice_text__startswith='Just hacking') >>> c.delete() (1, {'polls.Choice': 1})

   
   

5. Creating an admin user
   

   First we’ll need to create a user who can login to the admin site. Run the following command:

   Code Block
   python manage.py createsuperuser

   Enter your desired username and press enter.

   Code Block
   Username: admin

   You will then be prompted for your desired email address:

   Code Block
   Email address: admin@example.com

   The final step is to enter your password. You will be asked to enter your password twice, the second time as a confirmation of the first.

   Code Block
   Password: ********** Password (again): ********* Superuser created successfully.

   
   

6. Start the development server
   The Django admin site is activated by default. Let’s start the development server and explore it.

   If the server is not running start it like so:
   
   

   Code Block
   python manage.py runserver

   Now, open a Web browser and go to “/admin/” on your local domain – e.g., http://127.0.0.1:8000/admin/. You should see the admin’s login screen:
   
   

7. Enter the admin site
   If everything is okay, you will see following screen
   
   
   
   

8. Make the poll app modifiable in the admin
   Even though we created an app, that is not appeared on the admin index page.
   Just one thing to do: we need to tell the admin that Question objects have an admin interface. To do this, open the polls/admin.py file, and edit it to look like this:

   Code Block
   from django.contrib import admin # Register your models here. from .models import Question admin.site.register(Question)

   
   

9. Explore the free admin functionality 
   

   Now that we’ve registered Question, Django knows that it should be displayed on the admin index page:
   
   

   Click “Questions”. Now you’re at the “change list” page for questions. This page displays all the questions in the database and lets you choose one to change it. There’s the “What’s up?” question we created earlier:
   
   Click the “What’s up?” question to edit it:
   
   Note that the form is automatically generated from the Question model. I haven't seen such a kind software model in another software languages. 

STEP 4. Writing more views with Templates

In Django, web pages and other content are delivered by views. Each view is represented by a simple Python function (or method, in the case of class-based views). Django will choose a view by examining the URL that’s requested (to be precise, the part of the URL after the domain name).

...

1. Let’s add a few more views to polls/views.py. These views are slightly different, because they take an argument:

   Code Block
   title polls/views.py
   def detail(request, question_id): return HttpResponse("You're looking at question %s." % question_id) def results(request, question_id): response = "You're looking at the results of question %s." return HttpResponse(response % question_id) def vote(request, question_id): return HttpResponse("You're voting on question %s." % question_id)

   Wire these new views into the polls.urls module by adding the following path() calls:

   Code Block
   title polls/urls.py
   from django.urls import path from . import views urlpatterns = [ # ex: /polls/ path('', views.index, name='index'), # ex: /polls/5/ path('<int:question_id>/', views.detail, name='detail'), # ex: /polls/5/results/ path('<int:question_id>/results/', views.results, name='results'), # ex: /polls/5/vote/ path('<int:question_id>/vote/', views.vote, name='vote'), ]

   Take a look in your browser, at “/polls/34/”. It’ll run the detail() method and display whatever ID you provide in the URL. Try “/polls/34/results/” and “/polls/34/vote/” too – these will display the placeholder results and voting pages.

2. Here’s one stab at a new index() view, which displays the latest 5 poll questions in the system, separated by commas, according to publication date:

   Code Block
   title polls/urls.py
   def index(request): latest_question_list = Question.objects.order_by('-pub_date')[:5] output = ', '.join([q.question_text for q in latest_question_list]) return HttpResponse(output)

   There’s a problem here, though: the page’s design is hard-coded in the view. If you want to change the way the page looks, you’ll have to edit this Python code. So let’s use Django’s template system to separate the design from Python by creating a template that the view can use.
   
   

3. Create a directory called templates in your polls directory. Django will look for templates in there.
   Within the templates directory you have just created, create another directory called polls, and within that create a file called index.html. In other words, your template should be at polls/templates/polls/index.html. Because of how the app_directories template loader works as described above, you can refer to this template within Django simply as polls/index.html.

   Code Block
   title polls/templates/polls/index.html
   {% if latest_question_list %} <ul> {% for question in latest_question_list %} <li><a href="/polls/{{ question.id }}/">{{ question.question_text }}</a></li> {% endfor %} </ul> {% else %} <p>No polls are available.</p> {% endif %}

   The problem above is the URL is hardcoded - it may not critical, but let us add more flexibility by the defined argument in the path() function in  the polls.urls module, so you can remove a reliance on specific URL paths defined in your url configurations by using the {% url %} template tag like below:

   Code Block
   {% if latest_question_list %} <ul> {% for question in latest_question_list %} <li><a href="{% url 'detail' question.id %}">{{ question.question_text }}</a></li> {% endfor %} </ul> {% else %} <p>No polls are available.</p> {% endif %}

   
   Now let’s update our index view in polls/views.py to use the template:

   Code Block
   title polls/views.py
   from django.http import HttpResponse from django.template import loader from .models import Question . . . def index(request): latest_question_list = Question.objects.order_by('-pub_date')[:5] context = {'latest_question_list': latest_question_list} return HttpResponse(request, 'polls/index.html', context)

   
   

4. Raising a 404 error
   Now, let’s tackle the question detail view – the page that displays the question text for a given poll. Here’s the view:

   Code Block
   title polls/views.py
   from django.shortcuts import get_object_or_404, render from .models import Question . . . def detail(request, question_id): question = get_object_or_404(Question, pk=question_id) return render(request, 'polls/detail.html', {'question': question})

   And you will need to have detail.html on template

   Code Block
   title polls/templates/polls/detail.html
   <h1>{{ question.question_text }}</h1> <ul> {% for choice in question.choice_set.all %} <li>{{ choice.choice_text }}</li> {% endfor %} </ul>

   
   

5. Removing hardcoded URLs in templates by app_name as namespace

   The tutorial project has just one app, polls. In real Django projects, there might be five, ten, twenty apps or more. How does Django differentiate the URL names between them? For example, the polls app has a detail view, and so might an app on the same project that is for a blog. How does one make it so that Django knows which app view to create for a url when using the {% url %} template tag?

   The answer is to add namespaces to your URLconf. In the polls/urls.py file, go ahead and add an app_name to set the application namespace:

   Code Block
   language py title polls/urls.py
   from django.urls import path from . import views app_name = 'polls' urlpatterns = [ path('', views.index, name='index'), path('<int:question_id>/', views.detail, name='detail'), path('<int:question_id>/results/', views.results, name='results'), path('<int:question_id>/vote/', views.vote, name='vote'), ]

   
   Now change your polls/index.html template from:

   Code Block
   title polls/templates/polls/index.html
   <li><a href="{% url 'detail' question.id %}">{{ question.question_text }}</a></li>

   to point at the namespaced detail view:

   Code Block
   title polls/templates/polls/index.html
   <li><a href="{% url 'polls:detail' question.id %}">{{ question.question_text }}</a></li>

   
   

6. Write a simple form
   Let’s update our poll detail template (“polls/detail.html”) from the last tutorial, so that the template contains an HTML <form> element:

   Code Block
   language py title polls/templates/polls/detail.html
   <h1>{{ question.question_text }}</h1> {% if error_message %}<p><strong>{{ error_message }}</strong></p>{% endif %} <form action="{% url 'polls:vote' question.id %}" method="post"> {% csrf_token %} {% for choice in question.choice_set.all %} <input type="radio" name="choice" id="choice{{ forloop.counter }}" value="{{ choice.id }}"> <label for="choice{{ forloop.counter }}">{{ choice.choice_text }}</label><br> {% endfor %} <input type="submit" value="Vote"> </form>

    Note that we’re creating a POST form (which can have the effect of modifying data), we need to worry about Cross Site Request Forgeries. Thankfully, you don’t have to worry too hard, because Django comes with a very easy-to-use system for protecting against it. In short, all POST forms that are targeted at internal URLs should use the {%csrf_token %} template tag
   
   

7. We also created a dummy implementation of the vote() function. Let’s create a real version. Add the following to polls/views.py:

   Code Block
   language py title polls/views.py
   from django.http import HttpResponse, HttpResponseRedirect from django.shortcuts import get_object_or_404, render from django.urls import reverse from .models import Choice, Question . . . def vote(request, question_id): question = get_object_or_404(Question, pk=question_id) try: selected_choice = question.choice_set.get(pk=request.POST['choice']) except (KeyError, Choice.DoesNotExist): # Redisplay the question voting form. return render(request, 'polls/detail.html', { 'question': question, 'error_message': "You didn't select a choice.", }) else: selected_choice.votes += 1 selected_choice.save() # Always return an HttpResponseRedirect after successfully dealing # with POST data. This prevents data from being posted twice if a # user hits the Back button. return HttpResponseRedirect(reverse('polls:results', args=(question.id,)))

    Note that  we are using the reverse() function in the HttpResponseRedirect constructor in this example. This function helps avoid having to hardcode a URL in the view function. It is given the name of the view that we want to pass control to and the variable portion of the URL pattern that points to that view. In this case, using the URLconf we set up previously, this reverse() call will return a string like

   Code Block
   '/polls/3/results/'

   where the 3 is the value of question.id. This redirected URL will then call the 'results' view to display the final page.

   After somebody votes in a question, the vote() view redirects to the results page for the question. Let’s write that view:

   Code Block
   language py title polls/views.py
   from django.shortcuts import get_object_or_404, render def results(request, question_id): question = get_object_or_404(Question, pk=question_id) return render(request, 'polls/results.html', {'question': question})

   This is almost exactly the same as the detail() view previously. The only difference is the template name. We’ll fix this redundancy later.

   Now, create a polls/results.html template:

   Code Block
   language py title polls/templates/polls/results.html
   <h1>{{ question.question_text }}</h1> <ul> {% for choice in question.choice_set.all %} <li>{{ choice.choice_text }} -- {{ choice.votes }} vote{{ choice.votes|pluralize }}</li> {% endfor %} </ul> <a href="{% url 'polls:detail' question.id %}">Vote again?</a>

   Now, go to /polls/1/ in your browser and vote in the question. You should see a results page that gets updated each time you vote. If you submit the form without having chosen a choice, you should see the error message.

STEP 5. Optimizing code in Python way - less code is better

The detail() and results() views are very simple – and, as mentioned above, redundant. The index() view, which displays a list of polls, is similar.

...