Do not rename --vartext option yet #332

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

Author: pombredanne

src/attributecode/cmd.py

@@ -344,15 +344,15 @@ def gen(location, output,
 
 def validate_variables(ctx, param, value):
     """
-    Return the variables if valid or raise a UsageError otherwise.
+    Return the variable texts if valid or raise a UsageError otherwise.
     """
     if not value:
         return
 
     kvals, errors = parse_key_values(value)
     if errors:
         ive = '\n'.join(sorted('  ' + x for x in errors))
-        msg = ('Invalid --variable option(s):\n'
+        msg = ('Invalid --vartext option(s):\n'
                '{ive}'.format(**locals()))
         raise click.UsageError(msg)
     return kvals
@@ -394,11 +394,11 @@ def validate_template(ctx, param, value):
     help='Path to an optional custom attribution template to generate the '
          'attribution document. If not provided the default built-in template is used.')
 
-@click.option('--variable',
+@click.option('--vartext',
     multiple=True,
     callback=validate_variables,
     metavar='<key>=<value>',
-    help='Add variable(s) as key=value for use in a custom attribution template.')
+    help='Add variable text as key=value for use in a custom attribution template.')
 
 @click.option('--inventory',
     metavar='FILE',
@@ -429,7 +429,7 @@ def validate_template(ctx, param, value):
 
 @click.help_option('-h', '--help')
 
-def attrib(location, output, template, variable,
+def attrib(location, output, template, vartext,
            inventory, mapping, mapping_file,
            quiet, verbose):
     """
@@ -455,7 +455,7 @@ def attrib(location, output, template, variable,
         abouts=abouts,
         output_location=output,
         template_loc=template,
-        variables=variable,
+        variables=vartext,
         mapping_file=mapping_file,
         inventory_location=inventory,
     )

tests/testdata/test_cmd/help/about_attrib_help.txt

@@ -7,21 +7,21 @@ Usage: about attrib [OPTIONS] LOCATION OUTPUT
   OUTPUT: Path where to write the attribution document.
 
 Options:
-  --template FILE           Path to an optional custom attribution template to
-                            generate the attribution document. If not provided
-                            the default built-in template is used.
-  --variable <key>=<value>  Add variable(s) as key=value for use in a custom
-                            attribution template.
-  --inventory FILE          Path to an optional JSON or CSV inventory FILE
-                            listing the subset of .ABOUT files paths to consider
-                            when generating the attribution document.
-  --mapping                 Use the default built-in "mapping.config" file with
-                            mapping between input keys and .ABOUT field
-                            names.Cannot be combined with the --mapping-file
-                            option.
-  --mapping-file FILE       Path to an optional custom mapping FILE with mapping
-                            between input keys and .ABOUT field names. Cannot be
-                            combined with the --mapping option.
-  -q, --quiet               Do not print error or warning messages.
-  --verbose                 Show all error and warning messages.
-  -h, --help                Show this message and exit.
+  --template FILE          Path to an optional custom attribution template to
+                           generate the attribution document. If not provided
+                           the default built-in template is used.
+  --vartext <key>=<value>  Add variable text as key=value for use in a custom
+                           attribution template.
+  --inventory FILE         Path to an optional JSON or CSV inventory FILE
+                           listing the subset of .ABOUT files paths to consider
+                           when generating the attribution document.
+  --mapping                Use the default built-in "mapping.config" file with
+                           mapping between input keys and .ABOUT field
+                           names.Cannot be combined with the --mapping-file
+                           option.
+  --mapping-file FILE      Path to an optional custom mapping FILE with mapping
+                           between input keys and .ABOUT field names. Cannot be
+                           combined with the --mapping option.
+  -q, --quiet              Do not print error or warning messages.
+  --verbose                Show all error and warning messages.
+  -h, --help               Show this message and exit.