[1.8.x] Fixed #25526 -- Documented how to output colored text in custom management commands.

Backport of d26207d56c from master
This commit is contained in:
Elena Oat 2015-11-08 10:47:21 +01:00 committed by Tim Graham
parent b4aa38d106
commit a9f1ea3275
1 changed files with 15 additions and 0 deletions

View File

@ -320,6 +320,21 @@ All attributes can be set in your derived class and can be used in
because attempting to set the locale needs access to settings. This
condition will generate a :class:`CommandError`.
.. attribute:: BaseCommand.style
An instance attribute that helps create colored output when writing to
``stdout`` or ``stderr``. For example::
self.stdout.write(self.style.NOTICE('...'))
See :ref:`syntax-coloring` to learn how to modify the color palette and to
see the available styles (use uppercased versions of the "roles" described
in that section).
If you pass the :djadminopt:`--no-color` option when running your
command, all ``self.style()`` calls will return the original string
uncolored.
Methods
-------