Changeset 7888

Timestamp:

07/11/08 08:18:19 (4 months ago)

Author:

russellm

Message:

Fixed #6017 -- Modified the Lax parser to allow --settings and the other core management arguments to appear anywhere in the argument list. Thanks to Todd O'Bryan for the suggestion and patch.

Files:

• django/trunk/django/core/management/__init__.py (modified) (1 diff)
• django/trunk/tests/regressiontests/admin_scripts/management/commands/base_command.py (modified) (1 diff)
• django/trunk/tests/regressiontests/admin_scripts/tests.py (modified) (6 diffs)

django/trunk/django/core/management/__init__.py

@@ -135 +135 @@
-    def error(self, msg):
-        pass
+    
+    def _process_args(self, largs, rargs, values):
+        """
+        Overrides OptionParser._process_args to exclusively handle default
+        options and ignore args and other options. 
+        
+        This overrides the behavior of the super class, which stop parsing 
+        at the first unrecognized option.
+        """
+        while rargs:
+            arg = rargs[0]
+            try:
+                if arg[0:2] == "--" and len(arg) > 2:
+                    # process a single long option (possibly with value(s))
+                    # the superclass code pops the arg off rargs
+                    self._process_long_opt(rargs, values)
+                elif arg[:1] == "-" and len(arg) > 1:
+                    # process a cluster of short options (possibly with
+                    # value(s) for the last one only)
+                    # the superclass code pops the arg off rargs
+                    self._process_short_opts(rargs, values)
+                else:
+                    # it's either a non-default option or an arg
+                    # either way, add it to the args list so we can keep
+                    # dealing with options
+                    del rargs[0]
+                    raise error
+            except:
+                largs.append(arg)
-
-class ManagementUtility(object):

django/trunk/tests/regressiontests/admin_scripts/management/commands/base_command.py

@@ -1 +1 @@
-from django.core.management.base import BaseCommand
+from optparse import make_option
-
-class Command(BaseCommand):
+    option_list = BaseCommand.option_list + (
+        make_option('--option_a','-a', action='store', dest='option_a', default='1'),
+        make_option('--option_b','-b', action='store', dest='option_b', default='2'),
+        make_option('--option_c','-c', action='store', dest='option_c', default='3'),
+    )
-    help = 'Test basic commands'
-    requires_model_validation = False

django/trunk/tests/regressiontests/admin_scripts/tests.py

