factor out json modeling params loading to common

Author: lboeman

solarforecastarbiter/io/reference_observations/common.py

@@ -535,3 +535,31 @@ def create_forecasts(api, site, variables, templates):
                 create_one_forecast(api, site, template_fx, var,
                                     piggyback_on=piggyback_on))
     return created
+
+
+def apply_json_site_parameters(json_sitefile, site):
+    """Updates site metadata with modeling parameters found in a json file.
+
+    Parameters
+    ----------
+    json_sitefile: str
+        Absolute path of a json file with a 'sites' key containing a list of
+        sites in the Solar Forecast Arbiter JSON format.
+    site: dict
+
+    Returns
+    -------
+    dict
+        Copy of inputs plus a new key 'modeling_parameters'.
+    """
+    with open(json_sitefile) as fp:
+        sites_metadata = json.load(fp)['sites']
+    site_api_id = str(site['extra_parameters']['network_api_id'])
+    for site_metadata in sites_metadata:
+        site_extra_params = json.loads(site_metadata['extra_parameters'])
+        if str(site_extra_params['network_api_id']) == site_api_id:
+            site_out = site.copy()
+            site_out['modeling_parameters'] = site_metadata[
+                'modeling_parameters']
+            return site_out
+    return site

solarforecastarbiter/io/reference_observations/pvdaq.py

@@ -41,17 +41,7 @@ def adjust_site_parameters(site):
     --------
     solarforecastarbiter.io.reference_observations.site_df_to_dicts
     """
-    with open(DEFAULT_SITEFILE) as fp:
-        sites_metadata = json.load(fp)['sites']
-    site_api_id = int(site['extra_parameters']['network_api_id'])
-    for site_metadata in sites_metadata:
-        site_extra_params = json.loads(site_metadata['extra_parameters'])
-        if site_extra_params['network_api_id'] == site_api_id:
-            site_out = site.copy()
-            site_out['modeling_parameters'] = site_metadata[
-                'modeling_parameters']
-            site_out['extra_parameters'].update(site_extra_params)
-            return site_out
+    return common.apply_json_site_parameters(DEFAULT_SITEFILE, site)
 
 
 def initialize_site_observations(api, site):

solarforecastarbiter/io/reference_observations/srml.py

@@ -58,17 +58,7 @@ def adjust_site_parameters(site):
     dict
         Copy of inputs plus a new key 'modeling_parameters'.
     """
-    with open(DEFAULT_SITEFILE) as fp:
-        sites_metadata = json.load(fp)['sites']
-    site_api_id = site['extra_parameters']['network_api_id']
-    for site_metadata in sites_metadata:
-        site_extra_params = json.loads(site_metadata['extra_parameters'])
-        if site_extra_params['network_api_id'] == site_api_id:
-            site_out = site.copy()
-            site_out['modeling_parameters'] = site_metadata[
-                'modeling_parameters']
-            return site_out
-    return site
+    return common.apply_json_site_parameters(DEFAULT_SITEFILE, site)
 
 
 def request_data(site, year, month):

solarforecastarbiter/io/reference_observations/tests/conftest.py

@@ -1,5 +1,8 @@
 import copy
 import json
+from pkg_resources import resource_filename, Requirement
+
+
 import numpy as np
 import pandas as pd
 import pytest
@@ -150,3 +153,11 @@ def mock_fetch(mocker, fake_ghi_data):
     fetch = mocker.MagicMock()
     fetch.return_value = fake_ghi_data
     return fetch
+
+
+@pytest.fixture
+def test_json_site_file():
+    return resource_filename(
+        Requirement.parse('solarforecastarbiter'),
+        'solarforecastarbiter/io/reference_observations/'
+        'tests/data/test_site.json')

solarforecastarbiter/io/reference_observations/tests/test_common.py

@@ -726,3 +726,15 @@ def test_create_forecasts_outside(template_fx, mocker, log):
     templates = [template.replace(name='one'), template.replace(name='two')]
     with pytest.raises(ValueError):
         common.create_forecasts(api, site, vars_, templates)
+
+
+@pytest.mark.parametrize('params', [
+    {'network_api_id': 2},
+    {'network_api_id': '2'},
+])
+def test_apply_json_site_parameters_plant(test_json_site_file, params):
+    new_site = common.apply_json_site_parameters(
+        test_json_site_file,
+        {'extra_parameters': params},
+    )
+    assert 'modeling_parameters' in new_site