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

[Ülgen Sarıkavak]

The PR is ready to be reviewed 🙌🏻

[Ülgen Sarıkavak]

I'm a bit confused about who should set the "Ready for checkin" flag. The current info box on this page says

For a Django committer to do a final review of the patch and merge it if all looks good.

so I thought this is the correct state to be in but now the issue is no longer visible under https://code.djangoproject.com/query?status=!closed&needs_better_patch=0&needs_tests=0&needs_docs=0&has_patch=1&stage=Accepted&desc=1&order=changetime so I guess I shouldn't have touched that flag. Considering

If you’re really not certain if a ticket is ready, don’t mark it as such.

warning from ​https://docs.djangoproject.com/en/dev/internals/contributing/new-contributors/#be-cautious-when-marking-things-ready-for-check-in , I'm changing that flag back.

Sorry for the extra notifications going to the followers of the issue.

[Fabio Pozzi]

I was wondering if this is being worked on or if I can try to pick it up.

[Adam Johnson]

You can try picking it up, copying the existing PR and addressing the feedback! We call it the vulture strategy: ​https://youtu.be/A-3eTMNQ3rM?si=F3UmjFl_IfXk-3uH

[Ülgen Sarıkavak]

We give some time to original author to respond before vulturing tho :)

Let me give push the changes I had in mind first and if that gets a big review that I have no time to handle, I will inform you.

[Chris Rose]

I'm not actively working on it at the moment, so as far as I'm concerned go ahead.

[Johanan Oppong Amoateng]

Replying to Ülgen Sarıkavak:

We give some time to original author to respond before vulturing tho :)

Let me give push the changes I had in mind first and if that gets a big review that I have no time to handle, I will inform you.

Are you still actively working on this ticket?

[Ülgen Sarıkavak]

Replying to Johanan Oppong Amoateng:

Are you still actively working on this ticket?

Sorry for the silence on my end, but yes I am. Because the review process for my initial submission was overwhelming and not really productive in my opinion, I'm trying to pursue a different path, creating the command as a 3rd party library. I can share the link here when it's ready - but I promise it won't take longer than a week.

If you don't get another notification with a repo link in a week, please feel free to move forward with the task.

[Johanan Oppong Amoateng]

Replying to Ülgen Sarıkavak:

Replying to Johanan Oppong Amoateng:

Are you still actively working on this ticket?

Sorry for the silence on my end, but yes I am. Because the review process for my initial submission was overwhelming and not really productive in my opinion, I'm trying to pursue a different path, creating the command as a 3rd party library. I can share the link here when it's ready - but I promise it won't take longer than a week.

If you don't get another notification with a repo link in a week, please feel free to move forward with the task.

noted thank you

[Chris Rose]

I'm currently at PyCon US and was hoping I could either get ​https://github.com/django/django/pull/18769 (by Ülgen) or my own ​https://github.com/django/django/pull/18347 across the line.

I don't know why the two PRs got caught up in a very long back and forth process over what looks like a relatively simple management command, but I'd like to finish this up and land it.

[Jacob Walls]

Looking good, left a question about the DJANGO_COLORS env var.

[Jacob Walls]

Need to handle class-based views, which I think were supported in the django-extensions version, included a proposed fix.

[Jacob Walls <jacobtylerwalls@…>]

In 804660d6:

Refs #28800 -- Lifted some url functions from admindocs into urls.utils.

[Jacob Walls <jacobtylerwalls@…>]

In 22d25eff:

Refs #28800 -- Handled escaped literals in simplify_regex().

[Jacob Walls <jacobtylerwalls@…>]

In 9383fae0:

Fixed #28800 -- Added a listurls management command.

Thanks JaeHyuck Sa, Jacob Walls, and Tim McCurrach for reviews.

Co-authored-by: Ülgen Sarıkavak <ulgensrkvk@…>