Bläddra i källkod

Improve naming of arguments for the management commands

master
Michael van Tellingen 8 år sedan
förälder
incheckning
482473aaa7

+ 3
- 4
src/oscar/management/commands/oscar_fork_app.py Visa fil

@@ -7,14 +7,13 @@ from oscar.core import customisation
7 7
 
8 8
 
9 9
 class Command(BaseCommand):
10
-    args = '<app label> <destination folder>'
11 10
     help = (
12 11
         "Create a local version of one of Oscar's app so it can "
13 12
         "be customised")
14 13
 
15 14
     def add_arguments(self, parser):
16
-        parser.add_argument('<app label>')
17
-        parser.add_argument('<destination folder>')
15
+        parser.add_argument('app_label', help='The application to fork')
16
+        parser.add_argument('target_path', help='The path to copy the files to')
18 17
 
19 18
     def handle(self, *args, **options):
20 19
         # Use a stdout logger
@@ -23,7 +22,7 @@ class Command(BaseCommand):
23 22
         logger.addHandler(stream)
24 23
         logger.setLevel(logging.DEBUG)
25 24
 
26
-        app_label, folder_path = options['<app label>'], options['<destination folder>']
25
+        app_label, folder_path = options['app_label'], options['target_path']
27 26
         try:
28 27
             customisation.fork_app(app_label, folder_path, logger)
29 28
         except Exception as e:

+ 2
- 6
src/oscar/management/commands/oscar_fork_statics.py Visa fil

@@ -13,18 +13,14 @@ class Command(BaseCommand):
13 13
     Copy Oscar's statics into local project so they can be used as a base for
14 14
     styling a new site.
15 15
     """
16
-    args = '<destination folder>'
17 16
     help = "Copy Oscar's static files"
18 17
 
19 18
     def add_arguments(self, parser):
20
-        parser.add_argument(
21
-            '<destination folder>',
22
-            nargs='?',
23
-            default='static')
19
+        parser.add_argument('target_path', nargs='?', default='static')
24 20
 
25 21
     def handle(self, *args, **options):
26 22
         # Determine where to copy to
27
-        folder = options['<destination folder>']
23
+        folder = options['target_path']
28 24
         if not folder.startswith('/'):
29 25
             destination = os.path.join(os.getcwd(), folder)
30 26
         else:

+ 5
- 6
src/oscar/management/commands/oscar_generate_email_content.py Visa fil

@@ -8,25 +8,24 @@ Dispatcher = get_class('customer.utils', 'Dispatcher')
8 8
 
9 9
 
10 10
 class Command(BaseCommand):
11
-    args = '<communication_event_type> <order number>'
12 11
     help = 'For testing the content of order emails'
13 12
 
14 13
     def add_arguments(self, parser):
15
-        parser.add_argument('<communication_event_type>')
16
-        parser.add_argument('<order number>')
14
+        parser.add_argument('event_type', help='The CommunicationEventType')
15
+        parser.add_argument('order_number', help='The Order number')
17 16
 
18 17
     def handle(self, *args, **options):
19 18
         try:
20
-            order = Order.objects.get(number=options['<order number>'])
19
+            order = Order.objects.get(number=options['order_number'])
21 20
         except Order.DoesNotExist:
22 21
             raise CommandError(
23
-                "No order found with number %s" % options['<order number>'])
22
+                "No order found with number %s" % options['order_number'])
24 23
 
25 24
         ctx = {
26 25
             'order': order,
27 26
             'lines': order.lines.all(),
28 27
         }
29 28
         messages = CommunicationEventType.objects.get_and_render(
30
-            options['<communication_event_type>'], ctx)
29
+            options['event_type'], ctx)
31 30
         print("Subject: %s\nBody:\n\n%s\nBody HTML:\n\n%s" % (
32 31
             messages['subject'], messages['body'], messages['html']))

+ 4
- 4
src/oscar/management/commands/oscar_import_catalogue.py Visa fil

@@ -11,12 +11,12 @@ logger = logging.getLogger('oscar.catalogue.import')
11 11
 
12 12
 
13 13
 class Command(BaseCommand):
14
-    args = '/path/to/file1.csv /path/to/file2.csv ...'
15 14
     help = 'For creating product catalogues based on a CSV file'
16 15
 
17 16
     def add_arguments(self, parser):
18
-        parser.add_argument('/path/to/file.csv', nargs='+')
19
-
17
+        parser.add_argument(
18
+            'filename', nargs='+',
19
+            help='/path/to/file1.csv /path/to/file2.csv ...')
20 20
         parser.add_argument(
21 21
             '--flush',
22 22
             action='store_true',
@@ -34,7 +34,7 @@ class Command(BaseCommand):
34 34
         importer = CatalogueImporter(
35 35
             logger, delimiter=options.get('delimiter'),
36 36
             flush=options.get('flush'))
37
-        for file_path in options['/path/to/file.csv']:
37
+        for file_path in options['filename']:
38 38
             logger.info(" - Importing records from '%s'" % file_path)
39 39
             try:
40 40
                 importer.handle(file_path)

+ 2
- 6
src/oscar/management/commands/oscar_import_catalogue_images.py Visa fil

@@ -10,11 +10,10 @@ logger = logging.getLogger('oscar.catalogue.import')
10 10
 
11 11
 
12 12
 class Command(BaseCommand):
13
-    args = '/path/to/folder'
14 13
     help = 'For importing product images from a folder'
15 14
 
16 15
     def add_arguments(self, parser):
17
-        parser.add_argument('/path/to/folder')
16
+        parser.add_argument('path', help='/path/to/folder')
18 17
 
19 18
         parser.add_argument(
20 19
             '--filename',
@@ -23,10 +22,7 @@ class Command(BaseCommand):
23 22
             help='Product field to lookup from image filename')
24 23
 
25 24
     def handle(self, *args, **options):
26
-        # if len(args) != 1:
27
-        #     raise CommandError('Command requires a path to a single folder')
28
-
29 25
         logger.info("Starting image import")
30
-        dirname = options['/path/to/folder']
26
+        dirname = options['path']
31 27
         importer = Importer(logger, field=options.get('filename'))
32 28
         importer.handle(dirname)

Laddar…
Avbryt
Spara