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

garf_executors/entrypoints/utils.py

@@ -1,4 +1,4 @@
-# Copyright 2022 Google LLC
+# Copyright 2026 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -11,130 +11,15 @@
 # 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 various helpers for executing Garf as CLI tool."""
 
-from __future__ import annotations
 
-import enum
-import logging
-import sys
-from collections.abc import Sequence
-from typing import Any
+import warnings
 
-from rich import logging as rich_logging
+from garf.executors.entrypoints.utils import *
 
-
-class ParamsParser:
-  def __init__(self, identifiers: Sequence[str]) -> None:
-    self.identifiers = identifiers
-
-  def parse(self, params: Sequence) -> dict[str, dict | None]:
-    return {
-      identifier: self._parse_params(identifier, params)
-      for identifier in self.identifiers
-    }
-
-  def _parse_params(self, identifier: str, params: Sequence[Any]) -> dict:
-    parsed_params = {}
-    if params:
-      raw_params = [param.split('=', maxsplit=1) for param in params]
-      for param in raw_params:
-        param_pair = self._identify_param_pair(identifier, param)
-        if param_pair:
-          parsed_params.update(param_pair)
-    return parsed_params
-
-  def _identify_param_pair(
-    self, identifier: str, param: Sequence[str]
-  ) -> dict[str, Any] | None:
-    key = param[0]
-    if not identifier or identifier not in key:
-      return None
-    provided_identifier, *keys = key.split('.')
-    if not keys:
-      return None
-    if len(keys) > 1:
-      raise GarfParamsException(
-        f'{key} is invalid format,'
-        f'`--{identifier}.key=value` or `--{identifier}.key` '
-        'are the correct formats'
-      )
-    provided_identifier = provided_identifier.replace('--', '')
-    if provided_identifier not in self.identifiers:
-      supported_arguments = ', '.join(self.identifiers)
-      raise GarfParamsException(
-        f'CLI argument {provided_identifier} is not supported'
-        f', supported arguments {supported_arguments}'
-      )
-    if provided_identifier != identifier:
-      return None
-    key = keys[0].replace('-', '_')
-    if not key:
-      raise GarfParamsException(
-        f'{identifier} {key} is invalid,'
-        f'`--{identifier}.key=value` or `--{identifier}.key` '
-        'are the correct formats'
-      )
-    if len(param) == 2:
-      return {key: param[1]}
-    if len(param) == 1:
-      return {key: True}
-    raise GarfParamsException(
-      f'{identifier} {key} is invalid,'
-      f'`--{identifier}.key=value` or `--{identifier}.key` '
-      'are the correct formats'
-    )
-
-
-class GarfParamsException(Exception):
-  """Defines exception for incorrect parameters."""
-
-
-class LoggerEnum(str, enum.Enum):
-  local = 'local'
-  rich = 'rich'
-  gcloud = 'gcloud'
-
-
-def init_logging(
-  loglevel: str = 'INFO',
-  logger_type: str | LoggerEnum = 'local',
-  name: str = __name__,
-) -> logging.Logger:
-  loglevel = getattr(logging, loglevel)
-  if logger_type == 'rich':
-    logging.basicConfig(
-      format='%(message)s',
-      level=loglevel,
-      datefmt='%Y-%m-%d %H:%M:%S',
-      handlers=[
-        rich_logging.RichHandler(rich_tracebacks=True),
-      ],
-    )
-  elif logger_type == 'gcloud':
-    try:
-      import google.cloud.logging as glogging
-    except ImportError as e:
-      raise ImportError(
-        'Please install garf-executors with Cloud logging support - '
-        '`pip install garf-executors[bq]`'
-      ) from e
-
-    client = glogging.Client()
-    handler = glogging.handlers.CloudLoggingHandler(client, name=name)
-    handler.close()
-    glogging.handlers.setup_logging(handler, log_level=loglevel)
-    logging.basicConfig(
-      level=loglevel,
-      handlers=[handler],
-    )
-  else:
-    logging.basicConfig(
-      format='[%(asctime)s][%(name)s][%(levelname)s] %(message)s',
-      stream=sys.stdout,
-      level=loglevel,
-      datefmt='%Y-%m-%d %H:%M:%S',
-    )
-  logging.getLogger('smart_open.smart_open_lib').setLevel(logging.WARNING)
-  logging.getLogger('urllib3.connectionpool').setLevel(logging.WARNING)
-  return logging.getLogger(name)
+warnings.warn(
+  "The 'garf_executors.entrypoints' namespace is deprecated. "
+  "Please use 'garf.executors.entrypoints' instead.",
+  DeprecationWarning,
+  stacklevel=2,
+)

