Enum for management command verbosity levels

[MHLut]

Code of Conduct

• I agree to follow Django's Code of Conduct

Feature Description

Create an (int) enum for verbosity options in Django management commands.

This would be an optional feature for those who prefer a mapped value over a magic number. It would only affect Python code, as an add-on, and would not break existing management calls.

Problem

There is currently no default mapping for verbosity levels: only the numbers 0 to 4 are provided via the default management command option verbosity.

Using numbers directly does not clarify their meaning. They also trigger "magic number" warnings in linters.

Providing a standardized mapping in Django Core would:

1. More clearly define the meaning of each value.
2. Make verbosity-based if-statements more descriptive code.
3. Allow reusability of the values in documentation and tutorials.
4. Fix magic number warnings in linters and code other quality checkers.
5. Prevent developers from having to define such an enum themselves in their projects.

Request or proposal

request

Additional Details

Originally posted on the Django Forum: Should management command verbosity levels be labelled?.

Implementation Suggestions

Based on the current levels described in management help commands, the enum could look like this:

from enum import IntEnum


class Verbosity(IntEnum):
    MINIMAL = 0
    NORMAL = 1
    VERBOSE = 2
    VERY_VERBOSE = 3

Names chosen per the help output for the verbosity argument:

-v, --verbosity {0,1,2,3}
    Verbosity level; 0=minimal output, 1=normal output, 2=verbose output, 3=very verbose output

[github-actions]

Thank you MHLut for sharing your idea! We have a lot of them so please be patient. You can see the current queue here.

Community instructions

For commenters, please use the emoji reactions on the issue to express support, and/or concern easily. Please use the comments to ask questions or contribute knowledge about the idea. It is unhelpful to post comments of "I'd love this" or "What's the state of this?"

Reaction Guide

• 👍 This is something I would use
• 👎 This is something that would cause problems for me or Django
• 😕 I’m indifferent to this
• 🎉 This is an easy win

[adamchainz]

Looks like there's plenty of support here, and it's a small feature, so I'd say we're ready to move to a ticket and implementation!