get the correct client type; add a test

longshuicy · longshuicy · commit b629c6cee1a3 · 2024-08-27T14:49:45.000-05:00
diff --git a/pyincore/analyses/bridgedamage/bridgedamage.py b/pyincore/analyses/bridgedamage/bridgedamage.py
@@ -18,7 +18,7 @@ class BridgeDamage(BaseAnalysis):
     """Computes bridge structural damage for earthquake, tsunami, tornado, and hurricane hazards.
 
     Args:
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
 
     """
 
diff --git a/pyincore/analyses/buildingclusterrecovery/buildingclusterrecovery.py b/pyincore/analyses/buildingclusterrecovery/buildingclusterrecovery.py
@@ -22,7 +22,7 @@ class BuildingClusterRecovery(BaseAnalysis):
     to calculate building’s initial functionality loss.
 
     Args:
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
 
     """
 
diff --git a/pyincore/analyses/buildingeconloss/buildingeconloss.py b/pyincore/analyses/buildingeconloss/buildingeconloss.py
@@ -18,7 +18,7 @@ class BuildingEconLoss(BaseAnalysis):
     year and year of interest (current, date of hazard etc.)
 
     Args:
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
 
     """
 
diff --git a/pyincore/analyses/buildingfunctionality/buildingfunctionality.py b/pyincore/analyses/buildingfunctionality/buildingfunctionality.py
@@ -19,7 +19,7 @@ class BuildingFunctionality(BaseAnalysis):
     functional, buildings are considered to be able to receive electric power.
 
     Args:
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
 
     """
 
diff --git a/pyincore/analyses/buildingnonstructuraldamage/buildingnonstructuraldamage.py b/pyincore/analyses/buildingnonstructuraldamage/buildingnonstructuraldamage.py
@@ -20,7 +20,7 @@ class BuildingNonStructDamage(BaseAnalysis):
     """Computes non-structural structural building damage for an earthquake hazard.
 
     Args:
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
 
     """
 
diff --git a/pyincore/analyses/buildingstructuraldamage/buildingstructuraldamage.py b/pyincore/analyses/buildingstructuraldamage/buildingstructuraldamage.py
@@ -25,7 +25,7 @@ class BuildingStructuralDamage(BaseAnalysis):
     different hazard type such as earthquake, tsunami, and tornado.
 
     Args:
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
 
     """
 
diff --git a/pyincore/analyses/buyoutdecision/buyoutdecision.py b/pyincore/analyses/buyoutdecision/buyoutdecision.py
@@ -13,7 +13,7 @@ class BuyoutDecision(BaseAnalysis):
     """A framework to select households for buyout based on past and future flood damaged.
 
     Args:
-    incore_client(IncoreClient): Service authentication.
+    incore_client(Union[IncoreClient, IncoreInternalClient]): Service authentication.
 
     """
 
diff --git a/pyincore/analyses/capitalshocks/capitalshocks.py b/pyincore/analyses/capitalshocks/capitalshocks.py
@@ -13,7 +13,7 @@ class CapitalShocks(BaseAnalysis):
      before the natural disaster."
 
     Args:
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
 
     """
 
diff --git a/pyincore/analyses/combinedwindwavesurgebuildingdamage/combinedwindwavesurgebuildingdamage.py b/pyincore/analyses/combinedwindwavesurgebuildingdamage/combinedwindwavesurgebuildingdamage.py
@@ -14,7 +14,7 @@ class CombinedWindWaveSurgeBuildingDamage(BaseAnalysis):
     and uses the maximum damage probabilities from the 3 damages to determine overall damage
 
     Args:
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
     """
 
     def __init__(self, incore_client):
