Test get_builtin_models

pvlib · markcampanelli · May 12, 2024 · May 12, 2024 · May 12, 2024 · May 12, 2024
commit 2c0d11b4283cd1fce24bd86d92378a2d67eab743
diff --git a/pvlib/iam.py b/pvlib/iam.py
@@ -26,12 +26,13 @@ def get_builtin_models():
     info : dict
         A dictionary of dictionaries keyed by builtin IAM model name, with
         each model dictionary containing:
-        - callable : callable
+
+        * 'func': callable
             The callable model function
-        - params_required : set of str
-            The callable's required parameters
-        - params_optional : set of str
-            The callable's optional parameters
+        * 'params_required': set of str
+            The model function's required parameters
+        * 'params_optional': set of str
+            The model function's optional parameters
 
     See Also
     --------
@@ -44,32 +45,33 @@ def get_builtin_models():
     """
     return {
         'ashrae': {
-            'callable': ashrae,
+            'func': ashrae,
             'params_required': set(),
             'params_optional': {'b'},
         },
         'interp': {
-            'callable': interp,
+            'func': interp,
             'params_required': {'theta_ref', 'iam_ref'},
             'params_optional': {'method', 'normalize'},
         },
         'martin_ruiz': {
-            'callable': martin_ruiz,
+            'func': martin_ruiz,
             'params_required': set(),
             'params_optional': {'a_r'},
         },
         'physical': {
-            'callable': physical,
+            'func': physical,
             'params_required': set(),
             'params_optional': {'n', 'K', 'L', 'n_ar'},
         },
         'sapm': {
-            'callable': sapm,
+            'func': sapm,
+            # param_required must appear in module parameter.
             'params_required': {'B0', 'B1', 'B2', 'B3', 'B4', 'B5'},
             'params_optional': {'upper'},
         },
         'schlick': {
-            'callable': schlick,
+            'func': schlick,
             'params_required': set(),
             'params_optional': set(),
         },
@@ -687,7 +689,7 @@ def marion_diffuse(model, surface_tilt, **kwargs):
     """
     if callable(model):
         # A callable IAM model function was specified.
-        model_callable = model
+        func = model
     else:
         # Check that a builtin IAM function was specified.
         builtin_models = get_builtin_models()
@@ -699,9 +701,9 @@ def marion_diffuse(model, surface_tilt, **kwargs):
                 f'model must be one of: {builtin_models.keys()}'
             ) from exc
 
-        model_callable = model["callable"]
+        func = model["func"]
 
-    iam_function = functools.partial(model_callable, **kwargs)
+    iam_function = functools.partial(func, **kwargs)
 
     return {
         region: marion_integrate(iam_function, surface_tilt, region)

diff --git a/pvlib/pvsystem.py b/pvlib/pvsystem.py
@@ -1184,15 +1184,15 @@ def get_iam(self, aoi, iam_model='physical'):
 
         if model == "sapm":
             # sapm has exceptional interface requiring module_parameters.
-            return model_info["callable"](
+            return model_info["func"](
                 aoi, self.module_parameters, **params_optional
             )
 
         params_required = _build_kwargs(
             model_info["params_required"], self.module_parameters
         )
 
-        return model_info["callable"](
+        return model_info["func"](
             aoi, **params_required, **params_optional
         )
 

diff --git a/pvlib/tests/test_iam.py b/pvlib/tests/test_iam.py
@@ -3,6 +3,7 @@
 
 @author: cwhanse
 """
+import inspect
 
 import numpy as np
 import pandas as pd
@@ -15,6 +16,57 @@
 from pvlib import iam as _iam
 
 
+def test_get_builtin_models():
+    builtin_models = _iam.get_builtin_models()
+
+    models = set(builtin_models.keys())
+    models_expected = {
+        "ashrae", "interp", "martin_ruiz", "physical", "sapm", "schlick"
+    }
+    assert set(models) == models_expected
+
+    for model in models:
+        builtin_model = builtin_models[model]
+
+        if model == "sapm":
+            # sapm has exceptional interface requiring module_parameters.
+            params_required_expected = set(
+                k for k, v in inspect.signature(
+                    builtin_model["func"]
+                ).parameters.items() if v.default is inspect.Parameter.empty
+            )
+            assert {"aoi", "module"} == params_required_expected, model
+
+            assert builtin_model["params_required"] == \
+                {'B0', 'B1', 'B2', 'B3', 'B4', 'B5'}, model
+        else:
+            params_required_expected = set(
+                k for k, v in inspect.signature(
+                    builtin_model["func"]
+                ).parameters.items() if v.default is inspect.Parameter.empty
+            )
+            assert builtin_model["params_required"].union(
+                {"aoi"}
+            ) == params_required_expected, model
+
+        params_optional_expected = set(
+            k for k, v in inspect.signature(
+                builtin_model["func"]
+            ).parameters.items() if v.default is not inspect.Parameter.empty
+        )
+        assert builtin_model["params_optional"] == \
+            params_optional_expected, model
+
+
+def get_default_args(func):
+    signature = inspect.signature(func)
+    return {
+        k: v.default
+        for k, v in signature.parameters.items()
+        if v.default is not inspect.Parameter.empty
+    }
+
+
 def test_ashrae():
     thetas = np.array([-90., -67.5, -45., -22.5, 0., 22.5, 45., 67.5, 89., 90.,
                        np.nan])