Add a management command to list URL patterns

[Martín Peveri]

It would be practical to visualize all the urls of the application in a command, is it possible?. If it is not possible, it is something like this:

python manage.py routes

[Tim Graham]

​django-extensions has a show_urls command which "produce a tab-separated list of (url_pattern, view_function, name) tuples for a project." I'm not sure that this needs to be incorporated into Django itself.

[Martín Peveri]

I understand, but I depend on an extension. Tell me if you consider it to integrate it into the framework and I could send an RP. Thanks!

[Keryn Knight]

Can I suggest that its worth taking to the developers mailing list to discuss this possibility? As an anecdotal datapoint, I know I semi-frequently make use such a command when coming into a project which I've not previously been heavily involved with. The flat output (vs traversing a list of include() usages) gives a decent overview on what's what, and the contrib.admindocs package already provides a similar overview if installed into the admin.

It also isn't a huge amount of new work (in my mind, because ​I wrote a similar thing to the django-extensions command) precisely because it can depend on the same functions admindocs does. So the maintenance burden is arguably mostly already in place.

[Martín Peveri]

I think what Keryn Knight said is good. If approved, I could work on the ticket and send a PR.

[Tim Graham]

Someone could try to get a consensus on the DevelopersMailingList about this. I've never had a need for it myself. A rough criteria I've used for thinking about whether or not something should be in core is whether 80% of projects use it. The existence of an implementation in django-extensions demonstrates this can live as a third-party library which seems sufficient to me.

[Carlton Gibson]

Discussion at DjangoCon US 2022 suggests it would be a popular enough feature.

[Natalia Bidart]

​Link to post in the forum where consensus seems quite clear.

[Xavier Tilley]

I have the feature finished I just haven't had time to finished up the tests and documentation. Hopefully my day job will slow down a bit and I can get a PR in next month.

[Alexandr Artemyev]

Replying to Keanya Phelps:
Not sure if this change was made intentionally or by mistake.

Replying to Xavier Tilley:

I have the feature finished I just haven't had time to finished up the tests and documentation. Hopefully my day job will slow down a bit and I can get a PR in next month.

Do you still plan to make these changes?

Replying to Adam Johnson:
Could we push this feature?

[Chris Rose]

I've picked up the work started by Xavier Tilley and pushed a bit more onto it: ​https://github.com/django/django/pull/18347

[Ülgen Sarıkavak]

I've pinged Chris under the Github issue and with ​his approval, I'm taking the task. My plan is, first to consider which formatting options are needed, then to push the finalized version this weekend.

Replying to Chris Rose:

I've picked up the work started by Xavier Tilley and pushed a bit more onto it: ​https://github.com/django/django/pull/18347