garf-executors 0.0.6__py3-none-any.whl → 0.1.4__py3-none-any.whl

garf_executors/fetchers.py

@@ -13,25 +13,63 @@
 # limitations under the License.
 
 import inspect
+import sys
 from importlib.metadata import entry_points
 
 from garf_core import report_fetcher
+from opentelemetry import trace
 
+from garf_executors.telemetry import tracer
 
-def get_report_fetchers() -> dict[str, report_fetcher.ApiReportFetcher]:
-  fetchers = entry_points(group='garf')
-  found_fetchers = {}
-  for fetcher in fetchers:
+
+@tracer.start_as_current_span('find_fetchers')
+def find_fetchers() -> set[str]:
+  """Identifiers all available report fetchers."""
+  if entrypoints := _get_entrypoints('garf'):
+    return {fetcher.name for fetcher in entrypoints}
+  return set()
+
+
+@tracer.start_as_current_span('get_report_fetcher')
+def get_report_fetcher(source: str) -> type[report_fetcher.ApiReportFetcher]:
+  """Loads report fetcher for a given source.
+
+  Args:
+    source: Alias for a source associated with a fetcher.
+
+  Returns:
+    Class for a found report fetcher.
+
+  Raises:
+    ApiReportFetcherError: When fetcher cannot be loaded.
+    MissingApiReportFetcherError: When fetcher not found.
+  """
+  if source not in find_fetchers():
+    raise report_fetcher.MissingApiReportFetcherError(source)
+  for fetcher in _get_entrypoints('garf'):
+    if fetcher.name == source:
+      try:
+        with tracer.start_as_current_span('load_fetcher_module') as span:
+          fetcher_module = fetcher.load()
+          span.set_attribute('loaded_module', fetcher_module.__name__)
+        for name, obj in inspect.getmembers(fetcher_module):
+          if inspect.isclass(obj) and issubclass(
+            obj, report_fetcher.ApiReportFetcher
+          ):
+            return getattr(fetcher_module, name)
+      except ModuleNotFoundError:
+        continue
+  raise report_fetcher.ApiReportFetcherError(
+    f'No fetcher available for the source "{source}"'
+  )
+
+
+def _get_entrypoints(group='garf'):
+  if sys.version_info.major == 3 and sys.version_info.minor == 9:
     try:
-      fetcher_module = fetcher.load()
-      for name, obj in inspect.getmembers(fetcher_module):
-        if inspect.isclass(obj) and issubclass(
-          obj, report_fetcher.ApiReportFetcher
-        ):
-          found_fetchers[fetcher.name] = getattr(fetcher_module, name)
-    except ModuleNotFoundError:
-      continue
-  return found_fetchers
-
-
-FETCHERS = get_report_fetchers()
+      fetchers = entry_points()[group]
+    except KeyError:
+      fetchers = []
+  else:
+    fetchers = entry_points(group=group)
+  return fetchers

garf_executors/sql_executor.py

@@ -25,14 +25,24 @@ except ImportError as e:
 
 import logging
 import re
-from typing import Any
 
 import pandas as pd
+from garf_core import query_editor, report
+from opentelemetry import trace
 
-from garf_core import query_editor
+from garf_executors import exceptions, execution_context, executor
+from garf_executors.telemetry import tracer
 
+logger = logging.getLogger(__name__)
 
-class SqlAlchemyQueryExecutor(query_editor.TemplateProcessorMixin):
+
+class SqlAlchemyQueryExecutorError(exceptions.GarfExecutorError):
+  """Error when SqlAlchemyQueryExecutor fails to run query."""
+
+
+class SqlAlchemyQueryExecutor(
+  executor.Executor, query_editor.TemplateProcessorMixin
+):
   """Handles query execution via SqlAlchemy.
 
   Attributes:
@@ -51,36 +61,63 @@ class SqlAlchemyQueryExecutor(query_editor.TemplateProcessorMixin):
   def from_connection_string(
     cls, connection_string: str
   ) -> SqlAlchemyQueryExecutor:
+    """Creates executor from SqlAlchemy connection string.
+
+    https://docs.sqlalchemy.org/en/20/core/engines.html
+    """
     engine = sqlalchemy.create_engine(connection_string)
     return cls(engine)
 
+  @tracer.start_as_current_span('sql.execute')
   def execute(
     self,
-    script_name: str | None,
-    query_text: str,
-    params: dict[str, Any] | None = None,
-  ) -> pd.DataFrame:
+    query: str,
+    title: str,
+    context: execution_context.ExecutionContext = (
+      execution_context.ExecutionContext()
+    ),
+  ) -> report.GarfReport:
     """Executes query in a given database via SqlAlchemy.
 
     Args:
