Do not use a global for mapping #280

 * instead use a flag that is passed around as needed

Signed-off-by: Philippe Ombredanne <[email protected]>

Author: pombredanne

src/attributecode/attrib.py

@@ -138,8 +138,8 @@ def generate_from_file(abouts, template_loc=None):
     return generate(abouts, template_string=tpls)
 
 
-def generate_and_save(abouts, output_location, mapping, template_loc=None,
-                      inventory_location=None):
+def generate_and_save(abouts, output_location, use_mapping=False, 
+                      template_loc=None, inventory_location=None):
     """
     Generate attribution using template and save at output_location.
     Filter the list of about object based on the inventory CSV at
@@ -163,7 +163,8 @@ def generate_and_save(abouts, output_location, mapping, template_loc=None,
         if inventory_location.endswith('.csv') or inventory_location.endswith('.json'):
             try:
                 # Return a list which contains only the about file path
-                about_list = attributecode.util.get_about_file_path(mapping, inventory_location)
+                about_list = attributecode.util.get_about_file_path(
+                    inventory_location, use_mapping=use_mapping)
             except Exception:
                 # 'about_file_path' key/column doesn't exist
                 msg = u"The required key: 'about_file_path' does not exist. Generation halted."

src/attributecode/cmd.py

@@ -139,7 +139,7 @@ def inventory(location, output, quiet, format):
 @click.option('--license-notice-text-location', nargs=1,
               type=click.Path(exists=True, dir_okay=True, readable=True, resolve_path=True),
               help="Copy the 'license_file' from the directory to the generated location")
-@click.option('--mapping', is_flag=True, help='Use for mapping between the input keys and the ABOUT field names - mapping.config')
+@click.option('--mapping', is_flag=True, help='Use file mapping.config with mapping between input keys and ABOUT field names')
 @click.option('-q', '--quiet', is_flag=True, help='Do not print any error/warning.')
 def gen(location, output, mapping, license_notice_text_location, fetch_license, quiet):
     """
@@ -150,13 +150,16 @@ def gen(location, output, mapping, license_notice_text_location, fetch_license,
 
 OUTPUT: Path to a directory where ABOUT files are generated.
     """
-    click.echo('Running attributecode version ' + __version__)
+    click.echo('Running aboutcode-toolkit version ' + __version__)
     if not location.endswith('.csv') and not location.endswith('.json'):
         click.echo('ERROR: Input file. Only .csv and .json files are supported.')
         return
     click.echo('Generating ABOUT files...')
 
-    errors, abouts = attributecode.gen.generate(location, output, mapping, license_notice_text_location, fetch_license)
+    errors, abouts = attributecode.gen.generate(
+        location=location, base_dir=output, mapping=mapping, 
+        license_notice_text_location=license_notice_text_location, 
+        fetch_license=fetch_license)
 
     number_of_about_file = len(abouts)
     number_of_error = 0
@@ -174,7 +177,7 @@ def gen(location, output, mapping, license_notice_text_location, fetch_license,
 @click.argument('output', nargs=1, required=True, type=click.Path(exists=False, writable=True, resolve_path=True))
 @click.option('--inventory', required=False, type=click.Path(exists=True, file_okay=True, resolve_path=True),
               help='Path to an inventory file')
-@click.option('--mapping', is_flag=True, help='Use for mapping between the input keys and the ABOUT field names - mapping.config')
+@click.option('--mapping', is_flag=True, help='Use file mapping.config with mapping between input keys and ABOUT field names')
 @click.option('--template', type=click.Path(exists=True), nargs=1,
               help='Path to a custom attribution template')
 @click.option('-q', '--quiet', is_flag=True, help='Do not print any error/warning.')
@@ -196,12 +199,11 @@ def attrib(location, output, template, mapping, inventory, quiet):
         # accept zipped ABOUT files as input
         location = extract_zip(location)
 
-    if mapping:
-        attributecode.util.have_mapping = True
-
     errors, abouts = model.collect_inventory(location)
     no_match_errors = attributecode.attrib.generate_and_save(
-        abouts, output, mapping, template_loc=template, inventory_location=inventory)
+        abouts=abouts, output_location=output, 
+        use_mapping=mapping, template_loc=template, 
+        inventory_location=inventory)
 
     for no_match_error in no_match_errors:
         errors.append(no_match_error)
@@ -218,7 +220,7 @@ def check(location):
 
 LOCATION: Path to an ABOUT file or a directory containing ABOUT files.
     """
-    click.echo('Running attributecode version ' + __version__)
+    click.echo('Running aboutcode-toolkit version ' + __version__)
     click.echo('Checking ABOUT files...')
 
     errors, abouts = attributecode.model.collect_inventory(location)
@@ -241,6 +243,7 @@ def check(location):
     else:
         click.echo('No error is found.')
 
+
 def log_errors(errors, quiet, base_dir=False):
     """
     Iterate of sequence of Error objects and print and log errors with a severity

src/attributecode/gen.py

@@ -97,7 +97,8 @@ def check_duplicated_about_file_path(inventory_dict):
     return errors
 
 
-def load_inventory(mapping, location, base_dir, license_notice_text_location=None):
+def load_inventory(location, base_dir, 
+                   license_notice_text_location=None, use_mapping=False):
     """
     Load the inventory file at location. Return a list of errors and a list of About
     objects validated against the base_dir.
@@ -110,9 +111,9 @@ def load_inventory(mapping, location, base_dir, license_notice_text_location=Non
         if dup_cols_err:
             errors.extend(dup_cols_err)
             return errors, abouts
-        inventory = util.load_csv(mapping, location)
+        inventory = util.load_csv(location, use_mapping)
     else:
-        inventory = util.load_json(mapping, location)
+        inventory = util.load_json(location, use_mapping)
 
     try:
         dup_about_paths_err = check_duplicated_about_file_path(inventory)
@@ -126,9 +127,9 @@ def load_inventory(mapping, location, base_dir, license_notice_text_location=Non
 
     for i, fields in enumerate(inventory):
         # check does the input contains the required fields
-        requied_fileds = model.About.required_fields
+        required_fields = model.About.required_fields
 
-        for f in requied_fileds:
+        for f in required_fields:
             if f not in fields:
                 msg = (
                     "Required column: %(f)r not found.\n"
@@ -164,8 +165,8 @@ def load_inventory(mapping, location, base_dir, license_notice_text_location=Non
     return errors, abouts
 
 
-def generate(location, base_dir, mapping, license_notice_text_location, fetch_license, policy=None, conf_location=None,
-             with_empty=False, with_absent=False):
+def generate(location, base_dir, license_notice_text_location=None, fetch_license=False, policy=None, conf_location=None,
+             with_empty=False, with_absent=False, use_mapping=False):
     """
     Load ABOUT data from an inventory at csv_location. Write ABOUT files to
     base_dir using policy flags and configuration file at conf_location.
@@ -183,7 +184,11 @@ def generate(location, base_dir, mapping, license_notice_text_location, fetch_li
         gen_license = True
 
     bdir = to_posix(base_dir)
-    errors, abouts = load_inventory(mapping, location, bdir, license_notice_text_location)
+    errors, abouts = load_inventory(
+        location=location,
+        base_dir=bdir,
+        license_notice_text_location=license_notice_text_location,
+        use_mapping=use_mapping)
 
     if gen_license:
         license_dict, err = model.pre_process_and_fetch_license_dict(abouts, api_url, api_key)
@@ -291,4 +296,4 @@ def deduplicate(sequence):
     for item in sequence:
         if item not in deduped:
             deduped.append(item)
-    return deduped
+    return deduped