Формы Django

HTML-формы — это классический способ достижения интерактивности на веб-сайтах. В этой главе будет рассказано, как использовать Django для обработки данных формы, отправленных пользователями.


HTTP-запрос

Протокол HTTP работает по принципу «запрос-ответ». Когда клиент отправляет запрос, он может прикрепить данные к запросу. Разбирая запрос, сервер может получить данные, отправленные клиентом, и предоставить определённые услуги на основе URL.

Метод GET

В нашем предыдущем проекте создайте файл search.py для приёма запросов пользователей:

/HelloWorld/HelloWorld/search.py код файла:

from django.http import HttpResponse from django.shortcuts import render # Форма def search_form(request): return render(request, 'search_form.html') # Получение данных запроса def search(request): request.encoding='utf-8' if 'q' in request.GET and request.GET['q']: message = 'Содержимое, которое вы искали:' + request.GET['q'] else: message = 'Вы отправили пустую форму' return HttpResponse(message)

Добавьте форму search_form.html в каталог templates:

Код файла /HelloWorld/templates/search_form.html:

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Пример (example.com)</title> </head> <body> <form action="/search/" method="get"> <input type="text" name="q"> <input type="submit" value="Search"> </form> </body> </html>

Измените правила urls.py на следующую форму:

/HelloWorld/HelloWorld/urls.py код файла:

from django.conf.urls import url from . import views,testdb,search urlpatterns = [ url(r'^hello/$', views.example), url(r'^testdb/$', testdb.testdb), url(r'^search-form/$', search.search_form), url(r'^search/$', search.search), ]

Адрес доступаhttp://127.0.0.1:8000/search-form/И выполните поиск, результаты будут следующими:

Метод POST

Выше мы использовали метод GET, а отображение представления и обработка запроса выполняются двумя отдельными функциями.

При отправке данных чаще используется метод POST. Ниже мы используем этот метод и применяем один URL и одну функцию-обработчик как для отображения представления, так и для обработки запроса.

Мы создаём post.html в templates:

Код файла /HelloWorld/templates/post.html:

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Пример (example.com)</title> </head> <body> <form action="/search-post/" method="post"> {% csrf_token %} <input type="text" name="q"> <input type="submit" value="Search"> </form> <p>{{ rlt }}</p> </body> </html>

В конце шаблона мы добавляем маркер rlt, чтобы зарезервировать место для результата обработки формы.

После формы также есть{% csrf_token %}тег. CSRF расшифровывается как Cross Site Request Forgery. Это функция, предоставляемая Django для предотвращения замаскированной отправки запросов. Формы, отправляемые методом POST, должны включать этот тег.

Создайте новый файл search2.py в каталоге HelloWorld и используйте функцию search_post для обработки POST-запросов:

/HelloWorld/HelloWorld/search2.py код файла:

# -*- coding: utf-8 -*- from django.shortcuts import render from django.views.decorators import csrf # Получение данных POST-запроса def search_post(request): ctx ={} if request.POST: ctx['rlt'] = request.POST['q'] return render(request, "post.html", ctx)

Измените правила urls.py на следующую форму:

/HelloWorld/HelloWorld/urls.py код файла:

from django.conf.urls import url from . import views,testdb,search,search2 urlpatterns = [ url(r'^hello/$', views.hello), url(r'^testdb/$', testdb.testdb), url(r'^search-form/$', search.search_form), url(r'^search/$', search.search), url(r'^search-post/$', search2.search_post), ]

Перейдитеhttp://127.0.0.1:8000/search-post/Отображаемые результаты выглядят следующим образом:

После завершения приведенного выше примера наша структура каталогов выглядит так:

