garf-core 0.1.4.post1__py3-none-any.whl → 0.1.5.post0__py3-none-any.whl

garf_core/__init__.py

@@ -11,5 +11,19 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+"""`garf-core` contains the base abstractions for garf framework.
 
-__version__ = '0.1.4.post1'
+These abstractions are used by an implementation for a concrete reporting API.
+"""
+
+from garf_core.base_query import BaseQuery
+from garf_core.report import GarfReport
+from garf_core.report_fetcher import ApiReportFetcher
+
+__all__ = [
+  'BaseQuery',
+  'GarfReport',
+  'ApiReportFetcher',
+]
+
+__version__ = '0.1.5.post0'

garf_core/api_clients.py

@@ -18,29 +18,25 @@ from __future__ import annotations
 import abc
 import contextlib
 import csv
-import dataclasses
 import json
 import os
 import pathlib
 from collections.abc import Sequence
-from typing import Any
+from typing import Any, Union
 
+import pydantic
 import requests
-from typing_extensions import override
+from typing_extensions import TypeAlias, override
 
-from garf_core import exceptions
+from garf_core import exceptions, query_editor
 
+ApiRowElement: TypeAlias = Union[int, float, str, bool, list, dict, None]
 
-@dataclasses.dataclass
-class GarfApiRequest:
-  """Base class for specifying request."""
 
-
-@dataclasses.dataclass
-class GarfApiResponse:
+class GarfApiResponse(pydantic.BaseModel):
   """Base class for specifying response."""
 
-  results: list
+  results: list[ApiRowElement]
 
 
 class GarfApiError(exceptions.GarfError):
@@ -52,7 +48,7 @@ class BaseClient(abc.ABC):
 
   @abc.abstractmethod
   def get_response(
-    self, request: GarfApiRequest = GarfApiRequest(), **kwargs: str
+    self, request: query_editor.BaseQueryElements, **kwargs: str
   ) -> GarfApiResponse:
     """Method for getting response."""
 
@@ -69,11 +65,11 @@ class RestApiClient(BaseClient):
 
   @override
   def get_response(
-    self, request: GarfApiRequest = GarfApiRequest(), **kwargs: str
+    self, request: query_editor.BaseQueryElements, **kwargs: str
   ) -> GarfApiResponse:
     response = requests.get(f'{self.endpoint}/{request.resource_name}')
     if response.status_code == self.OK:
-      return GarfApiResponse(response.json())
+      return GarfApiResponse(results=response.json())
     raise GarfApiError('Failed to get data from API')
 
 
@@ -87,7 +83,7 @@ class FakeApiClient(BaseClient):
 
   @override
   def get_response(
-    self, request: GarfApiRequest = GarfApiRequest(), **kwargs: str
+    self, request: query_editor.BaseQueryElements, **kwargs: str
   ) -> GarfApiResponse:
     del request
     return GarfApiResponse(results=self.results)

garf_core/parsers.py

@@ -20,14 +20,12 @@ import contextlib
 import functools
 import operator
 from collections.abc import Mapping, MutableSequence
-from typing import Any, Union
+from typing import Any
 
-from typing_extensions import TypeAlias, override
+from typing_extensions import override
 
 from garf_core import api_clients, exceptions, query_editor
 
-ApiRowElement: TypeAlias = Union[int, float, str, bool, list, None]
-
 
 class BaseParser(abc.ABC):
   """An interface for all parsers to implement."""
@@ -41,7 +39,7 @@ class BaseParser(abc.ABC):
   def parse_response(
     self,
     response: api_clients.GarfApiResponse,
-  ) -> list[list[ApiRowElement]]:
+  ) -> list[list[api_clients.ApiRowElement]]:
     """Parses response."""
     if not response.results:
       return [[]]
@@ -62,7 +60,7 @@ class ListParser(BaseParser):
   def parse_row(
     self,
     row: list,
-  ) -> list[list[ApiRowElement]]:
+  ) -> list[list[api_clients.ApiRowElement]]:
     return row
 
 
