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

garf_executors/__init__.py

@@ -11,11 +11,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.
-"""Defines simplified import of executors.
-
-Instead of importing `garf_executors.api_executor.ApiQueryExecutor`
-import like this `garf_executors.ApiQueryExecutor`
-"""
+"""Executors to fetch data from various APIS and postprocess them."""
 
 from __future__ import annotations
 
@@ -27,4 +23,4 @@ __all__ = [
   'ApiQueryExecutor',
 ]
 
-__version__ = '0.0.6'
+__version__ = '0.0.7'

garf_executors/api_executor.py

@@ -80,21 +80,21 @@ class ApiQueryExecutor:
 
   async def aexecute(
     self, query: str, context: ApiExecutionContext, **kwargs: str
-  ) -> None:
+  ) -> str:
     """Reads query, extract results and stores them in a specified location.
 
     Args:
       query: Location of the query.
       context: Query execution context.
     """
-    self.execute(query, context, **kwargs)
+    await self.execute(query, context, **kwargs)
 
   def execute(
     self,
     query: str,
     title: str,
     context: ApiExecutionContext,
-  ) -> None:
+  ) -> str:
     """Reads query, extract results and stores them in a specified location.
 
     Args:
@@ -102,6 +102,9 @@ class ApiQueryExecutor:
       title: Name of the query.
       context: Query execution context.
 
+    Returns:
+      Result of writing the report.
+
     Raises:
       GarfExecutorError: When failed to execute query.
     """
@@ -118,13 +121,14 @@ class ApiQueryExecutor:
         title,
         type(writer_client),
       )
-      writer_client.write(results, title)
+      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 result
     except Exception as e:
       logger.error('%s generated an exception: %s', title, str(e))
       raise exceptions.GarfExecutorError(

garf_executors/entrypoints/server.py

@@ -20,6 +20,7 @@ import uvicorn
 
 import garf_executors
 from garf_executors import exceptions
+from garf_io import reader
 
 
 class ApiExecutorRequest(pydantic.BaseModel):
@@ -27,16 +28,32 @@ class ApiExecutorRequest(pydantic.BaseModel):
 
   Attributes:
     source: Type of API to interact with.
-    query: Query to execute.
     title: Name of the query used as an output for writing.
+    query: Query to execute.
+    query_path: Local or remote path to query.
     context: Execution context.
   """
 
   source: str
-  query: str
-  title: str
+  title: str | None = None
+  query: str | None = None
+  query_path: str | None = None
   context: garf_executors.api_executor.ApiExecutionContext
 
+  @pydantic.model_validator(mode='after')
+  def check_query_specified(self):
+    if not self.query_path and not self.query:
+      raise exceptions.GarfExecutorError(
+        'Missing one of required parameters: query, query_path'
+      )
+    return self
+
+  def model_post_init(self, __context__) -> None:
+    if self.query_path:
+      self.query = reader.FileReader().read(self.query_path)
+    if not self.title:
+      self.title = str(self.query_path)
+
 
 router = fastapi.APIRouter(prefix='/api')
 
@@ -52,10 +69,10 @@ async def execute(request: ApiExecutorRequest) -> dict[str, str]:
     concrete_api_fetcher(**request.context.fetcher_parameters)
   )
 
-  query_executor.execute(request.query, request.title, request.context)
+  result = query_executor.execute(request.query, request.title, request.context)
 
   return fastapi.responses.JSONResponse(
-    content=fastapi.encoders.jsonable_encoder({'result': 'success'})
+    content=fastapi.encoders.jsonable_encoder({'result': result})
   )
 
 

garf_executors/entrypoints/utils.py

@@ -298,6 +298,8 @@ class ParamsParser:
     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,'
@@ -306,9 +308,10 @@ class ParamsParser:
       )
     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 {", ".join(self.identifiers)}'
+        f', supported arguments {supported_arguments}'
       )
     if provided_identifier != identifier:
       return None

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: garf-executors
-Version: 0.0.6
+Version: 0.0.7
 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

garf_executors-0.0.7.dist-info/RECORD

@@ -0,0 +1,15 @@
+garf_executors/__init__.py,sha256=PK4dnVynkPmJi8EGUYwbv4lwQ2ELO_cTO8FQaZV3VXA,858
+garf_executors/api_executor.py,sha256=HOIBg-bILtLNHqtiklZio5h5xXNwVAuZMIRJTL7_5_U,4104
+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=CALlrRaKiKFOvsE1uQyjtz2UxqEeh_QqR5nBMQgMjCs,2430
+garf_executors/entrypoints/utils.py,sha256=p483h5RY_kfwOhNq2RqwMnunOoTGXGA59nCyHY_Lvgg,15057
+garf_executors-0.0.7.dist-info/METADATA,sha256=NBFu6iIeYifvVVMCJOr_o9GpMAEp5aMBdnK4cW5FlEs,2648
+garf_executors-0.0.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+garf_executors-0.0.7.dist-info/entry_points.txt,sha256=LskWNFIw8j0WJuI18-32OZrlASXAMg1XtrRYwsKBz2E,61
+garf_executors-0.0.7.dist-info/top_level.txt,sha256=sP4dCXOENPn1hDFAunjMV8Js4NND_KGeO_gQWuaT0EY,15
+garf_executors-0.0.7.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,,