garf-core 0.0.9__tar.gz → 0.0.11__tar.gz

{garf_core-0.0.9 → garf_core-0.0.11}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: garf-core
-Version: 0.0.9
+Version: 0.0.11
 Summary: Abstracts fetching data from API based on provided SQL-like query.
 Author-email: "Google Inc. (gTech gPS CSE team)" <no-reply@google.com>
 License: Apache 2.0
@@ -18,7 +18,7 @@ Classifier: License :: OSI Approved :: Apache Software License
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 Requires-Dist: python-dateutil
-Requires-Dist: jinja2==3.1.4
+Requires-Dist: jinja2
 Requires-Dist: typing-extensions
 Requires-Dist: requests
 Requires-Dist: pyyaml

{garf_core-0.0.9 → garf_core-0.0.11}/garf_core/__init__.py

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

{garf_core-0.0.9 → garf_core-0.0.11}/garf_core/api_clients.py

@@ -22,6 +22,8 @@ from collections.abc import Sequence
 import requests
 from typing_extensions import override
 
+from garf_core import exceptions
+
 
 @dataclasses.dataclass
 class GarfApiRequest:
@@ -35,7 +37,7 @@ class GarfApiResponse:
   results: list
 
 
-class GarfApiError(Exception):
+class GarfApiError(exceptions.GarfError):
   """API specific exception."""
 
 

{garf_core-0.0.9 → garf_core-0.0.11}/garf_core/exceptions.py

@@ -22,7 +22,7 @@
 # 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.
-"""Module for defining exceptions."""
+"""Defines common exceptions for the garf-core library."""
 
 from __future__ import annotations
 

{garf_core-0.0.9 → garf_core-0.0.11}/garf_core/query_editor.py

@@ -231,15 +231,14 @@ class BaseQueryElements:
   """Contains raw query and parsed elements.
 
   Attributes:
-      query_title: Title of the query that needs to be parsed.
-      query_text: Text of the query that needs to be parsed.
+      title: Title of the query that needs to be parsed.
+      text: Text of the query that needs to be parsed.
       resource_name: Name of Google Ads API reporting resource.
       fields: Ads API fields that need to be fetched.
       column_names: Friendly names for fields which are used when saving data
       column_names: Friendly names for fields which are used when saving data
       customizers: Attributes of fields that need to be be extracted.
       virtual_columns: Attributes of fields that need to be be calculated.
-      is_constant_resource: Whether resource considered a constant one.
       is_builtin_query: Whether query is built-in.
   """
 
@@ -256,6 +255,7 @@ class BaseQueryElements:
   virtual_columns: dict[str, VirtualColumn] = dataclasses.field(
     default_factory=dict
   )
+  is_builtin_query: bool = False
 
   def __eq__(self, other: BaseQueryElements) -> bool:  # noqa: D105
     return (

{garf_core-0.0.9 → garf_core-0.0.11}/garf_core/report.py

@@ -27,7 +27,7 @@ import json
 import warnings
 from collections import defaultdict
 from collections.abc import MutableSequence, Sequence
-from typing import Generator, Literal
+from typing import Generator, Literal, get_args
 
 from garf_core import exceptions, parsers, query_editor
 
@@ -213,13 +213,22 @@ class GarfReport:
       ) from e
     return pd.DataFrame(data=self.results, columns=self.column_names)
 
-  def to_json(self) -> str:
+  def to_jsonl(self) -> str:
+    """Converts report to JSON Lines."""
+    return self.to_json(output='jsonl')
+
+  def to_json(self, output: Literal['json', 'jsonl'] = 'json') -> str:
     """Converts report to JSON.
 
+    Args:
+      output: Format of json file (json or jsonl).
+
     Returns:
         JSON from report results and column_names.
     """
