Fixes determining resource path

pcmdi_metrics/diurnal/scripts/savg_fourier.py

@@ -24,9 +24,9 @@
 import cdms2
 import cdutil
 import MV2
-import pkg_resources
 
 import pcmdi_metrics
+from pcmdi_metrics import resources
 from pcmdi_metrics.diurnal.common import P, monthname_d, populateStringConstructor
 
 
@@ -244,13 +244,7 @@ def spacevavg(tvarb1, tvarb2, sftlf, model):
     OUT = pcmdi_metrics.io.base.Base(
         os.path.abspath(args.results_dir), os.path.basename(jsonname)
     )
-    try:
-        egg_pth = pkg_resources.resource_filename(
-            pkg_resources.Requirement.parse("pcmdi_metrics"), "share/pmp"
-        )
-    except Exception:
-        # python 2 seems to fail when ran in home directory of source?
-        egg_pth = os.path.join(os.getcwd(), "share", "pmp")
+    egg_pth = resources.resource_path()
     disclaimer = open(os.path.join(egg_pth, "disclaimer.txt")).read()
     metrics_dictionary["DISCLAIMER"] = disclaimer
     metrics_dictionary[

pcmdi_metrics/diurnal/scripts/std_of_dailymeans.py

@@ -29,9 +29,9 @@
 import cdp
 import cdutil
 import numpy.ma
-import pkg_resources
 
 import pcmdi_metrics
+from pcmdi_metrics import resources
 from pcmdi_metrics.diurnal.common import (
     INPUT,
     P,
@@ -148,13 +148,7 @@ def compute(param):
             stats_dic = metrics_dictionary["RESULTS"]
 
     OUT = pcmdi_metrics.io.base.Base(os.path.abspath(args.results_dir), jsonFile())
-    try:
-        egg_pth = pkg_resources.resource_filename(
-            pkg_resources.Requirement.parse("pcmdi_metrics"), "share/pmp"
-        )
-    except Exception:
-        # python 2 seems to fail when ran in home directory of source?
-        egg_pth = os.path.join(os.getcwd(), "share", "pmp")
+    egg_pth = resources.resource_path()
     disclaimer = open(os.path.join(egg_pth, "disclaimer.txt")).read()
     metrics_dictionary["DISCLAIMER"] = disclaimer
     metrics_dictionary["REFERENCE"] = (

pcmdi_metrics/diurnal/scripts/std_of_hourlyvalues.py

@@ -26,9 +26,9 @@
 import cdp
 import cdutil
 import numpy.ma
-import pkg_resources
 
 import pcmdi_metrics
+from pcmdi_metrics import resources
 from pcmdi_metrics.diurnal.common import (
     INPUT,
     P,
@@ -159,13 +159,7 @@ def compute(param):
             stats_dic = metrics_dictionary["RESULTS"]
 
     OUT = pcmdi_metrics.io.base.Base(os.path.abspath(args.results_dir), jsonFile())
-    try:
-        egg_pth = pkg_resources.resource_filename(
-            pkg_resources.Requirement.parse("pcmdi_metrics"), "share/pmp"
-        )
-    except Exception:
-        # python 2 seems to fail when ran in home directory of source?
-        egg_pth = os.path.join(os.getcwd(), "share", "pmp")
+    egg_pth = resources.resource_path()
     disclaimer = open(os.path.join(egg_pth, "disclaimer.txt")).read()
     metrics_dictionary["DISCLAIMER"] = disclaimer
     metrics_dictionary["REFERENCE"] = (

pcmdi_metrics/diurnal/scripts/std_of_meandiurnalcycle.py

@@ -24,9 +24,9 @@
 import cdp
 import cdutil
 import genutil
-import pkg_resources
 
 import pcmdi_metrics
+from pcmdi_metrics import resources
 from pcmdi_metrics.diurnal.common import (
     INPUT,
     P,
@@ -161,13 +161,7 @@ def compute(param):
             stats_dic = metrics_dictionary["RESULTS"]
 
     OUT = pcmdi_metrics.io.base.Base(os.path.abspath(args.results_dir), jsonFile())
-    try:
-        egg_pth = pkg_resources.resource_filename(
-            pkg_resources.Requirement.parse("pcmdi_metrics"), "share/pmp"
-        )
-    except Exception:
-        # python 2 seems to fail when ran in home directory of source?
-        egg_pth = os.path.join(os.getcwd(), "share", "pmp")
+    egg_pth = resources.resource_path()
     disclaimer = open(os.path.join(egg_pth, "disclaimer.txt")).read()
     metrics_dictionary["DISCLAIMER"] = disclaimer
     metrics_dictionary["REFERENCE"] = (

pcmdi_metrics/driver/dataset.py

@@ -5,9 +5,9 @@
 
 import cdms2
 import cdutil
-import pkg_resources
 from six import with_metaclass
 
+from pcmdi_metrics import resources
 from pcmdi_metrics.io.base import Base
 
 
@@ -120,13 +120,7 @@ def get(self):
     @staticmethod
     def load_path_as_file_obj(name):
         """Returns a File object for the file named name."""
-        try:
-            egg_pth = pkg_resources.resource_filename(
-                pkg_resources.Requirement.parse("pcmdi_metrics"), "share/pmp"
-            )
-        except Exception:
-            # python 2 seems to fail when ran in home directory of source?
-            egg_pth = os.path.join(os.getcwd(), "share", "pmp")
+        egg_pth = resources.resource_path()
         file_path = os.path.join(egg_pth, name)
         opened_file = None
         try:

pcmdi_metrics/driver/pmp_parser.py

@@ -1,9 +1,9 @@
 import os
 
 import cdp.cdp_parser
-import pkg_resources
 
 import pcmdi_metrics.driver.pmp_parameter
+from pcmdi_metrics import resources
 
 try:
     basestring  # noqa
@@ -13,9 +13,7 @@
 
 def path_to_default_args():
     """Returns path to Default Common Input Arguments in package egg."""
-    egg_pth = pkg_resources.resource_filename(
-        pkg_resources.Requirement.parse("pcmdi_metrics"), "share/pmp"
-    )
+    egg_pth = resources.resource_path()
     file_path = os.path.join(egg_pth, "DefArgsCIA.json")
     return file_path
 

pcmdi_metrics/enso/enso_driver.py

@@ -9,7 +9,6 @@
 import time
 
 import cdms2
-import pkg_resources
 from EnsoMetrics.EnsoCollectionsLib import (
     CmipVariables,
     ReferenceObservations,
@@ -18,6 +17,7 @@
 from EnsoMetrics.EnsoComputeMetricsLib import ComputeCollection
 from genutil import StringConstructor
 
+from pcmdi_metrics import resources
 from pcmdi_metrics.enso.lib import (
     AddParserArgument,
     CLIVAR_LargeEnsemble_Variables,
@@ -120,12 +120,7 @@
 # Prepare loop iteration
 # -------------------------------------------------
 # Environmental setup
-try:
-    egg_pth = pkg_resources.resource_filename(
-        pkg_resources.Requirement.parse("pcmdi_metrics"), "share/pmp"
-    )
-except Exception:
-    egg_pth = os.path.join(sys.prefix, "share", "pmp")
+egg_pth = resources.resource_path()
 print("egg_pth:", egg_pth)
 
 # Create output directory

pcmdi_metrics/enso/scripts_pcmdi/enso_driver_obsOnly.py

@@ -7,13 +7,12 @@
 import glob
 import json
 import os
-import sys
 
-import pkg_resources
 from EnsoMetrics.EnsoCollectionsLib import ReferenceObservations, defCollection
 from EnsoMetrics.EnsoComputeMetricsLib import ComputeCollection_ObsOnly
 from genutil import StringConstructor
 
+from pcmdi_metrics import resources
 from pcmdi_metrics.enso.lib import AddParserArgument, metrics_to_json
 
 # To avoid below error when using multi cores
@@ -100,12 +99,7 @@
 # Prepare loop iteration
 # -------------------------------------------------
 # Environmental setup
-try:
-    egg_pth = pkg_resources.resource_filename(
-        pkg_resources.Requirement.parse("pcmdi_metrics"), "share/pmp"
-    )
-except Exception:
-    egg_pth = os.path.join(sys.prefix, "share", "pmp")
+egg_pth = resources.resource_path()
 print("egg_pth:", egg_pth)
 
 # Create output directory

pcmdi_metrics/monsoon_sperber/scripts/driver_monsoon_sperber.py

@@ -53,9 +53,9 @@
 import matplotlib.pyplot as plt
 import MV2
 import numpy as np
-import pkg_resources
 
 import pcmdi_metrics
+from pcmdi_metrics import resources
 from pcmdi_metrics.monsoon_sperber.lib import (
     AddParserArgument,
     YearCheck,
@@ -202,9 +202,7 @@ def tree():
 # Loop start for given models
 # -------------------------------------------------
 regions_specs = {}
-egg_pth = pkg_resources.resource_filename(
-    pkg_resources.Requirement.parse("pcmdi_metrics"), "share/pmp"
-)
+egg_pth = resources.resource_path()
 exec(
     compile(
         open(os.path.join(egg_pth, "default_regions.py")).read(),

pcmdi_metrics/monsoon_wang/monsoon_wang_driver.py

@@ -6,10 +6,10 @@
 import cdms2
 import genutil
 import numpy
-import pkg_resources
 from genutil import statistics
 
 import pcmdi_metrics
+from pcmdi_metrics import resources
 from pcmdi_metrics.monsoon_wang import mpd, mpi_skill_scores
 from pcmdi_metrics.pcmdi.pmp_parser import PMPParser
 
@@ -151,13 +151,7 @@ def monsoon_wang_runner(args):
         raise RuntimeError("No model file found!")
     #########################################
 
-    try:
-        egg_pth = pkg_resources.resource_filename(
-            pkg_resources.Requirement.parse("pcmdi_metrics"), "share/pmp"
-        )
-    except Exception:
-        # python 2 seems to fail when ran in home directory of source?
-        egg_pth = os.path.join(os.getcwd(), "share", "pmp")
+    egg_pth = resources.resource_path()
     globals = {}
     locals = {}
     exec(

pcmdi_metrics/resources.py

@@ -0,0 +1,26 @@
+import os
+
+import pkg_resources
+
+
+def resource_path():
+    if "CONDA_PREFIX" in os.environ:
+        res_path = os.path.join(os.environ["CONDA_PREFIX"], "share", "pmp")
+
+        # Handle edge case when in conda env but the package is not installed
+        # with conda
+        if os.path.exists(res_path):
+            return res_path
+
+    try:
+        res_path = pkg_resources.resource_filename(
+            pkg_resources.Requirement.parse("pcmdi_metrics"),
+            "share/pmp",
+        )
+    except Exception:
+        res_path = os.path.join(os.getcwd(), "share", "pmp")
+
+    # Should never fail this
+    assert os.path.exists(res_path)
+
+    return res_path

pcmdi_metrics/variability_mode/variability_modes_driver.py

@@ -58,10 +58,10 @@
 import cdtime
 import cdutil
 import MV2
-import pkg_resources
 from genutil import StringConstructor
 
 import pcmdi_metrics
+from pcmdi_metrics import resources
 from pcmdi_metrics.variability_mode.lib import (
     AddParserArgument,
     VariabilityModeCheck,
@@ -95,9 +95,7 @@
     os.environ["UVCDAT_ANONYMOUS_LOG"] = "no"
 
 regions_specs = {}
-egg_pth = pkg_resources.resource_filename(
-    pkg_resources.Requirement.parse("pcmdi_metrics"), "share/pmp"
-)
+egg_pth = resources.resource_path()
 exec(
     compile(
         open(os.path.join(egg_pth, "default_regions.py")).read(),

tests/test_resources.py

@@ -0,0 +1,47 @@
+import os
+from unittest import mock
+
+from pcmdi_metrics import resources
+
+
+def test_conda_env(tmpdir):
+    conda_prefix = os.path.join(tmpdir, "conda")
+
+    pmp_share_path = os.path.join(conda_prefix, "share", "pmp")
+
+    os.makedirs(pmp_share_path)
+
+    with mock.patch.dict(os.environ, {"CONDA_PREFIX": conda_prefix}):
+        path = resources.resource_path()
+
+    assert path == os.path.join(tmpdir, "conda", "share", "pmp")
+
+
+@mock.patch("os.getcwd")
+@mock.patch("pkg_resources.resource_filename")
+def test_conda_env_no_exist(resource_filename, getcwd, tmpdir):
+    # Fix issue when tests are ran against an installed package
+    resource_filename.side_effect = Exception()
+
+    conda_prefix = os.path.join(tmpdir, "conda")
+
+    getcwd_path = os.path.join(tmpdir, "share", "pmp")
+
+    os.makedirs(getcwd_path)
+
+    getcwd.return_value = tmpdir
+
+    with mock.patch.dict(os.environ, {"CONDA_PREFIX": conda_prefix}):
+        path = resources.resource_path()
+
+    assert path == os.path.join(tmpdir, "share", "pmp")
+
+
+@mock.patch("pkg_resources.Requirement.parse")
+@mock.patch("pkg_resources.resource_filename")
+def test_pkg_resources(resource_filename, parse, tmpdir):
+    resource_filename.return_value = str(tmpdir)
+
+    path = resources.resource_path()
+
+    assert path == str(tmpdir)