#28412: BaseCommand "help" masks Python builtin
-------------------------------+--------------------------------------
Reporter: Carl Dunham | Owner: nobody
Type: Uncategorized | Status: new
Component: Uncategorized | 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
-------------------------------+--------------------------------------
Description changed by Carl Dunham:
Old description:
> When creating a command using BaseCommand, the help text is included in a
> class variable called 'help'. This masks the Python global 'help'
> function.
>
> While not likely to arise in normal use ('help' is considered an
> interactive command), this isn't a good code smell.
>
> {{{
> class Command(BaseCommand):
> help = 'Useful Advice'
> }}}
>
> https://pypi.python.org/pypi/flake8-builtins could be considered helpful
> here.
New description:
When creating a command using BaseCommand, the help text is included in a
class attribute called 'help'. This masks the Python global 'help'
function.
While not likely to arise in normal use ('help' is considered an
interactive command), this isn't a good code smell.
{{{
class Command(BaseCommand):
help = 'Useful Advice'
}}}
https://pypi.python.org/pypi/flake8-builtins could be considered helpful
here.
--
--
Ticket URL: <https://code.djangoproject.com/ticket/28412#comment:1>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/068.bba38656011efb493936bd23f4acbac8%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
