Django Tutorial #3

yjshin·2022년 12월 6일
django
0

Django_Tutorial

목록 보기
3/4

1. 뷰 추가하기

polls/views.py에 뷰를 추가,
이 뷰들은 인수를 ㅂ다기 때문에 조금 모양이 다름.

  • 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)

다음의 path() 호출을 추가하여 이러한 새로운 뷰를 polls.urls 모듈로 연결

  • 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'),
]

브라우저에 "/polls/34/"를 입력해보자.
이 주소에 접속하면 detail() 함수를 호출하여 URL에 입력한 ID를 출력
"/polls/34/results/"와 "/polls/34/vote/"도 실행
투표 결과와 투표 페이지의 뼈대가 되는 페이지가 출력된다.

사용자가 웹사이트의 페이지를 요청할 때, 예로
"/polls/34/"를 요청했다고 하면,
Django는 mysite.urls 파이썬 모듈을 불러오게 된다.

ROOT_URLCONF 설정에 의해 해당 모듈을 바라보도록 지정되어 있기 때문이다.

mysite.urls에서 urlpatterns라는 변수를 찾고, 순서대로 패턴을 따라간다.
'polls/'를 찾은 후엔, 일치하는 텍스트("polls/")를 버리고,
남은 텍스트인 "34/"를 'polls.urls' URLconf로 전달하여 남은 처리를 진행
거기에 '<int:question_id>/' 와 일치하여, 결과적으로 detail() 뷰 함수가 호출

detail(request=<HttpRequest object>, question_id=34)

question_id=34 부분은 <int:question_id>에서 왔다.
꺾쇠 괄호를 사용하면 URL의 일부가 "캡처"되어 키워드 인수로 view 함수에 전송
문자열의 question_id 부분은 일치하는 패턴을 식별하는 데 사용할
이름을 정의하고, int 부분은 URL 경로의 이 부분과 일치하는 패턴을 결정하는 변환기
콜론(:)은 컨버터와 패턴 이름을 구분한다.

2. 뷰가 실제로 뭔가를 하도록 만들기

각 뷰는 두 가지 중 하나를 하도록 되어 있다.
요청된 페이지의 내용이 담긴 HttpResponse 객체를 반환하거나,
혹은 Http404 같은 예외를 발생하게 해야한다.

내가 작성한 뷰는 데이터베이스의 레코드를 읽을 수도 있다.
또한 뷰는 Django나 Python에서 서드파티로 제공되는 템플릿 시스템을 사용할 수도 있다.
뷰는 PDF를 생성하거나, XML을 출력하거나, 실시간으로 ZIP 파일을 만들 수 있다.
뷰는 내가 원하는 무엇이든, Python의 어떤 라이브러리라도 사용할 수 있다.

Django에 필요한 것은 HttpResponse 객체 혹은 예외이다.

왜냐면, 그렇게 다루는게 편리하기 때문이다.
Tutorial 2장의 예제에서 다룬 Django 자체 데이터베이스 API를 사용해보자.
새로운 index() 뷰 하나를 호출했을 때, 시스템에 저장된 최소한 5개의 투표 질문이
콤마로 분리되어, 발행일에 따라 출력된다.

  • polls/views.py
from django.http import HttpResponse

from .models import Question


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)

# Leave the rest of the views (detail, results, vote) unchanged

여기 몇가지 문제가 있다.
뷰에서 페이지의 디자인이 하드코딩 되어 있다고 해보자.

만약 페이지가 보여지는 방식을 바꾸고 싶다면,
이 Python Code를 편집해야만 할 것이다.

그럼, 뷰에서 사용할 수 있는 템플릿을 작성하여,
Python Code로부터 디자인을 분리하도록 Django의 템플릿 시스템을 사용해 보자.

우선, polls 디렉토리에 templates라는 리덱토리를 만든다.
Django는 여기서 템플릿을 찾게 될 것이다.
프로젝트의 TEMPLATES 설정은 Django가 어떻게 템플릿을 불러오고
렌더링 할 것인지 기술한다.
기본설정 파일은 APP_DIRS 옵션이 True로 설정된 DjangoTemplates 백엔드를 구성한다.

관례에 따라,
DjangoTemplates은 각 INSTALLED_APPS 디렉토리의 "templates" 하위 디렉토리를 탐색한다.
방금 만든 templates 디렉토리 내에 templates라는 다른 디렉토리를 만들고 그 안에
index.html이라는 파일을 만든다.

