Django management command cannot see arguments?

Question

Since upgrading to Django 1.8, there's a strange bug in my Django management command.

I run it as follows:

python manage.py my_command $DB_NAME $DB_USER $DB_PASS

And then I collect the arguments as follows:

class Command(BaseCommand):

def handle(self, *args, **options):
    print args
    db_name = args[0]
    db_user = args[1]
    db_pass = args[2]
    self.conn = psycopg2.connect(database=db_name, user=db_user,
                                 password=db_pass)

Previously this worked fine, but now I see this error:

usage: manage.py my_command [-h] [--version] [-v {0,1,2,3}]
                                             [--settings SETTINGS]
                                             [--pythonpath PYTHONPATH]
                                             [--traceback] [--no-color]
manage.py my_command: error: unrecognized arguments: test test test

It's not even getting as far as the print args statement.

If I run it without any arguments, then it errors on the args[0] line, unsurprisingly.

Am I using args wrong here? Or is something else going on?

Is this a real case scenario? There is already dbshell in Django. You're reinventing the wheel. You can call the DB command line with python manage.py dbshell. — cezar
– cezar, Commented Jan 18, 2018 at 9:28

Géry Ogam · Accepted Answer · 2022-09-29 14:14:57Z

6

It is a change in Django 1.8. As detailed here:

Management commands that only accept positional arguments

If you have written a custom management command that only accepts positional arguments and you didn’t specify the args command variable, you might get an error like Error: unrecognized arguments: ..., as variable parsing is now based on argparse which doesn’t implicitly accept positional arguments. You can make your command backwards compatible by simply setting the args class variable. However, if you don’t have to keep compatibility with older Django versions, it’s better to implement the new add_arguments() method as described in Writing custom django-admin commands.

edited Sep 29, 2022 at 14:14

Géry Ogam

8,4345 gold badges53 silver badges89 bronze badges

answered May 14, 2015 at 18:10

Vlad Schnakovszki

8,6126 gold badges84 silver badges115 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

CodeMagnet · Accepted Answer · 2017-09-07 04:58:57Z

5

def add_arguments(self, parser):
    parser.add_argument('args', nargs='*')

Add the above for compatibility, breaking it was a really unwise decision from the folks updating the django.

answered Sep 7, 2017 at 4:58

CodeMagnet

511 silver badge1 bronze badge

1 Comment

cezar Over a year ago

This is the right way to specify the arguments. However I don't agree that it was really unwise. Sometimes you have to break with the past and move forward.

Collectives™ on Stack Overflow

Django management command cannot see arguments?

2 Answers 2

Management commands that only accept positional arguments

Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Management commands that only accept positional arguments

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related