garf_executors/exceptions.py

@@ -1,4 +1,4 @@
-# Copyright 2025 Google LLC
+# Copyright 2026 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -13,5 +13,13 @@
 # limitations under the License.
 
 
-class GarfExecutorError(Exception):
-  """Base class for garf executor exceptions."""
+import warnings
+
+from garf.executors.exceptions import *
+
+warnings.warn(
+  "The 'garf_executors' namespace is deprecated. "
+  "Please use 'garf.executors' instead.",
+  DeprecationWarning,
+  stacklevel=2,
+)

garf_executors/execution_context.py

@@ -1,4 +1,4 @@
-# Copyright 2025 Google LLC
+# Copyright 2026 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,72 +12,14 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# pylint: disable=C0330, g-bad-import-order, g-multiple-import
 
-"""Captures parameters for fetching data from APIs."""
+import warnings
 
-from __future__ import annotations
+from garf.executors.execution_context import *
 
-import os
-import pathlib
-
-import pydantic
-import smart_open
-import yaml
-from garf_core import query_editor
-from garf_io import writer
-from garf_io.writers import abs_writer
-
-
-class ExecutionContext(pydantic.BaseModel):
-  """Common context for executing one or more queries.
-
-  Attributes:
-    query_parameters: Parameters to dynamically change query text.
-    fetcher_parameters: Parameters to specify fetching setup.
-    writer: Type of writer to use.
-    writer_parameters: Optional parameters to setup writer.
-  """
-
-  query_parameters: query_editor.GarfQueryParameters | None = pydantic.Field(
-    default_factory=dict
-  )
-  fetcher_parameters: dict[str, str | bool | int | list[str | int]] | None = (
-    pydantic.Field(default_factory=dict)
-  )
-  writer: str | None = None
-  writer_parameters: dict[str, str] | None = pydantic.Field(
-    default_factory=dict
-  )
-
-  def model_post_init(self, __context__) -> None:
-    if self.fetcher_parameters is None:
-      self.fetcher_parameters = {}
-    if self.writer_parameters is None:
-      self.writer_parameters = {}
-    if not self.query_parameters:
-      self.query_parameters = query_editor.GarfQueryParameters()
-
-  @classmethod
-  def from_file(
-    cls, path: str | pathlib.Path | os.PathLike[str]
-  ) -> ExecutionContext:
-    """Builds context from local or remote yaml file."""
-    with smart_open.open(path, 'r', encoding='utf-8') as f:
-      data = yaml.safe_load(f)
-    return ExecutionContext(**data)
-
-  def save(self, path: str | pathlib.Path | os.PathLike[str]) -> str:
-    """Saves context to local or remote yaml file."""
-    with smart_open.open(path, 'w', encoding='utf-8') as f:
-      yaml.dump(self.model_dump(), f, encoding='utf-8')
-    return f'ExecutionContext is saved to {str(path)}'
-
-  @property
-  def writer_client(self) -> abs_writer.AbsWriter:
-    writer_client = writer.create_writer(self.writer, **self.writer_parameters)
-    if self.writer == 'bq':
-      _ = writer_client.create_or_get_dataset()
-    if self.writer == 'sheet':
-      writer_client.init_client()
-    return writer_client
+warnings.warn(
+  "The 'garf_executors' namespace is deprecated. "
+  "Please use 'garf.executors' instead.",
+  DeprecationWarning,
+  stacklevel=2,
+)

garf_executors/executor.py

@@ -1,4 +1,4 @@
-# Copyright 2025 Google LLC
+# Copyright 2026 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,76 +12,14 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""Defines common functionality between executors."""
 
-import asyncio
+import warnings
 
-from opentelemetry import trace
+from garf.executors.executor import *
 