즉 템플릿은 polls/templates/polls/index.html 이어야 한다.
위에서 설명한 것처럼 app_directories 템플릿 로더가 작동하는 방식 때문에
Django 내에 있는 이 템플잇을 polls/index.html로 지칭할 수 있다.

* 템플릿 네임스페이싱

이제 우리는 템플잇을 polls/templates에 직접 넣는 것에서 벗어날 수 있을지도 모르지만
(또 다른 polls 하위 디렉토리를 만드는 것보다는) 실제로는 좋은 생각이 아니다.
Django는 이름이 일치하는 첫 번째 템플릿을 선택하는데 만약 다른 응용 프로그램에
같은 이름의 템플릿이 있으면 Django는 이러한 템플릿을 구별할 수 없다.
Django에게 정확한 템플릿을 지정하기 위해서 가장 편리한 방법은 이름 공간으로
구분짓는 것이다. 이것은 애플리케이션의 이름으로 된 디렉토리에 이러한 템플릿들을 넣으면 된>다.

템플릿에 다음과 같은 코드를 입력한다.

  • 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 %}

*참고
튜토리얼을 짧게 하기 위해 모든 템플릿 예제가 불완전한 HTML을 사용한다.
자신의 프로젝트에서는 complete HTML documents를 사용해야 한다.

이제, 템플릿을 이용하여 polls/views.py에 index 뷰를 업데이트 해보도록 하자.

  • 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]
    template = loader.get_template('polls/index.html')
    context = {
    	'latest_question_list': latest_question_list,
    }
    return HttpResponse(template.render(context, request))

이 코드는 polls/index.html 템플릿을 불러온 후, context를 전달한다.
context는 템플릿에서 쓰이는 변수명과 Python 객체를 연결하는 사전형 값이다.

브라우저에서 "/polls" 페이지를 불러오면, Tutorial 2장에서
작성한 "What's up" 질문이 포함된 리스트가 표시된다.
표시된 질문의 링크는 해당 질문에 대한 세부 페이지를 가리킨다.

지름길: render()

템플릿에 context를 채워넣어 표현한 결과를
HttpResponse 객체와 함께 돌려주는 구문은 자주 쓰는 용법이다.
따라서 Django는 이런 표현을 쉽게 표현할 수 있도록 단축 기능(shortcuts)을 제공하낟.
index() 뷰를 단축 기능으로 작성하면 다음과 같다.

  • polls/views.py
from django.shortcuts import render

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 render(request, 'polls/index.html', context)

모든 뷰에 적용한다면, 더 이상 loader와 HttpRespnse를 임포트하지 않아도 된다.
(만약 detail, results, vote에서 stub 메소드를 가지고 있다면,
HttpResponse를 유지해야 할 것이다.)

render() 함수는 reqeust 객체를 첫 번째 인수로 받고,
템플릿 이름을 두 번째 인수로 받으며,
context 사전형 객체를 세번째 선택적(optional) 인수로 받는다.
인수로 지정된 context로 표현된 템플릿의 HttpResponse 객체가 반환된다.

404 에러 일으키기

질문의 상세 뷰에 태클을 걸어보자.
상세 뷰는 지정된 설문조사의 질문 내용을 보여준다.
코드는 다음과 같다.

  • polls/views.py

from django.http import Http404
from django.shortcuts import render

from .models import Question

# ...

def detail(request, question_id):
	try:
    	question = Question.objects.get(pk=question_id)
    except Question.DoesNotExist:
    	raise Http404("Question does not exist")
    return render(request, 'polls/detail.html', 
    {'question': question})

여기 새로운 내용이 추가 되었다.
뷰는 요청된 질문의 ID가 없을 경우 Http404를 예외 발생 시킨다.

조금 후에 polls/detail.html 템플릿에 무엇을 넣을 수 있는지
논의 하겠지만, 일단 위의 예제를 동작시키기 위해 아래의 내용이
들어있는 파일을 작성

  • polls/templates/polls/detail.html

    question

지름길 : get_object_or_404()

만약 객체가 존재하지 않을 때 get()을 사용하여 Http404 예외를
발생시키는 것은 자주 쓰이는 용법이다.
Django에서 이 기능에 대한 단축 기능을 제공한다.
detail() 뷰를 단축 키능으로 작성하면 다음 코드와 같다.

  • 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})

