Resolved merge conflicts in authentication approach

.github/workflows/tox.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.8', '3.9', '3.10']
+        python-version: ['3.9', '3.10', '3.11']
     defaults:
       run:
         working-directory: /home/runner/work/pyPrediktorMapClient/pyPrediktorMapClient

.readthedocs.yml

@@ -17,7 +17,7 @@ formats:
   - pdf
 
 python:
-  version: 3.8
+  version: 3.9
   install:
     - requirements: docs/requirements.txt
     - {path: ., method: pip}

docs/conf.py

@@ -150,6 +150,8 @@
 # If this is True, todo emits a warning for each TODO entries. The default is False.
 todo_emit_warnings = True
 
+# Since the documentation build process doesn't need to make actual database connections, we can mock the pyodbc module during the documentation build.
+autodoc_mock_imports = ["pyodbc"]
 
 # -- Options for HTML output -------------------------------------------------
 

setup.cfg

@@ -41,7 +41,7 @@ package_dir =
     =src
 
 # Require a min/specific Python version (comma-separated conditions)
-python_requires = >=3.8
+python_requires = >=3.9
 
 # Add here dependencies of your project (line-separated), e.g. requests>=2.2,<3.0.
 # Version specifiers like >=2.2,<3.0 avoid problems due to API changes in
@@ -53,7 +53,8 @@ install_requires =
     aiohttp >= 3.8.1
     pydantic >= 2.0
     pandas >= 1.4.4
-    pyodbc >= 4.0.39
+    pyodbc
+    pyPrediktorUtilities >= 0.3.2
 
 [options.packages.find]
 where = src
@@ -70,6 +71,8 @@ testing =
     setuptools
     pytest
     pytest-cov
+    pyPrediktorUtilities >= 0.3.2
+    pyodbc
 
 [options.entry_points]
 
@@ -118,10 +121,10 @@ version = 4.3
 package = pyprediktormapclient
 
 [tox:tox]
-envlist = py38, py39, py310, mypy
+envlist = py39, py310, py311, mypy
 
 [gh-actions]
 python =
-    3.8: py38
     3.9: py39
-    3.10: py310, mypy
+    3.10: py310, mypy
+    3.11: py311

src/pyprediktormapclient/__init__.py

@@ -5,7 +5,7 @@
 from .opc_ua import *
 
 if sys.version_info[:2] >= (3, 8):
-    # TODO: Import directly (no need for conditional) when `python_requires = >= 3.8`
+    # TODO: Import directly (no need for conditional) when `python_requires = >= 3.9`
     from importlib.metadata import PackageNotFoundError, version  # pragma: no cover
 else:
     from importlib_metadata import PackageNotFoundError, version  # pragma: no cover

src/pyprediktormapclient/dwh/context/enercast.py

@@ -1,6 +1,6 @@
 import json
 from pydantic import validate_call
-from typing import List, Dict, Any, Union
+from typing import List, Dict, Union
 
 from ..idwh import IDWH
 
@@ -10,19 +10,19 @@ def __init__(self, dwh: IDWH) -> None:
         self.dwh = dwh
 
     @validate_call
-    def get_plants_to_update(self) -> List[Any]:
+    def get_plants_to_update(self) -> List:
         query = "SET NOCOUNT ON; EXEC dwetl.GetEnercastPlantsToUpdate"
         return self.dwh.fetch(query)
 
     @validate_call
-    def get_live_meter_data(self, asset_name: str) -> List[Any]:
+    def get_live_meter_data(self, asset_name: str) -> List:
         query = f"SET NOCOUNT ON; EXEC dwetl.GetEnercastLiveMeterData '{asset_name}'"
         return self.dwh.fetch(query)
 
     @validate_call
     def upsert_forecast_data(
         self, enercast_forecast_data: Dict, forecast_type_key: Union[int, None] = None
-    ) -> List[Any]:
+    ) -> List:
         enercast_forecast_data_json = json.dumps({"results": enercast_forecast_data})
 
         query = "EXEC dwetl.UpsertEnercastForecastData ?, ?"

src/pyprediktormapclient/dwh/context/plant.py

@@ -1,6 +1,6 @@
 import json
 from pydantic import validate_call
-from typing import List, Dict, Any
+from typing import List, Dict
 
 from ..idwh import IDWH
 
@@ -10,15 +10,15 @@ def __init__(self, dwh: IDWH) -> None:
         self.dwh = dwh
 
     @validate_call
-    def get_optimal_tracker_angles(self, facility_name: str) -> List[Any]:
+    def get_optimal_tracker_angles(self, facility_name: str) -> List:
         query = (
             f"SET NOCOUNT ON; EXEC dwetl.GetOptimalTrackerAngleParameters "
             + f"@FacilityName = N'{facility_name}'"
         )
         return self.dwh.fetch(query)
 
     @validate_call
