Summary

Update the management commands to be compatible with Django 1.6+.

Review Request #8680 — Created Jan. 30, 2017 and submitted Feb. 2, 2017, 4:56 p.m.

Information

Owner

chipx86

Repository

Djblets

Branch

release-0.10.x

Bugs

Depends On

Commit

5489521...

Reviewers

Groups

djblets

People

Description

Newer versions of Django switched to using ArgumentParser instead of
OptionParser for arguments to management commands, and got rid of
NoArgsCommand. While ArgumentParser and OptionParser are fairly
compatible for most things, the changes to how options are registered in
Django management commands were fairly extensive, making it harder to
keep compatibility with both.

This change introduces a compatibility class for management commands
that allows the commands to code for the new style of argument
registration, while providing compatibility with the OptionParsers used
in Django 1.6. This can be used by projects that need to keep
compatibility between the two.

The management commands that ship with Djblets have been updated to use
the new class and new style of argument registration.

Testing Done

Tested each command on Django 1.6, 1.8, and 1.10.

Issues

Description	From	Last Updated
Col: 5 E303 too many blank lines (2)	reviewbot	Jan. 30, 2017, 3:42 p.m.
Col: 13 E265 block comment should start with '# '	reviewbot	Jan. 30, 2017, 3:43 p.m.
typo: exposrs	david	Feb. 2, 2017, 4:55 p.m.

Tool: Pyflakes
Processed Files:
    djblets/siteconfig/management/commands/get-siteconfig.py
    djblets/siteconfig/management/commands/list-siteconfig.py
    djblets/siteconfig/management/commands/set-siteconfig.py
    djblets/util/compat/django/core/management/base.py
    djblets/extensions/management/commands/install-extension-media.py

Ignored Files:
    djblets/util/compat/django/core/management/__init__.py



Tool: PEP8 Style Checker
Processed Files:
    djblets/siteconfig/management/commands/get-siteconfig.py
    djblets/siteconfig/management/commands/list-siteconfig.py
    djblets/siteconfig/management/commands/set-siteconfig.py
    djblets/util/compat/django/core/management/base.py
    djblets/extensions/management/commands/install-extension-media.py

Ignored Files:
    djblets/util/compat/django/core/management/__init__.py

djblets/siteconfig/management/commands/set-siteconfig.py (Diff revision 1)
Show all issues
```
Col: 5
 E303 too many blank lines (2)
```
djblets/util/compat/django/core/management/base.py (Diff revision 1)
Show all issues
```
Col: 13
 E265 block comment should start with '# '
```

djblets/util/compat/django/core/management/base.py (Diff revision 1)

Where does _use_real_option_list come from?

chipx86 Jan. 30, 2017, 3:41 p.m.

It's set right in this function, which is why we access it this way and provide a default.

Basically, we need to be able to populate a option_list from the arguments registered on the parser, but the act of creating the parser results in an access to the option_list attribute, which may/will have content that needs to be returned as-is. So we use this internal attribute to control which list we're accessing on lookup.

Change Summary:


Removed an old comment that shouldn't have been kept.
Removed an extra blank line.

Commit:

-	0ac324e7fc5a738c3be03384a6e08ff140343dc6
+	5489521e505a38fce29d0bd820ea5911e58752ae

Diff:

Revision 2 (+188 -33)

Show changes

	djblets/extensions/management/commands/install-extension-media.py
	djblets/siteconfig/management/commands/get-siteconfig.py
	djblets/siteconfig/management/commands/list-siteconfig.py
	djblets/siteconfig/management/commands/set-siteconfig.py
	djblets/util/compat/django/core/management/__init__.py
	djblets/util/compat/django/core/management/base.py

Tool: Pyflakes
Processed Files:
    djblets/siteconfig/management/commands/get-siteconfig.py
    djblets/siteconfig/management/commands/list-siteconfig.py
    djblets/siteconfig/management/commands/set-siteconfig.py
    djblets/util/compat/django/core/management/base.py
    djblets/extensions/management/commands/install-extension-media.py

Ignored Files:
    djblets/util/compat/django/core/management/__init__.py



Tool: PEP8 Style Checker
Processed Files:
    djblets/siteconfig/management/commands/get-siteconfig.py
    djblets/siteconfig/management/commands/list-siteconfig.py
    djblets/siteconfig/management/commands/set-siteconfig.py
    djblets/util/compat/django/core/management/base.py
    djblets/extensions/management/commands/install-extension-media.py

Ignored Files:
    djblets/util/compat/django/core/management/__init__.py

Ship it!

djblets/util/compat/django/core/management/base.py (Diff revision 2)
Show all issues
```
typo: exposrs
```

Status: Closed (submitted)

Change Summary:

Pushed to release-0.10.x (646f4ac)