mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-07-19 00:59:17 +00:00
Code Issues 32 Releases Wiki Activity

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

Browse Source 
Backport of d26207d56cab21e3767121d53ebaddbbfc78a4ce from master
This commit is contained in:
Elena Oat 2015-11-08 10:47:21 +01:00 committed by Tim Graham
parent 361038ee03
commit 43da3179a4
1 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/howto/custom-management-commands.txt
View File

@ -67,7 +67,7 @@ look like this::
poll.opened = False
poll.save()
self.stdout.write('Successfully closed poll "%s"' % poll_id)
self.stdout.write(self.style.SUCCESS('Successfully closed poll "%s"' % poll_id))
.. versionchanged:: 1.8
@ -303,6 +303,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.SUCCESS('...'))
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
-------