[Django] #25264: Misleading
Django
--------------------------------------------+--------------------
Reporter: mlorant | Owner: nobody
Type: Bug | Status: new
Component: Core (Management commands) | Version: master
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 0
--------------------------------------------+--------------------
Every commands has some options available, since the `BaseCommand`
initialize some options to the options parser: verbosity, settings,
traceback..
However, this can be misleading, because these arguments are not used by
every commands and sometimes this choice is ''by design''. For example,
the `runserver` command does not use the `verbosity` option, and it has
been explained why only there: https://code.djangoproject.com/ticket/15132
I think the framework should not show generic options that are not used in
the current commands (through an explicit list of generic options ignored
or an explicit list of commands used ?)
--
Ticket URL: <https://code.djangoproject.com/ticket/25264>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
-------------------------------------+-------------------------------------
Reporter: mlorant | Owner: nobody
Type: Bug | Status: new
commands) |
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 mlorant):
* needs_better_patch: => 0
* needs_docs: => 0
* needs_tests: => 0
--
Ticket URL: <https://code.djangoproject.com/ticket/25264#comment:1>
Django
-------------------------------------+-------------------------------------
Type: | Status: new
Cleanup/optimization |
Component: Core (Management | Version: master
commands) |
Severity: Normal | Resolution:
Has patch: 0 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Changes (by timgraham):
* type: Bug => Cleanup/optimization
* stage: Unreviewed => Accepted
Comment:
I don't know that this is a big problem that is worth changing, but I
guess if someone wants to propose a patch to fix the issue for
`runserver`, we could entertain it. The documentation says these options
are "[https://docs.djangoproject.com/en/1.8/ref/django-admin/#default-
options available on all options]" so this would require an update too.
One consideration is that subclasses of `runserver` might use these
options (`verbosity` most likely) so removing them by default would be
backwards incompatible.
--
Ticket URL: <https://code.djangoproject.com/ticket/25264#comment:2>
Django
-------------------------------------+-------------------------------------
Type: | Status: new
Cleanup/optimization |
Component: Core (Management | Version: dev
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
Changes (by David Smith):
* easy: 0 => 1
--
Ticket URL: <https://code.djangoproject.com/ticket/25264#comment:3>
Django
-------------------------------------+-------------------------------------
Type: | Status: assigned
Cleanup/optimization |
Component: Core (Management | Version: dev
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
* owner: nobody => Edald123
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/25264#comment:4>
Django
-------------------------------------+-------------------------------------
Type: | Status: new
Cleanup/optimization |
Component: Core (Management | Version: dev
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Edald123):
* owner: Edald123 => (none)
* status: assigned => new
--
Ticket URL: <https://code.djangoproject.com/ticket/25264#comment:5>
Django
-------------------------------------+-------------------------------------
Type: | Jeong
Cleanup/optimization | Status: assigned
Component: Core (Management | Version: dev
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
* owner: (none) => Yuneui Jeong
* status: new => assigned
Comment:
Can I have a look at and work on this ticket? This is my first
contribution, but I'll try my best.
--
Ticket URL: <https://code.djangoproject.com/ticket/25264#comment:6>
Django
-------------------------------------+-------------------------------------
Reporter: Maxime Lorant | Owner: Yuneui
Type: | Jeong
Cleanup/optimization | Status: assigned
Component: Core (Management | Version: dev
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Yuneui Jeong):
Here's the PR for this ticket: https://github.com/django/django/pull/14612
--
Ticket URL: <https://code.djangoproject.com/ticket/25264#comment:7>
Django
-------------------------------------+-------------------------------------
Reporter: Maxime Lorant | Owner: Yuneui
Type: | Jeong
Cleanup/optimization | Status: assigned
Component: Core (Management | Version: dev
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
* has_patch: 0 => 1
--
Ticket URL: <https://code.djangoproject.com/ticket/25264#comment:8>
Django
-------------------------------------+-------------------------------------
Reporter: Maxime Lorant | Owner: Yuneui
Type: | Jeong
Cleanup/optimization | Status: assigned
Component: Core (Management | Version: dev
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
* needs_better_patch: 0 => 1
--
Ticket URL: <https://code.djangoproject.com/ticket/25264#comment:9>
Django
-------------------------------------+-------------------------------------
Reporter: Maxime Lorant | Owner: Yuneui
Type: | Jeong
Cleanup/optimization | Status: assigned
Component: Core (Management | Version: dev
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Mariusz Felisiak):
* needs_better_patch: 1 => 0
* has_patch: 1 => 0
--
Ticket URL: <https://code.djangoproject.com/ticket/25264#comment:10>
Django
-------------------------------------+-------------------------------------
Type: | Status: new
Cleanup/optimization |
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
* owner: Yuneui Jeong => (none)
* status: assigned => new
--
Ticket URL: <https://code.djangoproject.com/ticket/25264#comment:11>
Django
-------------------------------------+-------------------------------------
Type: | Status: assigned
Cleanup/optimization |
Component: Core (Management | Version: dev
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
* owner: (none) => Jan Szoja
* status: new => assigned
Comment:
That shounds like nice and easy ticket for the beginner like myself.
I will start with allowing setting argparse.SUPPRESS(as suggester in PR)
in BaseCommand and possibly more advance way to tell which default
commands are supported. Will see.
--
Ticket URL: <https://code.djangoproject.com/ticket/25264#comment:12>
Django
-------------------------------------+-------------------------------------
Reporter: Maxime Lorant | Owner: Jan Szoja
Type: | Status: assigned
Cleanup/optimization |
Component: Core (Management | Version: dev
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Jan Szoja):
* cc: Jan Szoja (added)
* has_patch: 0 => 1
Comment:
Pull Request awailable at:
https://github.com/django/django/pull/14694
I've added new attribute to BaseCommand class, which allows to disable any
option/argument predefined in BaseCommand.create_parser.
All tests passed for admin_scripts.
--
Ticket URL: <https://code.djangoproject.com/ticket/25264#comment:13>
Django
-------------------------------------+-------------------------------------
Reporter: Maxime Lorant | Owner: Jan Szoja
Type: | Status: assigned
Cleanup/optimization |
Component: Core (Management | Version: dev
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
* needs_better_patch: 0 => 1
* needs_tests: 0 => 1
--
Ticket URL: <https://code.djangoproject.com/ticket/25264#comment:14>
Django
-------------------------------------+-------------------------------------
Reporter: Maxime Lorant | Owner: Jan Szoja
Type: | Status: assigned
Cleanup/optimization |
Component: Core (Management | Version: dev
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 1 | Patch needs improvement: 1
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Mariusz Felisiak):
* needs_docs: 0 => 1
--
Ticket URL: <https://code.djangoproject.com/ticket/25264#comment:15>
Django
-------------------------------------+-------------------------------------
Reporter: Maxime Lorant | Owner: Jan Szoja
Type: | Status: assigned
Cleanup/optimization |
Component: Core (Management | Version: dev
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
* needs_docs: 1 => 0
* needs_tests: 1 => 0
--
Ticket URL: <https://code.djangoproject.com/ticket/25264#comment:16>
Django
-------------------------------------+-------------------------------------
Reporter: Maxime Lorant | Owner: Jan Szoja
Type: | Status: assigned
Cleanup/optimization |
Component: Core (Management | Version: dev
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Jan Szoja):
* needs_better_patch: 1 => 0
--
Ticket URL: <https://code.djangoproject.com/ticket/25264#comment:17>
Django
-------------------------------------+-------------------------------------
Reporter: Maxime Lorant | Owner: Jan Szoja
Type: | Status: assigned
Cleanup/optimization |
Component: Core (Management | Version: dev
commands) |
Severity: Normal | Resolution:
| checkin
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Mariusz Felisiak):
* easy: 1 => 0
* stage: Accepted => Ready for checkin
--
Ticket URL: <https://code.djangoproject.com/ticket/25264#comment:18>
Django
-------------------------------------+-------------------------------------
Reporter: Maxime Lorant | Owner: Jan Szoja
Type: | Status: assigned
Cleanup/optimization |
Component: Core (Management | Version: dev
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"3cca5fdd3eb5906a385adaf9872581d4ed359041" 3cca5fdd]:
{{{
#!CommitTicketReference repository=""
revision="3cca5fdd3eb5906a385adaf9872581d4ed359041"
Refs #25264 -- Doc's that not all default options are supported by every
management command.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/25264#comment:19>
Django
-------------------------------------+-------------------------------------
Reporter: Maxime Lorant | Owner: Jan Szoja
Type: | Status: assigned
Cleanup/optimization |
Component: Core (Management | Version: dev
commands) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"97f377cd3520794f7d4e97b7aa1fa2093c426273" 97f377c]:
{{{
#!CommitTicketReference repository=""
revision="97f377cd3520794f7d4e97b7aa1fa2093c426273"
Refs #25264 -- Added test for command --help output with default options
and custom arguments.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/25264#comment:20>
Django
-------------------------------------+-------------------------------------
Reporter: Maxime Lorant | Owner: Jan Szoja
Cleanup/optimization |
Component: Core (Management | Version: dev
commands) |
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Mariusz Felisiak <felisiak.mariusz@…>):
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"b667ac24ead73300c49e265201b6c0b913ee36a3" b667ac2]:
{{{
#!CommitTicketReference repository=""
revision="b667ac24ead73300c49e265201b6c0b913ee36a3"
Fixed #25264 -- Allowed suppressing base command options in --help output.
This also suppresses -verbosity and --trackback options in the
runserver's help.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/25264#comment:21>
Django
-------------------------------------+-------------------------------------
Reporter: Maxime Lorant | Owner: Jan Szoja
Type: | Status: closed
Cleanup/optimization |
Component: Core (Management | Version: dev
commands) |
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"4e55806720f623f08ced65bf5927780ea210a80e" 4e55806]:
{{{
#!CommitTicketReference repository=""
revision="4e55806720f623f08ced65bf5927780ea210a80e"
[3.2.x] Refs #25264 -- Doc's that not all default options are supported by
every management command.
Backport of 3cca5fdd3eb5906a385adaf9872581d4ed359041 from main
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/25264#comment:22>