-    def upsert_optimal_tracker_angles(self, facility_data: Dict) -> List[Any]:
+    def upsert_optimal_tracker_angles(self, facility_data: Dict) -> List:
         facility_data_json = json.dumps(facility_data)
         facility_data_json.replace("'", '"')
 
@@ -33,7 +33,7 @@ def insert_log(
         data_type: str,
         has_thrown_error: bool = False,
         message: str = "",
-    ) -> List[Any]:
+    ) -> List:
         query = "EXEC dwetl.InsertExtDataUpdateLog @plantname = ?, @extkey = ?, @DataType = ?, @Message = ?, @Result = ?"
         return self.dwh.execute(
             query,

src/pyprediktormapclient/dwh/context/solcast.py

@@ -1,6 +1,6 @@
 import json
 from pydantic import validate_call
-from typing import List, Dict, Any, Union
+from typing import List, Dict, Union
 
 from ..idwh import IDWH
 
@@ -10,7 +10,7 @@ def __init__(self, dwh: IDWH) -> None:
         self.dwh = dwh
 
     @validate_call
-    def get_plants_to_update(self) -> List[Any]:
+    def get_plants_to_update(self) -> List:
         query = "SET NOCOUNT ON; EXEC dwetl.GetSolcastPlantsToUpdate"
         return self.dwh.fetch(query)
 
@@ -20,7 +20,7 @@ def upsert_forecast_data(
         plantname: str,
         solcast_forecast_data: Dict,
         forecast_type_key: Union[int, None] = None,
-    ) -> List[Any]:
+    ) -> List:
         solcast_forecast_data_json = json.dumps(
             {
                 "results": {

src/pyprediktormapclient/dwh/dwh.py

@@ -3,8 +3,8 @@
 import importlib
 from typing import Dict
 from pydantic import validate_call
+from pyprediktorutilities import Dwh as Db
 
-from .db import Db
 from . import context
 from .idwh import IDWH
 
@@ -65,17 +65,11 @@ def __init__(
 
     @validate_call
     def version(self) -> Dict:
-        """Get the DWH version.
+        """
+        Get the DWH version.
 
         Returns:
-        Dict: A dictionary with the following keys (or similar):
-                    DWHVersion,
-                    UpdateDate,
-                    ImplementedDate,
-                    Comment,
-                    MajorVersionNo,
-                    MinorVersionNo,
-                    InterimVersionNo
+            Dict: A dictionary with the following keys (or similar): DWHVersion, UpdateDate, ImplementedDate, Comment, MajorVersionNo, MinorVersionNo, InterimVersionNo
         """
         query = "SET NOCOUNT ON; EXEC [dbo].[GetVersion]"
         results = self.fetch(query)

src/pyprediktormapclient/dwh/idwh.py

@@ -1,4 +1,4 @@
-from typing import Dict, List, Any
+from typing import Dict, List
 from abc import ABC, abstractmethod
 
 
@@ -8,9 +8,9 @@ def version(self) -> Dict:
         pass
 
     @abstractmethod
-    def fetch(self, query: str, to_dataframe: bool = False) -> List[Any]:
+    def fetch(self, query: str, to_dataframe: bool = False) -> List:
         pass
 
     @abstractmethod
-    def execute(self, query: str, *args, **kwargs) -> List[Any]:
+    def execute(self, query: str, *args, **kwargs) -> List:
         pass

tests/dwh/test_db.py

@@ -11,9 +11,6 @@
 """
 Helpers
 """
-
-class Config:
-        arbitrary_types_allowed = True
 
 class mock_pyodbc_connection:
     def __init__(self, connection_string):

tests/dwh/test_dwh.py

@@ -36,14 +36,15 @@ def grs():
 Test Functions
 """
 
+
 def test_init_when_instantiate_dwh_but_pyodbc_throws_error_with_tolerance_to_attempts_then_throw_exception(
     monkeypatch,
 ):
     driver_index = 0
 
     # Mock the database connection
     monkeypatch.setattr(
-        "pyprediktormapclient.dwh.db.pyodbc.connect",
+        "pyprediktorutilities.dwh.pyodbc.connect",
         mock_pyodbc_connection_throws_error_not_tolerant_to_attempts,
     )
 
@@ -58,7 +59,7 @@ def test_init_when_instantiate_dwh_but_pyodbc_throws_error_tolerant_to_attempts_
 
     # Mock the database connection
     monkeypatch.setattr(
-        "pyprediktormapclient.dwh.db.pyodbc.connect",
+        "pyprediktorutilities.dwh.pyodbc.connect",
         mock_pyodbc_connection_throws_error_tolerant_to_attempts,
     )