artesian-sdk 3.1.2.dev19__tar.gz → 3.1.3__tar.gz

{artesian-sdk-3.1.2.dev19 → artesian-sdk-3.1.3}/.github/workflows/python-tests.yml

@@ -36,6 +36,14 @@ jobs:
       run: |
         flake8 .
 
+    - uses: jordemort/action-pyright@v1
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        reporter: github-check
+        lib: 
+        level: warning
+        filter_mode: file
+
     - name: Test Pytest
       run: |
         pytest --junitxml=junit/test-results-${{ matrix.python-version }}.xml

artesian-sdk-3.1.3/.vscode/extensions.json

@@ -0,0 +1,10 @@
+{
+    "recommendations": [
+        "ms-python.flake8",
+        "github.vscode-github-actions",
+        "ms-python.vscode-pylance",
+        "ms-python.python",
+        "ms-python.debugpy",
+        "ms-python.black-formatter"
+    ]
+}

{artesian-sdk-3.1.2.dev19 → artesian-sdk-3.1.3}/.vscode/settings.json

@@ -2,11 +2,9 @@
   "python.testing.pytestEnabled": true,
   "python.testing.unittestEnabled": false,
   "editor.fontSize": 16,
-  "python.formatting.provider": "none",
-  "python.linting.flake8Enabled": true,
   "editor.formatOnPaste": true,
   "editor.formatOnSave": true,
   "[python]": {
     "editor.defaultFormatter": "ms-python.black-formatter"
   }
-}
+}

