Update docs and project template to avoid "import *" for url patterns

[Rob Hudson]

Now that we have ​http://code.djangoproject.com/changeset/13590, we should probably avoid the import * for urls in our docs and project template.

[Gabriel Hurley]

I've often been bothered by the from django.conf.urls.defaults import * pattern myself, since we so often encourage people not to use import *. While technically that module does define __all__, I'd still rather see patterns, url, include, et. al. imported explicitly anyway. So I'm all for this change.

[Pablo Fernandez]

Explicitly included functions from urls.default for the project template.

[Pablo Fernandez]

Explicitly included functions from urls.default in django itself.

[Pablo Fernandez]

Explicitly included functions from urls.default in contrib apps.

[Pablo Fernandez]

Explicitly included functions from urls.default in documentation.

[Pablo Fernandez]

Explicitly included functions from urls.default in documentation for contrib apps.

[Pablo Fernandez]

Explicitly included functions from urls.default in tests.

[Pablo Fernandez]

Hello,

I wanted to make my first contribution to Django and this looked simple enough, I hope I did it correctly. My goal with this set of patches was to totally eradicate the import of * from urls.default. I've separated it in various parts so it's easy to pick what you consider is the correct set of changes starting with the small change to the template for new projects up to modifying every contrib app and test to follow this best practices.

[Pablo Fernandez]

Oh, something I didn't modify is the documentation for Django < 1.3, as I presume that should be left alone as it is now.

[Keryn Knight <keryn@…>]

I'm totally in favour of deprecating the star import, as it's something that's bugged me previously.

After a cursory glance of the changeset and the diffs pupeno has provided, I'd like to suggest that the documentation diff may need further work, to clarify the change as it affects handler404 & handler500.

Mostly, That takes care of setting ``handler404`` in the current module. [...] occurs in a couple of places, and whilst still semi-accurate now that we fallback instead of grabbing via a star import, it feels like further explanation might be expounded. However, as the changeset doesn't seem to have any doc changes, I'm not sure if this is already covered elsewhere.

[Gabriel Hurley]

Agreed with Keryn Knight that a few words in the docs would be helpful. However, this change is much more relevant to the rest of the codebase than it is to the docs, so I'm changing the component.

I have not tested this patch. Someone needs to apply it against trunk and verify that it passes the full test suite as well.

[Craig de Stigter]

all-in-one patch, & fixed typo in regressiontests/urlpatterns_reverse/included_named_urls2.py

[Craig de Stigter]

all-in-one patch, with tweaked docs and made from django.conf.urls import patterns work (& the standard way to import url functions)

[Craig de Stigter]

It struck me that we're making things awfully verbose by getting rid of the 'import *'...

So to compensate, I removed the '.defaults', which has always bugged me.

It's just easier to remember than 'from django.conf.urls.defaults import patterns'. The 'defaults' should be implied.

This shouldn't break anything, the code is still in defaults.py.

[Ramiro Morales]

This has been partially fixed in [15401].

[Carl Meyer]

Based on discussion in IRC with Alex and Russell, adding the ability to import from just "django.conf.urls" is good, but a feature not a bugfix, so not a candidate for 1.3 at this point. And we don't want to do two passes through all the contrib apps etc, so we're just going to hold off on the rest of this patch until after 1.3 is released.

[Carl Meyer]

In [15415]:

Refs #14675 - Added import of url() function in project template urls.py, added commented sample named url, and converted existing sample patterns to use url().

[Julien Phalip]

Changing the milestone as per Carl's comment above.

[patchhammer]

14675-remove-import-star-from-urlconfs-2.patch fails to apply cleanly on to trunk

[Ramiro Morales]

Patch updated to apply cleanly as of now

[Ramiro Morales]

Updated patch

[Ramiro Morales]

In [16818]:

Fixed #14675 -- Completed removal of from django.conf.urls.default import * usage.

This applies to both our own [test] code and documentation examples. Also:

• Moved the functions and handlers from django.conf.urls.defaults up to django.conf.urls deprecating the former module.
• Added documentation for handler403.
• Tweaked the URLs topic document a bit.

Thanks to pupeno and cdestigter for their great work contributing patches.

[GitHub <noreply@…>]

In 1136d57f:

Updated a test to reflect the fact that "import *" isn't used in URLconfs anymore (refs #14675).