get_object_or_404() 함수는 Django 모델을 첫 번째 인자로 받고,
몇 개의 키워드 인수를 모델 관리자의 get() 함수에 넘긴다.
만약 객체가 존재하지 않을 경우, Http404 예외가 발생한다.

또한, get_object_or_404() 함수처럼 동작하는 get_list_or_404() 함수가 있다. get() 대신 filter()를 쓴다는 것이 다르다.
리스트가 비어있을 경우, Http404 예외를 발생시킨다.

템플릿 시스템 사용하기

투표 어플리케이션의 detail() 뷰로 되돌아가 보자.
context 변수 question이 주어졌을 때, polls/detail.html이라는 템플릿이 어떻게 보이는지 보자.

  • 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>

템플릿 시스템은 변수의 속성에 접근하기 위해 점-탐색(dot-lookup) 문법을 사용한다.
예제의 {{ question.question_text }} 구문을 보면,
Django는 먼저 question 객체에 대해 사전형으로 탐색한다.
탐색에 실패하게 되면 속성값으로 탐색한다. (이 예제에서는 속성값에서 탐색이 완료됩니다만)
만약 속성 탐색에도 실패한다면 리스트의 인덱스 탐색을 시도하게 된다.

{% for %} 반복 구문에서 메소드 호출이 일어난다.
question.choice_set.all은 Python에서 question.choice_set.all() code로 해석되는데,
이때 반환된 Choice 객체의 반복자는 {% for %}에서 사용하기 적당하다.

템플릿에서 하드코딩된 URL 제거하기

poll/index.html 템플릿에 링크를 적으면, 이 링크는 다음 code와 같이 부분적으로 하드코딩된다는 것을 기억해라.

<li><a href="/polls/{{ question.id }}/">{{ question.question_text }}</a></li>

이러한 강력하게 결합되고 하드코딩된 접근방식의 문제는 수 많은 템플릿을 가진 프로젝트들의
URL을 바꾸는 게 어려운 일이 된다는 점이다.
그러나, polls.urls 모듈의 path() 함수에서 인수의 이름을 정의했으므로,
{% url %} template 태그를 사용하여
url 설정에 정의된 특정한 URL 경로들의 의존성을 제거할 수 있다.

<li><a href="{% url 'detail' question.id %}">{{ question.question_text }}</a></li>

이것이 polls.urls 모듈에 서술된 URL의 정의를 탐색하는 식으로 동작한다.
다음과 같이 'detail'이라는 이름의 URL이 어떻게 정의되어 있는지 확인할 수 있다.

# the 'name' value as called by the {% url %} template tag
path('<int:question_id>/', views.detail, name='detail'),

만약 상세 뷰의 URL을 polls/specifics/12/로 바꾸고 싶다면,
템플릿에서 바꾸는 것이 아니라 polls/urls.py에서 바꿔야 한다.

# added the word 'specifics'
path('specifics/<int:question_id>/', views.detail, name='detail'),

URL의 이름공간 정하기

튜토리얼의 프로젝트는 polls라는 앱 하나만 가지고 진행했다.
실제 Django 프로젝트는 앱이 몇개라도 올 수 있다.
Django는 이 앱들의 URL을 어떻게 구별해 낼 수 있을까?
예를 들어, polls 앱은 detail이라는 뷰를 가지고 있고,
동일한 프로젝트에 블로그를 위한 앱이 있을 수도 있다.
Django가 {% url %} 템플릿 태그를 사용할 때,
어떤 앱의 뷰에서 URL을 생성할지 알 수 있을까?

정답은 URLconf에 이름공간(namespace)을 추가하는 것이다.
polls/urls.py 파일에 app_name을 추가하여 어플리케이션의 이름공간을 설정할 수 있다.

  • 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'),
]

이제, polls/index.html 템플릿의 기존 내용을

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

아래와 같이 이름공간으로 나눠진 상세 뷰를 가리키도록 변경해라

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

view를 작성하는 것에 익숙해졌다면,
part4 of this tutorial에서 폼 처리 및 제너릭 뷰에 대한 기본 사항을 알아보자.

Django Tutorial Part3 Link : https://docs.djangoproject.com/ko/4.1/intro/tutorial03/

profile
yjshin
study
이전 포스트

Django Tutorial #2

다음 포스트

Django Tutorial #4

0개의 댓글