Merge pull request django-haystack#1340 from claudep/manage_commands

chg: migrate management commands to argparse

Author: acdha

haystack/management/commands/build_solr_schema.py

@@ -2,26 +2,26 @@
 
 from __future__ import absolute_import, division, print_function, unicode_literals
 
-import sys
-from optparse import make_option
-
 from django.core.exceptions import ImproperlyConfigured
 from django.core.management.base import BaseCommand
 from django.template import Context, loader
 
-from haystack import constants
+from haystack import connections, connection_router, constants
 from haystack.backends.solr_backend import SolrSearchBackend
 
 
 class Command(BaseCommand):
     help = "Generates a Solr schema that reflects the indexes."
-    base_options = (
-        make_option("-f", "--filename", action="store", type="string", dest="filename",
-                    help='If provided, directs output to a file instead of stdout.'),
-        make_option("-u", "--using", action="store", type="string", dest="using", default=constants.DEFAULT_ALIAS,
-                    help='If provided, chooses a connection to work with.'),
-    )
-    option_list = BaseCommand.option_list + base_options
+
+    def add_arguments(self, parser):
+        parser.add_argument(
+            "-f", "--filename",
+            help='If provided, directs output to a file instead of stdout.'
+        )
+        parser.add_argument(
+            "-u", "--using", default=constants.DEFAULT_ALIAS,
+            help='If provided, chooses a connection to work with.'
+        )
 
     def handle(self, **options):
         """Generates a Solr schema that reflects the indexes."""
@@ -34,13 +34,14 @@ def handle(self, **options):
             self.print_stdout(schema_xml)
 
     def build_context(self, using):
-        from haystack import connections, connection_router
         backend = connections[using].get_backend()
 
         if not isinstance(backend, SolrSearchBackend):
             raise ImproperlyConfigured("'%s' isn't configured as a SolrEngine)." % backend.connection_alias)
 
