# documentação Django 3.1.9.dev

# `django.urls` functions for use in URLconfs

## `path()`

`path`(route, view, kwargs=None, name=None)

Returns an element for inclusion in `urlpatterns`. For example:

    from django.urls import include, path

    urlpatterns = [
        path('index/', views.index, name='main-view'),
        path('bio/<username>/', views.bio, name='bio'),
        path('articles/<slug:title>/', views.article, name='article-detail'),
        path('articles/<slug:title>/<int:section>/', views.section, name='article-section'),
        path('weblog/', include('blog.urls')),
        ...
    ]

O argumento `route` deve ser uma string ou `gettext_lazy()` (veja Translating URL patterns) que contém um padrão de URL. A string pode conter colchetes angulares (como `<username>` acima) para capturar parte da URL e enviá-la como um argumento nomeado para a view. Os colchetes angulares podem incluir uma especificação do conversor (como a parte `int` de `2`) que limita os caracteres correspondidos e também podem alterar o tipo da variável passada para a view. Por exemplo, `<int:section>` corresponde a uma string de dígitos decimais e converte o valor em um `int`. Veja how-django-process-a-request para mais detalhes.

O argumento `view` é uma função de view ou o resultado de `as_view()` para views baseadas em classe. Também pode ser um `django.urls.include()`.

O argumento `kwargs` permite que você passe argumentos adicionais ao método ou função view. Veja Passando opções extras para função “view” para um exemplo.

Veja Padrões de nomenclatura de URL para o motivo do argumento `name` ser útil.

## `re_path()`

`re_path`(route, view, kwargs=None, name=None)

Returns an element for inclusion in `urlpatterns`. For example:

    from django.urls import include, re_path

    urlpatterns = [
        re_path(r'^index/$', views.index, name='index'),
        re_path(r'^bio/(?P<username>\w+)/$', views.bio, name='bio'),
        re_path(r'^weblog/', include('blog.urls')),
        ...
    ]

The `route` argument should be a string or `gettext_lazy()` (see Translating URL patterns) that contains a regular expression compatible with Python’s `re` module. Strings typically use raw string syntax (`r''`) so that they can contain sequences like `\d` without the need to escape the backslash with another backslash. When a match is made, captured groups from the regular expression are passed to the view – as named arguments if the groups are named, and as positional arguments otherwise. The values are passed as strings, without any type conversion.

The `view`, `kwargs` and `name` arguments are the same as for `path()`.

## `include()`

`include`(module, namespace=None)
`include`(pattern_list)
`include`((pattern_list, app_namespace), namespace=None)

  A function that takes a full Python import path to another URLconf module that should be “included” in this place. Optionally, the application namespace and instance namespace where the entries will be included into can also be specified.

  Usually, the application namespace should be specified by the included module. If an application namespace is set, the `namespace` argument can be used to set a different instance namespace.

  `include()` also accepts as an argument either an iterable that returns URL patterns or a 2-tuple containing such iterable plus the names of the application namespaces.

  Parâmetros: | module – URLconf module (or module name) namespace (str) – Instance namespace for the URL entries being included pattern_list – Iterable of `path()` and/or `re_path()` instances. app_namespace (str) – Application namespace for the URL entries being included

See Incluindo outros URLconfs and Domínios de nomes de URL e URLconfs incluídos.

## `register_converter()`

`register_converter`(converter, type_name)

The function for registering a converter for use in `path()` `route`s.

The `converter` argument is a converter class, and `type_name` is the converter name to use in path patterns. See Registering custom path converters for an example.

# `django.conf.urls` functions for use in URLconfs

## `static()`

`static.``static`(prefix, view=django.views.static.serve, **kwargs)

Helper function to return a URL pattern for serving files in debug mode:

    from django.conf import settings
    from django.conf.urls.static import static

    urlpatterns = [
        # ... the rest of your URLconf goes here ...
    ] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)

## `url()`

`url`(regex, view, kwargs=None, name=None)

This function is an alias to `django.urls.re_path()`.

Obsoleto desde a versão 3.1: Alias of `django.urls.re_path()` for backwards compatibility.

## `handler400`

`handler400`

A callable, or a string representing the full Python import path to the view that should be called if the HTTP client has sent a request that caused an error condition and a response with a status code of 400.

By default, this is `django.views.defaults.bad_request()`. If you implement a custom view, be sure it accepts `request` and `exception` arguments and returns an `HttpResponseBadRequest`.

## `handler403`

`handler403`

A callable, or a string representing the full Python import path to the view that should be called if the user doesn’t have the permissions required to access a resource.

By default, this is `django.views.defaults.permission_denied()`. If you implement a custom view, be sure it accepts `request` and `exception` arguments and returns an `HttpResponseForbidden`.

## `handler404`

`handler404`

A callable, or a string representing the full Python import path to the view that should be called if none of the URL patterns match.

By default, this is `django.views.defaults.page_not_found()`. If you implement a custom view, be sure it accepts `request` and `exception` arguments and returns an `HttpResponseNotFound`.

## `handler500`

`handler500`

A callable, or a string representing the full Python import path to the view that should be called in case of server errors. Server errors happen when you have runtime errors in view code.

By default, this is `django.views.defaults.server_error()`. If you implement a custom view, be sure it accepts a `request` argument and returns an `HttpResponseServerError`.