{"title":"django.conf.urls utility functions","version":"1.11","locale":"pt-br","docname":"ref/urls","url":"/pt-br/1.11/ref/urls/","canonical":"https://djangodocs.dev/pt-br/1.11/ref/urls/","summary":"Helper function to return a URL pattern for serving files in debug mode. urlpatterns should be a list of url() instances.","html":"<span id=\"django-conf-urls-utility-functions\"></span><h1><code class=\"docutils literal notranslate\">django.conf.urls</code> utility functions<a class=\"heading-anchor\" href=\"#module-django.conf.urls\"><span class=\"visually-hidden\">Link para este cabeçalho</span><span aria-hidden=\"true\">#</span></a></h1>\n<section id=\"static\">\n<h2><code class=\"docutils literal notranslate\">static()</code><a class=\"heading-anchor\" href=\"#static\"><span class=\"visually-hidden\">Link para este cabeçalho</span><span aria-hidden=\"true\">#</span></a></h2>\n<dl class=\"py function\">\n<dt class=\"sig sig-object py\" id=\"django.conf.urls.static.static\">\n<span class=\"sig-prename descclassname\">static.</span><span class=\"sig-name descname\">static</span><span class=\"sig-paren\">(</span><em class=\"sig-param\">prefix</em>, <em class=\"sig-param\">view<span class=\"o\">=</span><span class=\"default_value\">django.views.static.serve</span></em>, <em class=\"sig-param\"><span class=\"o\">**</span>kwargs</em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.conf.urls.static.static\"><span class=\"visually-hidden\">Link para esta definição</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<p>Helper function to return a URL pattern for serving files in debug mode:</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"kn\">from</span> <span class=\"nn\">django.conf</span> <span class=\"kn\">import</span> settings\n<span class=\"kn\">from</span> <span class=\"nn\">django.conf.urls.static</span> <span class=\"kn\">import</span> static\n\nurlpatterns <span class=\"o\">=</span> <span class=\"p\">[</span>\n    <span class=\"c1\"># ... the rest of your URLconf goes here ...</span>\n<span class=\"p\">]</span> <span class=\"o\">+</span> static<span class=\"p\">(</span>settings<span class=\"o\">.</span>MEDIA_URL<span class=\"p\">,</span> document_root<span class=\"o\">=</span>settings<span class=\"o\">.</span>MEDIA_ROOT<span class=\"p\">)</span>\n</code></pre></div>\n</section>\n<section id=\"url\">\n<h2><code class=\"docutils literal notranslate\">url()</code><a class=\"heading-anchor\" href=\"#url\"><span class=\"visually-hidden\">Link para este cabeçalho</span><span aria-hidden=\"true\">#</span></a></h2>\n<dl class=\"py function\">\n<dt class=\"sig sig-object py\" id=\"django.conf.urls.url\">\n<span class=\"sig-name descname\">url</span><span class=\"sig-paren\">(</span><em class=\"sig-param\">regex</em>, <em class=\"sig-param\">view</em>, <em class=\"sig-param\">kwargs<span class=\"o\">=</span><span class=\"default_value\">None</span></em>, <em class=\"sig-param\">name<span class=\"o\">=</span><span class=\"default_value\">None</span></em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.conf.urls.url\"><span class=\"visually-hidden\">Link para esta definição</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<p><code class=\"docutils literal notranslate\">urlpatterns</code> should be a list of <code class=\"docutils literal notranslate\">url()</code> instances. For example:</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"kn\">from</span> <span class=\"nn\">django.conf.urls</span> <span class=\"kn\">import</span> include<span class=\"p\">,</span> url\n\nurlpatterns <span class=\"o\">=</span> <span class=\"p\">[</span>\n    url<span class=\"p\">(</span><span class=\"sa\">r</span><span class=\"s1\">&#39;^index/$&#39;</span><span class=\"p\">,</span> index_view<span class=\"p\">,</span> name<span class=\"o\">=</span><span class=\"s1\">&#39;main-view&#39;</span><span class=\"p\">),</span>\n    url<span class=\"p\">(</span><span class=\"sa\">r</span><span class=\"s1\">&#39;^weblog/&#39;</span><span class=\"p\">,</span> include<span class=\"p\">(</span><span class=\"s1\">&#39;blog.urls&#39;</span><span class=\"p\">)),</span>\n    <span class=\"o\">...</span>\n<span class=\"p\">]</span>\n</code></pre></div>\n<p>The <code class=\"docutils literal notranslate\">regex</code> parameter should be a string or\n<a class=\"reference internal\" href=\"/pt-br/1.11/ref/utils/#django.utils.translation.ugettext_lazy\" title=\"django.utils.translation.ugettext_lazy\"><code class=\"xref py py-func docutils literal notranslate\">ugettext_lazy()</code></a> (see\n<a class=\"reference internal\" href=\"/pt-br/1.11/topics/i18n/translation/#translating-urlpatterns\"><span class=\"std std-ref\">Translating URL patterns</span></a>) that contains a regular expression compatible\nwith Python’s <a class=\"reference external\" href=\"https://docs.python.org/3/library/re.html#module-re\" title=\"(em Python v3.14)\"><code class=\"xref py py-mod docutils literal notranslate\">re</code></a> module. Strings typically use raw string syntax\n(<code class=\"docutils literal notranslate\">r''</code>) so that they can contain sequences like <code class=\"docutils literal notranslate\">\\d</code> without the need to\nescape the backslash with another backslash.</p>\n<p>The <code class=\"docutils literal notranslate\">view</code> parameter is a view function or the result of\n<a class=\"reference internal\" href=\"/pt-br/1.11/ref/class-based-views/base/#django.views.generic.base.View.as_view\" title=\"django.views.generic.base.View.as_view\"><code class=\"xref py py-meth docutils literal notranslate\">as_view()</code></a> for class-based views. It can\nalso be an <a class=\"reference internal\" href=\"#django.conf.urls.include\" title=\"django.conf.urls.include\"><code class=\"xref py py-func docutils literal notranslate\">include()</code></a>.</p>\n<p>The <code class=\"docutils literal notranslate\">kwargs</code> parameter allows you to pass additional arguments to the view\nfunction or method. See <a class=\"reference internal\" href=\"/pt-br/1.11/topics/http/urls/#views-extra-options\"><span class=\"std std-ref\">Passando opções extras para função “view”</span></a> for an example.</p>\n<p>See <a class=\"reference internal\" href=\"/pt-br/1.11/topics/http/urls/#naming-url-patterns\"><span class=\"std std-ref\">Naming URL patterns</span></a> for why the <code class=\"docutils literal notranslate\">name</code>\nparameter is useful.</p>\n</section>\n<section id=\"include\">\n<h2><code class=\"docutils literal notranslate\">include()</code><a class=\"heading-anchor\" href=\"#include\"><span class=\"visually-hidden\">Link para este cabeçalho</span><span aria-hidden=\"true\">#</span></a></h2>\n<dl class=\"py function\">\n<dt class=\"sig sig-object py\" id=\"django.conf.urls.include\">\n<span class=\"sig-name descname\">include</span><span class=\"sig-paren\">(</span><em class=\"sig-param\">module</em>, <em class=\"sig-param\">namespace<span class=\"o\">=</span><span class=\"default_value\">None</span></em>, <em class=\"sig-param\">app_name<span class=\"o\">=</span><span class=\"default_value\">None</span></em><span class=\"sig-paren\">)</span><a class=\"heading-anchor\" href=\"#django.conf.urls.include\"><span class=\"visually-hidden\">Link para esta definição</span><span aria-hidden=\"true\">#</span></a></dt>\n<dt class=\"sig sig-object py\">\n<span class=\"sig-name descname\">include</span><span class=\"sig-paren\">(</span><em class=\"sig-param\">pattern_list</em><span class=\"sig-paren\">)</span></dt>\n<dt class=\"sig sig-object py\">\n<span class=\"sig-name descname\">include</span><span class=\"sig-paren\">(</span><em class=\"sig-param\">(pattern_list</em>, <em class=\"sig-param\">app_namespace)</em>, <em class=\"sig-param\">namespace=None</em><span class=\"sig-paren\">)</span></dt>\n<dt class=\"sig sig-object py\">\n<span class=\"sig-name descname\">include</span><span class=\"sig-paren\">(</span><em class=\"sig-param\">(pattern_list</em>, <em class=\"sig-param\">app_namespace</em>, <em class=\"sig-param\">instance_namespace)</em><span class=\"sig-paren\">)</span></dt>\n<dd><p>A function that takes a full Python import path to another URLconf module\nthat should be “included” in this place. Optionally, the <a class=\"reference internal\" href=\"/pt-br/1.11/topics/http/urls/#term-application-namespace\"><span class=\"xref std std-term\">application\nnamespace</span></a> and <a class=\"reference internal\" href=\"/pt-br/1.11/topics/http/urls/#term-instance-namespace\"><span class=\"xref std std-term\">instance namespace</span></a> where the entries will be included\ninto can also be specified.</p>\n<p>Usually, the application namespace should be specified by the included\nmodule. If an application namespace is set, the <code class=\"docutils literal notranslate\">namespace</code> argument\ncan be used to set a different instance namespace.</p>\n<p><code class=\"docutils literal notranslate\">include()</code> also accepts as an argument either an iterable that returns\nURL patterns, a 2-tuple containing such iterable plus the names of the\napplication namespaces, or a 3-tuple containing the iterable and the names\nof both the application and instance namespace.</p>\n<dl class=\"field-list simple\">\n<dt class=\"field-odd\">Parâmetros<span class=\"colon\">:</span></dt>\n<dd class=\"field-odd\"><ul class=\"simple\">\n<li><p><strong>module</strong> – URLconf module (or module name)</p></li>\n<li><p><strong>namespace</strong> (<a class=\"reference external\" href=\"https://docs.python.org/3/library/stdtypes.html#str\" title=\"(em Python v3.14)\"><em>str</em></a>) – Instance namespace for the URL entries being included</p></li>\n<li><p><strong>app_name</strong> (<a class=\"reference external\" href=\"https://docs.python.org/3/library/stdtypes.html#str\" title=\"(em Python v3.14)\"><em>str</em></a>) – Application namespace for the URL entries being included</p></li>\n<li><p><strong>pattern_list</strong> – Iterable of <a class=\"reference internal\" href=\"#django.conf.urls.url\" title=\"django.conf.urls.url\"><code class=\"xref py py-func docutils literal notranslate\">django.conf.urls.url()</code></a> instances</p></li>\n<li><p><strong>app_namespace</strong> (<a class=\"reference external\" href=\"https://docs.python.org/3/library/stdtypes.html#str\" title=\"(em Python v3.14)\"><em>str</em></a>) – Application namespace for the URL entries being included</p></li>\n<li><p><strong>instance_namespace</strong> (<a class=\"reference external\" href=\"https://docs.python.org/3/library/stdtypes.html#str\" title=\"(em Python v3.14)\"><em>str</em></a>) – Instance namespace for the URL entries being included</p></li>\n</ul>\n</dd>\n</dl>\n</dd></dl>\n\n<p>See <a class=\"reference internal\" href=\"/pt-br/1.11/topics/http/urls/#including-other-urlconfs\"><span class=\"std std-ref\">Incluindo outros URLconfs</span></a> and <a class=\"reference internal\" href=\"/pt-br/1.11/topics/http/urls/#namespaces-and-include\"><span class=\"std std-ref\">Domínios de nomes de URL e URLconfs incluídos</span></a>.</p>\n<aside class=\"version-note version-deprecated\" data-version=\"1.9\" role=\"note\">\n<p class=\"version-note-title\">Deprecated since Django 1.9</p><p><span class=\"versionmodified deprecated\">Descontinuado desde a versão 1.9: </span>Support for the <code class=\"docutils literal notranslate\">app_name</code> argument is deprecated and will be removed in\nDjango 2.0. Specify the <code class=\"docutils literal notranslate\">app_name</code> as explained in\n<a class=\"reference internal\" href=\"/pt-br/1.11/topics/http/urls/#namespaces-and-include\"><span class=\"std std-ref\">Domínios de nomes de URL e URLconfs incluídos</span></a> instead.</p>\n<p>Support for passing a 3-tuple is also deprecated and will be removed in\nDjango 2.0. Pass a 2-tuple containing the pattern list and application\nnamespace, and use the <code class=\"docutils literal notranslate\">namespace</code> argument instead.</p>\n<p>Lastly, support for an instance namespace without an application namespace\nhas been deprecated and will be removed in Django 2.0. Specify the\napplication namespace or remove the instance namespace.</p>\n</aside>\n</section>\n<section id=\"handler400\">\n<h2><code class=\"docutils literal notranslate\">handler400</code><a class=\"heading-anchor\" href=\"#handler400\"><span class=\"visually-hidden\">Link para este cabeçalho</span><span aria-hidden=\"true\">#</span></a></h2>\n<dl class=\"py data\">\n<dt class=\"sig sig-object py\" id=\"django.conf.urls.handler400\">\n<span class=\"sig-name descname\">handler400</span><a class=\"heading-anchor\" href=\"#django.conf.urls.handler400\"><span class=\"visually-hidden\">Link para esta definição</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<p>A callable, or a string representing the full Python import path to the view\nthat should be called if the HTTP client has sent a request that caused an error\ncondition and a response with a status code of 400.</p>\n<p>By default, this is <code class=\"docutils literal notranslate\">'django.views.defaults.bad_request'</code>. If you\nimplement a custom view, be sure it returns an\n<a class=\"reference internal\" href=\"/pt-br/1.11/ref/request-response/#django.http.HttpResponseBadRequest\" title=\"django.http.HttpResponseBadRequest\"><code class=\"xref py py-class docutils literal notranslate\">HttpResponseBadRequest</code></a>.</p>\n<p>See the documentation about <a class=\"reference internal\" href=\"/pt-br/1.11/ref/views/#http-bad-request-view\"><span class=\"std std-ref\">the 400 (bad request) view</span></a> for more information.</p>\n</section>\n<section id=\"handler403\">\n<h2><code class=\"docutils literal notranslate\">handler403</code><a class=\"heading-anchor\" href=\"#handler403\"><span class=\"visually-hidden\">Link para este cabeçalho</span><span aria-hidden=\"true\">#</span></a></h2>\n<dl class=\"py data\">\n<dt class=\"sig sig-object py\" id=\"django.conf.urls.handler403\">\n<span class=\"sig-name descname\">handler403</span><a class=\"heading-anchor\" href=\"#django.conf.urls.handler403\"><span class=\"visually-hidden\">Link para esta definição</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<p>A callable, or a string representing the full Python import path to the view\nthat should be called if the user doesn’t have the permissions required to\naccess a resource.</p>\n<p>By default, this is <code class=\"docutils literal notranslate\">'django.views.defaults.permission_denied'</code>. If you\nimplement a custom view, be sure it returns an\n<a class=\"reference internal\" href=\"/pt-br/1.11/ref/request-response/#django.http.HttpResponseForbidden\" title=\"django.http.HttpResponseForbidden\"><code class=\"xref py py-class docutils literal notranslate\">HttpResponseForbidden</code></a>.</p>\n<p>See the documentation about <a class=\"reference internal\" href=\"/pt-br/1.11/ref/views/#http-forbidden-view\"><span class=\"std std-ref\">the 403 (HTTP Forbidden) view</span></a> for more information.</p>\n</section>\n<section id=\"handler404\">\n<h2><code class=\"docutils literal notranslate\">handler404</code><a class=\"heading-anchor\" href=\"#handler404\"><span class=\"visually-hidden\">Link para este cabeçalho</span><span aria-hidden=\"true\">#</span></a></h2>\n<dl class=\"py data\">\n<dt class=\"sig sig-object py\" id=\"django.conf.urls.handler404\">\n<span class=\"sig-name descname\">handler404</span><a class=\"heading-anchor\" href=\"#django.conf.urls.handler404\"><span class=\"visually-hidden\">Link para esta definição</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<p>A callable, or a string representing the full Python import path to the view\nthat should be called if none of the URL patterns match.</p>\n<p>By default, this is <code class=\"docutils literal notranslate\">'django.views.defaults.page_not_found'</code>. If you\nimplement a custom view, be sure it returns an\n<a class=\"reference internal\" href=\"/pt-br/1.11/ref/request-response/#django.http.HttpResponseNotFound\" title=\"django.http.HttpResponseNotFound\"><code class=\"xref py py-class docutils literal notranslate\">HttpResponseNotFound</code></a>.</p>\n<p>See the documentation about <a class=\"reference internal\" href=\"/pt-br/1.11/ref/views/#http-not-found-view\"><span class=\"std std-ref\">the 404 (HTTP Not Found) view</span></a> for more information.</p>\n</section>\n<section id=\"handler500\">\n<h2><code class=\"docutils literal notranslate\">handler500</code><a class=\"heading-anchor\" href=\"#handler500\"><span class=\"visually-hidden\">Link para este cabeçalho</span><span aria-hidden=\"true\">#</span></a></h2>\n<dl class=\"py data\">\n<dt class=\"sig sig-object py\" id=\"django.conf.urls.handler500\">\n<span class=\"sig-name descname\">handler500</span><a class=\"heading-anchor\" href=\"#django.conf.urls.handler500\"><span class=\"visually-hidden\">Link para esta definição</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<p>A callable, or a string representing the full Python import path to the view\nthat should be called in case of server errors. Server errors happen when you\nhave runtime errors in view code.</p>\n<p>By default, this is <code class=\"docutils literal notranslate\">'django.views.defaults.server_error'</code>. If you\nimplement a custom view, be sure it returns an\n<a class=\"reference internal\" href=\"/pt-br/1.11/ref/request-response/#django.http.HttpResponseServerError\" title=\"django.http.HttpResponseServerError\"><code class=\"xref py py-class docutils literal notranslate\">HttpResponseServerError</code></a>.</p>\n<p>See the documentation about <a class=\"reference internal\" href=\"/pt-br/1.11/ref/views/#http-internal-server-error-view\"><span class=\"std std-ref\">the 500 (HTTP Internal Server Error) view</span></a> for more information.</p>\n</section>","rootId":"module-django.conf.urls","toc":[{"title":"static()","anchor":"static","children":[]},{"title":"url()","anchor":"url","children":[]},{"title":"include()","anchor":"include","children":[]},{"title":"handler400","anchor":"handler400","children":[]},{"title":"handler403","anchor":"handler403","children":[]},{"title":"handler404","anchor":"handler404","children":[]},{"title":"handler500","anchor":"handler500","children":[]}],"breadcrumbs":[{"docname":"ref/index","title":"Referência da API","url":"/pt-br/1.11/ref/"}],"prev":{"docname":"ref/urlresolvers","title":"django.urls utility functions","url":"/pt-br/1.11/ref/urlresolvers/"},"next":{"docname":"ref/utils","title":"Django Utils","url":"/pt-br/1.11/ref/utils/"},"formats":{"html":"/pt-br/1.11/ref/urls/","markdown":"/pt-br/1.11/ref/urls.md","json":"/pt-br/1.11/ref/urls.json"},"source":"https://github.com/django/django/blob/stable/1.11.x/docs/ref/urls.txt","official":"https://docs.djangoproject.com/pt-br/1.11/ref/urls/","inVersions":["6.1","6.0","5.2","5.1","5.0","4.2","4.1","4.0","3.2","3.1","3.0","2.2","2.1","2.0","1.11","1.10","1.9"],"inLocales":["en","fr","ja","id","pt-br","ko","es","el","pl"]}