@@ -8 +8 @@
-import shutil
-
-
+, get_version
-from django.conf import settings
-
@@ -726 +726 @@
-        self.remove_settings('settings.py')
-    
+    def test_version(self):
+        "--version is handled as a special case"
+        args = ['--version']
+        out, err = self.run_manage(args)
+        self.assertNoOutput(err)
+        # Only check the first part of the version number
+        self.assertOutput(out, get_version().split('-')[0])
+
+    def test_help(self):
+        "--help is handled as a special case"
+        args = ['--help']
+        out, err = self.run_manage(args)
+        self.assertOutput(out, "Usage: manage.py [options]")
+        self.assertOutput(err, "Type 'manage.py help <subcommand>' for help on a specific subcommand.")
+
+    def test_specific_help(self):
+        "--help can be used on a specific command"
+        args = ['sqlall','--help']
+        out, err = self.run_manage(args)
+        self.assertNoOutput(err)
+        self.assertOutput(out, "Prints the CREATE TABLE, custom SQL and CREATE INDEX SQL statements for the given model module name(s).")
+    
-    def test_base_command(self):
-        "User BaseCommands can execute when a label is provided"
@@ -731 +753 @@
-        out, err = self.run_manage(args)
-        self.assertNoOutput(err)
-
+option_a', '1'), ('option_b', '2'), ('option_c', '3'), ('
-        
-    def test_base_command_no_label(self):
@@ -738 +760 @@
-        out, err = self.run_manage(args)
-        self.assertNoOutput(err)
-
+option_a', '1'), ('option_b', '2'), ('option_c', '3'), ('
-
-    def test_base_command_multiple_label(self):
@@ -745 +767 @@
-        out, err = self.run_manage(args)
-        self.assertNoOutput(err)
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-                
-    def test_noargs(self):
@@ -816 +852 @@
-        self.assertOutput(out, "EXECUTE:LabelCommand label=testlabel, options=[('pythonpath', None), ('settings', None), ('traceback', None)]")
-        self.assertOutput(out, "EXECUTE:LabelCommand label=anotherlabel, options=[('pythonpath', None), ('settings', None), ('traceback', None)]")
+
+class ArgumentOrder(AdminScriptTestCase):
+    """Tests for 2-stage argument parsing scheme.
+
+    django-admin command arguments are parsed in 2 parts; the core arguments
+    (--settings, --traceback and --pythonpath) are parsed using a Lax parser.
+    This Lax parser ignores any unknown options. Then the full settings are 
+    passed to the command parser, which extracts commands of interest to the
+    individual command.    
+    """
+    def setUp(self):
+        self.write_settings('settings.py', apps=['django.contrib.auth','django.contrib.contenttypes'])
+        self.write_settings('alternate_settings.py')
+        
+    def tearDown(self):
+        self.remove_settings('settings.py')
+        self.remove_settings('alternate_settings.py')
+
+    def test_setting_then_option(self):
+        "Options passed after settings are correctly handled"
+        args = ['base_command','testlabel','--settings=alternate_settings','--option_a=x']
+        out, err = self.run_manage(args)
+        self.assertNoOutput(err)
+        self.assertOutput(out, "EXECUTE:BaseCommand labels=('testlabel',), options=[('option_a', 'x'), ('option_b', '2'), ('option_c', '3'), ('pythonpath', None), ('settings', 'alternate_settings'), ('traceback', None)]")
+
+    def test_setting_then_short_option(self):
+        "Short options passed after settings are correctly handled"
+        args = ['base_command','testlabel','--settings=alternate_settings','--option_a=x']
+        out, err = self.run_manage(args)
+        self.assertNoOutput(err)
+        self.assertOutput(out, "EXECUTE:BaseCommand labels=('testlabel',), options=[('option_a', 'x'), ('option_b', '2'), ('option_c', '3'), ('pythonpath', None), ('settings', 'alternate_settings'), ('traceback', None)]")
+
+    def test_option_then_setting(self):
+        "Options passed before settings are correctly handled"
+        args = ['base_command','testlabel','--option_a=x','--settings=alternate_settings']
+        out, err = self.run_manage(args)
+        self.assertNoOutput(err)
+        self.assertOutput(out, "EXECUTE:BaseCommand labels=('testlabel',), options=[('option_a', 'x'), ('option_b', '2'), ('option_c', '3'), ('pythonpath', None), ('settings', 'alternate_settings'), ('traceback', None)]")
+
+    def test_short_option_then_setting(self):
+        "Short options passed before settings are correctly handled"
+        args = ['base_command','testlabel','-a','x','--settings=alternate_settings']
+        out, err = self.run_manage(args)
+        self.assertNoOutput(err)
+        self.assertOutput(out, "EXECUTE:BaseCommand labels=('testlabel',), options=[('option_a', 'x'), ('option_b', '2'), ('option_c', '3'), ('pythonpath', None), ('settings', 'alternate_settings'), ('traceback', None)]")
+
+    def test_option_then_setting_then_option(self):
+        "Options are correctly handled when they are passed before and after a setting"
+        args = ['base_command','testlabel','--option_a=x','--settings=alternate_settings','--option_b=y']
+        out, err = self.run_manage(args)
+        self.assertNoOutput(err)
+        self.assertOutput(out, "EXECUTE:BaseCommand labels=('testlabel',), options=[('option_a', 'x'), ('option_b', 'y'), ('option_c', '3'), ('pythonpath', None), ('settings', 'alternate_settings'), ('traceback', None)]")
+