garf-core 0.1.0__py3-none-any.whl → 0.1.2__py3-none-any.whl

garf_core/__init__.py

@@ -12,4 +12,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-__version__ = '0.1.0'
+__version__ = '0.1.2'

garf_core/fetchers/fake.py

@@ -20,6 +20,8 @@ from __future__ import annotations
 
 import logging
 import os
+from collections.abc import Sequence
+from typing import Any
 
 from garf_core import (
   api_clients,
@@ -36,7 +38,7 @@ class FakeApiReportFetcher(report_fetcher.ApiReportFetcher):
 
   def __init__(
     self,
-    data: list[dict[str, parsers.ApiRowElement]] | None = None,
+    api_client: api_clients.FakeApiClient | None = None,
     parser: parsers.BaseParser = parsers.DictParser,
     query_specification_builder: query_editor.QuerySpecification = (
       query_editor.QuerySpecification
@@ -46,29 +48,33 @@ class FakeApiReportFetcher(report_fetcher.ApiReportFetcher):
     json_location: str | os.PathLike[str] | None = None,
     **kwargs: str,
   ) -> None:
-    if not data and not (
+    if not api_client and not (
       data_location := json_location or csv_location or data_location
     ):
       raise report_fetcher.ApiReportFetcherError(
         'Missing fake data for the fetcher.'
       )
-    api_client = (
-      api_clients.FakeApiClient(data)
-      if data
-      else api_clients.FakeApiClient.from_file(data_location)
-    )
+    if not api_client:
+      api_client = api_clients.FakeApiClient.from_file(data_location)
     super().__init__(api_client, parser, query_specification_builder, **kwargs)
 
+  @classmethod
+  def from_data(cls, data: Sequence[dict[str, Any]]) -> FakeApiReportFetcher:
+    """Initializes FakeApiReportFetcher from a sequence of data."""
+    return FakeApiReportFetcher(
+      api_client=api_clients.FakeApiClient(results=data)
+    )
+
   @classmethod
   def from_csv(
     cls, file_location: str | os.PathLike[str]
   ) -> FakeApiReportFetcher:
-    """Initialized FakeApiReportFetcher from a csv file."""
+    """Initializes FakeApiReportFetcher from a csv file."""
     return FakeApiReportFetcher(csv_location=file_location)
 
   @classmethod
   def from_json(
     cls, file_location: str | os.PathLike[str]
   ) -> FakeApiReportFetcher:
-    """Initialized FakeApiReportFetcher from a json file."""
+    """Initializes FakeApiReportFetcher from a json file."""
     return FakeApiReportFetcher(json_location=file_location)

garf_core/fetchers/rest.py

@@ -40,11 +40,12 @@ class RestApiReportFetcher(report_fetcher.ApiReportFetcher):
 
   def __init__(
     self,
-    endpoint: str,
+    api_client: api_clients.RestApiClient | None = None,
     parser: parsers.BaseParser = parsers.DictParser,
     query_specification_builder: query_editor.QuerySpecification = (
       query_editor.QuerySpecification
     ),
+    endpoint: str | None = None,
     **kwargs: str,
   ) -> None:
     """Instantiates RestApiReportFetcher.
@@ -54,5 +55,17 @@ class RestApiReportFetcher(report_fetcher.ApiReportFetcher):
       parser: Type of parser to convert API response.
       query_specification_builder: Class to perform query parsing.
     """
-    api_client = api_clients.RestApiClient(endpoint)
+    if not api_client and not endpoint:
+      raise report_fetcher.ApiReportFetcherError(
+        'Missing api_client or endpoint for the fetcher.'
+      )
+    if not api_client:
+      api_client = api_clients.RestApiClient(endpoint)
     super().__init__(api_client, parser, query_specification_builder, **kwargs)
+
+  @classmethod
+  def from_endpoint(cls, endpoint: str) -> RestApiReportFetcher:
+    """Initializes RestApiReportFetcher: from an API endpoint."""
+    return RestApiReportFetcher(
+      api_client=api_clients.RestApiClient(endpoint=endpoint)
+    )

garf_core/parsers.py

@@ -32,21 +32,26 @@ ApiRowElement: TypeAlias = Union[int, float, str, bool, list, None]
 class BaseParser(abc.ABC):
   """An interface for all parsers to implement."""
 
+  def __init__(
+    self, query_specification: query_editor.BaseQueryElements
+  ) -> None:
+    """Initializes BaseParser."""
+    self.query_spec = query_specification
+
   def parse_response(
     self,
     response: api_clients.GarfApiResponse,
-    query_specification: query_editor.BaseQueryElements,
   ) -> list[list[ApiRowElement]]:
     """Parses response."""
     if not response.results:
       return [[]]
     results = []
     for result in response.results:
-      results.append(self.parse_row(result, query_specification))
+      results.append(self.parse_row(result))
     return results
 
   @abc.abstractmethod
-  def parse_row(self, row, query_specification):
+  def parse_row(self, row):
     """Parses single row from response."""
 
 
@@ -57,7 +62,6 @@ class ListParser(BaseParser):
   def parse_row(
     self,
     row: list,
-    query_specification: query_editor.BaseQueryElements,
   ) -> list[list[ApiRowElement]]:
     return row
 
@@ -69,12 +73,11 @@ class DictParser(BaseParser):
   def parse_row(
     self,
     row: list,
-    query_specification: query_editor.BaseQueryElements,
   ) -> list[list[ApiRowElement]]:
     if not isinstance(row, Mapping):
       raise GarfParserError
     result = []
-    for field in query_specification.fields:
+    for field in self.query_spec.fields:
       result.append(self.get_nested_field(row, field))
     return result
 

garf_core/report.py

@@ -45,25 +45,25 @@ class GarfReport:
 
   def __init__(
     self,
-    results: Sequence[Sequence[parsers.ApiRowElement]],
-    column_names: Sequence[str],
+    results: Sequence[Sequence[parsers.ApiRowElement]] | None = None,
+    column_names: Sequence[str] | None = None,
     results_placeholder: Sequence[Sequence[parsers.ApiRowElement]]
     | None = None,
-    query_specification: query_editor.BaseQuerySpecification | None = None,
+    query_specification: query_editor.BaseQueryElements | None = None,
     auto_convert_to_scalars: bool = True,
   ) -> None:
     """Initializes GarfReport from API response.
 
     Args:
-        results: Contains data from Ads API in a form of nested list
-        column_names: Maps in each element in sublist of results to name.
-        results_placeholder: Optional placeholder values for missing results.
-        query_specification: Specification used to get data from Ads API.
-        auto_convert_to_scalars: Whether to simplify slicing operations.
+      results: Contains data from Ads API in a form of nested list
+      column_names: Maps in each element in sublist of results to name.
+      results_placeholder: Optional placeholder values for missing results.
+      query_specification: Specification used to get data from Ads API.
+      auto_convert_to_scalars: Whether to simplify slicing operations.
     """
-    self.results = results
-    self.column_names = column_names
-    self._multi_column_report = len(column_names) > 1
+    self.results = results or []
+    self.column_names = column_names or []
+    self._multi_column_report = len(column_names) > 1 if column_names else False
     if results_placeholder:
       self.results_placeholder = list(results_placeholder)
     else:
@@ -238,6 +238,8 @@ class GarfReport:
     Raises:
       GarfReportError: If row or column index are out of bounds.
     """
+    if not self:
+      raise GarfReportError('Cannot get value from an empty report')
     if column_index >= len(self.column_names):
       raise GarfReportError(
         'Column %d of report is not found; report contains only %d columns.',
@@ -298,6 +300,10 @@ class GarfReport:
     Raises:
         GarfReportError: When incorrect column_name specified.
     """
+    if not self:
+      if isinstance(key, (MutableSequence, str)):
+        raise GarfReportError(f"Cannot get '{key}' from an empty report")
+      raise GarfReportError('Cannot get element from an empty report')
     if isinstance(key, (MutableSequence, str)):
       return self._get_columns_slice(key)
     return self._get_rows_slice(key)
@@ -342,6 +348,8 @@ class GarfReport:
     Raises:
         GarfReportError: When incorrect column_name specified.
     """
+    if not self:
+      return self
     if isinstance(key, str):
       key = [key]
     if set(key).issubset(set(self.column_names)):
@@ -356,15 +364,13 @@ class GarfReport:
         results.append(rows)
       # TODO: propagate placeholders and query specification to new report
       return GarfReport(results, key)
-    non_existing_keys = set(key).intersection(set(self.column_names))
+    non_existing_keys = set(key).difference(set(self.column_names))
     if len(non_existing_keys) > 1:
-      message = (
-        f"Columns '{', '.join(list(non_existing_keys))}' "
-        'cannot be found in the report'
-      )
-    message = (
-      f"Column '{non_existing_keys.pop()}' " 'cannot be found in the report'
-    )
+      missing_columns = ', '.join(list(non_existing_keys))
+    else:
+      missing_columns = non_existing_keys.pop()
+
+    message = f"Columns '{missing_columns}' cannot be found in the report"
     raise GarfReportError(message)
 
   def __eq__(self, other) -> bool:

garf_core/report_fetcher.py

@@ -39,6 +39,17 @@ class ApiReportFetcherError(exceptions.GarfError):
   """Base exception for all ApiReportFetchers."""
 
 
+class MissingApiReportFetcherError(ApiReportFetcherError):
+  """Exception for not found report fetcher."""
+
+  def __init__(self, source: str) -> None:
+    """Initializes MissingApiReportFetcherError."""
+    self.source = source
+
+  def __str__(self) -> str:
+    return f'No fetcher available for the source "{self.source}"'
+
+
 class ApiReportFetcher:
   """Class responsible for getting data from report API.
 
@@ -69,7 +80,7 @@ class ApiReportFetcher:
         Mapping between query name and function for generating GarfReport.
     """
     self.api_client = api_client
-    self.parser = parser()
+    self.parser = parser
     self.query_specification_builder = query_specification_builder
     self.query_args = kwargs
     self.builtin_queries = builtin_queries or {}
@@ -135,7 +146,7 @@ class ApiReportFetcher:
       return builtin_report(self, **kwargs)
 
     response = self.api_client.get_response(query, **kwargs)
-    parsed_response = self.parser.parse_response(response, query)
+    parsed_response = self.parser(query).parse_response(response)
     return report.GarfReport(
       results=parsed_response, column_names=query.column_names
     )

{garf_core-0.1.0.dist-info → garf_core-0.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: garf-core
-Version: 0.1.0
+Version: 0.1.2
 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.2.dist-info/RECORD

@@ -0,0 +1,16 @@
+garf_core/__init__.py,sha256=GIvTQD8k9INUEIQO5HBfLShtzbins5jjqQfi0z2J9h0,598
+garf_core/api_clients.py,sha256=k4vjFsA3JOx7Hp_pXIQNwzMXqq4u4dDcz-ddkJC0JhI,4651
+garf_core/base_query.py,sha256=ZDAw2ojmismXRO0HXEvKDukpS7OAc7390LnM8kvCSCY,1201
+garf_core/exceptions.py,sha256=Gzvkl2M-rA_XQRAMd3CC62KHeFQE_b6uby0fD0pouw4,1269
+garf_core/parsers.py,sha256=-178UL2hbrC83GkMqAPgrmpGpJitR7T9xT3OgJ8w16Y,3189
+garf_core/query_editor.py,sha256=lA1aMFc_1wo6e2CyVISarnZxtH2jnKkuZfJecQqslDg,17191
+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.2.dist-info/METADATA,sha256=dGX17SeAetNBUlagvqWDGHX4yzIura36Bl1CP0Bd0OU,2443
+garf_core-0.1.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+garf_core-0.1.2.dist-info/entry_points.txt,sha256=u4h-ujHO1hbxVXRQzwcC4ftju9_KBYtq5mCLKEBHMj0,69
+garf_core-0.1.2.dist-info/top_level.txt,sha256=Gj-Zp7fM2turGut5vTJuo5xEcKfow7cTLX3y3WFfNgA,10
+garf_core-0.1.2.dist-info/RECORD,,

garf_core-0.1.0.dist-info/RECORD

@@ -1,16 +0,0 @@
-garf_core/__init__.py,sha256=TVigAs35ZN82B6dDphIRXsuJqB2gTIaFv23NVzjAtT8,598
-garf_core/api_clients.py,sha256=k4vjFsA3JOx7Hp_pXIQNwzMXqq4u4dDcz-ddkJC0JhI,4651
-garf_core/base_query.py,sha256=ZDAw2ojmismXRO0HXEvKDukpS7OAc7390LnM8kvCSCY,1201
-garf_core/exceptions.py,sha256=Gzvkl2M-rA_XQRAMd3CC62KHeFQE_b6uby0fD0pouw4,1269
-garf_core/parsers.py,sha256=Uj7aT7roYUofivrBKVKWfcSeG37oYGGLIJ-op2C3hZc,3238
-garf_core/query_editor.py,sha256=lA1aMFc_1wo6e2CyVISarnZxtH2jnKkuZfJecQqslDg,17191
-garf_core/report.py,sha256=2z4tUR5mg29CkwodGaFIXs8Vpo2DCyyzwJWXhBrT0R4,19910
-garf_core/report_fetcher.py,sha256=o6YT_o0t9EPutiJk9R637lQabkHSaOrzoF2ciOmpQPA,4560
-garf_core/fetchers/__init__.py,sha256=_cSjg1D5RhUKxaVeVbaDdb8AAoI9glKJXgN5H4qXFkw,783
-garf_core/fetchers/fake.py,sha256=Ba8EnSIZyNkTza3kfo2OlWWQSKcOawp1aIoyoX-Uw74,2313
-garf_core/fetchers/rest.py,sha256=0d6sRVcxBSwWpMv5TH2L9lGGxad5vbK24q9-Ql8DcCc,1701
-garf_core-0.1.0.dist-info/METADATA,sha256=V9eJEM7smpVTRquelpfDiWhqQUxIKGQSocoHpcVXmrQ,2443
-garf_core-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-garf_core-0.1.0.dist-info/entry_points.txt,sha256=u4h-ujHO1hbxVXRQzwcC4ftju9_KBYtq5mCLKEBHMj0,69
-garf_core-0.1.0.dist-info/top_level.txt,sha256=Gj-Zp7fM2turGut5vTJuo5xEcKfow7cTLX3y3WFfNgA,10
-garf_core-0.1.0.dist-info/RECORD,,