[core] chore: ensure that Rest and FakeApiReportFetcher are confirming ApiReportFetcher interface

* Always accept api_client as a first argument of __init__
* Add class methods for initializing clients (FakeApiReportFetcher.from_data and RestApiClient.from_endpoint)

Author: AndreyMarkinPPC

libs/garf_core/garf_core/__init__.py

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

libs/garf_core/garf_core/fetchers/fake.py

@@ -20,6 +20,8 @@
 
 import logging
 import os
+from collections.abc import Sequence
+from typing import Any
 
 from garf_core import (
   api_clients,
@@ -36,7 +38,7 @@ class FakeApiReportFetcher(report_fetcher.ApiReportFetcher):
 
   def __init__(
     self,
-    data: list[dict[str, parsers.ApiRowElement]] | None = None,
+    api_client: api_clients.FakeApiClient | None = None,
     parser: parsers.BaseParser = parsers.DictParser,
     query_specification_builder: query_editor.QuerySpecification = (
       query_editor.QuerySpecification
@@ -46,29 +48,33 @@ def __init__(
     json_location: str | os.PathLike[str] | None = None,
     **kwargs: str,
   ) -> None:
-    if not data and not (
+    if not api_client and not (
       data_location := json_location or csv_location or data_location
     ):
       raise report_fetcher.ApiReportFetcherError(
         'Missing fake data for the fetcher.'
       )
-    api_client = (
-      api_clients.FakeApiClient(data)
-      if data
-      else api_clients.FakeApiClient.from_file(data_location)
-    )
+    if not api_client:
+      api_client = api_clients.FakeApiClient.from_file(data_location)
     super().__init__(api_client, parser, query_specification_builder, **kwargs)
 
+  @classmethod
+  def from_data(cls, data: Sequence[dict[str, Any]]) -> FakeApiReportFetcher:
+    """Initializes FakeApiReportFetcher from a sequence of data."""
+    return FakeApiReportFetcher(
+      api_client=api_clients.FakeApiClient(results=data)
+    )
+
   @classmethod
   def from_csv(
     cls, file_location: str | os.PathLike[str]
   ) -> FakeApiReportFetcher:
-    """Initialized FakeApiReportFetcher from a csv file."""
+    """Initializes FakeApiReportFetcher from a csv file."""
     return FakeApiReportFetcher(csv_location=file_location)
 
   @classmethod
   def from_json(
     cls, file_location: str | os.PathLike[str]
   ) -> FakeApiReportFetcher:
-    """Initialized FakeApiReportFetcher from a json file."""
+    """Initializes FakeApiReportFetcher from a json file."""
     return FakeApiReportFetcher(json_location=file_location)

libs/garf_core/garf_core/fetchers/rest.py

@@ -40,11 +40,12 @@ class RestApiReportFetcher(report_fetcher.ApiReportFetcher):
 
   def __init__(
     self,
-    endpoint: str,
+    api_client: api_clients.RestApiClient | None = None,
     parser: parsers.BaseParser = parsers.DictParser,
     query_specification_builder: query_editor.QuerySpecification = (
       query_editor.QuerySpecification
     ),
+    endpoint: str | None = None,
     **kwargs: str,
   ) -> None:
     """Instantiates RestApiReportFetcher.
@@ -54,5 +55,17 @@ def __init__(
       parser: Type of parser to convert API response.
       query_specification_builder: Class to perform query parsing.
     """
-    api_client = api_clients.RestApiClient(endpoint)
+    if not api_client and not endpoint:
+      raise report_fetcher.ApiReportFetcherError(
+        'Missing api_client or endpoint for the fetcher.'
+      )
+    if not api_client:
+      api_client = api_clients.RestApiClient(endpoint)
     super().__init__(api_client, parser, query_specification_builder, **kwargs)
+
+  @classmethod
+  def from_endpoint(cls, endpoint: str) -> RestApiReportFetcher:
+    """Initializes RestApiReportFetcher: from an API endpoint."""
+    return RestApiReportFetcher(
+      api_client=api_clients.RestApiClient(endpoint=endpoint)
+    )

libs/garf_core/tests/unit/fetchers/test_fake.py

@@ -27,7 +27,7 @@ class TestFakeApiReportFetcher:
   ]
 
   def test_fetch_from_data_returns_correct_result(self):
-    fetcher = FakeApiReportFetcher(data=self.data)
+    fetcher = FakeApiReportFetcher.from_data(self.data)
 
     result = fetcher.fetch(
       'SELECT field1.subfield AS column_name FROM resource_name'