HelloWorld
|-- HelloWorld
|   |-- __init__.py
|   |-- __init__.pyc
|   |-- search.py
|   |-- search.pyc
|   |-- search2.py
|   |-- search2.pyc
|   |-- settings.py
|   |-- settings.pyc
|   |-- testdb.py
|   |-- testdb.pyc
|   |-- urls.py
|   |-- urls.pyc
|   |-- views.py
|   |-- views.pyc
|   |-- wsgi.py
|   `-- wsgi.pyc
|-- TestModel
|   |-- __init__.py
|   |-- __init__.pyc
|   |-- admin.py
|   |-- admin.pyc
|   |-- apps.py
|   |-- migrations
|   |   |-- 0001_initial.py
|   |   |-- 0001_initial.pyc
|   |   |-- __init__.py
|   |   `-- __init__.pyc
|   |-- models.py
|   |-- models.pyc
|   |-- tests.py
|   `-- views.py
|-- db.sqlite3
|-- manage.py
`-- templates
    |-- base.html
    |-- hello.html
    |-- post.html
    `-- search_form.html

Объект запроса

Первый параметр каждой функции представления — объект HttpRequest, как в функции example() ниже:

from django.http import HttpResponse

def example(request):
    return HttpResponse("Hello world")

Объект HttpRequest содержит некоторую информацию о текущем URL запроса:

Свойство

Описание

path

Полный путь запрошенной страницы, не включая доменное имя — например, "/hello/".

method

Строковое представление метода HTTP, используемого в запросе. Представление в верхнем регистре. Например:

if request.method == 'GET':
    do_something()
elif request.method == 'POST':
    do_something_else()

GET

Объект, подобный словарю, содержащий все параметры HTTP GET. См. документацию QueryDict.

POST

Объект, подобный словарю, содержащий все параметры HTTP POST. См. документацию QueryDict.

Возможно, что сервер получает пустой POST-запрос. То есть форма отправляет запрос методом HTTP POST, но в форме может не быть данных. Поэтому нельзя использовать выражение if request.POST, чтобы определить, используется ли метод HTTP POST; следует использовать if request.method == "POST" (см. атрибут method в этой таблице).

Примечание: POST не включает информацию о загрузке файлов. См. атрибут FILES.

REQUEST

Для удобства этот атрибут представляет собой комбинацию атрибутов POST и GET, но у него особое поведение: сначала он ищет атрибут POST, затем атрибут GET. Он смоделирован по образцу $_REQUEST в PHP.

Например, если GET = {"name": "john"} и POST = {"age": '34'}, тогда значение REQUEST["name"] равно "john", значение REQUEST["age"] равно "34".

Настоятельно рекомендуется использовать GET и POST, потому что эти два атрибута более явные, и написанный код легче понять.

COOKIES

Стандартный объект словаря Python, содержащий все куки. И ключи, и значения являются строками.

FILES

Объект, подобный словарю, содержащий все загруженные файлы. Каждый ключ в FILES — это значение атрибута name в теге <input type="file" name="" />. Каждое значение в FILES также является стандартным объектом словаря Python, содержащим следующие три ключа:

  • filename: имя загруженного файла, представленное в виде строки Python.
  • content-type: тип содержимого загруженного файла
  • content: необработанное содержимое загруженного файла.

Примечание: FILES содержит данные только тогда, когда метод запроса — POST и у тега <form> на странице запроса есть атрибут enctype="multipart/form-data". В противном случае FILES — пустой словарь.

META

Словарь, содержащий всю доступную информацию о заголовках HTTP. Например:

  • CONTENT_LENGTH
  • CONTENT_TYPE
  • QUERY_STRING: неразобранная исходная строка запроса.
  • REMOTE_ADDR: IP-адрес клиента
  • REMOTE_HOST: имя хоста клиента
  • SERVER_NAME: имя хоста сервера
  • SERVER_PORT: порт сервера

Эти заголовки в META имеют префиксHTTP_Часть до двоеточия (:) — это ключ, а часть после — значение, например:

  • HTTP_ACCEPT_ENCODING
  • HTTP_ACCEPT_LANGUAGE
  • HTTP_HOST: информация о заголовке host HTTP, отправленная клиентом.
  • HTTP_REFERER: страница перехода
  • HTTP_USER_AGENT: строка user-agent клиента
  • HTTP_X_BENDER: информация заголовка X-Bender

user

является объектом django.contrib.auth.models.User, представляющим текущего вошедшего в систему пользователя.

Если обращающийся пользователь в данный момент не вошёл в систему, user будет инициализирован как экземпляр django.contrib.auth.models.AnonymousUser.

Вы можете использовать метод is_authenticated() у user, чтобы определить, вошёл ли пользователь в систему:

if request.user.is_authenticated():
    # Do something for logged-in users.
else:
    # Do something for anonymous users.

Этот атрибут доступен только при активированном AuthenticationMiddleware в Django.

session

Единственный атрибут для чтения и записи, объект-словарь, представляющий текущую сессию. Этот атрибут доступен только при включённой поддержке сессий Django.

raw_post_data

Необработанные неразобранные данные HTTP POST. Это полезно для расширенной обработки.

Объект Request также имеет несколько полезных методов:

МетодыОписание
__getitem__(key) Возвращает значение ключа из GET/POST, сначала беря POST, затем GET. Вызывает KeyError, если ключ не существует.
Это позволяет обращаться к объекту HttpRequest с использованием синтаксиса словаря.
Например, request["foo"] эквивалентно операции: сначала request.POST["foo"], затем request.GET["foo"].
has_key() Проверяет, содержит ли request.GET или request.POST ключ, указанный в параметре.
get_full_path() Возвращает путь запроса, включая строку запроса. Например, "/music/bands/the_beatles/?print=true"
is_secure() Возвращает True, если запрос безопасен, то есть если он был выполнен через HTTPS.

Объект QueryDict

В объекте HttpRequest атрибуты GET и POST являются экземплярами класса django.http.QueryDict.

QueryDict — это пользовательский класс, подобный словарю, используемый для обработки ситуации, когда одному ключу соответствует несколько значений.

QueryDict реализует все стандартные методы словаря. Он также включает некоторые специальные методы:

Методы Описание

__getitem__

Есть одно отличие от стандартной обработки словаря: если ключу соответствует несколько значений, __getitem__() возвращает последнее значение.

__setitem__

Устанавливает список значений (список Python) для указанного ключа. Примечание: его можно вызывать только для изменяемого объекта QueryDict (то есть копии объекта QueryDict, созданной с помощью copy()).

get()

Если ключу соответствует несколько значений, get() возвращает последнее значение.

update()

Параметр может быть QueryDict или стандартным словарём. В отличие от метода update стандартного словаря, этот метод добавляет элементы словаря, а не заменяет их:

>>> q = QueryDict('a=1')

>>> q = q.copy() # to make it mutable

>>> q.update({'a': '2'})

>>> q.getlist('a')

 ['1', '2']

>>> q['a'] # returns the last

['2']

items()

Есть одно отличие от метода items() стандартного словаря: этот метод использует логику единственного значения __getitem__():

>>> q = QueryDict('a=1&a=2&a=3')

>>> q.items()

[('a', '3')]

values()

Есть одно отличие от метода values() стандартного словаря: этот метод использует логику единственного значения __getitem__():

Кроме того, QueryDict также имеет некоторые методы, как показано в следующей таблице:

Методы Описание

copy()

Возвращает копию объекта, внутренне реализованную с использованием copy.deepcopy() из стандартной библиотеки Python. Эта копия изменяема — то есть значения копии можно изменять.

getlist(key)

Возвращает все значения, соответствующие параметру key, в виде списка Python. Если ключ не существует, возвращает пустой список. Гарантируется возврат списка какого-либо типа..

setlist(key,list_)

Устанавливает значение ключа key в list_ (в отличие от __setitem__()).

appendlist(key,item)

Добавляет элемент во внутренний список, связанный с ключом key.

setlistdefault(key,list)

Есть одно отличие от setdefault: он принимает список в качестве параметра, а не одно значение.

lists()

Есть одно отличие от items(): он возвращает все значения для ключа key в виде списка, например:

>>> q = QueryDict('a=1&a=2&a=3')

>>> q.lists()

[('a', ['1', '2', '3'])]

urlencode()

Возвращает строку, отформатированную как строка запроса (например: "a=2&b=3&b=5").

Другие расширения