diff --git a/pyincore/analyses/combinedwindwavesurgebuildingloss/combinedwindwavesurgebuildingloss.py b/pyincore/analyses/combinedwindwavesurgebuildingloss/combinedwindwavesurgebuildingloss.py
@@ -23,7 +23,7 @@ class CombinedWindWaveSurgeBuildingLoss(BaseAnalysis):
         147. 04021185. 10.1061/(ASCE)ST.1943-541X.0003144.
 
     Args:
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
     """
 
     def __init__(self, incore_client):
diff --git a/pyincore/analyses/commercialbuildingrecovery/commercialbuildingrecovery.py b/pyincore/analyses/commercialbuildingrecovery/commercialbuildingrecovery.py
@@ -34,7 +34,7 @@ class CommercialBuildingRecovery(BaseAnalysis):
         in Community Resilience Modeling. Natural Hazards Review, 24(4), p.04023031.
 
     Args:
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
 
     """
 
diff --git a/pyincore/analyses/epfdamage/epfdamage.py b/pyincore/analyses/epfdamage/epfdamage.py
@@ -16,7 +16,7 @@ class EpfDamage(BaseAnalysis):
     """Computes electric power facility structural damage for an earthquake, tsunami, tornado, and hurricane hazards.
 
     Args:
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
 
     """
 
diff --git a/pyincore/analyses/epfrepaircost/epfrepaircost.py b/pyincore/analyses/epfrepaircost/epfrepaircost.py
@@ -14,7 +14,7 @@ class EpfRepairCost(BaseAnalysis):
     """Computes electric power facility repair cost.
 
     Args:
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
 
     """
 
diff --git a/pyincore/analyses/galvestoncge/galvestoncge.py b/pyincore/analyses/galvestoncge/galvestoncge.py
@@ -30,7 +30,7 @@ class GalvestonCGEModel(BaseAnalysis):
 
 
     Args:
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
 
     """
 
diff --git a/pyincore/analyses/gasfacilitydamage/gasfacilitydamage.py b/pyincore/analyses/gasfacilitydamage/gasfacilitydamage.py
@@ -22,7 +22,7 @@ class GasFacilityDamage(BaseAnalysis):
     """Computes gas facility structural damage for earthquake.
 
     Args:
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
 
     """
 
diff --git a/pyincore/analyses/housingrecoverysequential/housingrecoverysequential.py b/pyincore/analyses/housingrecoverysequential/housingrecoverysequential.py
@@ -32,7 +32,7 @@ class HousingRecoverySequential(BaseAnalysis):
         and duration based on social vulnerability. Risk Analysis, 40(12), pp.2675-2695.
 
     Args:
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
     """
 
     # Social vulnerability value generators per zone
diff --git a/pyincore/analyses/housingvaluationrecovery/housingvaluationrecovery.py b/pyincore/analyses/housingvaluationrecovery/housingvaluationrecovery.py
@@ -36,7 +36,7 @@ class HousingValuationRecovery(BaseAnalysis):
         seasonal/vacation housing markets in coastal communities. Natural Hazards Review.
 
     Args:
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
 
     """
 
diff --git a/pyincore/analyses/indp/indp.py b/pyincore/analyses/indp/indp.py
@@ -36,7 +36,7 @@ class INDP(BaseAnalysis):
         | Implementation: Chen Wang and NCSA IN-CORE Dev Team
 
     Args:
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
     """
 
     def __init__(self, incore_client):
diff --git a/pyincore/analyses/joplincge/joplincge.py b/pyincore/analyses/joplincge/joplincge.py
@@ -24,7 +24,7 @@ class JoplinCGEModel(BaseAnalysis):
     tax revenues in order to finance the provision of public services; and (4) the rest of the world.
 
     Args:
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
 
     """
 
diff --git a/pyincore/analyses/joplinempiricalbuildingrestoration/joplinempiricalbuildingrestoration.py b/pyincore/analyses/joplinempiricalbuildingrestoration/joplinempiricalbuildingrestoration.py
@@ -20,7 +20,7 @@ class JoplinEmpiricalBuildingRestoration(BaseAnalysis):
     Level 4 (FL4, the lowest functionality) to Functionality Level 0 (FL0, full functionality).
 
     Args:
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
 
     """
 
