Django custom command error: unrecognized arguments

Question

I'm trying to create a command similar to createsuperuser which will take two arguments (username and password)

Its working fine in django 1.7 but not in 1.8. (I'm also using python3.4)

this is the code I wrote

myapp/management/commands/createmysuperuser.py

from django.core.management.base import BaseCommand, CommandError
from django.contrib.auth.models import User


class Command(BaseCommand):
    help = 'Create a super user'

    def handle(self, *args, **options):

        if len(args) != 2:
            raise CommandError('need exactly two arguments for username and password')
        username, password = args

        u, created = User.objects.get_or_create(username=username)
        if created:
            u.is_superuser = True
            u.is_staff = True
            u.set_password(password)
            u.save()
        else:
            raise CommandError("user '%s' already exist" % username)

        return "Password changed successfully for user '%s'" % u.username

and when I try to run this command

$ python manage.py createmysuperuser myuser mypassword

I get this error

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

but when I dont pass any arguments it raises CommandError which is expected.

CommandError: need exactly two arguments for username and password

catavaran · Accepted Answer · 2015-05-14 10:13:44Z

42

In django 1.8 you should add arguments to you command:

class Command(BaseCommand):
    ...
    def add_arguments(self, parser):
        parser.add_argument('username')
        parser.add_argument('password')

add_argument() method of argparse is documented here.

UPDATE: By default arguments are passed in the options parameter so the handle() method should look like this:

def handle(self, *args, **options):
    username = options['username']
    password = options['password']
    ...

And you don't need to check the length of the args list - it is already done by argparse. This is the recommended method but if you want to use the args argument then you have to use the "compatibility mode" and name the added argument as args:

class Command(BaseCommand):

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

    def handle(self, *args, **options):
        if len(args) != 2:
            ...

Read the "Changed in Django 1.8" side note in the first chapter of the docs (right after the closepoll.py example).

UPDATE2: Here is the full working example:

from django.core.management.base import BaseCommand    

class Command(BaseCommand):

    def add_arguments(self, parser):
        parser.add_argument('username')
        parser.add_argument('password')

    def handle(self, *args, **options):
        username = options['username']
        password = options['password']
        return u'Username: %s  Password: %s' % (username, password)

edited May 14, 2015 at 10:13

answered May 14, 2015 at 6:25

catavaran

45.7k8 gold badges104 silver badges89 bronze badges

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

8 Comments

micheal Over a year ago

python manage.py createmysuperuser username myuser password mypasswd this command gives this error error: unrecognized arguments: password mypasswd

micheal Over a year ago

I've added add_arguments method just as in your answer and this below line to handle method username, password = options['username'], options['password'] am I doing wrong?

catavaran Over a year ago

See the updated answer. You should call the command like: python manage.py createmysuperuser myuser mypasswd.

micheal Over a year ago

I tried your code but still same error see my final code ideone.com/SbtYSB is there any problem with this?

catavaran Over a year ago

You forgot to add the add_arguments() method from my first snippet.

|

ns15 · Accepted Answer · 2018-08-09 07:48:00Z

8

For minimal changes just add the method add_arguments() in Command class.

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

You can continue to use args as before.

answered Aug 9, 2018 at 7:48

ns15

9,3521 gold badge71 silver badges70 bronze badges

Collectives™ on Stack Overflow

Django custom command error: unrecognized arguments

2 Answers 2

8 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

8 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related