ImproperlyConfiguredError sobre app_name cuando se usa el espacio de nombres en include ()

105

Actualmente estoy probando Django. Utilizo el namespaceargumento en uno de mis include()s en urls.py. Cuando ejecuto el servidor e intento navegar, aparece este error.

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.

Estos son mis archivos 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)),
]

y

#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'),
]

¿Qué paso app_namecomo se indica en el mensaje de error?

Nelson M
fuente

Respuestas:

152

Consulte los documentos para incluir aquí .

Lo que ha hecho no es una forma aceptable de pasar parámetros para incluir. Podrías hacerlo:

url(r'^reviews/', include(('reviews.urls', 'reviews'), namespace='reviews')),
Unixia
fuente
Intenté esto y obtuve otro error ... url (r '^ reviews /', include ('reviews.urls', namespace = 'reviews', app_name = 'reviews')), TypeError: include () obtuvo un mensaje inesperado argumento de palabra clave 'nombre_aplicación'
Nelson M
1
Lo siento extremadamente. Se suponía que debía usarse con módulos, no con patrones. Verifique la respuesta actualizada.
unixia
1
Esta solución también fue útil para mí. Estaba siguiendo el tutorial de django-oauth-toolkit.readthedocs.io/en/latest/tutorial/… y hay una instrucción para hacer: urlpatterns = [# OAuth 2 endpoints: url (r '^ o /', include ( oauth2_endpoint_views, namespace = "oauth2_provider")), url (r '^ api / hello', ApiEndpoint.as_view ()), # un punto final de recurso de ejemplo]. Esto genera el mismo error que mencionaste.
Koji D'infinte
1
La sintaxis de tupla no funcionó para mí, solo funcionó cuando cambié (mi versión de) reviews.urlpara tener una app_namevariable en django 2.1.
Herbert
¿Cuál es el caso de uso para esto? Tengo muchas URL incluidas en mi proyecto y todas con el mismo patrón: path("the_app/", include(("app.urls", <name>), namespace=<the same name>))y es bastante molesto.
user4052054
80

Django 1.11+, 2.0+

Debe establecer el nombre de la aplicación en el archivo de URL que está incluyendo

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

app_name = 'reviews'
     

Entonces puede incluirlo de la forma en que lo está haciendo.

Además, podría valer la pena señalar lo que dicen los documentos de Django aquí https://docs.djangoproject.com/en/1.11/ref/urls/#include :

En desuso desde la versión 1.9: la compatibilidad con el argumento app_name está obsoleta y se eliminará en Django 2.0. Especifique el nombre_aplicación como se explica en los espacios de nombres URL e incluya URLconfs en su lugar.

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

Beto
fuente
32

Django 2.0 debe especificar app_name en su urls.py , no es necesario especificar el argumento app_name en incluir.

Archivo 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 incluida

from django.urls import path
from . import views

app_name = 'main_app'

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

Luego use usar en la plantilla como

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

Más detalles: https://code.djangoproject.com/ticket/28691 Django 2.0 Docs

Brayan Loayza
fuente
2
Me pregunto, ¿cuál es el uso de app_name = "main" es? y cómo Django usa esta variable
Kanishk Tanwar
4

Incluí una biblioteca que aún no es (totalmente) compatible con django 2.1 (django_auth_pro_saml2). Por lo tanto, creo un segundo archivo saml_urls.py:

from django_saml2_pro_auth.urls import urlpatterns

app_name = 'saml'

De modo que podría incluir las URL como:

from django.urls import include, re_path as url

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

Hacky, pero funcionó para mí, mientras que el url(r'^reviews/', include(('reviews.urls', 'reviews'), namespace='reviews'))no.

Herbert
fuente
0

También me enfrento al mismo error en Django 2.2 y lo resuelvo de esta manera

archivo urls.py

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

archivo polls / urls.py

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

ejemplo de uso del espacio de nombres en el método de vista basado en calss

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

ejemplo de uso de espacio de nombres en plantillas

{% url 'polls:index' %}

Aquí polls: index mean app_name [define in polls / urls.py file ]: name [define in polls / urls.py file inside path function]

su oficial, que es bastante bueno, puedes consultar más información namespace_django_official_doc

sayalok
fuente
-6

En mi caso, estaba escribiendo las URL fuera de la lista de patrones de URL. Revisa otra vez, por favor.

coderanger
fuente