Django передача параметров в url
Функции-представления могут принимать параметры, через которые могут передаваться различные данные. Подобный параметры передаются в в адресе URL. Например, в запросе http://localhost/index/3/5/ поледние два сегмента 3/5/ могут представлять параметры URL, которые могут быть связанны с параметрами функции-представления через систему маршрутизации.
Определение параметров через функцию re_path
Определим в приложении в файле views.py следующие функции:
Во втором шаблоне адреса определяются два параметра: id и name ( (?P \d+)/(?P \D+) ). При этом параметр id должен представлять число, а параметр name должен состоять только из буквенных символов.
Ну и также отметим, что количество и название параметров в шаблонах адресов URL соответствуют количеству и названиям параметров соответствующих функций, которые обрабатывают запросы по данным адресам.
Теперь мы можем чем адресную строку передать данные в приложение:
Однако, что если мы не передадим значение для параметра или передадим ему значение, которое не соответствует регулярному выражению? В этом случае система не смодет найти ресурс для обработки запроса:
В этом случае мы можем определить в файле views.py для параметра функции products значение параметра по умолчанию:
То есть если в функцию не передается значение для параметра productid, то он получает значение 21.
В этом случае надо дополнительно определить еще один маршрут в файле urls.py :
Определение параметров через функцию path
Возьмем те же функции в файле views.py :
Определение параметров с помощью функции path() будет выглядеть следующим образом:
По умолчанию Django предоставляет следующие спецификаторы:
str : соответствует любой строке за исключенем символа «/». Если спецификатор не указан, то используется по умолчанию
int : соответствует любому положительному числу
slug : соответствует последовательности буквенных символов ASCII, цифр, дефиса и символа подчеркивания, например, building-your-1st-django-site
uuid : сооветствует идентификатору UUID, например, 075194d3-6885-417e-a8a8-6c931e272f00
path : соответствует любой строке, которая также может включать символ «/» в отличие от спецификатора str
Значения для параметров по умолчанию
Определеним для функций в views.py значения для параметров по умолчанию:
В этом случае для каждой функции надо определить по два маршрута:
Как передать get параметры в url в Django?
Не могу понять, как передать get параметры в URl, если их не хардкодить.
url(r’^coupons$’, views.coupons, name=’coupons’),
Пытаюсь вывести в html что-то по типу:
А зачем именно через гет параметр?
А когда страница самостоятельная, то почему ее не сделать
/coupons/category/1
/coupons/category1
The URLconf searches against the requested URL, as a normal Python string. This does not include GET or POST parameters, or the domain name.
Если сильно хочется, то можно написать свой темплейт таг и ему скармливать параметры
Диспетчер URL¶
Смотрите Классные URI не меняются от создателя World Wide Web Тима Бернерса-Ли, где приведены убедительные аргументы в пользу того, почему URL-адреса должны быть чистыми и удобными.
Быстрый обзор¶
Чтобы разработать URL-адреса для приложения, вы создаете модуль Python, неофициально называемый URLconf (конфигурация URL-адреса). Этот модуль представляет собой чистый код Python и является отображением между выражениями пути URL и функциями Python (вашими представлениями).
Это сопоставление может быть сколь угодно коротким или длинным. Оно может ссылаться на другие сопоставления. И поскольку это чистый код Python, его можно создавать динамически.
Как Django обрабатывает запрос¶
Когда пользователь запрашивает страницу вашего сайта на Django, система следует этому алгоритму, чтобы определить, какой код Python выполнить:
Пример¶
Вот пример URLconf:
Конвертеры пути¶
По умолчанию доступны следующие конвертеры пути:
Регистрация пользовательских конвертеров пути¶
Для более сложных требований соответствия вы можете определить свои собственные преобразователи пути.
Атрибут класса regex в виде строки.
Зарегистрируйте пользовательские классы конвертера в вашем URLconf, используя register_converter() :
Использование регулярных выражений¶
Вот пример URLconf из предыдущего, переписанный с использованием регулярных выражений:
Это примерно то же самое, что и в предыдущем примере, за исключением:
При переключении с path() на re_path() или наоборот, особенно важно знать, что тип аргументов представления может измениться, и поэтому вы может потребоваться адаптировать ваши отображения (функции).
Использование безымянных групп регулярных выражений¶
Это использование не особенно рекомендуется, поскольку оно упрощает случайное внесение ошибок между предполагаемым значением совпадения и аргументами представления.
В любом случае рекомендуется использовать только один стиль в данном регулярном выражении. Когда оба стиля смешаны, любые безымянные группы игнорируются, и только именованные группы передаются в функцию просмотра.
Вложенные аргументы¶
Регулярные выражения допускают вложенные аргументы, и Django разрешит их и передаст в представление. При реверсировании Django попытается заполнить все внешние захваченные аргументы, игнорируя все вложенные захваченные аргументы. Рассмотрим следующие шаблоны URL, которые могут принимать аргумент страницы:
Вложенные захваченные аргументы создают сильную связь между аргументами представления и URL-адресом, как показано на примере blog_articles : представление получает часть URL-адреса ( page-2/ ), а не только значение, которое интересует представление. Эта связь еще более выражена при реверсировании, так как для переворота представления нам нужно передать часть URL вместо номера страницы.
Как правило, фиксируйте только те значения, с которыми представление должно работать, и используйте аргументы без захвата, когда регулярному выражению требуется аргумент, но представление его игнорирует.
Что ищет URLconf¶
URLconf выполняет поиск по запрошенному URL как в обычной строке Python. Не включает параметры GET или POST или имя домена.
Определение значений по умолчанию для аргументов представлений¶
Производительность¶
Каждое регулярное выражение в urlpatterns компилируется при первом обращении к нему. Это делает систему невероятно быстрой.
Синтаксис переменной urlpatterns ¶
Обработка ошибок¶
Когда Django не может найти соответствие для запрошенного URL или когда возникает исключение, Django вызывает представление обработки ошибок.
Представления для использования в этих случаях задаются четырьмя переменными. Их значений по умолчанию должно хватить для большинства проектов, но возможна дальнейшая настройка, переопределив их значения по умолчанию.
Смотрите документацию по настройка представлений ошибок для получения полной информации.
Такие значения можно установить в корневом URLconf. Установка этих переменных в любом другом URLconf не даст никакого эффекта.
Значения должны быть вызываемыми или строками, представляющими полный путь импорта Python к представлению, которое должно быть вызвано для обработки текущего состояния ошибки.
Включение других URLconfs¶
В любой момент ваши urlpatterns могут «включать» другие модули URLconf. По сути, это «корень» набора нижестоящих URL-адресов.
Например, вот выдержка из URLconf для самого сайта Django. Он включает ряд других URLconfs:
Это можно использовать для удаления избыточности из URLconfs, где один префикс шаблона используется многократно. Например, рассмотрим этот URLconf:
Мы можем улучшить это, указав общий префикс пути только один раз и сгруппировав суффиксы, которые отличаются:
Захваченные параметры¶
Включенный URLconf получает любые захваченные параметры из родительских URLconfs, поэтому следующий пример допустим:
В приведенном выше примере захваченная переменная username передается во включенный URLconf, как и ожидалось.
Передача дополнительных параметров функции предствления¶
У URLconfs есть ловушка, которая позволяет передавать дополнительные аргументы функциям просмотра в виде словаря Python.
Функция path() может принимать необязательный третий аргумент, который должен быть словарем дополнительных ключевых аргументов для передачи в функцию представление.
Этот метод используется в фреймворке синдикации для передачи метаданных и параметров представлениям.
Возможно иметь шаблон URL, который захватывает именованные ключевые аргументы, а также передает аргументы с такими же именами в свой словарь дополнительных аргументов. Когда это произойдет, аргументы в словаре будут использоваться вместо аргументов, записанных в URL-адресе.
Передача дополнительных параметров в include() ¶
Например, эти два набора URLconf функционально идентичны:
Обратите внимание, что дополнительные параметры будут всегда передаваться каждой строке во включенном URLconf, независимо от того, действительно ли представление строки принимает эти параметры как действительные. По этой причине этот метод полезен только в том случае, если вы уверены, что каждое представление во включенном URLconf принимает дополнительные параметры, которые вы передаете.
Обратное разрешение URL-адресов¶
Распространенной потребностью при работе над проектом Django является возможность получения URL-адресов в их окончательных формах либо для встраивания в сгенерированный контент (URL-адреса представлений и ресурсов, URL-адреса, отображаемые пользователю и т.д.), либо для обработки потока навигации на сервере (перенаправления и т.д.)
Настоятельно рекомендуется избегать жесткого кодирования этих URL-адресов (трудоемкая, немасштабируемая и подверженная ошибкам стратегия). Столь же опасна разработка специальных механизмов для генерации URL-адресов, которые параллельны структуре, описанной в URLconf, что может привести к созданию URL-адресов, которые со временем устареют.
Другими словами, нужен DRY механизм. Среди других преимуществ это позволит эволюционировать дизайн URL без необходимости просматривать весь исходный код проекта для поиска и замены устаревших URL.
Основная информация, доступная для получения URL-адреса – это идентификация (например, имя) представления, отвечающего за его обработку. Другая часть информации, которая обязательно должна участвовать в поиске правильного URL, – это типы (позиционные, ключевые слова) и значения аргументов представления.
Django предоставляет решение, в котором преобразователь URL-адресов является единственным хранилищем дизайна URL-адресов. Вы загружаете его с помощью своего URLconf, и затем его можно использовать в обоих направлениях:
Django предоставляет инструменты для реверсирования URL-адресов, соответствующие различным уровням, на которых требуются URL-адреса:
Примеры¶
Снова рассмотрим эту запись URLconf:
Вы можете получить их в коде шаблона, используя:
Если по какой-то причине было решено, что URL-адреса, по которым публикуется контент для ежегодных архивов статей, должны быть изменены, вам нужно будет изменить только запись в URLconf.
В некоторых сценариях, где представления носят общий характер, между URL-адресами и представлениями может существовать отношение «многие к одному». В таких случаях имя представления не является достаточно хорошим идентификатором, когда приходит время реверсирования URL-адресов. Прочтите следующий раздел, чтобы узнать о решении, которое предлагает Django для этого.
Именование шаблонов URL¶
Чтобы выполнить реверсирование URL, вам необходимо использовать именованные шаблоны URL, как это сделано в примерах выше. Строка, используемая для имени URL, может содержать любые символы. Вы не ограничены допустимыми именами Python.
Добавление префикса к именам URL-адресов, возможно, производных от имени приложения (например, myapp-comment вместо comment ), снижает вероятность коллизий.
Пространства имен URL¶
Вступление¶
Пространство имен URL состоит из двух частей, каждая из которых является строкой:
Реверсирование пространств имён URL¶
Получив URL-адрес с пространством имен (например, ‘polls:index’ ) для разрешения, Django разбивает полное имя на части, а затем пытается выполнить следующий поиск:
Сначала Django ищет соответствующий application namespace (в этом примере ‘polls’ ). Это даст список экземпляров этого приложения.
Если экземпляра приложения по умолчанию нет, Django выберет последний развернутый экземпляр приложения, каким бы ни было его имя экземпляра.
Если есть вложенные пространства имен, эти шаги повторяются для каждой части пространства имен, пока не будет найдено только имя представления. Затем имя представления будет преобразовано в URL-адрес в найденном пространстве имен.
Пример¶
Документация Django 3.0
Чистая, элегантная схема URL-ов – это важная часть качественного приложения. Django позволяет проектировать URL-адреса как вы пожелаете, без ограничений «фреймворка».
Читайте Cool URIs don’t change, создателя World Wide Web, Тима Бернерса-Ли, чтобы узнать почему URL-ы должны быть красивыми и практичными.
Обзор¶
To design URLs for an app, you create a Python module informally called a URLconf (URL configuration). This module is pure Python code and is a mapping between URL path expressions to Python functions (your views).
Эта конфигурация может быть короткой или длинной настолько, насколько это нужно. Она может ссылаться на другие конфигурации. И, так как это код Python, может создаваться динамически.
Django также предоставляет метод для перевода URL на текущий язык. Обратитесь к документации на интернационализацию для подробностей.
Как Django обрабатывает запрос¶
При запросе к странице вашего Django-сайта, используется такой алгоритм для определения какой код выполнить:
Django determines the root URLconf module to use. Ordinarily, this is the value of the ROOT_URLCONF setting, but if the incoming HttpRequest object has a urlconf attribute (set by middleware), its value will be used in place of the ROOT_URLCONF setting.
Once one of the URL patterns matches, Django imports and calls the given view, which is a Python function (or a class-based view ). The view gets passed the following arguments:
If the matched URL pattern contained no named groups, then the matches from the regular expression are provided as positional arguments.
In older versions, the keyword arguments with None values are made up also for not provided named parts.
If no URL pattern matches, or if an exception is raised during any point in this process, Django invokes an appropriate error-handling view. See Error handling below.
Например¶
Вот пример простого URLconf:
Path converters¶
The following path converters are available by default:
Registering custom path converters¶
For more complex matching requirements, you can define your own path converters.
A converter is a class that includes the following:
Register custom converter classes in your URLconf using register_converter() :
Using regular expressions¶
Here’s the example URLconf from earlier, rewritten using regular expressions:
This accomplishes roughly the same thing as the previous example, except:
When switching from using path() to re_path() or vice versa, it’s particularly important to be aware that the type of the view arguments may change, and so you may need to adapt your views.
Using unnamed regular expression groups¶
This usage isn’t particularly recommended as it makes it easier to accidentally introduce errors between the intended meaning of a match and the arguments of the view.
In either case, using only one style within a given regex is recommended. When both styles are mixed, any unnamed groups are ignored and only named groups are passed to the view function.
Вложенные аргументы¶
Регулярные выражения позволяют использовать вложенные аргументы, и Django может их найти и передать в представление. Во время поиска аргументов Django попытается получить самый внешний аргумент, игнорируя вложенные аргументы. Возьмем следующие шаблоны URL-ов, которые принимает необязательный номер страницы:
При получении URL-а для представления blog_articles необходимо указать самый внешний аргумент( page-2/ ) или ни одного аргумента в данном случае. В то время как для comments необходимо передать значение page_number или не одного аргумента.
Вложенные захватываемые аргументы создают сильную связанность между URL и аргументами представления, как это показано для blog_articles : представление получает часть URL-а ( page-2/ ) вместо значение, которое на самом деле необходимо представлению. Эта связанность особенно заметна при создании URL-а т.к. необходимо передать часть URL-а вместо номера страницы.
Как правило, URL-шаблон должен захватывать только необходимые для представления аргументы.
Что использует URLconf при поиске нужного шаблона URL¶
URLconf использует запрашиваемый URL как обычную строку Python. Он не учитывает параметры GET, POST и имя домена.
Значения по умолчанию для аргументов представления¶
Принято указывать значения по-умолчанию для аргументов представления. Пример URLconf и представления:
Производительность¶
Каждое регулярное выражение в urlpatterns будет скомпилировано при первом использовании. Это делает систему невероятно быстрой.
Syntax of the urlpatterns variable¶
urlpatterns should be a sequence of path() and/or re_path() instances.
Обработчики ошибок¶
When Django can’t find a match for the requested URL, or when an exception is raised, Django invokes an error-handling view.
Эти представления определены в четырёх переменных. Их значения по-умолчанию должны подойти для большинства проектов, но вы можете их поменять при необходимости.
Эти значения должны быть определены в главном URLconf.
Значение это функции, или полный путь для импорта, которая будет вызвана, если не был найден подходящий URL-шаблон.
Есть следующие переменные:
Комбинирование URLconfs¶
В любой момент, ваш urlpatterns может «включать» другие модули URLconf.
Вот пример URLconf для сайта Django. Он включает множество других конфигураций URL:
Another possibility is to include additional URL patterns by using a list of path() instances. For example, consider this URLconf:
Такой подход может применяться для уменьшения дублирования кода в настройках URL, когда используется один и тот же шаблонный префикс. Например, возьмём такую конфигурацию URL:
Мы можем сделать её проще, указав общий префикс только один раз и сгруппировав различающиеся суффиксы:
Нахождение аргументов в URL¶
Включенный URLconf получает все аргументы найденные родительским URLconfs, поэтому этот пример работает:
В примере выше, найденный аргумент «username» передается во включенный URLconf, как и ожидалось.
Передача дополнительных аргументов в представление¶
Конфигурация URL-ов позволяет определить дополнительные аргументы для функции представления, используя словарь Python.
The path() function can take an optional third argument which should be a dictionary of extra keyword arguments to pass to the view function.
Такой подход используется в syndication framework для передачи параметров и дополнительных данных в представление.
Если регулярное выражение URL-шаблона выделяет из URL-а аргумент с названием, которое уже используется в дополнительных именованных аргументах, будет использован аргумент из словаря дополнительных аргументов, вместо значения из URL.
Передача дополнительных аргументов в include() ¶
Similarly, you can pass extra options to include() and each line in the included URLconf will be passed the extra options.
Например, эти два URLconf работают идентично:
Дополнительные аргументы всегда передаются каждому представлению во включенном URLconf, независимо от того, принимает оно эти аргументы или нет. Поэтому, такой подход полезен только если вы уверенны, что каждое представление принимает передаваемые аргументы.
Поиск URL-а по URL-шаблону¶
Обычной задачей является получение URL-а по его определению для отображения пользователю или для редиректа.
Очень важно не «хардкодить» URL-ы (трудоемкая и плохо поддерживаемая стратегия). Также не следует создавать «костыли» для генерации URL-ов, которые не следуют задокументированному дизайну URLconf.
В общем необходимо придерживаться принципа DRY. Немаловажно иметь возможность менять URL-ы в одном месте, а не выполнять поиск и замену по всему проекту.
Для получения URL-а нам необходим его идентификатор, то есть название URL-шаблона, и позиционные и именованные аргументы.
В Django для работы с URL-ами используется так называемый «URL mapper». Ему передается URLconf, и теперь его можно использовать в два направления:
Первое это то, что мы уже рассмотрели в предыдущем разделе. Второе называется URL reversing, в общем получение URL-а по его названию.
Django предоставляет инструменты для получения URL-ов в различных компонентах фреймворка:
Примеры¶
Рассмотрим следующий URLconf:
Вы можете получить его в шаблоне следующим образом:
Если по каким-либо причинам необходимо будет изменить URL, достаточно будет изменить запись в вашем URLconf.
В некоторых случаях URL-ы и представления могут соотноситься как многое-к-одному. В таких случаях название представления не может идентифицировать конкретный URL. Как решить эту проблему читайте в следующем разделе.
Именованные URL-шаблоны¶
Для того, чтобы выполнить обратное разрешение URL, вам потребуется использовать именованные URL шаблоны, как это показано в примерах выше. Строка, использованная для наименования URL, может содержать любые символы. Вы не ограничены только теми именами, что позволяет Python.
When naming URL patterns, choose names that are unlikely to clash with other applications“ choice of names. If you call your URL pattern comment and another application does the same thing, the URL that reverse() finds depends on whichever pattern is last in your project’s urlpatterns list.
Putting a prefix on your URL names, perhaps derived from the application name (such as myapp-comment instead of comment ), decreases the chance of collision.
You may also use the same name for multiple URL patterns if they differ in their arguments. In addition to the URL name, reverse() matches the number of arguments and the names of the keyword arguments.
Пространства имен в конфигурации URL-ов¶
Описание¶
Пространства имен позволяют получить URL по названию URL-шаблона даже, если несколько приложений используют одинаковые названия. Для сторонних приложений использование пространств имен – хорошая практика (как мы и делали в учебнике). Аналогично можно получить URL, если несколько экземпляров одного приложения подключены в конфигурацию URL-ов.
Пространство имен состоит из двух частей, каждая из которых это строка:
Поиск URL-а по шаблону с пространством имен¶
Если необходимо найти URL по названию с пространством имен (например, ‘polls:index’ ), Django разбивает название на части и следует такому алгоритму:
Первым делом, Django проверяет название(пространсву имен) приложения (например, polls ). Django получает список экземпляров приложения.
If there is a current application defined, Django finds and returns the URL resolver for that instance. The current application can be specified with the current_app argument to the reverse() function.
If there is no current application, Django looks for a default application instance. The default application instance is the instance that has an instance namespace matching the application namespace (in this example, an instance of polls called ‘polls’ ).
Если экземпляр по-умолчанию не найден, Django возьмет последний установленный экземпляр приложения, не обращая внимание на его название.
Если на первом шаге не было найдено приложение по указанному пространству имен, Django попытается найти экземпляр приложения по его названию, используя пространство имен как название экземпляра.
Если пространство имен вложенное, этот процесс будет повторен, пока неопределенным не останется только название представления. URL для названия представления будет искаться среди URL-шаблонов определенных в приложении, найденном через пространство имен.