-from garf_executors import execution_context
-from garf_executors.telemetry import tracer
-
-
-class Executor:
-  """Defines common functionality between executors."""
-
-  @tracer.start_as_current_span('api.execute_batch')
-  def execute_batch(
-    self,
-    batch: dict[str, str],
-    context: execution_context.ExecutionContext,
-    parallel_threshold: int = 10,
-  ) -> list[str]:
-    """Executes batch of queries for a common context.
-
-    Args:
-      batch: Mapping between query_title and its text.
-      context: Execution context.
-      parallel_threshold: Number of queries to execute in parallel.
-
-    Returns:
-      Results of execution.
-    """
-    span = trace.get_current_span()
-    span.set_attribute('api.parallel_threshold', parallel_threshold)
-    return asyncio.run(
-      self._run(
-        batch=batch, context=context, parallel_threshold=parallel_threshold
-      )
-    )
-
-  async def aexecute(
-    self,
-    query: str,
-    title: str,
-    context: execution_context.ExecutionContext,
-  ) -> str:
-    """Performs query execution asynchronously.
-
-    Args:
-      query: Location of the query.
-      title: Name of the query.
-      context: Query execution context.
-
-    Returns:
-      Result of writing the report.
-    """
-    return await asyncio.to_thread(self.execute, query, title, context)
-
-  async def _run(
-    self,
-    batch: dict[str, str],
-    context: execution_context.ExecutionContext,
-    parallel_threshold: int,
-  ):
-    semaphore = asyncio.Semaphore(value=parallel_threshold)
-
-    async def run_with_semaphore(fn):
-      async with semaphore:
-        return await fn
-
-    tasks = [
-      self.aexecute(query=query, title=title, context=context)
-      for title, query in batch.items()
-    ]
-    return await asyncio.gather(*(run_with_semaphore(task) for task in tasks))
+warnings.warn(
+  "The 'garf_executors' namespace is deprecated. "
+  "Please use 'garf.executors' instead.",
+  DeprecationWarning,
+  stacklevel=2,
+)

garf_executors/fetchers.py

@@ -1,4 +1,4 @@
-# Copyright 2025 Google LLC
+# Copyright 2026 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,64 +12,14 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import inspect
-import sys
-from importlib.metadata import entry_points
 
-from garf_core import report_fetcher
-from opentelemetry import trace
+import warnings
 
-from garf_executors.telemetry import tracer
+from garf.executors.fetchers import *
 
-
-@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:
-      fetchers = entry_points()[group]
-    except KeyError:
-      fetchers = []
-  else:
-    fetchers = entry_points(group=group)
-  return fetchers
+warnings.warn(
+  "The 'garf_executors' namespace is deprecated. "
+  "Please use 'garf.executors' instead.",
+  DeprecationWarning,
+  stacklevel=2,
+)

garf_executors/sql_executor.py

@@ -1,4 +1,4 @@
-# Copyright 2024 Google LLC
+# Copyright 2026 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -11,113 +11,15 @@
 # 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.
-"""Defines mechanism for executing queries via SqlAlchemy."""
 
-from __future__ import annotations
 
-try:
-  import sqlalchemy
-except ImportError as e:
-  raise ImportError(
-    'Please install garf-executors with sqlalchemy support '
-    '- `pip install garf-executors[sqlalchemy]`'
-  ) from e
+import warnings
 
-import logging
-import re
+from garf.executors.sql_executor import *
 
-import pandas as pd
-from garf_core import query_editor, report
-from opentelemetry import trace
-
-from garf_executors import exceptions, execution_context, executor
-from garf_executors.telemetry import tracer
-
-logger = logging.getLogger(__name__)
-
-
-class SqlAlchemyQueryExecutorError(exceptions.GarfExecutorError):
-  """Error when SqlAlchemyQueryExecutor fails to run query."""
-
-
-class SqlAlchemyQueryExecutor(
-  executor.Executor, query_editor.TemplateProcessorMixin
-):
-  """Handles query execution via SqlAlchemy.
-
-  Attributes:
-      engine: Initialized Engine object to operated on a given database.
-  """
-
-  def __init__(self, engine: sqlalchemy.engine.base.Engine) -> None:
-    """Initializes executor with a given engine.
-
-    Args:
-        engine: Initialized Engine object to operated on a given database.
-    """
-    self.engine = engine
-
-  @classmethod
-  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,
-    query: str,
-    title: str,
-    context: execution_context.ExecutionContext = (
-      execution_context.ExecutionContext()
-    ),
-  ) -> report.GarfReport:
-    """Executes query in a given database via SqlAlchemy.
-
-    Args:
-      query: Location of the query.
-      title: Name of the query.
-      context: Query execution context.
-
-    Returns:
-      Report with data if query returns some data otherwise empty Report.
-    """
-    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)
-        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
+warnings.warn(
+  "The 'garf_executors' namespace is deprecated. "
+  "Please use 'garf.executors' instead.",
+  DeprecationWarning,
+  stacklevel=2,
+)

