garf-executors 0.0.1__py3-none-any.whl

garf_executors/entrypoints/cli/gaarf.py

@@ -0,0 +1,213 @@
+# Copyright 2022 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.
+"""Module for defing `garf` CLI utility.
+
+`garf` allows to execute GAQL queries and store results in local/remote
+storage.
+"""
+
+from __future__ import annotations
+
+import argparse
+import functools
+import sys
+from collections.abc import MutableSequence
+from concurrent import futures
+from pathlib import Path
+
+import smart_open
+import yaml
+from garf import api_clients, exceptions, query_executor
+from garf.cli import utils
+from garf.io import reader, writer
+
+
+def main():
+  parser = argparse.ArgumentParser()
+  parser.add_argument('query', nargs='*')
+  parser.add_argument('-c', '--config', dest='garf_config', default=None)
+  parser.add_argument('--account', dest='account', default=None)
+  parser.add_argument('--output', dest='output', default=None)
+  parser.add_argument('--input', dest='input', default='file')
+  parser.add_argument(
+    '--ads-config', dest='config', default=str(Path.home() / 'google-ads.yaml')
+  )
+  parser.add_argument('--api-version', dest='api_version', default=None)
+  parser.add_argument('--log', '--loglevel', dest='loglevel', default='info')
+  parser.add_argument('--logger', dest='logger', default='local')
+  parser.add_argument(
+    '--customer-ids-query', dest='customer_ids_query', default=None
+  )
+  parser.add_argument(
+    '--customer-ids-query-file', dest='customer_ids_query_file', default=None
+  )
+  parser.add_argument('--save-config', dest='save_config', action='store_true')
+  parser.add_argument(
+    '--no-save-config', dest='save_config', action='store_false'
+  )
+  parser.add_argument(
+    '--config-destination', dest='save_config_dest', default='config.yaml'
+  )
+  parser.add_argument(
+    '--parallel-queries', dest='parallel_queries', action='store_true'
+  )
+  parser.add_argument(
+    '--no-parallel-queries', dest='parallel_queries', action='store_false'
+  )
+  parser.add_argument(
+    '--optimize-performance', dest='optimize_performance', default='NONE'
+  )
+  parser.add_argument('--dry-run', dest='dry_run', action='store_true')
+  parser.add_argument(
+    '--disable-account-expansion',
+    dest='disable_account_expansion',
+    action='store_true',
+  )
+  parser.add_argument('-v', '--version', dest='version', action='store_true')
+  parser.add_argument(
+    '--parallel-threshold', dest='parallel_threshold', default=None, type=int
+  )
+  parser.set_defaults(save_config=False)
+  parser.set_defaults(parallel_queries=True)
+  parser.set_defaults(dry_run=False)
+  parser.set_defaults(disable_account_expansion=False)
+  args = parser.parse_known_args()
+  main_args = args[0]
+
+  if main_args.version:
+    import pkg_resources
+
+    version = pkg_resources.require('google-ads-api-report-fetcher')[0].version
+    print(f'garf version {version}')
+    sys.exit()
+
+  logger = utils.init_logging(
+    loglevel=main_args.loglevel.upper(), logger_type=main_args.logger
+  )
+  if not main_args.query:
+    logger.error('Please provide one or more queries to run')
+    raise exceptions.GarfMissingQueryException(
+      'Please provide one or more queries to run'
+    )
+
+  with smart_open.open(main_args.config, 'r', encoding='utf-8') as f:
+    google_ads_config_dict = yaml.safe_load(f)
+
+  config = utils.ConfigBuilder('garf').build(vars(main_args), args[1])
+  if not config.account:
+    if mcc := google_ads_config_dict.get('login_customer_id'):
+      config.account = str(mcc)
+    else:
+      raise exceptions.GarfMissingAccountException(
+        'No account found, please specify via --account CLI flag'
+        'or add as login_customer_id in google-ads.yaml'
+      )
+  logger.debug('config: %s', config)
+
+  if main_args.save_config and not main_args.garf_config:
+    utils.ConfigSaver(main_args.save_config_dest).save(config)
+  if main_args.dry_run:
+    sys.exit()
+
+  if config.params:
+    config = utils.initialize_runtime_parameters(config)
+  logger.debug('initialized config: %s', config)
+
+  ads_client = api_clients.GoogleAdsApiClient(
+    config_dict=google_ads_config_dict,
+    version=config.api_version,
+    use_proto_plus=main_args.optimize_performance
+    not in ('PROTOBUF', 'BATCH_PROTOBUF'),
+  )
+  ads_query_executor = query_executor.AdsQueryExecutor(ads_client)
+  reader_factory = reader.ReaderFactory()
+  reader_client = reader_factory.create_reader(main_args.input)
+
+  if config.customer_ids_query:
+    customer_ids_query = config.customer_ids_query
+  elif config.customer_ids_query_file:
+    file_reader = reader_factory.create_reader('file')
+    customer_ids_query = file_reader.read(config.customer_ids_query_file)
+  else:
+    customer_ids_query = None
+
+  if main_args.disable_account_expansion:
+    logger.info(
+      'Skipping account expansion because of ' 'disable_account_expansion flag'
+    )
+    customer_ids = (
+      config.account
+      if isinstance(config.account, MutableSequence)
+      else [config.account]
+    )
+  else:
+    customer_ids = ads_query_executor.expand_mcc(
+      config.account, customer_ids_query
+    )
+  if not customer_ids:
+    logger.warning(
+      'Not a single under MCC %s is found that satisfies '
+      'the following customer_id query: "%s"',
+      config.account,
+      customer_ids_query,
+    )
+    sys.exit()
+  writer_client = writer.WriterFactory().create_writer(
+    config.output, **config.writer_params
+  )
+  if config.output == 'bq':
+    _ = writer_client.create_or_get_dataset()
+  if config.output == 'sheet':
+    writer_client.init_client()
+
+  logger.info(
+    'Total number of customer_ids is %d, accounts=[%s]',
+    len(customer_ids),
+    ','.join(map(str, customer_ids)),
+  )
+
+  if main_args.parallel_queries:
+    logger.info('Running queries in parallel')
+    with futures.ThreadPoolExecutor(main_args.parallel_threshold) as executor:
+      future_to_query = {
+        executor.submit(
+          ads_query_executor.execute,
+          reader_client.read(query),
+          query,
+          customer_ids,
+          writer_client,
+          config.params,
+          main_args.optimize_performance,
+        ): query
+        for query in main_args.query
+      }
+      for future in futures.as_completed(future_to_query):
+        query = future_to_query[future]
+        utils.garf_runner(query, future.result, logger)
+  else:
+    logger.info('Running queries sequentially')
+    for query in main_args.query:
+      callback = functools.partial(
+        ads_query_executor.execute,
+        reader_client.read(query),
+        query,
+        customer_ids,
+        writer_client,
+        config.params,
+        main_args.optimize_performance,
+      )
+      utils.garf_runner(query, callback, logger)
+
+
+if __name__ == '__main__':
+  main()

