#33387: Separate between words in Django commands and methods
-------------------------------------+-------------------------------------
Reporter: אורי | Owner: nobody
Type: | Status: closed
Cleanup/optimization |
Component: Core (Management | Version: dev
commands) |
Severity: Normal | Resolution: wontfix
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 אורי:
Old description:
> I checked the list of [https://docs.djangoproject.com/en/4.0/ref/django-
> admin/ Django commands], and a long time ago I noticed that many of them
> contain two or even three words but they are not separated. For example
> `makemigrations`, `makemessages`, `changepassword` and `createsuperuser`.
> Although I found commands with separated words such as
> `remove_stale_contenttypes` (which I was not aware of until right now). I
> checked [https://www.python.org/dev/peps/pep-0008/#function-and-variable-
> names PEP 8] and there it is written:
>
> > Function names should be lowercase, with words separated by underscores
> as necessary to improve readability.
> >
> > Variable names follow the same convention as function names.
>
> I think Django commands should follow the same logic, and separate words
> by underscores (`make_migrations`, `make_messages`, `change_password` and
> `create_super_user`, `remove_stale_content_types`). I suggest that you
> add the new spelling while keeping the old spelling working, or maybe
> deprecate the old spelling but for at least 3 Django releases, so they
> will still work. But according to PEP 8 I think words should be separated
> by underscores.
>
> This is also relevant to `TestCase` methods such as `setUp` and
> `tearDownClass`. Although there I assume Django inherits them from Python
> the language, and maybe the changes should be done also there.
>
> By the way, I already defined a few such commands in Speedy Net since
> 2019:
> https://github.com/speedy-net/speedy-
> net/tree/master/speedy/core/base/management/commands
New description:
I checked the list of [https://docs.djangoproject.com/en/4.0/ref/django-
admin/ Django commands], and a long time ago I noticed that many of them
contain two or even three words but they are not separated. For example
`makemigrations`, `makemessages`, `changepassword` and `createsuperuser`.
Although I found commands with separated words such as
`remove_stale_contenttypes` (which I was not aware of until right now). I
checked [https://www.python.org/dev/peps/pep-0008/#function-and-variable-
names PEP 8] and there it is written:
> Function names should be lowercase, with words separated by underscores
as necessary to improve readability.
>
> Variable names follow the same convention as function names.
I think Django commands should follow the same logic, and separate words
by underscores (`make_migrations`, `make_messages`, `change_password`,
`create_super_user`, `remove_stale_content_types`). I suggest that you add
the new spelling while keeping the old spelling working, or maybe
deprecate the old spelling but for at least 3 Django releases, so they
will still work. But according to PEP 8 I think words should be separated
by underscores.
This is also relevant to `TestCase` methods such as `setUp` and
`tearDownClass`. Although there I assume Django inherits them from Python
the language, and maybe the changes should be done also there.
By the way, I already defined a few such commands in Speedy Net since
2019:
https://github.com/speedy-net/speedy-
net/tree/master/speedy/core/base/management/commands
--
--
Ticket URL: <https://code.djangoproject.com/ticket/33387#comment:3>
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 view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/069.0a483ba34f83ff3dd5604989843e3989%40djangoproject.com.
