Django command: How to insert newline in the help text?

Question

I was looking to do something like this, but for a Django management command: Python argparse: How to insert newline in the help text?

score 28 · Accepted Answer · edited Oct 05 '21 at 08:20

28

From the documentation

You can customize the instance by overriding this method and calling super() with kwargs of ArgumentParser parameters.

By overriding create_parser method you can set the formatter_class of the ArgumentParser:

from argparse import RawTextHelpFormatter
from django.core.management.base import BaseCommand


class Command(BaseCommand):
    def create_parser(self, *args, **kwargs):
        parser = super(Command, self).create_parser(*args, **kwargs)
        parser.formatter_class = RawTextHelpFormatter
        return parser

edited Oct 05 '21 at 08:20

oglop

1,175
1
9
15

answered Feb 18 '16 at 00:44

Seán Hayes

4,060
4
33
48

2

Sure would be nice to have multiline help text be the default for management commands project wide. – shacker Sep 08 '17 at 21:32
1

How do you apply this to `help_text`? – alias51 May 31 '21 at 11:41
Unclear or partial answer. How to use this with `help_text`. Can you please state the elaborated answer – ajinzrathod Sep 08 '21 at 08:34

score 4 · Answer 2 · answered Nov 27 '19 at 10:59

4

You can insert the new line in help_text by entering the HTML
tag

For e.g.

name=models.Charfield(max_length=10, help_text="Enter First name or <br/> Enter full name")

answered Nov 27 '19 at 10:59

OM Tiwari

75
2

4

This is not for a django management command, but Model field help text to be displayed in admin. – smido Mar 06 '20 at 09:42

Django command: How to insert newline in the help text?

2 Answers2