@@ -73,7 +71,7 @@ class DictParser(BaseParser):
   def parse_row(
     self,
     row: list,
-  ) -> list[list[ApiRowElement]]:
+  ) -> list[list[api_clients.ApiRowElement]]:
     if not isinstance(row, Mapping):
       raise GarfParserError
     result = []
@@ -88,7 +86,7 @@ class DictParser(BaseParser):
     key = key.split('.')
     try:
       return functools.reduce(operator.getitem, key, dictionary)
-    except KeyError:
+    except (TypeError, KeyError):
       return None
 
 

garf_core/query_editor.py

@@ -445,7 +445,9 @@ class QuerySpecification(CommonParametersMixin, TemplateProcessorMixin):
     return self
 
   def remove_trailing_comma(self) -> Self:
-    self.text = re.sub(r',\s+from', ' FROM', self.query.text, re.IGNORECASE)
+    self.text = re.sub(
+      r',\s+from', ' FROM', self.query.text, count=0, flags=re.IGNORECASE
+    )
     return self
 
   def extract_resource_name(self) -> Self:

garf_core/report.py

@@ -29,7 +29,7 @@ from collections import defaultdict
 from collections.abc import MutableSequence, Sequence
 from typing import Generator, Literal, get_args
 
-from garf_core import exceptions, parsers, query_editor
+from garf_core import api_clients, exceptions, query_editor
 
 
 class GarfReport:
@@ -45,9 +45,9 @@ class GarfReport:
 
   def __init__(
     self,
-    results: Sequence[Sequence[parsers.ApiRowElement]] | None = None,
+    results: Sequence[Sequence[api_clients.ApiRowElement]] | None = None,
     column_names: Sequence[str] | None = None,
-    results_placeholder: Sequence[Sequence[parsers.ApiRowElement]]
+    results_placeholder: Sequence[Sequence[api_clients.ApiRowElement]]
     | None = None,
     query_specification: query_editor.BaseQueryElements | None = None,
     auto_convert_to_scalars: bool = True,
@@ -92,7 +92,7 @@ class GarfReport:
     row_type: Literal['list', 'dict', 'scalar'] = 'list',
     flatten: bool = False,
     distinct: bool = False,
-  ) -> list[parsers.ApiRowElement]:
+  ) -> list[api_clients.ApiRowElement]:
     """Converts report to a list.
 
     Args:
@@ -137,7 +137,7 @@ class GarfReport:
     key_column: str,
     value_column: str | None = None,
     value_column_output: Literal['scalar', 'list'] = 'list',
-  ) -> dict[str, parsers.ApiRowElement | list[parsers.ApiRowElement]]:
+  ) -> dict[str, api_clients.ApiRowElement | list[api_clients.ApiRowElement]]:
     """Converts report to dictionary.
 
     Args:
@@ -232,7 +232,7 @@ class GarfReport:
 
   def get_value(
     self, column_index: int = 0, row_index: int = 0
-  ) -> parsers.ApiRowElement:
+  ) -> api_clients.ApiRowElement:
     """Extracts data from report as a scalar.
 
     Raises:
@@ -310,7 +310,7 @@ class GarfReport:
 
   def _get_rows_slice(
     self, key: slice | int
-  ) -> GarfReport | GarfRow | parsers.ApiRowElement:
+  ) -> GarfReport | GarfRow | api_clients.ApiRowElement:
     """Gets one or several rows from the report.
 
     Args:
@@ -476,7 +476,7 @@ class GarfReport:
     data = json.loads(json_str)
 
     def validate_value(value):