-        content_field_name, fields = backend.build_schema(connections[using].get_unified_index().all_searchfields())
+        content_field_name, fields = backend.build_schema(
+            connections[using].get_unified_index().all_searchfields()
+        )
         return Context({
             'content_field_name': content_field_name,
             'fields': fields,
@@ -56,15 +57,14 @@ def build_template(self, using):
         return t.render(c)
 
     def print_stdout(self, schema_xml):
-        sys.stderr.write("\n")
-        sys.stderr.write("\n")
-        sys.stderr.write("\n")
-        sys.stderr.write("Save the following output to 'schema.xml' and place it in your Solr configuration directory.\n")
-        sys.stderr.write("--------------------------------------------------------------------------------------------\n")
-        sys.stderr.write("\n")
-        print(schema_xml)
+        self.stderr.write("\n")
+        self.stderr.write("\n")
+        self.stderr.write("\n")
+        self.stderr.write("Save the following output to 'schema.xml' and place it in your Solr configuration directory.\n")
+        self.stderr.write("--------------------------------------------------------------------------------------------\n")
+        self.stderr.write("\n")
+        self.stdout.write(schema_xml)
 
     def write_file(self, filename, schema_xml):
-        schema_file = open(filename, 'w')
-        schema_file.write(schema_xml)
-        schema_file.close()
+        with open(filename, 'w') as schema_file:
+            schema_file.write(schema_xml)

haystack/management/commands/clear_index.py

@@ -2,33 +2,32 @@
 
 from __future__ import absolute_import, division, print_function, unicode_literals
 
-import sys
-from optparse import make_option
-
 from django.core.management.base import BaseCommand
 from django.utils import six
 
+from haystack import connections
+
 
 class Command(BaseCommand):
     help = "Clears out the search index completely."
-    base_options = (
-        make_option('--noinput', action='store_false', dest='interactive', default=True,
+
+    def add_arguments(self, parser):
+        parser.add_argument(
+            '--noinput', action='store_false', dest='interactive', default=True,
             help='If provided, no prompts will be issued to the user and the data will be wiped out.'
-        ),
-        make_option("-u", "--using", action="append", dest="using",
-            default=[],
+        )
+        parser.add_argument(
+            "-u", "--using", action="append", default=[],
             help='Update only the named backend (can be used multiple times). '
                  'By default all backends will be updated.'
-        ),
-        make_option('--nocommit', action='store_false', dest='commit',
+        )
+        parser.add_argument(
+            '--nocommit', action='store_false', dest='commit',
             default=True, help='Will pass commit=False to the backend.'
-        ),
-    )
-    option_list = BaseCommand.option_list + base_options
+        )
 
     def handle(self, **options):
         """Clears out the search index completely."""
-        from haystack import connections
         self.verbosity = int(options.get('verbosity', 1))
         self.commit = options.get('commit', True)
 
@@ -37,23 +36,21 @@ def handle(self, **options):
             using = connections.connections_info.keys()
 
         if options.get('interactive', True):
-            print()
-            print("WARNING: This will irreparably remove EVERYTHING from your search index in connection '%s'." % "', '".join(using))
-            print("Your choices after this are to restore from backups or rebuild via the `rebuild_index` command.")
+            self.stdout.write("WARNING: This will irreparably remove EVERYTHING from your search index in connection '%s'." % "', '".join(using))
+            self.stdout.write("Your choices after this are to restore from backups or rebuild via the `rebuild_index` command.")
 
             yes_or_no = six.moves.input("Are you sure you wish to continue? [y/N] ")
-            print
 
             if not yes_or_no.lower().startswith('y'):
-                print("No action taken.")
-                sys.exit()
+                self.stdout.write("No action taken.")
+                return
 
         if self.verbosity >= 1:
-            print("Removing all documents from your index because you said so.")
+            self.stdout.write("Removing all documents from your index because you said so.")
 
         for backend_name in using:
             backend = connections[backend_name].get_backend()
             backend.clear(commit=self.commit)
 
         if self.verbosity >= 1:
-            print("All documents removed.")
+            self.stdout.write("All documents removed.")

haystack/management/commands/haystack_info.py

@@ -2,20 +2,23 @@
 
 from __future__ import absolute_import, division, print_function, unicode_literals
 
-from django.core.management.base import NoArgsCommand
+from django.core.management.base import BaseCommand
 
+from haystack import connections
 
-class Command(NoArgsCommand):
+
+class Command(BaseCommand):
     help = "Provides feedback about the current Haystack setup."
 
-    def handle_noargs(self, **options):
+    def handle(self, **options):
         """Provides feedback about the current Haystack setup."""
-        from haystack import connections
 
         unified_index = connections['default'].get_unified_index()
         indexed = unified_index.get_indexed_models()
         index_count = len(indexed)
-        print("Number of handled %s index(es)." % index_count)
+        self.stdout.write("Number of handled %s index(es)." % index_count)
 
         for index in indexed:
-            print("  - Model: %s by Index: %s" % (index.__name__, unified_index.get_indexes()[index]))
+            self.stdout.write("  - Model: %s by Index: %s" % (
+                index.__name__, unified_index.get_indexes()[index])
+            )

haystack/management/commands/rebuild_index.py

@@ -5,21 +5,28 @@
 from django.core.management import call_command
 from django.core.management.base import BaseCommand
 
-from haystack.management.commands.clear_index import Command as ClearCommand
-from haystack.management.commands.update_index import Command as UpdateCommand
-
-__all__ = ['Command']
-
-_combined_options = list(BaseCommand.option_list)
-_combined_options.extend(option for option in UpdateCommand.base_options
-                         if option.get_opt_string() not in [i.get_opt_string() for i in _combined_options])
-_combined_options.extend(option for option in ClearCommand.base_options
-                         if option.get_opt_string() not in [i.get_opt_string() for i in _combined_options])
-
 
 class Command(BaseCommand):
     help = "Completely rebuilds the search index by removing the old data and then updating."
-    option_list = _combined_options
+
+    def add_arguments(self, parser):
+        parser.add_argument(
+            '--noinput', action='store_false', dest='interactive', default=True,
+            help='If provided, no prompts will be issued to the user and the data will be wiped out.'
+        )
+        parser.add_argument(
+            '-u', '--using', action='append', default=[],
+            help='Update only the named backend (can be used multiple times). '
+                 'By default all backends will be updated.'
+        )
+        parser.add_argument(
+            '-k', '--workers', default=0, type=int,
+            help='Allows for the use multiple workers to parallelize indexing. Requires multiprocessing.'
+        )
+        parser.add_argument(
+            '--nocommit', action='store_false', dest='commit',
+            default=True, help='Will pass commit=False to the backend.'
+        )
 
     def handle(self, **options):
         call_command('clear_index', **options)