{artesian-sdk-3.1.2.dev19 → artesian-sdk-3.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: artesian-sdk
-Version: 3.1.2.dev19
+Version: 3.1.3
 Summary: Library provides read access to the Artesian API
 Author-email: ARK Lab <arklab@ark-energy.eu>
 Maintainer-email: ARK Lab <arklab@ark-energy.eu>

{artesian-sdk-3.1.2.dev19 → artesian-sdk-3.1.3}/pyproject.toml

@@ -155,4 +155,11 @@ python_files = "Test*.py"
 testpaths = [
     "tests"
 ]
-addopts = "--doctest-modules --junitxml=junit/test-results.xml --cov=src --cov-report=xml --cov-report=html"
+addopts = "--doctest-modules --junitxml=junit/test-results.xml --cov=src --cov-report=xml --cov-report=html"
+
+[tool.pyright]
+include = ["src"]
+exclude = [
+  "**/node_modules",
+  "**/__pycache__"
+]

{artesian-sdk-3.1.2.dev19 → artesian-sdk-3.1.3}/src/Artesian/Exceptions.py

@@ -125,7 +125,7 @@ class ArtesianSdkOptimisticConcurrencyException(ArtesianSdkRemoteException):
     """
 
     def __init__(
-        self: ArtesianSdkValidationException,
+        self: ArtesianSdkOptimisticConcurrencyException,
         method: str,
         url: str,
         statusCode: int,

{artesian-sdk-3.1.2.dev19 → artesian-sdk-3.1.3}/src/Artesian/GMEPublicOffers/GMEPublicOfferQuery.py

@@ -15,7 +15,6 @@ from ._Enum.UnitType import UnitType
 from ._Enum.Zone import Zone
 import asyncio
 from urllib import parse
-import itertools
 
 
 class GMEPublicOfferQuery:
@@ -209,8 +208,8 @@ class GMEPublicOfferQuery:
         Returns:
             list of GMEPublicOffers.
         """
-        urls = self.__buildRequest()
-        return self._exec(urls)
+        url = self.__buildRequest()
+        return self._exec(url)
 
     async def executeAsync(self: GMEPublicOfferQuery) -> Any:
         """
@@ -219,13 +218,12 @@ class GMEPublicOfferQuery:
         Returns:
             Enumerable of TimeSerieRow Actual.
         """
-        urls = self.__buildRequest()
-        return await self._execAsync(urls)
+        url = self.__buildRequest()
+        return await self._execAsync(url)
 
     def __buildRequest(self: GMEPublicOfferQuery) -> str:
         self._validateQuery()
         qp = self._queryParameters
-        urls = []
 
         url = "/{0}/{1}/{2}/{3}?_=1".format(
             self.__routePrefix,
@@ -281,9 +279,7 @@ class GMEPublicOfferQuery:
             enc = parse.quote_plus(baType)
             url = url + "&baType=" + enc
 
-        urls.append(url)
-
-        return urls
+        return url
 
     def __getScope(self: GMEPublicOfferQuery, scope: Scope) -> str:
         switcher = {
@@ -352,14 +348,19 @@ class GMEPublicOfferQuery:
             raise Exception("Not supported Market")
         return vr
 
-    def __getPurpose(self: GMEPublicOfferQuery, purpose: Purpose) -> str:
+    def __getPurpose(self: GMEPublicOfferQuery, purpose: Purpose | None) -> str:
+        if purpose is None:
+            raise Exception("Not supported Purpose")
         switcher = {Purpose.BID: "BID", Purpose.OFF: "OFF"}
         vr = switcher.get(purpose, "Defpurp")
         if vr == "Defpurp":
             raise Exception("Not supported Purpose")
         return vr
 
-    def __getStatus(self: GMEPublicOfferQuery, status: Status) -> str:
+    def __getStatus(self: GMEPublicOfferQuery, status: Status | None) -> str:
+        if status is None:
+            raise Exception("Not supported Status")
+
         switcher = {
             Status.ACC: "ACC",
             Status.INC: "INC",
@@ -433,27 +434,19 @@ class GMEPublicOfferQuery:
         subPath = f"{self.__toUrlParam(queryParamaters.extractionRangeConfig.date)}"
         return subPath
 
-    def _buildExtractionStatus(self: GMEPublicOfferQuery, status: Status) -> str:
-        subPath = f"{parse.quote_plus(status)}"
-        return subPath
-
-    def _buildExtractionPurpose(self: GMEPublicOfferQuery, purpose: Purpose) -> str:
-        subPath = f"{parse.quote_plus(purpose)}"
-        return subPath
-
-    def _exec(self: GMEPublicOfferQuery, urls: List[str]) -> list:
+    def _exec(self: GMEPublicOfferQuery, url: str) -> Any:
         loop = get_event_loop()
-        rr = loop.run_until_complete(self._execAsync(urls))
+        rr = loop.run_until_complete(self._execAsync(url))
         return rr
 
-    async def _execAsync(self: GMEPublicOfferQuery, urls: List[str]) -> list:
+    async def _execAsync(self: GMEPublicOfferQuery, url: str) -> Any:
         with self.__client as c:
             res = await asyncio.gather(
-                *[self.__executor.exec(c.exec, "GET", i, None) for i in urls]
+                *[self.__executor.exec(c.exec, "GET", url, None)]
             )
-            return list(itertools.chain(*res))
+            return res[0]
 
-    def __toUrlParam(self: GMEPublicOfferQuery, date: str) -> str:
+    def __toUrlParam(self: GMEPublicOfferQuery, date: str | None) -> str:
         return f"{date}"
 
     def _validateQuery(self: GMEPublicOfferQuery) -> None:

{artesian-sdk-3.1.2.dev19 → artesian-sdk-3.1.3}/src/Artesian/MarketData/MarketDataService.py

@@ -118,7 +118,7 @@ class MarketDataService:
         self: MarketDataService,
         page: int,
         pageSize: int,
-        searchText: str = None,
+        searchText: str | None = None,
         filters: Optional[Dict[str, List[str]]] = None,
         sorts: Optional[List[str]] = None,
         doNotLoadAdditionalInfo: bool = False,

{artesian-sdk-3.1.2.dev19 → artesian-sdk-3.1.3}/src/Artesian/MarketData/_Dto/ArtesianMetadataFacet.py

@@ -29,5 +29,5 @@ class ArtesianMetadataFacet:
     """
 
     facetName: Optional[str] = None
-    facetType: ArtesianMetadataFacetType = None
+    facetType: Optional[ArtesianMetadataFacetType] = None
     values: Optional[List[ArtesianMetadataFacetCount]] = None

{artesian-sdk-3.1.2.dev19 → artesian-sdk-3.1.3}/src/Artesian/Query/DefaultPartitionStrategy.py

@@ -1,6 +1,8 @@
 from __future__ import annotations
 import copy
-from typing import List
+from typing import List, TypeVar
+
+from ._QueryParameters.QueryParameters import _QueryParameters
 from ._QueryParameters.ActualQueryParameters import ActualQueryParameters
 from ._QueryParameters.VersionedQueryParameters import VersionedQueryParameters
 from ._QueryParameters.AuctionQueryParameters import AuctionQueryParameters
@@ -8,6 +10,9 @@ from ._QueryParameters.MasQueryParameters import MasQueryParameters
 from ._QueryParameters.BidAskQueryParameters import BidAskQueryParameters
 
 
+T = TypeVar("T", bound=_QueryParameters)
+
+
 class DefaultPartitionStrategy:
     """Class for the default strategy to partition Query Parameters."""
 
@@ -89,9 +94,9 @@ class DefaultPartitionStrategy:
         return self._tsPartitionStrategy(bidAskQueryParameters)
 
     def _tsPartitionStrategy(
-        self: DefaultPartitionStrategy, Parameters: List[MasQueryParameters]
-    ) -> List[MasQueryParameters]:
-        res: List[MasQueryParameters] = []
+        self: DefaultPartitionStrategy, Parameters: List[T]
+    ) -> List[T]:
+        res: List[T] = []
         for param in Parameters:
             if param.ids is None:
                 res.append(param)

{artesian-sdk-3.1.2.dev19 → artesian-sdk-3.1.3}/src/Artesian/Query/_Query.py

@@ -172,7 +172,7 @@ class _Query:
             )
             return list(itertools.chain(*res))
 
-    def __toUrlParam(self: _Query, start: str, end: str) -> str:
+    def __toUrlParam(self: _Query, start: str | None, end: str | None) -> str:
         return f"{start}/{end}"
 
     def _validateQuery(self: _Query) -> None:

{artesian-sdk-3.1.2.dev19 → artesian-sdk-3.1.3}/src/Artesian/Query/_QueryParameters/QueryParameters.py

@@ -40,7 +40,7 @@ class _FillCustomTimeserieStrategy(_FillStrategy):
         return f"fillerK=CustomValue&fillerDV={self.val}"
 
 
-def toQueryParams(vals: List[List[str]]) -> str:
+def toQueryParams(vals: List[List[str | float | int | None]]) -> str:
     filtered = filter(lambda x: x[1], vals)
     stringVals = map(lambda x: [x[0], str(x[1])], filtered)
     joinedEqual = map(lambda x: "=".join(x), stringVals)

{artesian-sdk-3.1.2.dev19 → artesian-sdk-3.1.3}/src/Artesian/_ClientsExecutor/ArtesianJsonSerializer.py

@@ -57,7 +57,7 @@ def __artesianDictDeserializer(
     obj: list, cls: type, *args: Any, **kwargs: Any
 ) -> object:
     key, value = get_args(cls)
-    result: Dict[key, value] = {
+    result: Dict[key, value] = {  # type: ignore
         jsons.load(item["Key"], key, *args, **kwargs): jsons.load(
             item["Value"], value, *args, **kwargs
         )

{artesian-sdk-3.1.2.dev19 → artesian-sdk-3.1.3}/src/Artesian/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '3.1.2.dev19'
-__version_tuple__ = version_tuple = (3, 1, 2, 'dev19')
+__version__ = version = '3.1.3'
+__version_tuple__ = version_tuple = (3, 1, 3)

{artesian-sdk-3.1.2.dev19 → artesian-sdk-3.1.3}/src/artesian_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: artesian-sdk
-Version: 3.1.2.dev19
+Version: 3.1.3
 Summary: Library provides read access to the Artesian API
 Author-email: ARK Lab <arklab@ark-energy.eu>
 Maintainer-email: ARK Lab <arklab@ark-energy.eu>

{artesian-sdk-3.1.2.dev19 → artesian-sdk-3.1.3}/src/artesian_sdk.egg-info/SOURCES.txt

@@ -7,6 +7,7 @@ pyproject.toml
 .github/dependabot.yml
 .github/workflows/dependency-review.yaml
 .github/workflows/python-tests.yml
+.vscode/extensions.json
 .vscode/launch.json
 .vscode/settings.json
 samples/TestActual.py

{artesian-sdk-3.1.2.dev19 → artesian-sdk-3.1.3}/tests/TestGMEPO.py

@@ -9,6 +9,8 @@ from Artesian.GMEPublicOffers import (
 from . import helpers
 import unittest
 from urllib.parse import unquote
+from Artesian._ClientsExecutor.ArtesianJsonSerializer import artesianJsonSerialize
+import responses
 
 cfg = ArtesianConfig("https://arkive.artesian.cloud/tenantName/", "APIKey")
 
@@ -16,6 +18,20 @@ qs = GMEPublicOfferService(cfg)
 
 
 class TestGMEPO(unittest.TestCase):
+
+    def setUp(self) -> None:
+        self.__baseurl = "https://arkive.artesian.cloud/tenantName//"
+        self.__sampleOutput = dict(
+            Page=1,
+            PageSize=10,
+            Count=0,
+            IsCountPartial=False,
+            Data=[[]],
+        )
+        self.__serializedOutput = artesianJsonSerialize(self.__sampleOutput)
+
+        return super().setUp()
+
     @helpers.TrackGMEPORequests
     def test_Market(self, requests):
         url = (
@@ -87,3 +103,24 @@ class TestGMEPO(unittest.TestCase):
         query = requests.getQs()
         self.assertEqual(query["page"], "1")
         self.assertEqual(query["pageSize"], "100")
+
+    def test_checkreturnedPayload(self):
+        with responses.RequestsMock() as rsps:
+            rsps.add(
+                "GET",
+                self.__baseurl
+                + "gmepublicoffer/v2.0/extract/2024-01-21/BID/ACC?_=1&page=1&pageSize=10",
+                json=self.__sampleOutput,
+                status=200,
+            )
+
+            output = (
+                qs.createQuery()
+                .forDate("2024-01-21")
+                .forStatus(Status.ACC)
+                .forPurpose(Purpose.BID)
+                .withPagination(1, 10)
+                .execute()
+            )
+
+        self.assertEqual(output, self.__sampleOutput)

{artesian-sdk-3.1.2.dev19 → artesian-sdk-3.1.3}/tests/helpers.py

@@ -15,7 +15,7 @@ class Qs:
         return dict(
             map(
                 lambda x: x.split("="),
-                unquote(self._mock.call_args.args[0][0]).split("?")[1].split("&"),
+                unquote(urlparse(self._mock.call_args.args[0][0]).query).split("&"),
             )
         )
 
@@ -23,6 +23,23 @@ class Qs:
         return urlparse(self._mock.call_args.args[0][0]).path
 
 
+class QsPO:
+
+    def __init__(self: QsPO, mock: Mock) -> None:
+        self._mock = mock
+
+    def getQs(self: QsPO) -> Dict[str, str]:
+        return dict(
+            map(
+                lambda x: x.split("="),
+                unquote(urlparse(self._mock.call_args.args[0]).query).split("&"),
+            )
+        )
+
+    def getPath(self: Qs) -> str:
+        return urlparse(self._mock.call_args.args[0]).path
+
+
 def TrackRequests(func: Callable) -> Callable[[Any, Qs], None]:
     @patch.object(_Query._Query, "_exec")
     def wrapper(self: Any, mock: Mock) -> None:
@@ -34,6 +51,6 @@ def TrackRequests(func: Callable) -> Callable[[Any, Qs], None]:
 def TrackGMEPORequests(func: Callable) -> Callable[[Any, Qs], None]:
     @patch.object(_GMEPO.GMEPublicOfferQuery, "_exec")
     def wrapper(self: Any, mock: Mock) -> None:
-        func(self, Qs(mock))
+        func(self, QsPO(mock))
 
     return wrapper