garf_executors/entrypoints/cli/sql.py

@@ -0,0 +1,109 @@
+# Copyright 2023 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.
+"""Module for defing `garf` CLI utility.
+
+`garf-sql` allows to execute SQL queries in various Databases via SqlAlchemy.
+"""
+
+from __future__ import annotations
+
+import argparse
+import functools
+import sys
+from concurrent import futures
+
+import sqlalchemy
+from garf_writers import reader  # type: ignore
+
+from garf_executors import sql_executor
+from garf_executors.entrypoints import utils
+
+
+def main():
+  parser = argparse.ArgumentParser()
+  parser.add_argument('query', nargs='+')
+  parser.add_argument('-c', '--config', dest='garf_config', default=None)
+  parser.add_argument('--conn', '--connection-string', dest='connection_string')
+  parser.add_argument('--save-config', dest='save_config', action='store_true')
+  parser.add_argument(
+    '--no-save-config', dest='save_config', action='store_false'
+  )
+  parser.add_argument(
+    '--config-destination', dest='save_config_dest', default='config.yaml'
+  )
+  parser.add_argument('--log', '--loglevel', dest='loglevel', default='info')
+  parser.add_argument('--logger', dest='logger', default='local')
+  parser.add_argument('--dry-run', dest='dry_run', action='store_true')
+  parser.add_argument(
+    '--parallel-queries', dest='parallel_queries', action='store_true'
+  )
+  parser.add_argument(
+    '--no-parallel-queries', dest='parallel_queries', action='store_false'
+  )
+  parser.add_argument(
+    '--parallel-threshold', dest='parallel_threshold', default=None, type=int
+  )
+  parser.set_defaults(save_config=False)
+  parser.set_defaults(dry_run=False)
+  parser.set_defaults(parallel_queries=True)
+  args = parser.parse_known_args()
+  main_args = args[0]
+
+  logger = utils.init_logging(
+    loglevel=main_args.loglevel.upper(), logger_type=main_args.logger
+  )
+
+  config = utils.ConfigBuilder('garf-sql').build(vars(main_args), args[1])
+  logger.debug('config: %s', config)
+  if main_args.save_config and not main_args.garf_config:
+    utils.ConfigSaver(main_args.save_config_dest).save(config)
+  if main_args.dry_run:
+    sys.exit()
+
+  config = utils.initialize_runtime_parameters(config)
+  logger.debug('initialized config: %s', config)
+
+  engine = sqlalchemy.create_engine(config.connection_string)
+  sqlalchemy_query_executor = sql_executor.SqlAlchemyQueryExecutor(engine)
+
+  reader_client = reader.FileReader()
+
+  if main_args.parallel_queries:
+    logger.info('Running queries in parallel')
+    with futures.ThreadPoolExecutor(
+      max_workers=main_args.parallel_threshold
+    ) as executor:
+      future_to_query = {
+        executor.submit(
+          sqlalchemy_query_executor.execute,
+          query,
+          reader_client.read(query),
+          config.params,
+        ): query
+        for query in sorted(main_args.query)
+      }
+      for future in futures.as_completed(future_to_query):
+        query = future_to_query[future]
+        utils.postprocessor_runner(query, future.result, logger)
+  else:
+    logger.info('Running queries sequentially')
+    for query in sorted(main_args.query):
+      callback = functools.partial(
+        executor.execute, query, reader_client.read(query), config.params
+      )
+      utils.postprocessor_runner(query, callback, logger)
+
+
+if __name__ == '__main__':
+  main()