[Django] #28800: List routes in the console

[Django]

#28800: List routes in the console
-----------------------------------------+------------------------
Reporter: Martín Peveri | Owner: nobody
Type: New feature | Status: new
Component: Core (URLs) | Version: 1.11
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-----------------------------------------+------------------------
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

--
Ticket URL: <https://code.djangoproject.com/ticket/28800>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#28800: List routes in the console

-------------------------------+--------------------------------------

Reporter: Martín Peveri | Owner: nobody
Type: New feature | Status: new
Component: Core (URLs) | Version: 1.11

Severity: Normal | Resolution:

Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------+--------------------------------------

Comment (by Tim Graham):

[https://github.com/django-extensions/django-extensions 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.

--
Ticket URL: <https://code.djangoproject.com/ticket/28800#comment:1>

[Django]

#28800: List routes in the console

-------------------------------+--------------------------------------

Reporter: Martín Peveri | Owner: nobody
Type: New feature | Status: new
Component: Core (URLs) | Version: 1.11

Severity: Normal | Resolution:

Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------+--------------------------------------

Comment (by 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!

--
Ticket URL: <https://code.djangoproject.com/ticket/28800#comment:2>

[Django]

#28800: List routes in the console

-------------------------------+--------------------------------------

Reporter: Martín Peveri | Owner: nobody
Type: New feature | Status: new
Component: Core (URLs) | Version: 1.11

Severity: Normal | Resolution:

Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------+--------------------------------------
Changes (by Keryn Knight):

* cc: Keryn Knight (added)

Comment:

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
[https://github.com/kezabelle/django-unfurl 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.

--
Ticket URL: <https://code.djangoproject.com/ticket/28800#comment:3>

[Django]

#28800: List routes in the console

-------------------------------+--------------------------------------

Reporter: Martín Peveri | Owner: nobody
Type: New feature | Status: new
Component: Core (URLs) | Version: 1.11

Severity: Normal | Resolution:

Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------+--------------------------------------

Comment (by Martín Peveri):

I like what I say Keryn Knight. If approved, I could work on the ticket
and send a PR.

--
Ticket URL: <https://code.djangoproject.com/ticket/28800#comment:4>

[Django]

#28800: Add a management command to list URL patterns
-------------------------------------+-------------------------------------

Reporter: Martín Peveri | Owner: nobody
Type: New feature | Status: new

Component: Core (Management | Version: 1.11
commands) |

Severity: Normal | Resolution:
Keywords: | Triage Stage:

| Someday/Maybe

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------
Changes (by Tim Graham):

* stage: Unreviewed => Someday/Maybe
* component: Core (URLs) => Core (Management commands)

Comment:

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.

--
Ticket URL: <https://code.djangoproject.com/ticket/28800#comment:5>

[Django]

#28800: Add a management command to list URL patterns
-------------------------------------+-------------------------------------

Reporter: Martín Peveri | Owner: Xavier
| Tilley
Type: New feature | Status: assigned

Component: Core (Management | Version: 1.11
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Someday/Maybe

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------
Changes (by Xavier Tilley):

* owner: nobody => Xavier Tilley
* status: new => assigned

--
Ticket URL: <https://code.djangoproject.com/ticket/28800#comment:6>

[Django]

#28800: Add a management command to list URL patterns
-------------------------------------+-------------------------------------
Reporter: Martín Peveri | Owner: Xavier
| Tilley
Type: New feature | Status: assigned
Component: Core (Management | Version: 1.11
commands) |
Severity: Normal | Resolution:

Keywords: | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------
Changes (by Carlton Gibson):

* stage: Someday/Maybe => Accepted

Comment:

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

--
Ticket URL: <https://code.djangoproject.com/ticket/28800#comment:7>

[Django]

#28800: Add a management command to list URL patterns
-------------------------------------+-------------------------------------
Reporter: Martín Peveri | Owner: Xavier
| Tilley
Type: New feature | Status: assigned
Component: Core (Management | Version: 1.11
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------
Changes (by Adam Johnson):

* cc: Adam Johnson (added)

--
Ticket URL: <https://code.djangoproject.com/ticket/28800#comment:8>

[Django]

#28800: Add a management command to list URL patterns
-------------------------------------+-------------------------------------
Reporter: Martín Peveri | Owner: Xavier
| Tilley
Type: New feature | Status: assigned
Component: Core (Management | Version: 1.11
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------

Comment (by Tom Carrick):

This looks very similar to the new `GeneratedField` - is there still some
value here?

--
Ticket URL: <https://code.djangoproject.com/ticket/28800#comment:9>

[Django]

#28800: Add a management command to list URL patterns
-------------------------------------+-------------------------------------
Reporter: Martín Peveri | Owner: Xavier
| Tilley
Type: New feature | Status: assigned
Component: Core (Management | Version: 1.11
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------

Comment (by Natalia Bidart):

Discussion in the forum where consensus seems quite clear:
https://forum.djangoproject.com/t/should-the-show-urls-command-be-part-of-
djangos-standard-library/20739

--
Ticket URL: <https://code.djangoproject.com/ticket/28800#comment:9>

[Django]

#28800: Add a management command to list URL patterns
-------------------------------------+-------------------------------------
Reporter: Martín Peveri | Owner: Xavier
| Tilley
Type: New feature | Status: assigned
Component: Core (Management | Version: 1.11
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------

Comment (by 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.

--
Ticket URL: <https://code.djangoproject.com/ticket/28800#comment:10>

[Django]

#28800: Add a management command to list URL patterns
-------------------------------------+-------------------------------------

Reporter: Martín Peveri | Owner: Keanya
| Phelps

Type: New feature | Status: assigned
Component: Core (Management | Version: 1.11
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------
Changes (by Keanya Phelps):

* owner: Xavier Tilley => Keanya Phelps

--
Ticket URL: <https://code.djangoproject.com/ticket/28800#comment:11>

[Django]

#28800: Add a management command to list URL patterns
-------------------------------------+-------------------------------------
Reporter: Martín Peveri | Owner: Keanya
| Phelps
Type: New feature | Status: assigned
Component: Core (Management | Version: 1.11
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------
Comment (by Alexandr Artemyev):

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

Replying to [comment:10 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 [comment:8 Adam Johnson]:
Could we push this feature?
--
Ticket URL: <https://code.djangoproject.com/ticket/28800#comment:12>

[Django]

#28800: Add a management command to list URL patterns
-------------------------------------+-------------------------------------
Reporter: Martín Peveri | Owner: Keanya
| Phelps
Type: New feature | Status: assigned
Component: Core (Management | Version: 1.11
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------
Changes (by Ryan Hiebert):

* cc: Ryan Hiebert (added)

--
Ticket URL: <https://code.djangoproject.com/ticket/28800#comment:13>

[Django]

#28800: Add a management command to list URL patterns
-------------------------------------+-------------------------------------
Reporter: Martín Peveri | Owner: Keanya
| Phelps
Type: New feature | Status: assigned

Component: Core (Management | Version: 5.1

commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0
Needs tests: 1 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------
Changes (by Chris Rose):

* cc: Chris Rose (added)
* has_patch: 0 => 1
* needs_tests: 0 => 1
* version: 1.11 => 5.1

Comment:

I've picked up the work started by Xavier Tilley and pushed a bit more
onto it.
--
Ticket URL: <https://code.djangoproject.com/ticket/28800#comment:14>

[Django]

#28800: Add a management command to list URL patterns
-------------------------------------+-------------------------------------

Reporter: Martín Peveri | Owner: Ülgen
| Sarıkavak

Type: New feature | Status: assigned
Component: Core (Management | Version: 5.1
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0
Needs tests: 1 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------
Changes (by Ülgen Sarıkavak):

* owner: Keanya Phelps => Ülgen Sarıkavak

Comment:

I've pinged Chris under the Github issue and with
[https://github.com/django/django/pull/18347#issuecomment-2444708485 his
approval], I'm taking the task. My plan is, first to consider with
formatting options are needed, then to push the finalized version this
weekend.

Replying to [comment:14 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
--
Ticket URL: <https://code.djangoproject.com/ticket/28800#comment:15>

[Django]

#28800: Add a management command to list URL patterns
-------------------------------------+-------------------------------------
Reporter: Martín Peveri | Owner: Ülgen
| Sarıkavak
Type: New feature | Status: assigned
Component: Core (Management | Version: 5.1
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0
Needs tests: 1 | Patch needs improvement: 1

Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------
Changes (by Ülgen Sarıkavak):

* needs_better_patch: 0 => 1

--
Ticket URL: <https://code.djangoproject.com/ticket/28800#comment:16>

[Django]

#28800: Add a management command to list URL patterns
-------------------------------------+-------------------------------------
Reporter: Martín Peveri | Owner: Ülgen
| Sarıkavak
Type: New feature | Status: assigned
Component: Core (Management | Version: 5.1
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0
Needs tests: 1 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------
Changes (by Ülgen Sarıkavak):

* needs_better_patch: 1 => 0

Comment:

The PR is ready to be reviewed 🙌🏻
--
Ticket URL: <https://code.djangoproject.com/ticket/28800#comment:17>

[Django]

#28800: Add a management command to list URL patterns
-------------------------------------+-------------------------------------
Reporter: Martín Peveri | Owner: Ülgen
| Sarıkavak
Type: New feature | Status: assigned
Component: Core (Management | Version: 5.1
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------
Changes (by Ülgen Sarıkavak):

* needs_tests: 1 => 0

--
Ticket URL: <https://code.djangoproject.com/ticket/28800#comment:18>

[Django]

#28800: Add a management command to list URL patterns
-------------------------------------+-------------------------------------
Reporter: Martín Peveri | Owner: Ülgen
| Sarıkavak
Type: New feature | Status: assigned
Component: Core (Management | Version: 5.1
commands) |
Severity: Normal | Resolution:

Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------
Changes (by Ülgen Sarıkavak):

* stage: Accepted => Ready for checkin

--
Ticket URL: <https://code.djangoproject.com/ticket/28800#comment:19>

[Django]

#28800: Add a management command to list URL patterns
-------------------------------------+-------------------------------------
Reporter: Martín Peveri | Owner: Ülgen
| Sarıkavak
Type: New feature | Status: assigned
Component: Core (Management | Version: 5.1
commands) |
Severity: Normal | Resolution:

Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------
Changes (by Ülgen Sarıkavak):

* stage: Ready for checkin => Accepted

Comment:

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.
--
Ticket URL: <https://code.djangoproject.com/ticket/28800#comment:20>

[Django]

#28800: Add a management command to list URL patterns
-------------------------------------+-------------------------------------
Reporter: Martín Peveri | Owner: Ülgen
| Sarıkavak
Type: New feature | Status: assigned
Component: Core (Management | Version: 5.1
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1

Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------
Changes (by Sarah Boyce):

* needs_better_patch: 0 => 1

--
Ticket URL: <https://code.djangoproject.com/ticket/28800#comment:21>