chore(knowledge-graph): restructure package

Author: AndreyMarkinPPC

libs/community/google/knowledge-graph/README.md

@@ -19,8 +19,8 @@
 
 ### Run as a library
 ```
-from garf_knowledge_graph_api import report_fetcher
-from garf_io import writer
+from garf.community.google.knowledge_graph import report_fetcher
+from garf.io import writer
 
 
 # Specify query

libs/community/google/knowledge-graph/garf/community/google/knowledge_graph/__init__.py

@@ -0,0 +1,31 @@
+# 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.
+
+"""Defines simplified imports."""
+
+from __future__ import annotations
+
+from garf.community.google.knowledge_graph.api_clients import (
+  KnowledgeGraphApiClient,
+)
+from garf.community.google.knowledge_graph.report_fetcher import (
+  KnowledgeGraphApiReportFetcher,
+)
+
+__all__ = [
+  'KnowledgeGraphApiClient',
+  'KnowledgeGraphApiReportFetcher',
+]
+
+__version__ = '0.0.1'

libs/community/google/knowledge-graph/garf/community/google/knowledge_graph/api_clients.py

@@ -0,0 +1,49 @@
+# 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.
+"""Creates API client for Knowledge Graph Search API."""
+
+import os
+
+import requests
+from garf.core import api_clients, query_editor
+from typing_extensions import override
+
+
+class KnowledgeGraphApiClient(api_clients.BaseClient):
+  def __init__(
+    self,
+    api_key: str = os.getenv('KG_API_KEY'),
+    **kwargs: str,
+  ) -> None:
+    """Initializes KnowledgeGraphApiClient."""
+    self.api_key = api_key
+    self.query_args = kwargs
+
+  @override
+  def get_response(
+    self, request: query_editor.BaseQueryElements, **kwargs: str
+  ) -> api_clients.GarfApiResponse:
+    service_url = 'https://kgsearch.googleapis.com/v1/entities:search'
+    params = {
+      request.resource_name: request.filters,
+      'limit': 100,
+      'key': self.api_key,
+    }
+    response = requests.get(service_url, params=params)
+    results = []
+    for result in response.json().get('itemListElement', []):
+      tmp_result = result.get('result')
+      tmp_result.update({'result_score': result.get('resultScore')})
+      results.append(tmp_result)
+    return api_clients.GarfApiResponse(results=results)

libs/community/google/knowledge-graph/garf/community/google/knowledge_graph/query_editor.py

@@ -0,0 +1,38 @@
+# 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.
+"""Defines KnowledgeGraphApiQuery."""
+
+from garf.core import query_editor
+from typing_extensions import Self
+
+
+class KnowledgeGraphApiQuery(query_editor.QuerySpecification):
+  """Query to Knowledge Graph Search api."""
+
+  def __init__(
+    self,
+    text: str,
+    title: str | None = None,
+    args: dict[str, str] | None = None,
+    **kwargs,
+  ) -> None:
+    """Initializes KnowledgeGraphApiQuery."""
+    super().__init__(text, title, args, **kwargs)
+
+  def extract_column_names(self) -> Self:
+    """Removes extra symbols from column names."""
+    for line in self._extract_query_lines():
+      line_elements = query_editor.ExtractedLineElements.from_query_line(line)
+      self.query.column_names.append(line_elements.alias.replace('@', ''))
+    return self

libs/community/google/knowledge-graph/garf/community/google/knowledge_graph/report_fetcher.py

@@ -0,0 +1,84 @@
+# 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.
+
+"""Defines report fetcher."""
+
+import functools
+import itertools
+import operator
+from collections.abc import Iterable, MutableSequence
+from typing import Any, Final
+
+from garf.community.google.knowledge_graph import (
+  KnowledgeGraphApiClient,
+  query_editor,
+)
+from garf.core import parsers, report, report_fetcher
+from typing_extensions import override
+
+ALLOWED_QUERY_PARAMETERS: Final[set[str]] = (
+  'query',
+  'ids',
+  'languages',
+  'prefix',
+)
+
+MAX_BATCH_SIZE: Final[int] = 100
+
+
+def _batched(iterable: Iterable[str], chunk_size: int):
+  iterator = iter(iterable)
+  while chunk := list(itertools.islice(iterator, chunk_size)):
+    yield chunk
+
+
+class KnowledgeGraphApiReportFetcher(report_fetcher.ApiReportFetcher):
+  """Defines report fetcher."""
+
+  def __init__(
+    self,
+    api_client: KnowledgeGraphApiClient = KnowledgeGraphApiClient(),
+    parser: parsers.BaseParser = parsers.NumericConverterDictParser,
+    query_spec: query_editor.KnowledgeGraphApiQuery = (
+      query_editor.KnowledgeGraphApiQuery,
+    ),
+    **kwargs: str,
+  ) -> None:
+    """Initializes KnowledgeGraphApiReportFetcher."""
+    super().__init__(api_client, parser, query_spec, **kwargs)
+
+  @override
+  def fetch(
+    self,
+    query_specification,
+    args: dict[str, Any] = None,
+    **kwargs,
+  ) -> report.GarfReport:
+    results = []
+    filter_identifier = list(
+      set(ALLOWED_QUERY_PARAMETERS).intersection(set(kwargs.keys()))
+    )
+    if len(filter_identifier) == 1:
+      name = filter_identifier[0]
+      ids = kwargs.pop(name)
+      if not isinstance(ids, MutableSequence):
+        ids = ids.split(',')
+    else:
+      return super().fetch(query_specification, args, **kwargs)
+    for batch in _batched(ids, MAX_BATCH_SIZE):
+      batch_ids = {name: batch[0]} if name != 'id' else {name: batch}
+      results.append(
+        super().fetch(query_specification, args, **batch_ids, **kwargs)
+      )
+    return functools.reduce(operator.add, results)

libs/community/google/knowledge-graph/garf_knowledge_graph_api/__init__.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.
@@ -12,18 +12,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""Defines simplified imports."""
+import warnings
 
-from __future__ import annotations
+from garf.community.google.knowledge_graph import *
 
-from garf_knowledge_graph_api.api_clients import KnowledgeGraphApiClient
-from garf_knowledge_graph_api.report_fetcher import (
-  KnowledgeGraphApiReportFetcher,
+warnings.warn(
+  "The 'garf_knowledge_graph_api' namespace is deprecated. "
+  "Please use 'garf.community.google.knowledge_graph' instead.",
+  DeprecationWarning,
+  stacklevel=2,
 )
-
-__all__ = [
-  'KnowledgeGraphApiClient',
-  'KnowledgeGraphApiReportFetcher',
-]
-
-__version__ = '0.0.1'

libs/community/google/knowledge-graph/garf_knowledge_graph_api/api_clients.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.
@@ -11,39 +11,14 @@
 # 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.
-"""Creates API client for Knowledge Graph Search API."""
 
-import os
+import warnings
 
-import requests
-from garf_core import api_clients, query_editor
-from typing_extensions import override
+from garf.community.google.knowledge_graph.api_clients import *
 
-
-class KnowledgeGraphApiClient(api_clients.BaseClient):
-  def __init__(
-    self,
-    api_key: str = os.getenv('KG_API_KEY'),
-    **kwargs: str,
-  ) -> None:
-    """Initializes KnowledgeGraphApiClient."""
-    self.api_key = api_key
-    self.query_args = kwargs
-
-  @override
-  def get_response(
-    self, request: query_editor.BaseQueryElements, **kwargs: str
-  ) -> api_clients.GarfApiResponse:
-    service_url = 'https://kgsearch.googleapis.com/v1/entities:search'
-    params = {
-      request.resource_name: request.filters,
-      'limit': 100,
-      'key': self.api_key,
-    }
-    response = requests.get(service_url, params=params)
-    results = []
-    for result in response.json().get('itemListElement', []):
-      tmp_result = result.get('result')
-      tmp_result.update({'result_score': result.get('resultScore')})
-      results.append(tmp_result)
-    return api_clients.GarfApiResponse(results=results)
+warnings.warn(
+  "The 'garf_knowledge_graph_api' namespace is deprecated. "
+  "Please use 'garf.community.google.knowledge_graph' instead.",
+  DeprecationWarning,
+  stacklevel=2,
+)

libs/community/google/knowledge-graph/garf_knowledge_graph_api/query_editor.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.
@@ -11,28 +11,14 @@
 # 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 KnowledgeGraphApiQuery."""
 
-from garf_core import query_editor
-from typing_extensions import Self
+import warnings
 
+from garf.community.google.knowledge_graph.query_editor import *
 
-class KnowledgeGraphApiQuery(query_editor.QuerySpecification):
-  """Query to Knowledge Graph Search api."""
-
-  def __init__(
-    self,
-    text: str,
-    title: str | None = None,
-    args: dict[str, str] | None = None,
-    **kwargs,
-  ) -> None:
-    """Initializes KnowledgeGraphApiQuery."""
-    super().__init__(text, title, args, **kwargs)
-
-  def extract_column_names(self) -> Self:
-    """Removes extra symbols from column names."""
-    for line in self._extract_query_lines():
-      line_elements = query_editor.ExtractedLineElements.from_query_line(line)
-      self.query.column_names.append(line_elements.alias.replace('@', ''))
-    return self
+warnings.warn(
+  "The 'garf_knowledge_graph_api' namespace is deprecated. "
+  "Please use 'garf.community.google.knowledge_graph' instead.",
+  DeprecationWarning,
+  stacklevel=2,
+)