diff --git a/pyincore/analyses/meandamage/meandamage.py b/pyincore/analyses/meandamage/meandamage.py
@@ -14,7 +14,7 @@
 class MeanDamage(BaseAnalysis):
     """
     Args:
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
     """
 
     def __init__(self, incore_client):
diff --git a/pyincore/analyses/montecarlolimitstateprobability/montecarlolimitstateprobability.py b/pyincore/analyses/montecarlolimitstateprobability/montecarlolimitstateprobability.py
@@ -15,7 +15,7 @@
 class MonteCarloLimitStateProbability(BaseAnalysis):
     """
     Args:
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
 
     """
 
diff --git a/pyincore/analyses/multiobjectiveretrofitoptimization/multiobjectiveretrofitoptimization.py b/pyincore/analyses/multiobjectiveretrofitoptimization/multiobjectiveretrofitoptimization.py
@@ -36,7 +36,7 @@ class MultiObjectiveRetrofitOptimization(BaseAnalysis):
 
     Args:
 
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
 
     """
 
diff --git a/pyincore/analyses/ncifunctionality/ncifunctionality.py b/pyincore/analyses/ncifunctionality/ncifunctionality.py
@@ -39,7 +39,7 @@ class NciFunctionality(BaseAnalysis):
 
     Args:
 
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
 
     """
 
diff --git a/pyincore/analyses/pipelinefunctionality/pipelinefunctionality.py b/pyincore/analyses/pipelinefunctionality/pipelinefunctionality.py
@@ -35,7 +35,7 @@ class PipelineFunctionality(BaseAnalysis):
         approach for generalized network-system analysis. Reliability Engineering & System Safety, 217, 108042.
 
     Args:
-    incore_client (IncoreClient): Service authentication.
+    incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
 
     """
 
diff --git a/pyincore/analyses/pipelinerepaircost/pipelinerepaircost.py b/pyincore/analyses/pipelinerepaircost/pipelinerepaircost.py
@@ -14,7 +14,7 @@ class PipelineRepairCost(BaseAnalysis):
     """Computes pipeline repair cost.
 
     Args:
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
 
     """
 
diff --git a/pyincore/analyses/pipelinerestoration/pipelinerestoration.py b/pyincore/analyses/pipelinerestoration/pipelinerestoration.py
@@ -15,7 +15,7 @@
 class PipelineRestoration(BaseAnalysis):
     """
     Args:
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
 
     """
 
diff --git a/pyincore/analyses/populationdislocation/populationdislocation.py b/pyincore/analyses/populationdislocation/populationdislocation.py
@@ -25,7 +25,7 @@ class PopulationDislocation(BaseAnalysis):
     of damage. The two approaches produce different results.
 
     Args:
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
 
     """
 
diff --git a/pyincore/analyses/residentialbuildingrecovery/residentialbuildingrecovery.py b/pyincore/analyses/residentialbuildingrecovery/residentialbuildingrecovery.py
@@ -35,7 +35,7 @@ class ResidentialBuildingRecovery(BaseAnalysis):
         and Effects of Pre-and Post-event Policies." International Journal of Disaster Risk Reduction (2021): 102259.
 
     Args:
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
 
     """
 
diff --git a/pyincore/analyses/roaddamage/roaddamage.py b/pyincore/analyses/roaddamage/roaddamage.py
@@ -21,7 +21,7 @@ class RoadDamage(BaseAnalysis):
     """Road Damage Analysis calculates the probability of road damage based on an earthquake or tsunami hazard.
 
     Args:
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
 
     """
 
diff --git a/pyincore/analyses/saltlakecge/saltlakecge.py b/pyincore/analyses/saltlakecge/saltlakecge.py
@@ -33,7 +33,7 @@ class SaltLakeCGEModel(BaseAnalysis):
 
 
     Args:
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
 
     """
 