-    return json.dumps(self.to_list(row_type='dict'))
+    if output == 'json':
+      return json.dumps(self.to_list(row_type='dict'))
+    return '\n'.join(json.dumps(row) for row in self.to_list(row_type='dict'))
 
   def get_value(
     self, column_index: int = 0, row_index: int = 0
@@ -414,8 +423,8 @@ class GarfReport:
       import polars as pl
     except ImportError as e:
       raise ImportError(
-        'Please install garf-io with Polars support '
-        '- `pip install garf-io[polars]`'
+        'Please install garf-core with Polars support '
+        '- `pip install garf-core[polars]`'
       ) from e
     return cls(
       results=df.to_numpy().tolist(), column_names=list(df.schema.keys())
@@ -438,11 +447,63 @@ class GarfReport:
       import pandas as pd
     except ImportError as e:
       raise ImportError(
-        'Please install garf-io with Pandas support '
-        '- `pip install garf-io[pandas]`'
+        'Please install garf-core with Pandas support '
+        '- `pip install garf-core[pandas]`'
       ) from e
     return cls(results=df.values.tolist(), column_names=list(df.columns.values))
 
+  @classmethod
+  def from_json(cls, json_str: str) -> GarfReport:
+    """Creates a GarfReport object from a JSON string.
+
+    Args:
+        json_str: JSON string representation of the data.
+
+    Returns:
+        Report build from a json string.
+
+    Raises:
+        TypeError: If any value in the JSON data is not a supported type.
+        ValueError: If `data` is a list but not all dictionaries
+        have the same keys.
+    """
+    data = json.loads(json_str)
+
+    def validate_value(value):
+      if not isinstance(value, get_args(parsers.ApiRowElement)):
+        raise TypeError(
+          f'Unsupported type {type(value)} for value {value}. '
+          'Expected types: int, float, str, bool, list, or None.'
+        )
+      return value
+
+    # Case 1: `data` is a dictionary
+    if isinstance(data, dict):
+      column_names = list(data.keys())
+      if not data.values():
+        results = []
+      else:
+        results = [[validate_value(value) for value in data.values()]]
+
+    # Case 2: `data` is a list of dictionaries, each representing a row
+    elif isinstance(data, list):
+      column_names = list(data[0].keys()) if data else []
+      for row in data:
+        if not isinstance(row, dict):
+          raise TypeError('All elements in the list must be dictionaries.')
+        if list(row.keys()) != column_names:
+          raise ValueError(
+            'All dictionaries must have consistent keys in the same order.'
+          )
+      results = [
+        [validate_value(value) for value in row.values()] for row in data
+      ]
+    else:
+      raise TypeError(
+        'Input JSON must be a dictionary or a list of dictionaries.'
+      )
+    return cls(results=results, column_names=column_names)
+
 
 class GarfRow:
   """Helper class to simplify iteration of GarfReport.

{garf_core-0.0.9 → garf_core-0.0.11}/garf_core.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: garf-core
-Version: 0.0.9
+Version: 0.0.11
 Summary: Abstracts fetching data from API based on provided SQL-like query.
 Author-email: "Google Inc. (gTech gPS CSE team)" <no-reply@google.com>
 License: Apache 2.0
@@ -18,7 +18,7 @@ Classifier: License :: OSI Approved :: Apache Software License
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 Requires-Dist: python-dateutil
-Requires-Dist: jinja2==3.1.4
+Requires-Dist: jinja2
 Requires-Dist: typing-extensions
 Requires-Dist: requests
 Requires-Dist: pyyaml

{garf_core-0.0.9 → garf_core-0.0.11}/garf_core.egg-info/requires.txt

@@ -1,5 +1,5 @@
 python-dateutil
-jinja2==3.1.4
+jinja2
 typing-extensions
 requests
 pyyaml

{garf_core-0.0.9 → garf_core-0.0.11}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 name = "garf-core"
 dependencies = [
     "python-dateutil",
-    "jinja2==3.1.4",
+    "jinja2",
     "typing-extensions",
     "requests",
     "pyyaml",