Specifying a namespace in include() without providing an app_name is not supported

created at 07-17-2021 views: 6

error message

File "I:\xx\urls.py", line 22, in <module>
    url('', include('system.urls', namespace='system-urls')),
File "I:\xx\venv\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.

error code

urlpatterns = [
    url('', include('apps.urls', namespace='apps-urls')),
    ]

environment:

django == 2.1

The error means:

django.core.exceptions.ImproperlyConfigured: does not support specifying the namespace in include() without providing app_name. Set the app_name attribute in the included module, or pass a 2-tuple containing a list of patterns and app_name.

Source file:

def include(arg, namespace=None):
    app_name = None
    if isinstance(arg, tuple):
        # Callable returning a namespace hint.
        try:
            urlconf_module, app_name = arg
        except ValueError:
            if namespace:
                raise ImproperlyConfigured(
                    'Cannot override the namespace for a dynamic module that '
                    'provides a namespace.'
                )
            raise ImproperlyConfigured(
                'Passing a %d-tuple to include() is not supported. Pass a '
                '2-tuple containing the list of patterns and app_name, and '
                'provide the namespace argument to include() instead.' % len(arg)
            )
    else:
        # No namespace hint - use manually provided namespace.
        urlconf_module = arg

    if isinstance(urlconf_module, str):
        urlconf_module = import_module(urlconf_module)
    patterns = getattr(urlconf_module, 'urlpatterns', urlconf_module)
    app_name = getattr(urlconf_module, 'app_name', app_name)
    if namespace and not app_name:
        raise 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.',
        )
    namespace = namespace or app_name
    # Make sure the patterns can be iterated through (without this, some
    # testcases will break).
    if isinstance(patterns, (list, tuple)):
        for url_pattern in patterns:
            pattern = getattr(url_pattern, 'pattern', None)
            if isinstance(pattern, LocalePrefixPattern):
                raise ImproperlyConfigured(
                    'Using i18n_patterns in an included URLconf is not allowed.'
                )
    return (urlconf_module, app_name, namespace)

As you can see from the above source code, include requires two parameters, arg and namespace. When namespace is not empty, the arg parameter must be a 2-tuple. In addition to urlpatterns, app_name must also be filled in.

solution

urlpatterns = [
    url('', include(('apps.urls', 'apps'), namespace='apps-urls')),
    ]
Please log in to leave a comment.