diff --git a/pyincore/analyses/seasidecge/seasidecge.py b/pyincore/analyses/seasidecge/seasidecge.py
@@ -27,7 +27,7 @@ class SeasideCGEModel(BaseAnalysis):
      tax revenues in order to finance the provision of public services; and (4) the rest of the world.
 
     Args:
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
 
     """
 
diff --git a/pyincore/analyses/socialvulnerabilityscore/socialvulnerabilityscore.py b/pyincore/analyses/socialvulnerabilityscore/socialvulnerabilityscore.py
@@ -23,7 +23,7 @@ class SocialVulnerabilityScore(BaseAnalysis):
     Related publications
 
     Args:
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
 
     """
 
diff --git a/pyincore/analyses/waterfacilityrepaircost/waterfacilityrepaircost.py b/pyincore/analyses/waterfacilityrepaircost/waterfacilityrepaircost.py
@@ -14,7 +14,7 @@ class WaterFacilityRepairCost(BaseAnalysis):
     """Computes water facility repair cost.
 
     Args:
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
 
     """
 
diff --git a/pyincore/baseanalysis.py b/pyincore/baseanalysis.py
@@ -24,7 +24,7 @@ class BaseAnalysis:
     specifications.
 
     Args:
-        incore_client (IncoreClient): Service authentication.
+        incore_client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
 
     """
 
diff --git a/pyincore/client.py b/pyincore/client.py
@@ -463,16 +463,18 @@ def __init__(
         service_url: str = None,
         username: str = None,
         usergroups: list = None,
+        offline: bool = False,
     ):
         """
 
         Args:
             service_url (str): Service url.
             username (str): Username.
             usergroups (list): User groups.
-            offline (bool): Flag to indicate offline mode or not.
+            offline (bool): Flag to indicate offline mode or not. Default to False.
         """
         super().__init__()
+        self.offline = offline
 
         if service_url is None or len(service_url.strip()) == 0:
             service_url = pyglobals.INCORE_INTERNAL_API_URL
@@ -494,10 +496,11 @@ def __init__(
             os.makedirs(self.hashed_svc_data_dir)
 
         # Constructing the headers
-        self.session.headers[
-            "x-auth-userinfo"
-        ] = f'{{"preferred_username":"{username}"}}'
-        self.session.headers["x-auth-usergroup"] = f'{{"groups":{usergroups}}}'
+        self.session.headers["x-auth-userinfo"] = json.dumps(
+            {"preferred_username": username}
+        )
+        self.session.headers["x-auth-usergroup"] = json.dumps({"groups": usergroups})
+
         print(
             "Internal connection successful to IN-CORE services.",
             "pyIncore version detected:",
diff --git a/pyincore/dataservice.py b/pyincore/dataservice.py
@@ -11,9 +11,10 @@
 import re
 import zipfile
 import ntpath
+from typing import Union
 
 import pyincore.globals as pyglobals
-from pyincore import IncoreClient
+from pyincore import IncoreClient, IncoreInternalClient
 from pyincore.decorators import forbid_offline
 from pyincore.utils import return_http_response
 from urllib.parse import urljoin
@@ -25,11 +26,11 @@ class DataService:
     """Data service client.
 
     Args:
-        client (IncoreClient): Service authentication.
+        client (Union[IncoreClient, IncoreInternalClient]): Service authentication.
 
     """
 
-    def __init__(self, client: IncoreClient):
+    def __init__(self, client: Union[IncoreClient, IncoreInternalClient]):
         self.client = client
         self.base_url = urljoin(client.service_url, "data/api/datasets/")
         self.files_url = urljoin(client.service_url, "data/api/files/")
diff --git a/pyincore/dfr3service.py b/pyincore/dfr3service.py
diff --git a/pyincore/fragilityservice.py b/pyincore/fragilityservice.py
diff --git a/pyincore/hazardservice.py b/pyincore/hazardservice.py
diff --git a/pyincore/repairservice.py b/pyincore/repairservice.py
diff --git a/pyincore/restorationservice.py b/pyincore/restorationservice.py
diff --git a/pyincore/semanticservice.py b/pyincore/semanticservice.py
diff --git a/pyincore/spaceservice.py b/pyincore/spaceservice.py
diff --git a/tests/pyincore/test_internal_client.py b/tests/pyincore/test_internal_client.py