-      if not isinstance(value, get_args(parsers.ApiRowElement)):
+      if not isinstance(value, get_args(api_clients.ApiRowElement)):
         raise TypeError(
           f'Unsupported type {type(value)} for value {value}. '
           'Expected types: int, float, str, bool, list, or None.'
@@ -520,7 +520,7 @@ class GarfRow:
   """
 
   def __init__(
-    self, data: parsers.ApiRowElement, column_names: Sequence[str]
+    self, data: api_clients.ApiRowElement, column_names: Sequence[str]
   ) -> None:
     """Initializes new GarfRow.
 
@@ -530,11 +530,11 @@ class GarfRow:
     super().__setattr__('data', data)
     super().__setattr__('column_names', column_names)
 
-  def to_dict(self) -> dict[str, parsers.ApiRowElement]:
+  def to_dict(self) -> dict[str, api_clients.ApiRowElement]:
     """Maps column names to corresponding data point."""
     return {x[1]: x[0] for x in zip(self.data, self.column_names)}
 
-  def get_value(self, column_index: int = 0) -> parsers.ApiRowElement:
+  def get_value(self, column_index: int = 0) -> api_clients.ApiRowElement:
     """Extracts data from row as a scalar.
 
     Raises:
@@ -548,7 +548,7 @@ class GarfRow:
       )
     return self.data[column_index]
 
-  def __getattr__(self, element: str) -> parsers.ApiRowElement:
+  def __getattr__(self, element: str) -> api_clients.ApiRowElement:
     """Gets element from row as an attribute.
 
     Args:
@@ -564,7 +564,7 @@ class GarfRow:
       return self.data[self.column_names.index(element)]
     raise AttributeError(f'cannot find {element} element!')
 
-  def __getitem__(self, element: str | int) -> parsers.ApiRowElement:
+  def __getitem__(self, element: str | int) -> api_clients.ApiRowElement:
     """Gets element from row by index.
 
     Args:
@@ -584,7 +584,7 @@ class GarfRow:
       return self.__getattr__(element)
     raise GarfReportError(f'cannot find {element} element!')
 
-  def __setattr__(self, name: str, value: parsers.ApiRowElement) -> None:
+  def __setattr__(self, name: str, value: api_clients.ApiRowElement) -> None:
     """Sets new value for an attribute.
 
     Args:
@@ -609,7 +609,7 @@ class GarfRow:
       self.data.append(value)
       self.column_names.append(name)
 
-  def get(self, item: str) -> parsers.ApiRowElement:
+  def get(self, item: str) -> api_clients.ApiRowElement:
     """Extracts value as dictionary get operation.
 
     Args:
@@ -620,7 +620,7 @@ class GarfRow:
     """
     return self.__getattr__(item)
 
-  def __iter__(self) -> parsers.ApiRowElement:
+  def __iter__(self) -> api_clients.ApiRowElement:
     """Yields each element of a row."""
     for field in self.data:
       yield field

{garf_core-0.1.4.post1.dist-info → garf_core-0.1.5.post0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: garf-core
-Version: 0.1.4.post1
+Version: 0.1.5.post0
 Summary: Abstracts fetching data from API based on provided SQL-like query.
 Author-email: "Google Inc. (gTech gPS CSE team)" <no-reply@google.com>, Andrei Markin <andrey.markin.ppc@gmail.com>
 License: Apache 2.0

garf_core-0.1.5.post0.dist-info/RECORD

@@ -0,0 +1,16 @@
+garf_core/__init__.py,sha256=ZKDzKwZl1HtqUnBH6ijUMZgu6dRZJsbgMGuL8s9gzNU,960
+garf_core/api_clients.py,sha256=P9fSy0xUXqmQoupWGWP1-SVBz_yZ80Jh58fvkh2dY8s,4694
+garf_core/base_query.py,sha256=ZDAw2ojmismXRO0HXEvKDukpS7OAc7390LnM8kvCSCY,1201
+garf_core/exceptions.py,sha256=Gzvkl2M-rA_XQRAMd3CC62KHeFQE_b6uby0fD0pouw4,1269
+garf_core/parsers.py,sha256=A4Yb614ydN_psKvyUfWZjnTG5-aooT0pz2Cm6CHUnC4,3283
+garf_core/query_editor.py,sha256=QPbUz8jHloTcGm_Nz2Nog_sdYIPiDshtm_t45-R76pk,17147
+garf_core/report.py,sha256=J2-oNV3Nh7ToYhm2fsdovkiE__-UhT0K5-wP0jBD0oQ,20330
+garf_core/report_fetcher.py,sha256=dgErrkRv1bdPN0npX3atZbJrOpzy9OmoPC38e2FpBSQ,4883
+garf_core/fetchers/__init__.py,sha256=_cSjg1D5RhUKxaVeVbaDdb8AAoI9glKJXgN5H4qXFkw,783
+garf_core/fetchers/fake.py,sha256=fgJjxuHyd6EIUflUtj8r_HfaMS1YTDrOqDlaj6Kvbjs,2584
+garf_core/fetchers/rest.py,sha256=-5B2-Ck_t3hG99ym59AKwlzctiDxRFI2Nnc8STBxRDo,2201
+garf_core-0.1.5.post0.dist-info/METADATA,sha256=-YyPa7wDx_3dzKaWEPlEupNyg2QtKblNLvem6pWhew0,2433
+garf_core-0.1.5.post0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+garf_core-0.1.5.post0.dist-info/entry_points.txt,sha256=u4h-ujHO1hbxVXRQzwcC4ftju9_KBYtq5mCLKEBHMj0,69
+garf_core-0.1.5.post0.dist-info/top_level.txt,sha256=Gj-Zp7fM2turGut5vTJuo5xEcKfow7cTLX3y3WFfNgA,10
+garf_core-0.1.5.post0.dist-info/RECORD,,

garf_core-0.1.4.post1.dist-info/RECORD

@@ -1,16 +0,0 @@
-garf_core/__init__.py,sha256=wx96KFgXZaBUmTV19ZxJvuyZKiS2Xm_ehzAyXl6Cz84,604
-garf_core/api_clients.py,sha256=HGnRI-wK2TX79xDYQkE1CtVT4R4tZ7Ylq7dhcW5cNCQ,4669
-garf_core/base_query.py,sha256=ZDAw2ojmismXRO0HXEvKDukpS7OAc7390LnM8kvCSCY,1201
-garf_core/exceptions.py,sha256=Gzvkl2M-rA_XQRAMd3CC62KHeFQE_b6uby0fD0pouw4,1269
-garf_core/parsers.py,sha256=PmF8Ez0s1k2duSbO-0MZClslILxzbZyGMbTlhFjOtVE,3321
-garf_core/query_editor.py,sha256=yWKElbOFE2K_4vakE1izzpZGCwf6giff-j29KJohv_I,17120
-garf_core/report.py,sha256=O0SPxgVQckxi_QuD3vy1h_1mi5aMjQNw0LYP-jgN2Do,20262
-garf_core/report_fetcher.py,sha256=dgErrkRv1bdPN0npX3atZbJrOpzy9OmoPC38e2FpBSQ,4883
-garf_core/fetchers/__init__.py,sha256=_cSjg1D5RhUKxaVeVbaDdb8AAoI9glKJXgN5H4qXFkw,783
-garf_core/fetchers/fake.py,sha256=fgJjxuHyd6EIUflUtj8r_HfaMS1YTDrOqDlaj6Kvbjs,2584
-garf_core/fetchers/rest.py,sha256=-5B2-Ck_t3hG99ym59AKwlzctiDxRFI2Nnc8STBxRDo,2201
-garf_core-0.1.4.post1.dist-info/METADATA,sha256=3dKfHXvn9Yh28oFRRjfzZdJlUCZvAvNWecA-WNlVLys,2433
-garf_core-0.1.4.post1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-garf_core-0.1.4.post1.dist-info/entry_points.txt,sha256=u4h-ujHO1hbxVXRQzwcC4ftju9_KBYtq5mCLKEBHMj0,69
-garf_core-0.1.4.post1.dist-info/top_level.txt,sha256=Gj-Zp7fM2turGut5vTJuo5xEcKfow7cTLX3y3WFfNgA,10
-garf_core-0.1.4.post1.dist-info/RECORD,,