ImproperlyConfiguredError sobre app_name ao usar namespace em include ()

105

Atualmente, estou testando Django. Eu uso o namespaceargumento em um dos meus include()s em urls.py. Quando executo o servidor e tento navegar, recebo este erro.

File "C:\Users\User\AppData\Local\Programs\Python\Python36-32\lib\site-packages\django\urls\conf.py", line 39, in include
    'Specifying a namespace in include() without providing an app_name '
django.core.exceptions.ImproperlyConfigured: Specifying a namespace in include() without providing an app_name is not supported. Set the app_name attribute in the included module, or pass a 2-tuple containing the list of patterns and app_name instead.

Estes são meus arquivos urls.py:

#project/urls.py

from django.conf.urls import include, url
from django.contrib import admin

urlpatterns = [
    url(r'^reviews/', include('reviews.urls', namespace='reviews')),
    url(r'^admin/', include(admin.site.urls)),
]

e

#app/urls.py

from django.conf.urls import url

from . import views

urlpatterns = [
    # ex: /
    url(r'^$', views.review_list, name='review_list'),
    # ex: /review/5/
    url(r'^review/(?P<review_id>[0-9]+)/$', views.review_detail, name='review_detail'),
    # ex: /wine/
    url(r'^wine$', views.wine_list, name='wine_list'),
    # ex: /wine/5/
    url(r'^wine/(?P<wine_id>[0-9]+)/$', views.wine_detail, name='wine_detail'),
]

O que eu passo app_namena mensagem de erro?

Nelson M
fonte

Respostas:

152

Verifique os documentos para incluir aqui .

O que você fez não é uma maneira aceitável de passar parâmetros a serem incluídos. Você poderia fazer:

url(r'^reviews/', include(('reviews.urls', 'reviews'), namespace='reviews')),
unixia
fonte
Tentei fazer isso e recebi outro erro ... url (r '^ reviews /', include ('reviews.urls', namespace = 'reviews', app_name = 'reviews')), TypeError: include () obteve um inesperado argumento de palavra-chave 'app_name'
Nelson M
1
Extremamente arrependido. Isso deveria ser usado com módulos, não padrões. Verifique a resposta atualizada.
unixia
1
Essa solução também foi útil para mim. Eu estava seguindo o tutorial de django-oauth-toolkit.readthedocs.io/en/latest/tutorial/… e há uma instrução para fazer: urlpatterns = [# OAuth 2 endpoints: url (r '^ o /', include ( oauth2_endpoint_views, namespace = "oauth2_provider")), url (r '^ api / hello', ApiEndpoint.as_view ()), # um exemplo de endpoint de recurso]. Isso gera o mesmo erro que você mencionou.
Koji D'infinte
1
A sintaxe da tupla não funcionou para mim, ela só funcionou quando mudei (minha versão de) reviews.urlpara ter uma app_namevariável em django 2.1.
Herbert
Qual é o caso de uso para isso? Eu tenho muitos urls incluídos no meu projeto e todos com o mesmo padrão: path("the_app/", include(("app.urls", <name>), namespace=<the same name>))e é muito chato.
user4052054
80

Django 1.11+, 2.0+

Você deve definir o app_name no arquivo de urls que está incluindo

# reviews/urls.py  <-- i.e. in your app's urls.py

app_name = 'reviews'
     

Então você pode incluí-lo da maneira que está fazendo.

Além disso, pode valer a pena observar o que os documentos do Django dizem aqui https://docs.djangoproject.com/en/1.11/ref/urls/#include :

Obsoleto desde a versão 1.9: O suporte para o argumento app_name está obsoleto e será removido no Django 2.0. Especifique o app_name conforme explicado em namespaces de URL e URLconfs incluídos.

( https://docs.djangoproject.com/en/1.11/topics/http/urls/#namespaces-and-include )

Prumo
fonte
32

Django 2.0 você deve especificar app_name em seu urls.py , não é necessário especificar o argumento app_name no include.

Arquivo de URL principal.

from django.contrib import admin
from django.urls import path, include

urlpatterns = [
    path('', include('apps.main.urls')),
    path('admin/', admin.site.urls),
]

Url incluído.

from django.urls import path
from . import views

app_name = 'main_app'

urlpatterns = [
    path('', views.index, name='index'),
]

Em seguida, use o uso no modelo como

<a href="{% url main_app:index' %}"> link </a>

Mais detalhes: https://code.djangoproject.com/ticket/28691 Django 2.0 Docs

Brayan Loayza
fonte
2
Eu me pergunto, qual é o uso de app_name = "main" é? e como django usa essa variável
Kanishk Tanwar
4

Incluí uma biblioteca ainda não compatível (totalmente) com django 2.1 (django_auth_pro_saml2). Portanto, crio um segundo arquivo saml_urls.py:

from django_saml2_pro_auth.urls import urlpatterns

app_name = 'saml'

Para que eu pudesse incluir os urls como:

from django.urls import include, re_path as url

urlpatterns = [
    ..., url(r'', include('your_app.saml_urls', namespace='saml')), ...
]

Hacky, mas funcionou para mim, enquanto url(r'^reviews/', include(('reviews.urls', 'reviews'), namespace='reviews'))não funcionou.

Herbert
fonte
0

Também estou enfrentando o mesmo erro no Django 2.2 e resolvo dessa forma

arquivo urls.py

urlpatterns = [
   path('publisher-polls/', include('polls.urls', namespace='publisher-polls')),
]

arquivo polls / urls.py

app_name = 'polls'
urlpatterns = [
  path('', views.IndexView.as_view(), name='index')
]

exemplo de uso de namespace no método de visualização baseado em calss

def get_absolute_url(self):
    from django.urls import reverse
    return reverse('polls.index', args=[str(self.id)])

exemplo de uso de namespace em templates

{% url 'polls:index' %}

Aqui enquetes: index mean app_name [definir em polls / arquivo urls.py ]: nome [definir em polls / urls.py arquivo dentro da função de caminho]

seu oficial, que é muito bom, você pode verificar para mais informações namespace_django_official_doc

Sayalok
fonte
-6

No meu caso, eu estava escrevendo os urls fora da lista de urlpatterns. Por favor cheque duas vezes.

coderanger
fonte
O que? hahaahaha
Brayan Loayza