github-haystack 2.0.0__tar.gz → 2.1.0__tar.gz

{github_haystack-2.0.0 → github_haystack-2.1.0}/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## [integrations/github-v2.0.0] - 2026-01-12
+
+### 📚 Documentation
+
+- Add pydoc configurations for Docusaurus (#2411)
+
+### ⚙️ CI
+
+- Change pytest command (#2475)
+
+### 🧹 Chores
+
+- Remove Readme API CI workflow and configs (#2573)
+- Fix nightly test (#2580)
+- Make fmt command more forgiving (#2671)
+- [**breaking**] Github - drop Python 3.9 and use X|Y typing (#2705)
+
+### 🌀 Miscellaneous
+
+- Adopt PEP 585 type hinting (part 3) (#2510)
+- Chore: Fix tool validation test failures in github integration (#2659)
+- Fix: Fix github integration unit tests (#2703)
+
 ## [integrations/github-v1.2.1] - 2025-10-20
 
 ### 🚀 Features

{github_haystack-2.0.0 → github_haystack-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: github-haystack
-Version: 2.0.0
+Version: 2.1.0
 Summary: Haystack components for interacting with GitHub repositories
 Project-URL: Source, https://github.com/deepset-ai/haystack-core-integrations/github
 Project-URL: Documentation, https://github.com/deepset-ai/haystack-core-integrations/blob/main/integrations/github/README.md
@@ -15,6 +15,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.10

github_haystack-2.1.0/pydoc/config_docusaurus.yml

@@ -0,0 +1,18 @@
+loaders:
+  - modules:
+      - haystack_integrations.components.connectors.github.file_editor
+      - haystack_integrations.components.connectors.github.issue_commenter
+      - haystack_integrations.components.connectors.github.issue_viewer
+      - haystack_integrations.components.connectors.github.pr_creator
+      - haystack_integrations.components.connectors.github.repo_viewer
+      - haystack_integrations.components.connectors.github.repo_forker
+    search_path: [../src]
+processors:
+  - type: filter
+    documented_only: true
+    skip_empty_modules: true
+renderer:
+  description: GitHub integration for Haystack
+  id: integrations-github
+  filename: github.md
+  title: GitHub

{github_haystack-2.0.0 → github_haystack-2.1.0}/pyproject.toml

@@ -19,6 +19,7 @@ classifiers = [
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
   "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
   "Programming Language :: Python :: Implementation :: CPython",
   "Programming Language :: Python :: Implementation :: PyPy",
 ]
@@ -45,7 +46,7 @@ installer = "uv"
 dependencies = ["haystack-pydoc-tools", "ruff"]
 
 [tool.hatch.envs.default.scripts]
-docs = ["pydoc-markdown pydoc/config_docusaurus.yml"]
+docs = ["haystack-pydoc pydoc/config_docusaurus.yml"]
 fmt = "ruff check --fix {args}; ruff format {args}"
 fmt-check = "ruff check {args} && ruff format --check {args}"
 
@@ -63,7 +64,8 @@ dependencies = [
 unit = 'pytest -m "not integration" {args:tests}'
 integration = 'pytest -m "integration" {args:tests}'
 all = 'pytest {args:tests}'
-cov-retry = 'pytest --cov=haystack_integrations --reruns 3 --reruns-delay 30 -x {args:tests}'
+unit-cov-retry = 'pytest --cov=haystack_integrations --reruns 3 --reruns-delay 30 -x -m "not integration" {args:tests}'
+integration-cov-append-retry = 'pytest --cov=haystack_integrations --cov-append --reruns 3 --reruns-delay 30 -x -m "integration" {args:tests}'
 
 types = """mypy -p haystack_integrations.components.connectors.github \
 -p haystack_integrations.prompts.github \
@@ -81,9 +83,17 @@ line-length = 120
 [tool.ruff.lint]
 select = [
   "A",
+  "ANN",
   "ARG",
   "B",
   "C",
+  "D102",   # Missing docstring in public method
+  "D103",   # Missing docstring in public function
+  "D205",   # 1 blank line required between summary line and description
+  "D209",   # Closing triple quotes go to new line
+  "D213",   # summary lines must be positioned on the second physical line of the docstring
+  "D417",   # Missing argument descriptions in the docstring
+  "D419",   # Docstring is empty
   "DTZ",
   "E",
   "EM",
@@ -121,6 +131,8 @@ ignore = [
   # Misc
   "B008",
   "S101",
+  # Allow `Any` - used legitimately for dynamic types and SDK boundaries
+  "ANN401",
 ]
 
 [tool.ruff.lint.isort]
@@ -131,13 +143,14 @@ ban-relative-imports = "parents"
 
 [tool.ruff.lint.per-file-ignores]
 # Tests can use magic values, assertions, and relative imports
-"tests/**/*" = ["PLR2004", "S101", "TID252"]
+"tests/**/*" = ["D", "PLR2004", "S101", "TID252", "ANN"]
 # Ignore RUF001 for all files in the prompts directory
 "src/haystack_integrations/components/prompts/**/*" = ["RUF001"]
 
 [tool.coverage.run]
 source = ["haystack_integrations"]
 branch = true
+relative_files = true
 parallel = false
 
 

{github_haystack-2.0.0 → github_haystack-2.1.0}/src/haystack_integrations/components/connectors/github/file_editor.py

@@ -82,7 +82,7 @@ class GitHubFileEditor:
         repo: str | None = None,
         branch: str = "main",
         raise_on_failure: bool = True,
-    ):
+    ) -> None:
         """
         Initialize the component.
 

{github_haystack-2.0.0 → github_haystack-2.1.0}/src/haystack_integrations/components/connectors/github/issue_commenter.py

@@ -41,7 +41,7 @@ class GitHubIssueCommenter:
         github_token: Secret = Secret.from_env_var("GITHUB_TOKEN"),
         raise_on_failure: bool = True,
         retry_attempts: int = 2,
-    ):
+    ) -> None:
         """
         Initialize the component.
 

{github_haystack-2.0.0 → github_haystack-2.1.0}/src/haystack_integrations/components/connectors/github/issue_viewer.py

@@ -40,7 +40,7 @@ class GitHubIssueViewer:
         github_token: Secret | None = None,
         raise_on_failure: bool = True,
         retry_attempts: int = 2,
-    ):
+    ) -> None:
         """
         Initialize the component.
 

{github_haystack-2.0.0 → github_haystack-2.1.0}/src/haystack_integrations/components/connectors/github/pr_creator.py

@@ -38,7 +38,12 @@ class GitHubPRCreator:
     ```
     """
 
-    def __init__(self, *, github_token: Secret = Secret.from_env_var("GITHUB_TOKEN"), raise_on_failure: bool = True):
+    def __init__(
+        self,
+        *,
+        github_token: Secret = Secret.from_env_var("GITHUB_TOKEN"),
+        raise_on_failure: bool = True,
+    ) -> None:
         """
         Initialize the component.
 

{github_haystack-2.0.0 → github_haystack-2.1.0}/src/haystack_integrations/components/connectors/github/repo_forker.py

@@ -48,7 +48,7 @@ class GitHubRepoForker:
         poll_interval: int = 2,
         auto_sync: bool = True,
         create_branch: bool = True,
-    ):
+    ) -> None:
         """
         Initialize the component.
 

{github_haystack-2.0.0 → github_haystack-2.1.0}/src/haystack_integrations/components/connectors/github/repo_viewer.py

@@ -76,7 +76,7 @@ class GitHubRepoViewer:
         max_file_size: int = 1_000_000,  # 1MB default limit
         repo: str | None = None,
         branch: str = "main",
-    ):
+    ) -> None:
         """
         Initialize the component.
 

{github_haystack-2.0.0 → github_haystack-2.1.0}/src/haystack_integrations/tools/github/file_editor_tool.py

@@ -31,7 +31,7 @@ class GitHubFileEditorTool(ComponentTool):
         outputs_to_string: dict[str, str | Callable[[Any], str]] | None = None,
         inputs_from_state: dict[str, str] | None = None,
         outputs_to_state: dict[str, dict[str, str | Callable]] | None = None,
-    ):
+    ) -> None:
         """
         Initialize the GitHub file editor tool.
 

{github_haystack-2.0.0 → github_haystack-2.1.0}/src/haystack_integrations/tools/github/issue_commenter_tool.py

@@ -30,7 +30,7 @@ class GitHubIssueCommenterTool(ComponentTool):
         outputs_to_string: dict[str, str | Callable[[Any], str]] | None = None,
         inputs_from_state: dict[str, str] | None = None,
         outputs_to_state: dict[str, dict[str, str | Callable]] | None = None,
-    ):
+    ) -> None:
         """
         Initialize the GitHub issue commenter tool.
 

{github_haystack-2.0.0 → github_haystack-2.1.0}/src/haystack_integrations/tools/github/issue_viewer_tool.py

@@ -30,7 +30,7 @@ class GitHubIssueViewerTool(ComponentTool):
         outputs_to_string: dict[str, str | Callable[[Any], str]] | None = None,
         inputs_from_state: dict[str, str] | None = None,
         outputs_to_state: dict[str, dict[str, str | Callable]] | None = None,
-    ):
+    ) -> None:
         """
         Initialize the GitHub issue viewer tool.
 

{github_haystack-2.0.0 → github_haystack-2.1.0}/src/haystack_integrations/tools/github/pr_creator_tool.py

@@ -29,7 +29,7 @@ class GitHubPRCreatorTool(ComponentTool):
         outputs_to_string: dict[str, str | Callable[[Any], str]] | None = None,
         inputs_from_state: dict[str, str] | None = None,
         outputs_to_state: dict[str, dict[str, str | Callable]] | None = None,
-    ):
+    ) -> None:
         """
         Initialize the GitHub PR creator tool.
 

{github_haystack-2.0.0 → github_haystack-2.1.0}/src/haystack_integrations/tools/github/repo_forker_tool.py

@@ -29,7 +29,7 @@ class GitHubRepoForkerTool(ComponentTool):
         outputs_to_string: dict[str, str | Callable[[Any], str]] | None = None,
         inputs_from_state: dict[str, str] | None = None,
         outputs_to_state: dict[str, dict[str, str | Callable]] | None = None,
-    ):
+    ) -> None:
         """
         Initialize the GitHub Repo Forker tool.
 

{github_haystack-2.0.0 → github_haystack-2.1.0}/src/haystack_integrations/tools/github/repo_viewer_tool.py

@@ -32,7 +32,7 @@ class GitHubRepoViewerTool(ComponentTool):
         outputs_to_string: dict[str, str | Callable[[Any], str]] | None = None,
         inputs_from_state: dict[str, str] | None = None,
         outputs_to_state: dict[str, dict[str, str | Callable]] | None = None,
-    ):
+    ) -> None:
         """
         Initialize the GitHub repository viewer tool.
 

{github_haystack-2.0.0 → github_haystack-2.1.0}/src/haystack_integrations/tools/github/utils.py

@@ -21,7 +21,7 @@ def message_handler(documents: list[Document], max_length: int = 150_000) -> str
     result_str = ""
     for document in documents:
         if document.meta["type"] in ["file", "dir", "error"]:
-            result_str += document.content or "" + "\n"
+            result_str += (document.content or "") + "\n"
         else:
             result_str += f"File Content for {document.meta['path']}\n\n"
             result_str += document.content or ""
@@ -29,7 +29,7 @@ def message_handler(documents: list[Document], max_length: int = 150_000) -> str
     if len(result_str) > max_length:
         result_str = result_str[:max_length] + "...(large file can't be fully displayed)"
 
-    return result_str
+    return result_str.strip()
 
 
 def serialize_handlers(

{github_haystack-2.0.0 → github_haystack-2.1.0}/tests/test_file_editor.py

@@ -280,3 +280,94 @@ class TestGitHubFileEditor:
         assert "Authorization" not in headers
         assert headers["Accept"] == "application/vnd.github.v3+json"
         assert headers["User-Agent"] == "Haystack/GitHubFileEditor"
+
+    @pytest.mark.parametrize(
+        "file_b64,original,expected",
+        [
+            ("SGVsbG8gV29ybGQ=", "missing", "Error: Original string not found in file"),
+            ("SGVsbG8gSGVsbG8=", "Hello", "Error: Original string appears multiple times. Please provide more context"),
+        ],
+    )
+    @patch("requests.get")
+    def test_run_edit_string_edge_cases(self, mock_get, file_b64, original, expected, monkeypatch):
+        monkeypatch.setenv("GITHUB_TOKEN", "test-token")
+        mock_get.return_value.json.return_value = {"content": file_b64, "sha": "abc123"}
+        mock_get.return_value.raise_for_status.return_value = None
+
+        editor = GitHubFileEditor()
+        result = editor.run(
+            command=Command.EDIT,
+            payload={"path": "f.txt", "original": original, "replacement": "X", "message": "m"},
+            repo="owner/repo",
+            branch="main",
+        )
+        assert result["result"] == expected
+
+    @patch("requests.get")
+    def test_run_undo_not_last_user(self, mock_get, monkeypatch):
+        monkeypatch.setenv("GITHUB_TOKEN", "test-token")
+
+        mock_get.return_value.raise_for_status.return_value = None
+        mock_get.return_value.json.side_effect = [
+            [{"author": {"login": "different_user"}, "sha": "sha1"}],
+            {"login": "another_user"},
+        ]
+
+        editor = GitHubFileEditor()
+        result = editor.run(command=Command.UNDO, payload={"message": "m"}, repo="owner/repo", branch="main")
+        assert result["result"] == "Error: Last commit was not made by the current user"
+
+    @pytest.mark.parametrize(
+        "kwargs,expected_substring",
+        [
+            ({"command": Command.EDIT, "payload": {}}, "Error: No repository specified"),
+            (
+                {"command": "bogus", "payload": {}, "repo": "owner/repo"},
+                None,
+            ),
+        ],
+    )
+    def test_run_validation_errors(self, kwargs, expected_substring, monkeypatch):
+        monkeypatch.setenv("GITHUB_TOKEN", "test-token")
+        editor = GitHubFileEditor()
+        if expected_substring is None:
+            with pytest.raises(ValueError):
+                editor.run(**kwargs)
+        else:
+            result = editor.run(**kwargs)
+            assert expected_substring in result["result"]
+
+    @patch("requests.get")
+    def test_run_command_as_string(self, mock_get, monkeypatch):
+        monkeypatch.setenv("GITHUB_TOKEN", "test-token")
+        mock_get.return_value.json.return_value = {"content": "SGVsbG8=", "sha": "abc"}
+        mock_get.return_value.raise_for_status.return_value = None
+
+        editor = GitHubFileEditor(repo="owner/repo")
+        with patch.object(editor, "_update_file", return_value=True):
+            result = editor.run(
+                command="EDIT",
+                payload={"path": "f.txt", "original": "Hello", "replacement": "Hi", "message": "m"},
+            )
+        assert result["result"] == "Edit successful"
+
+    @pytest.mark.parametrize(
+        "command,payload",
+        [
+            (Command.UNDO, {"message": "m"}),
+            (Command.CREATE, {"path": "n.txt", "content": "x", "message": "m"}),
+            (Command.DELETE, {"path": "n.txt", "message": "m"}),
+        ],
+    )
+    @patch("requests.get")
+    def test_run_command_error_handling_no_raise(self, mock_get, command, payload, monkeypatch):
+        monkeypatch.setenv("GITHUB_TOKEN", "test-token")
+        mock_get.side_effect = requests.RequestException("API Error")
+
+        editor = GitHubFileEditor(raise_on_failure=False)
+        with (
+            patch("requests.put", side_effect=requests.RequestException("API Error")),
+            patch("requests.delete", side_effect=requests.RequestException("API Error")),
+        ):
+            result = editor.run(command=command, payload=payload, repo="owner/repo", branch="main")
+        assert "Error: API Error" in result["result"]

{github_haystack-2.0.0 → github_haystack-2.1.0}/tests/test_file_editor_tool.py

@@ -205,6 +205,13 @@ class TestGitHubFileEditorTool:
             "connection_type_validation": True,
         }
 
+        # Compatibility with newer versions of Haystack that include these parameters
+        for key in ["confirmation_strategies", "required_variables", "user_prompt"]:
+            if key in pipeline_dict["components"]["agent"]["init_parameters"]:
+                expected_dict["components"]["agent"]["init_parameters"][key] = pipeline_dict["components"]["agent"][
+                    "init_parameters"
+                ][key]
+
         assert pipeline_dict == expected_dict
 
         deserialized_pipeline = Pipeline.from_dict(pipeline_dict)

{github_haystack-2.0.0 → github_haystack-2.1.0}/tests/test_pr_creator.py

@@ -143,3 +143,82 @@ class TestGitHubPRCreator:
         assert "Authorization" not in headers
         assert headers["Accept"] == "application/vnd.github.v3+json"
         assert headers["User-Agent"] == "Haystack/GitHubPRCreator"
+
+    def test_parse_issue_url_invalid(self, monkeypatch):
+        monkeypatch.setenv("GITHUB_TOKEN", "test-token")
+        pr_creator = GitHubPRCreator()
+        with pytest.raises(ValueError, match="Invalid GitHub issue URL format"):
+            pr_creator._parse_issue_url("https://github.com/owner/repo/pull/1")
+
+    @patch("requests.get")
+    def test_run_returns_error_when_fork_not_found(self, mock_get, monkeypatch):
+        monkeypatch.setenv("GITHUB_TOKEN", "test-token")
+        mock_get.return_value.json.return_value = {"login": "test_user"}
+        mock_get.return_value.raise_for_status.return_value = None
+
+        pr_creator = GitHubPRCreator()
+        with patch.object(pr_creator, "_check_fork_exists", return_value=False):
+            result = pr_creator.run(
+                issue_url="https://github.com/owner/repo/issues/456",
+                title="Test PR",
+                branch="feature-branch",
+                base="main",
+            )
+        assert result == {"result": "Error: Fork not found at test_user/repo"}
+
+    @pytest.mark.parametrize(
+        "fork_payload,raises_request,expected",
+        [
+            ({"fork": True}, False, True),
+            ({"fork": False}, False, False),
+            ({}, False, False),
+            (None, True, False),
+        ],
+    )
+    @patch("requests.get")
+    def test_check_fork_exists(self, mock_get, fork_payload, raises_request, expected, monkeypatch):
+        monkeypatch.setenv("GITHUB_TOKEN", "test-token")
+        if raises_request:
+            mock_get.side_effect = requests.RequestException("boom")
+        else:
+            mock_get.return_value.json.return_value = fork_payload
+            mock_get.return_value.raise_for_status.return_value = None
+
+        pr_creator = GitHubPRCreator()
+        assert pr_creator._check_fork_exists("repo", "test_user") is expected
+
+    @pytest.mark.parametrize("raise_on_failure", [True, False])
+    @patch("requests.post")
+    def test_create_fork(self, mock_post, raise_on_failure, monkeypatch):
+        monkeypatch.setenv("GITHUB_TOKEN", "test-token")
+        mock_post.return_value.json.return_value = {"owner": {"login": "test_user"}}
+        mock_post.return_value.raise_for_status.return_value = None
+
+        pr_creator = GitHubPRCreator(raise_on_failure=raise_on_failure)
+        assert pr_creator._create_fork("owner", "repo") == "test_user"
+
+        mock_post.side_effect = requests.RequestException("boom")
+        if raise_on_failure:
+            with pytest.raises(RuntimeError, match="Failed to create fork"):
+                pr_creator._create_fork("owner", "repo")
+        else:
+            assert pr_creator._create_fork("owner", "repo") is None
+
+    @pytest.mark.parametrize("raise_on_failure", [True, False])
+    @patch("requests.post")
+    @patch("requests.get")
+    def test_create_branch(self, mock_get, mock_post, raise_on_failure, monkeypatch):
+        monkeypatch.setenv("GITHUB_TOKEN", "test-token")
+        mock_get.return_value.json.return_value = {"object": {"sha": "abc123"}}
+        mock_get.return_value.raise_for_status.return_value = None
+        mock_post.return_value.raise_for_status.return_value = None
+
+        pr_creator = GitHubPRCreator(raise_on_failure=raise_on_failure)
+        assert pr_creator._create_branch("owner", "repo", "feature", "main") is True
+
+        mock_get.side_effect = requests.RequestException("boom")
+        if raise_on_failure:
+            with pytest.raises(RuntimeError, match="Failed to create branch"):
+                pr_creator._create_branch("owner", "repo", "feature", "main")
+        else:
+            assert pr_creator._create_branch("owner", "repo", "feature", "main") is False

{github_haystack-2.0.0 → github_haystack-2.1.0}/tests/test_repo_forker.py

@@ -272,3 +272,57 @@ class TestGitHubRepoForker:
         assert "Authorization" not in headers
         assert headers["Accept"] == "application/vnd.github.v3+json"
         assert headers["User-Agent"] == "Haystack/GitHubRepoForker"
+
+    @pytest.mark.parametrize(
+        "status_code,raises,expected",
+        [
+            (200, False, True),
+            (404, False, False),
+            (None, True, False),
+        ],
+    )
+    @patch("requests.get")
+    def test_check_fork_status(self, mock_get, status_code, raises, expected, monkeypatch):
+        monkeypatch.setenv("GITHUB_TOKEN", "test-token")
+        if raises:
+            mock_get.side_effect = requests.RequestException("boom")
+        else:
+            mock_get.return_value.status_code = status_code
+
+        forker = GitHubRepoForker()
+        assert forker._check_fork_status("test_user/repo") is expected
+
+    def test_get_existing_repository_returns_none_on_exception(self, monkeypatch):
+        monkeypatch.setenv("GITHUB_TOKEN", "test-token")
+
+        forker = GitHubRepoForker()
+        with (
+            patch.object(forker, "_get_authenticated_user", return_value="test_user"),
+            patch("requests.get", side_effect=requests.RequestException("boom")),
+        ):
+            assert forker._get_existing_repository("repo") is None
+
+    @pytest.mark.parametrize("succeeds_within_timeout", [True, False])
+    def test_run_wait_for_completion(self, succeeds_within_timeout, monkeypatch):
+        monkeypatch.setenv("GITHUB_TOKEN", "test-token")
+
+        forker = GitHubRepoForker(
+            wait_for_completion=True,
+            max_wait_seconds=5 if succeeds_within_timeout else 0,
+            poll_interval=0,
+            create_branch=False,
+        )
+        with (
+            patch.object(forker, "_parse_github_url", return_value=("owner", "repo", "123")),
+            patch.object(forker, "_get_authenticated_user", return_value="test_user"),
+            patch.object(forker, "_get_existing_repository", return_value=None),
+            patch.object(forker, "_create_fork", return_value="test_user/repo"),
+            patch.object(forker, "_check_fork_status", side_effect=[False, True]),
+            patch("time.sleep", lambda _: None),
+        ):
+            if succeeds_within_timeout:
+                result = forker.run(url="https://github.com/owner/repo/issues/123")
+                assert result == {"repo": "test_user/repo", "issue_branch": None}
+            else:
+                with pytest.raises(TimeoutError):
+                    forker.run(url="https://github.com/owner/repo/issues/123")

{github_haystack-2.0.0 → github_haystack-2.1.0}/tests/test_repo_viewer.py

@@ -186,3 +186,52 @@ class TestGitHubRepoViewer:
         assert "Authorization" not in headers
         assert headers["Accept"] == "application/vnd.github.v3+json"
         assert headers["User-Agent"] == "Haystack/GitHubRepoViewer"
+
+    def test_run_no_repo_raises(self, monkeypatch):
+        monkeypatch.setenv("GITHUB_TOKEN", "test-token")
+        viewer = GitHubRepoViewer()
+        with pytest.raises(ValueError, match="Repository not provided"):
+            viewer.run(path="README.md")
+
+    @pytest.mark.parametrize(
+        "file_payload,error_substring",
+        [
+            (
+                {
+                    "name": "big.bin",
+                    "path": "big.bin",
+                    "size": 2_000_000,
+                    "html_url": "https://x",
+                    "content": "",
+                    "encoding": "base64",
+                },
+                "exceeds limit",
+            ),
+            (
+                {
+                    "name": "raw.txt",
+                    "path": "raw.txt",
+                    "size": 5,
+                    "html_url": "https://x",
+                    "content": "Hello",
+                    "encoding": "utf-8",
+                },
+                None,
+            ),
+        ],
+    )
+    @patch("requests.get")
+    def test_run_file_size_and_encoding(self, mock_get, file_payload, error_substring, monkeypatch):
+        monkeypatch.setenv("GITHUB_TOKEN", "test-token")
+        mock_get.return_value.json.return_value = file_payload
+        mock_get.return_value.raise_for_status.return_value = None
+
+        viewer = GitHubRepoViewer(raise_on_failure=False)
+        result = viewer.run(repo="owner/repo", path=file_payload["path"])
+        doc = result["documents"][0]
+        if error_substring is None:
+            assert doc.content == "Hello"
+            assert doc.meta["type"] == "file_content"
+        else:
+            assert doc.meta["type"] == "error"
+            assert error_substring in doc.content

github_haystack-2.1.0/tests/test_utils.py

@@ -0,0 +1,63 @@
+# SPDX-FileCopyrightText: 2023-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+import pytest
+from haystack import Document
+
+from haystack_integrations.tools.github.utils import message_handler, serialize_handlers
+
+
+class TestMessageHandler:
+    @pytest.mark.parametrize(
+        "documents,expected",
+        [
+            (
+                [Document(content="error message", meta={"type": "error"})],
+                "error message",
+            ),
+            (
+                [
+                    Document(content="docs", meta={"type": "dir"}),
+                    Document(content="README.md", meta={"type": "file"}),
+                ],
+                "docs\nREADME.md",
+            ),
+            (
+                [Document(content="print('hi')", meta={"type": "file_content", "path": "main.py"})],
+                "File Content for main.py\n\nprint('hi')",
+            ),
+        ],
+    )
+    def test_message_handler_renders_documents(self, documents, expected):
+        assert message_handler(documents) == expected
+
+    def test_message_handler_truncates_to_max_length(self):
+        big_content = "x" * 200
+        doc = Document(content=big_content, meta={"type": "file_content", "path": "main.py"})
+        result = message_handler([doc], max_length=50)
+        assert result.endswith("...(large file can't be fully displayed)")
+        assert len(result) == 50 + len("...(large file can't be fully displayed)")
+
+
+class TestSerializeHandlers:
+    @pytest.mark.parametrize(
+        "outputs_to_state,outputs_to_string,error_match",
+        [
+            (
+                {"documents": {"handler": "not_callable"}},
+                None,
+                "outputs_to_state\\[documents\\] is not a callable",
+            ),
+            (
+                None,
+                {"handler": "not_callable"},
+                "outputs_to_string is not a callable",
+            ),
+        ],
+    )
+    def test_serialize_handlers_raises_when_handler_not_callable(
+        self, outputs_to_state, outputs_to_string, error_match
+    ):
+        serialized: dict = {}
+        with pytest.raises(ValueError, match=error_match):
+            serialize_handlers(serialized, outputs_to_state, outputs_to_string)

github_haystack-2.0.0/pydoc/config_docusaurus.yml

@@ -1,33 +0,0 @@
-loaders:
-- ignore_when_discovered:
-  - __init__
-  modules:
-  - haystack_integrations.components.connectors.github.file_editor
-  - haystack_integrations.components.connectors.github.issue_commenter
-  - haystack_integrations.components.connectors.github.issue_viewer
-  - haystack_integrations.components.connectors.github.pr_creator
-  - haystack_integrations.components.connectors.github.repo_viewer
-  - haystack_integrations.components.connectors.github.repo_forker
-  search_path:
-  - ../src
-  type: haystack_pydoc_tools.loaders.CustomPythonLoader
-processors:
-- do_not_filter_modules: false
-  documented_only: true
-  expression: null
-  skip_empty_modules: true
-  type: filter
-- type: smart
-- type: crossref
-renderer:
-  description: GitHub integration for Haystack
-  id: integrations-github
-  markdown:
-    add_member_class_prefix: false
-    add_method_class_prefix: true
-    classdef_code_block: false
-    descriptive_class_title: false
-    descriptive_module_title: true
-    filename: github.md
-  title: GitHub
-  type: haystack_pydoc_tools.renderers.DocusaurusRenderer