-        script_name: Script identifier.
-        query_text: Query to be executed.
-        params: Optional parameters to be replaced in query text.
+      query: Location of the query.
+      title: Name of the query.
+      context: Query execution context.
 
     Returns:
-        DataFrame if query returns some data otherwise empty DataFrame.
+      Report with data if query returns some data otherwise empty Report.
     """
-    logging.info('Executing script: %s', script_name)
-    query_text = self.replace_params_template(query_text, params)
+    span = trace.get_current_span()
+    logging.info('Executing script: %s', title)
+    query_text = self.replace_params_template(query, context.query_parameters)
     with self.engine.begin() as conn:
       if re.findall(r'(create|update) ', query_text.lower()):
         conn.connection.executescript(query_text)
-        return pd.DataFrame()
-      temp_table_name = f'temp_{script_name}'.replace('.', '_')
-      query_text = f'CREATE TABLE {temp_table_name} AS {query_text}'
-      conn.connection.executescript(query_text)
-      try:
-        result = pd.read_sql(f'SELECT * FROM {temp_table_name}', conn)
-      finally:
-        conn.connection.execute(f'DROP TABLE {temp_table_name}')
-      return result
+        results = report.GarfReport()
+      else:
+        temp_table_name = f'temp_{title}'.replace('.', '_')
+        query_text = f'CREATE TABLE {temp_table_name} AS {query_text}'
+        conn.connection.executescript(query_text)
+        try:
+          results = report.GarfReport.from_pandas(
+            pd.read_sql(f'SELECT * FROM {temp_table_name}', conn)
+          )
+        finally:
+          conn.connection.execute(f'DROP TABLE {temp_table_name}')
+      if context.writer and results:
+        writer_client = context.writer_client
+        logger.debug(
+          'Start writing data for query %s via %s writer',
+          title,
+          type(writer_client),
+        )
+        writing_result = writer_client.write(results, title)
+        logger.debug(
+          'Finish writing data for query %s via %s writer',
+          title,
+          type(writer_client),
+        )
+        logger.info('%s executed successfully', title)
+        return writing_result
+      span.set_attribute('execute.num_results', len(results))
+      return results

garf_executors/telemetry.py

@@ -0,0 +1,20 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# 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.
+
+# pylint: disable=C0330, g-bad-import-order, g-multiple-import
+from opentelemetry import trace
+
+tracer = trace.get_tracer(
+  instrumenting_module_name='garf_executors',
+)

{garf_executors-0.0.6.dist-info → garf_executors-0.1.4.dist-info}/METADATA

@@ -1,34 +1,39 @@
 Metadata-Version: 2.4
 Name: garf-executors
-Version: 0.0.6
+Version: 0.1.4
 Summary: Executes queries against API and writes data to local/remote storage.
 Author-email: "Google Inc. (gTech gPS CSE team)" <no-reply@google.com>, Andrei Markin <andrey.markin.ppc@gmail.com>
 License: Apache 2.0
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Intended Audience :: Developers
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Operating System :: OS Independent
 Classifier: License :: OSI Approved :: Apache Software License
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 Requires-Dist: garf-core
 Requires-Dist: garf-io
 Requires-Dist: pyyaml
 Requires-Dist: pydantic
+Requires-Dist: opentelemetry-api
+Requires-Dist: opentelemetry-sdk
 Provides-Extra: bq
 Requires-Dist: garf-io[bq]; extra == "bq"
 Requires-Dist: pandas; extra == "bq"
+Requires-Dist: google-cloud-logging; extra == "bq"
 Provides-Extra: sql
 Requires-Dist: garf-io[sqlalchemy]; extra == "sql"
 Requires-Dist: pandas; extra == "sql"
 Provides-Extra: server
 Requires-Dist: fastapi[standard]; extra == "server"
+Requires-Dist: opentelemetry-instrumentation-fastapi; extra == "server"
+Requires-Dist: opentelemetry-exporter-otlp; extra == "server"
 Provides-Extra: all
 Requires-Dist: garf-executors[bq,server,sql]; extra == "all"
 

garf_executors-0.1.4.dist-info/RECORD

@@ -0,0 +1,20 @@
+garf_executors/__init__.py,sha256=4BZv9zb3tjlpF4kQSdTj1L5IdR-BiNQwtejg5dPTTcY,1933
+garf_executors/api_executor.py,sha256=TxHtdnXjXjfBDU0z13yCulqF0XcEqAoOdVeGczdTSXs,3590
+garf_executors/bq_executor.py,sha256=LOKNitigaMk4U-UjBZTHy4vG092nw6suEbgo2rrHCTI,5002
+garf_executors/config.py,sha256=TqCzijm1PRvL4p-9Zl-kPkcC1SFKjhgTfKMJFmJW3fQ,1688
+garf_executors/exceptions.py,sha256=U_7Q2ZMOUf89gzZd2pw7y3g7i1NeByPPKfpZ3q7p3ZU,662
+garf_executors/execution_context.py,sha256=X4Wm_rE1mnnN2FuC_9bL05a8h8ko7qraeGY955ijNJc,2800
+garf_executors/executor.py,sha256=_Nj6CKgyhzwFOxneODDhV1bvLjrMEvIu93W8YF9-sXo,2481
+garf_executors/fetchers.py,sha256=HQqnMb0wlasVfXmAA7cnsd73POXPEGPxaC5mpEOnQk4,2443
+garf_executors/sql_executor.py,sha256=_4oVPZKTd3lrDE0SM6uQ_bl13Ay9uhQuD-PHO9247WM,3920
+garf_executors/telemetry.py,sha256=P75klGEoYgJ_-pR-izUIQ7B88ufskQ4vmW1rETg63Nc,747
+garf_executors/entrypoints/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+garf_executors/entrypoints/cli.py,sha256=Qbg10LLWHEMBjjsOfEMDZQtjWpUwh6WJKSnqiXOzF6A,4765
+garf_executors/entrypoints/server.py,sha256=b9blyBvN774RiTHUCZkfE5kNVnrTaANrETI4WMDHJeQ,3255
+garf_executors/entrypoints/tracer.py,sha256=A_nolmGuMT3wOZJsoPORjfdtPO2lXdbr6CZt5BW0RTY,1374
+garf_executors/entrypoints/utils.py,sha256=5XiGR2IOxdzAOY0lEWUeUV7tIpKBGRnQaIwBYvzQB7c,4337
+garf_executors-0.1.4.dist-info/METADATA,sha256=3Z0plyqxqwCKYOm2PlXIfvxGo0lAVkdIaLD0s0pgZzQ,2900
+garf_executors-0.1.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+garf_executors-0.1.4.dist-info/entry_points.txt,sha256=LskWNFIw8j0WJuI18-32OZrlASXAMg1XtrRYwsKBz2E,61
+garf_executors-0.1.4.dist-info/top_level.txt,sha256=sP4dCXOENPn1hDFAunjMV8Js4NND_KGeO_gQWuaT0EY,15
+garf_executors-0.1.4.dist-info/RECORD,,

garf_executors-0.0.6.dist-info/RECORD

@@ -1,15 +0,0 @@
-garf_executors/__init__.py,sha256=bcb29OEvsx2XNTpbUW0LvKxoYJt5BSX3S2gqQLdRIqU,955
-garf_executors/api_executor.py,sha256=udrlMiYUmKh5NsIuJkNowqCenvtf5O925FPFawXSXbM,4021
-garf_executors/bq_executor.py,sha256=JBPxbDRYgUgpJv6SqYiFPypTFjZGIZ-SOOb6dS2sZQY,3822
-garf_executors/exceptions.py,sha256=U_7Q2ZMOUf89gzZd2pw7y3g7i1NeByPPKfpZ3q7p3ZU,662
-garf_executors/fetchers.py,sha256=gkAKHsDPzJySg4wYLZeCmNINtk6f17-jFzOP7tE82r8,1226
-garf_executors/sql_executor.py,sha256=6tpsd1Ive5igAlQuhCSkli-tZHp58uWAU86JWGvdVpE,2722
-garf_executors/entrypoints/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-garf_executors/entrypoints/cli.py,sha256=mWvPQkaqarDj5byHRvNAweVbUQiHZLXrC-35zY7l4fs,4043
-garf_executors/entrypoints/server.py,sha256=rJ29VKWKaYJci1BLxZx-0LSILmUMf5BK8G1RRjRS2ts,1836
-garf_executors/entrypoints/utils.py,sha256=ZZJFe2N4KwgzPRvak9gW_B25qESnzOyuF-qYZ2wW2_M,14974
-garf_executors-0.0.6.dist-info/METADATA,sha256=35dBABJ8cVH2nI0NonZ5VGO6W4IF0gtiiw-ZFZqZhgs,2648
-garf_executors-0.0.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-garf_executors-0.0.6.dist-info/entry_points.txt,sha256=LskWNFIw8j0WJuI18-32OZrlASXAMg1XtrRYwsKBz2E,61
-garf_executors-0.0.6.dist-info/top_level.txt,sha256=sP4dCXOENPn1hDFAunjMV8Js4NND_KGeO_gQWuaT0EY,15
-garf_executors-0.0.6.dist-info/RECORD,,