garf-core 0.2.0__tar.gz → 0.2.2__tar.gz

{garf_core-0.2.0 → garf_core-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: garf-core
-Version: 0.2.0
+Version: 0.2.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.2.0 → garf_core-0.2.2}/garf_core/__init__.py

@@ -26,4 +26,4 @@ __all__ = [
   'ApiReportFetcher',
 ]
 
-__version__ = '0.2.0'
+__version__ = '0.2.2'

{garf_core-0.2.0 → garf_core-0.2.2}/garf_core/api_clients.py

@@ -20,12 +20,12 @@ import contextlib
 import csv
 import json
 import os
-import pathlib
 from collections.abc import Sequence
 from typing import Any, Union
 
 import pydantic
 import requests
+import smart_open
 from typing_extensions import TypeAlias, override
 
 from garf_core import exceptions, query_editor
@@ -124,7 +124,7 @@ class FakeApiClient(BaseClient):
       GarfApiError: When file with data not found.
     """
     try:
-      with pathlib.Path.open(file_location, 'r', encoding='utf-8') as f:
+      with smart_open.open(file_location, 'r', encoding='utf-8') as f:
         data = json.load(f)
         return FakeApiClient(data)
     except FileNotFoundError as e:
@@ -144,7 +144,7 @@ class FakeApiClient(BaseClient):
       GarfApiError: When file with data not found.
     """
     try:
-      with pathlib.Path.open(file_location, 'r', encoding='utf-8') as f:
+      with smart_open.open(file_location, 'r', encoding='utf-8') as f:
         reader = csv.DictReader(f)
         data = []
         for row in reader:

{garf_core-0.2.0 → garf_core-0.2.2}/garf_core/query_editor.py

@@ -29,7 +29,7 @@ from typing_extensions import Self, TypeAlias
 
 from garf_core import exceptions
 
-QueryParameters: TypeAlias = dict[str, Union[str, float, int]]
+QueryParameters: TypeAlias = dict[str, Union[str, float, int, list]]
 
 
 class GarfQueryParameters(pydantic.BaseModel):
@@ -386,7 +386,7 @@ class QuerySpecification(CommonParametersMixin, TemplateProcessorMixin):
     self,
     text: str,
     title: str | None = None,
-    args: GarfQueryParameters | None = GarfQueryParameters(),
+    args: GarfQueryParameters | None = None,
     **kwargs: str,
   ) -> None:
     """Instantiates QuerySpecification based on text, title and optional args.
@@ -405,7 +405,10 @@ class QuerySpecification(CommonParametersMixin, TemplateProcessorMixin):
     """Returns macros with injected common parameters."""
     common_params = dict(self.common_params)
     if macros := self.args.macro:
-      common_params.update(macros)
+      converted_macros = {
+        key: convert_date(value) for key, value in macros.items()
+      }
+      common_params.update(converted_macros)
     return common_params
 
   def generate(self) -> BaseQueryElements:
@@ -441,14 +444,15 @@ class QuerySpecification(CommonParametersMixin, TemplateProcessorMixin):
     """Removes comments and converts text to lines."""
     result: list[str] = []
     multiline_comment = False
-    for line in self.query.text.split('\n'):
+    for raw_line in self.query.text.split('\n'):
+      line = raw_line.strip()
       if re.match('\\*/', line):
         multiline_comment = False
         continue
       if re.match('/\\*', line) or multiline_comment:
         multiline_comment = True
         continue
-      if re.match('^(#|--|//) ', line):
+      if re.match('^(#|--|//) ', line) or line in ('--', '#', '//'):
         continue
       cleaned_query_line = re.sub(
         ';$', '', re.sub('(--|//) .*$', '', line).strip()
@@ -564,3 +568,50 @@ def _is_invalid_field(field) -> bool:
   is_constant = _is_constant(field)
   has_operator = any(operator in field for operator in operators)
   return is_constant or has_operator
+
+
+def convert_date(date_string: str) -> str:
+  """Converts specific dates parameters to actual dates.
+
+  Returns:
+    Date string in YYYY-MM-DD format.
+
+  Raises:
+    GarfMacroError:
+     If dynamic lookback value (:YYYYMMDD-N) is incorrect.
+  """
+  if isinstance(date_string, list) or date_string.find(':Y') == -1:
+    return date_string
+  current_date = datetime.date.today()
+  base_date, *date_customizer = re.split('\\+|-', date_string)
+  if len(date_customizer) > 1:
+    raise GarfMacroError(
+      'Invalid format for date macro, should be in :YYYYMMDD-N format'
+    )
+  if not date_customizer:
+    days_lookback = 0
+  else:
+    try:
+      days_lookback = int(date_customizer[0])
+    except ValueError as e:
+      raise GarfMacroError(
+        'Must provide numeric value for a number lookback period, '
+        'i.e. :YYYYMMDD-1'
+      ) from e
+  if base_date == ':YYYY':
+    new_date = datetime.datetime(current_date.year, 1, 1)
+    delta = relativedelta.relativedelta(years=days_lookback)
+  elif base_date == ':YYYYMM':
+    new_date = datetime.datetime(current_date.year, current_date.month, 1)
+    delta = relativedelta.relativedelta(months=days_lookback)
+  elif base_date == ':YYYYMMDD':
+    new_date = current_date
+    delta = relativedelta.relativedelta(days=days_lookback)
+  else:
+    raise GarfMacroError(
+      'Invalid format for date macro, should be in :YYYYMMDD-N format'
+    )
+
+  if '-' in date_string:
+    return (new_date - delta).strftime('%Y-%m-%d')
+  return (new_date + delta).strftime('%Y-%m-%d')

{garf_core-0.2.0 → garf_core-0.2.2}/garf_core/report_fetcher.py

@@ -96,7 +96,7 @@ class ApiReportFetcher:
 
   async def afetch(
     self,
-    query_specification: str | query_editor.QueryElements,
+    query_specification: str | query_editor.QuerySpecification,
     args: query_editor.GarfQueryParameters | None = None,
     **kwargs: str,
   ) -> report.GarfReport:

{garf_core-0.2.0 → garf_core-0.2.2}/garf_core.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: garf-core
-Version: 0.2.0
+Version: 0.2.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