Put SAM product renaming code in a separate function, simplify, add warning. (#753)

* Put product renaming code in a separate function, simplify, add warning.

* Add test and pacify stickler somewhat.

* Add one comment

* u -> o

Author: adriesse

pvlib/pvsystem.py

@@ -1537,26 +1537,41 @@ def retrieve_sam(name=None, path=None):
     return _parse_raw_sam_df(csvdata)
 
 
+def _normalize_sam_product_names(names):
+    '''
+    Replace special characters within the product names to make them more
+    suitable for use as Dataframe column names.
+    '''
+    # Contributed by Anton Driesse (@adriesse), PV Performance Labs. July, 2019
+
+    import warnings
+
+    BAD_CHARS  = ' -.()[]:+/",'
+    GOOD_CHARS = '____________'
+
+    mapping = str.maketrans(BAD_CHARS, GOOD_CHARS)
+    names = pd.Series(data=names)
+    norm_names = names.str.translate(mapping)
+
+    n_duplicates = names.duplicated().sum()
+    if n_duplicates > 0:
+        warnings.warn('Original names contain %d duplicate(s).' % n_duplicates)
+
+    n_duplicates = norm_names.duplicated().sum()
+    if n_duplicates > 0:
+        warnings.warn('Normalized names contain %d duplicate(s).' % n_duplicates)
+
+    return norm_names.values
+
+
 def _parse_raw_sam_df(csvdata):
+
     df = pd.read_csv(csvdata, index_col=0, skiprows=[1, 2])
-    colnames = df.columns.values.tolist()
-    parsedcolnames = []
-    for cn in colnames:
-        parsedcolnames.append(cn.replace(' ', '_'))
-
-    df.columns = parsedcolnames
-
-    parsedindex = []
-    for index in df.index:
-        parsedindex.append(index.replace(' ', '_').replace('-', '_')
-                                .replace('.', '_').replace('(', '_')
-                                .replace(')', '_').replace('[', '_')
-                                .replace(']', '_').replace(':', '_')
-                                .replace('+', '_').replace('/', '_')
-                                .replace('"', '_').replace(',', '_'))
-
-    df.index = parsedindex
+
+    df.columns = df.columns.str.replace(' ', '_')
+    df.index = _normalize_sam_product_names(df.index)
     df = df.transpose()
+
     if 'ADRCoefficients' in df.index:
         ad_ce = 'ADRCoefficients'
         # for each inverter, parses a string of coefficients like

pvlib/test/test_pvsystem.py

@@ -107,6 +107,28 @@ def test_PVSystem_get_iam_interp(sapm_module_params, mocker):
     with pytest.raises(ValueError):
         system.get_iam(45, iam_model='interp')
 
+def test__normalize_sam_product_names():
+
+    BAD_NAMES  = [' -.()[]:+/",', 'Module[1]']
+    NORM_NAMES = ['____________', 'Module_1_']
+
+    norm_names = pvsystem._normalize_sam_product_names(BAD_NAMES)
+    assert list(norm_names) == NORM_NAMES
+
+    BAD_NAMES  = ['Module[1]', 'Module(1)']
+    NORM_NAMES = ['Module_1_', 'Module_1_']
+
+    with pytest.warns(UserWarning):
+        norm_names = pvsystem._normalize_sam_product_names(BAD_NAMES)
+    assert list(norm_names) == NORM_NAMES
+
+    BAD_NAMES  = ['Module[1]', 'Module[1]']
+    NORM_NAMES = ['Module_1_', 'Module_1_']
+
+    with pytest.warns(UserWarning):
+        norm_names = pvsystem._normalize_sam_product_names(BAD_NAMES)
+    assert list(norm_names) == NORM_NAMES
+
 
 def test_PVSystem_get_iam_invalid(sapm_module_params, mocker):
     system = pvsystem.PVSystem(module_parameters=sapm_module_params)