garf_executors/telemetry.py

@@ -1,4 +1,4 @@
-# Copyright 2025 Google LLC
+# Copyright 2026 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,9 +12,14 @@
 # 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',
+import warnings
+
+from garf.executors.telemetry import *
+
+warnings.warn(
+  "The 'garf_executors' namespace is deprecated. "
+  "Please use 'garf.executors' instead.",
+  DeprecationWarning,
+  stacklevel=2,
 )

garf_executors/workflow.py

@@ -0,0 +1,25 @@
+# Copyright 2026 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.
+
+
+import warnings
+
+from garf.executors.workflow import *
+
+warnings.warn(
+  "The 'garf_executors' namespace is deprecated. "
+  "Please use 'garf.executors' instead.",
+  DeprecationWarning,
+  stacklevel=2,
+)

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: garf-executors
-Version: 0.1.4
+Version: 1.0.2
 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
@@ -17,25 +17,29 @@ Classifier: Operating System :: OS Independent
 Classifier: License :: OSI Approved :: Apache Software License
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
-Requires-Dist: garf-core
-Requires-Dist: garf-io
+Requires-Dist: garf-core>=1.0.0
+Requires-Dist: garf-io>=1.0.0
 Requires-Dist: pyyaml
 Requires-Dist: pydantic
 Requires-Dist: opentelemetry-api
 Requires-Dist: opentelemetry-sdk
+Requires-Dist: opentelemetry-exporter-otlp
 Provides-Extra: bq
 Requires-Dist: garf-io[bq]; extra == "bq"
 Requires-Dist: pandas; extra == "bq"
 Requires-Dist: google-cloud-logging; extra == "bq"
+Requires-Dist: smart_open[gcs]; extra == "bq"
 Provides-Extra: sql
 Requires-Dist: garf-io[sqlalchemy]; extra == "sql"
 Requires-Dist: pandas; extra == "sql"
+Provides-Extra: gcp
+Requires-Dist: opentelemetry-exporter-gcp-trace; extra == "gcp"
 Provides-Extra: server
 Requires-Dist: fastapi[standard]; extra == "server"
 Requires-Dist: opentelemetry-instrumentation-fastapi; extra == "server"
-Requires-Dist: opentelemetry-exporter-otlp; extra == "server"
+Requires-Dist: typer; extra == "server"
 Provides-Extra: all
-Requires-Dist: garf-executors[bq,server,sql]; extra == "all"
+Requires-Dist: garf-executors[bq,gcp,server,sql]; extra == "all"
 
 # `garf-executors` - One stop-shop for interacting with Reporting APIs.
 
@@ -64,8 +68,14 @@ garf <QUERIES> --source <API_SOURCE> \
 where
 
 * `<QUERIES>`- local or remote path(s) to files with queries.
-* `<API_SOURCE>`- type of API to use. Based on that the appropriate report fetcher will be initialized.
-* `<OUTPUT_TYPE>` - output supported by [`garf-io` library](../garf_io/README.md).
+* `source`- type of API to use. Based on that the appropriate report fetcher will be initialized. Explore supported APIs [here](https://google.github.io/garf/fetchers/overview/)
+* `output` - output supported by [`garf-io` library](https://google.github.io/garf/usage/writers/).
 
 If your report fetcher requires additional parameters you can pass them via key value pairs under `--source.` argument, i.e.`--source.regionCode='US'` - to get data only from *US*.
 > Concrete `--source` parameters are dependent on a particular report fetcher and should be looked up in a documentation for this fetcher.
+
+## Documentation
+
+Explore full documentation working with `garf-executors`
+
+* [Documentation](https://google.github.io/garf/usage/executors/)