chore: Cohere namespace change (#247)

* Reorganize cohere integration project layout, adjust pyproject.toml * Update tests * Fix for tests * Remove workspace file * Remove file * Fix lint issues * More linting fixes * Add cohere suffix dirs * Remove idea folder
deepset-ai · Jan 22, 2024 · f8efcfe · f8efcfe
1 parent 9548026
commit f8efcfe
Show file tree

Hide file tree

Showing 13 changed files with 48 additions and 36 deletions.
diff --git a/integrations/cohere/pyproject.toml b/integrations/cohere/pyproject.toml
@@ -34,6 +34,9 @@ Documentation = "https://github.com/deepset-ai/haystack-core-integrations/tree/m
 Issues = "https://github.com/deepset-ai/haystack-core-integrations/issues"
 Source = "https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/cohere"
 
+[tool.hatch.build.targets.wheel]
+packages = ["src/haystack_integrations"]
+
 [tool.hatch.version]
 source = "vcs"
 tag-pattern = 'integrations\/cohere-v(?P<version>.*)'
@@ -70,7 +73,7 @@ dependencies = [
   "ruff>=0.0.243",
 ]
 [tool.hatch.envs.lint.scripts]
-typing = "mypy --install-types --non-interactive {args:src/cohere_haystack tests}"
+typing = "mypy --install-types --non-interactive --explicit-package-bases {args:src/ tests}"
 style = [
   "ruff {args:.}",
   "black --check --diff {args:.}",
@@ -133,26 +136,23 @@ unfixable = [
 ]
 
 [tool.ruff.isort]
-known-first-party = ["cohere_haystack"]
+known-first-party = ["src"]
 
 [tool.ruff.flake8-tidy-imports]
-ban-relative-imports = "all"
+ban-relative-imports = "parents"
 
 [tool.ruff.per-file-ignores]
 # Tests can use magic values, assertions, and relative imports
 "tests/**/*" = ["PLR2004", "S101", "TID252"]
 
 [tool.coverage.run]
-source_pkgs = ["cohere_haystack", "tests"]
+source_pkgs = ["src", "tests"]
 branch = true
 parallel = true
-omit = [
-  "src/cohere_haystack/__about__.py",
-]
 
 [tool.coverage.paths]
-cohere_haystack = ["src/cohere_haystack", "*/cohere-haystack/src/cohere_haystack"]
-tests = ["tests", "*/cohere-haystack/tests"]
+cohere_haystack = ["src/haystack_integrations", "*/cohere/src/haystack_integrations"]
+tests = ["tests", "*/cohere/tests"]
 
 [tool.coverage.report]
 exclude_lines = [
@@ -165,6 +165,7 @@ exclude_lines = [
 module = [
   "cohere.*",
   "haystack.*",
+  "haystack_integrations.*",
   "pytest.*",
   "numpy.*",
 ]

diff --git a/integrations/cohere/src/haystack_integrations/components/embedders/cohere/__init__.py b/integrations/cohere/src/haystack_integrations/components/embedders/cohere/__init__.py
@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: 2023-present deepset GmbH <[email protected]>
+#
+# SPDX-License-Identifier: Apache-2.0
+from .document_embedder import CohereDocumentEmbedder
+from .text_embedder import CohereTextEmbedder
+
+__all__ = ["CohereDocumentEmbedder", "CohereTextEmbedder"]
diff --git a/...e_haystack/embedders/document_embedder.py → ...nts/embedders/cohere/document_embedder.py b/...e_haystack/embedders/document_embedder.py → ...nts/embedders/cohere/document_embedder.py
@@ -5,10 +5,10 @@
 import os
 from typing import Any, Dict, List, Optional
 
-from cohere import COHERE_API_URL, AsyncClient, Client
 from haystack import Document, component, default_to_dict
+from haystack_integrations.components.embedders.cohere.utils import get_async_response, get_response
 
-from cohere_haystack.embedders.utils import get_async_response, get_response
+from cohere import COHERE_API_URL, AsyncClient, Client
 
 
 @component

diff --git a/...ohere_haystack/embedders/text_embedder.py → ...ponents/embedders/cohere/text_embedder.py b/...ohere_haystack/embedders/text_embedder.py → ...ponents/embedders/cohere/text_embedder.py
@@ -5,10 +5,10 @@
 import os
 from typing import Any, Dict, List, Optional
 
-from cohere import COHERE_API_URL, AsyncClient, Client
 from haystack import component, default_to_dict
+from haystack_integrations.components.embedders.cohere.utils import get_async_response, get_response
 
-from cohere_haystack.embedders.utils import get_async_response, get_response
+from cohere import COHERE_API_URL, AsyncClient, Client
 
 
 @component

diff --git a/...re/src/cohere_haystack/embedders/utils.py → ...ions/components/embedders/cohere/utils.py b/...re/src/cohere_haystack/embedders/utils.py → ...ions/components/embedders/cohere/utils.py
@@ -3,9 +3,10 @@
 # SPDX-License-Identifier: Apache-2.0
 from typing import Any, Dict, List, Tuple
 
-from cohere import AsyncClient, Client, CohereError
 from tqdm import tqdm
 
+from cohere import AsyncClient, Client, CohereError
+
 
 async def get_async_response(cohere_async_client: AsyncClient, texts: List[str], model_name, input_type, truncate):
     all_embeddings: List[List[float]] = []

diff --git a/...ns/cohere/src/cohere_haystack/__init__.py → .../components/generators/cohere/__init__.py b/...ns/cohere/src/cohere_haystack/__init__.py → .../components/generators/cohere/__init__.py
@@ -1,3 +1,6 @@
 # SPDX-FileCopyrightText: 2023-present deepset GmbH <[email protected]>
 #
 # SPDX-License-Identifier: Apache-2.0
+from .generator import CohereGenerator
+
+__all__ = ["CohereGenerator"]
diff --git a/...src/cohere_haystack/embedders/__init__.py → ...onents/generators/cohere/chat/__init__.py b/...src/cohere_haystack/embedders/__init__.py → ...onents/generators/cohere/chat/__init__.py
@@ -1,3 +1,6 @@
 # SPDX-FileCopyrightText: 2023-present deepset GmbH <[email protected]>
 #
 # SPDX-License-Identifier: Apache-2.0
+from .chat_generator import CohereChatGenerator
+
+__all__ = ["CohereChatGenerator"]
diff --git a/...rc/cohere_haystack/chat/chat_generator.py → .../generators/cohere/chat/chat_generator.py b/...rc/cohere_haystack/chat/chat_generator.py → .../generators/cohere/chat/chat_generator.py
diff --git a/...s/cohere/src/cohere_haystack/generator.py → ...components/generators/cohere/generator.py b/...s/cohere/src/cohere_haystack/generator.py → ...components/generators/cohere/generator.py
@@ -6,9 +6,10 @@
 import sys
 from typing import Any, Callable, Dict, List, Optional, cast
 
+from haystack import DeserializationError, component, default_from_dict, default_to_dict
+
 from cohere import COHERE_API_URL, Client
 from cohere.responses import Generations
-from haystack import DeserializationError, component, default_from_dict, default_to_dict
 
 logger = logging.getLogger(__name__)
 

diff --git a/integrations/cohere/tests/test_cohere_chat_generator.py b/integrations/cohere/tests/test_cohere_chat_generator.py
@@ -5,8 +5,7 @@
 import pytest
 from haystack.components.generators.utils import default_streaming_callback
 from haystack.dataclasses import ChatMessage, ChatRole, StreamingChunk
-
-from cohere_haystack.chat.chat_generator import CohereChatGenerator
+from haystack_integrations.components.generators.cohere.chat import CohereChatGenerator
 
 pytestmark = pytest.mark.chat_generators
 
@@ -88,7 +87,7 @@ def test_to_dict_default(self):
         component = CohereChatGenerator(api_key="test-api-key")
         data = component.to_dict()
         assert data == {
-            "type": "cohere_haystack.chat.chat_generator.CohereChatGenerator",
+            "type": "haystack_integrations.components.generators.cohere.chat.chat_generator.CohereChatGenerator",
             "init_parameters": {
                 "model": "command",
                 "streaming_callback": None,
@@ -108,7 +107,7 @@ def test_to_dict_with_parameters(self):
         )
         data = component.to_dict()
         assert data == {
-            "type": "cohere_haystack.chat.chat_generator.CohereChatGenerator",
+            "type": "haystack_integrations.components.generators.cohere.chat.chat_generator.CohereChatGenerator",
             "init_parameters": {
                 "model": "command-nightly",
                 "streaming_callback": "haystack.components.generators.utils.default_streaming_callback",
@@ -128,7 +127,7 @@ def test_to_dict_with_lambda_streaming_callback(self):
         )
         data = component.to_dict()
         assert data == {
-            "type": "cohere_haystack.chat.chat_generator.CohereChatGenerator",
+            "type": "haystack_integrations.components.generators.cohere.chat.chat_generator.CohereChatGenerator",
             "init_parameters": {
                 "model": "command",
                 "api_base_url": "test-base-url",
@@ -141,7 +140,7 @@ def test_to_dict_with_lambda_streaming_callback(self):
     def test_from_dict(self, monkeypatch):
         monkeypatch.setenv("COHERE_API_KEY", "fake-api-key")
         data = {
-            "type": "cohere_haystack.chat.chat_generator.CohereChatGenerator",
+            "type": "haystack_integrations.components.generators.cohere.chat.chat_generator.CohereChatGenerator",
             "init_parameters": {
                 "model": "command",
                 "api_base_url": "test-base-url",
@@ -159,7 +158,7 @@ def test_from_dict(self, monkeypatch):
     def test_from_dict_fail_wo_env_var(self, monkeypatch):
         monkeypatch.delenv("COHERE_API_KEY", raising=False)
         data = {
-            "type": "cohere_haystack.chat.chat_generator.CohereChatGenerator",
+            "type": "haystack_integrations.components.generators.cohere.chat.chat_generator.CohereChatGenerator",
             "init_parameters": {
                 "model": "command",
                 "api_base_url": "test-base-url",

diff --git a/integrations/cohere/tests/test_cohere_generators.py b/integrations/cohere/tests/test_cohere_generators.py
@@ -5,8 +5,7 @@
 
 import pytest
 from cohere import COHERE_API_URL
-
-from cohere_haystack.generator import CohereGenerator
+from haystack_integrations.components.generators.cohere import CohereGenerator
 
 pytestmark = pytest.mark.generators
 
@@ -48,7 +47,7 @@ def test_to_dict_default(self):
         component = CohereGenerator(api_key="test-api-key")
         data = component.to_dict()
         assert data == {
-            "type": "cohere_haystack.generator.CohereGenerator",
+            "type": "haystack_integrations.components.generators.cohere.generator.CohereGenerator",
             "init_parameters": {
                 "model": "command",
                 "streaming_callback": None,
@@ -67,7 +66,7 @@ def test_to_dict_with_parameters(self):
         )
         data = component.to_dict()
         assert data == {
-            "type": "cohere_haystack.generator.CohereGenerator",
+            "type": "haystack_integrations.components.generators.cohere.generator.CohereGenerator",
             "init_parameters": {
                 "model": "command-light",
                 "max_tokens": 10,
@@ -88,7 +87,7 @@ def test_to_dict_with_lambda_streaming_callback(self):
         )
         data = component.to_dict()
         assert data == {
-            "type": "cohere_haystack.generator.CohereGenerator",
+            "type": "haystack_integrations.components.generators.cohere.generator.CohereGenerator",
             "init_parameters": {
                 "model": "command",
                 "streaming_callback": "tests.test_cohere_generators.<lambda>",
@@ -101,7 +100,7 @@ def test_to_dict_with_lambda_streaming_callback(self):
     def test_from_dict(self, monkeypatch):
         monkeypatch.setenv("COHERE_API_KEY", "test-key")
         data = {
-            "type": "cohere_haystack.generator.CohereGenerator",
+            "type": "haystack_integrations.components.generators.cohere.generator.CohereGenerator",
             "init_parameters": {
                 "model": "command",
                 "max_tokens": 10,

diff --git a/integrations/cohere/tests/test_document_embedder.py b/integrations/cohere/tests/test_document_embedder.py
@@ -6,8 +6,7 @@
 import pytest
 from cohere import COHERE_API_URL
 from haystack import Document
-
-from cohere_haystack.embedders.document_embedder import CohereDocumentEmbedder
+from haystack_integrations.components.embedders.cohere import CohereDocumentEmbedder
 
 pytestmark = pytest.mark.embedders
 
@@ -60,7 +59,7 @@ def test_to_dict(self):
         embedder_component = CohereDocumentEmbedder(api_key="test-api-key")
         component_dict = embedder_component.to_dict()
         assert component_dict == {
-            "type": "cohere_haystack.embedders.document_embedder.CohereDocumentEmbedder",
+            "type": "haystack_integrations.components.embedders.cohere.document_embedder.CohereDocumentEmbedder",
             "init_parameters": {
                 "model": "embed-english-v2.0",
                 "input_type": "search_document",
@@ -93,7 +92,7 @@ def test_to_dict_with_custom_init_parameters(self):
         )
         component_dict = embedder_component.to_dict()
         assert component_dict == {
-            "type": "cohere_haystack.embedders.document_embedder.CohereDocumentEmbedder",
+            "type": "haystack_integrations.components.embedders.cohere.document_embedder.CohereDocumentEmbedder",
             "init_parameters": {
                 "model": "embed-multilingual-v2.0",
                 "input_type": "search_query",

diff --git a/integrations/cohere/tests/test_text_embedder.py b/integrations/cohere/tests/test_text_embedder.py
@@ -5,8 +5,7 @@
 
 import pytest
 from cohere import COHERE_API_URL
-
-from cohere_haystack.embedders.text_embedder import CohereTextEmbedder
+from haystack_integrations.components.embedders.cohere import CohereTextEmbedder
 
 pytestmark = pytest.mark.embedders
 
@@ -57,7 +56,7 @@ def test_to_dict(self):
         embedder_component = CohereTextEmbedder(api_key="test-api-key")
         component_dict = embedder_component.to_dict()
         assert component_dict == {
-            "type": "cohere_haystack.embedders.text_embedder.CohereTextEmbedder",
+            "type": "haystack_integrations.components.embedders.cohere.text_embedder.CohereTextEmbedder",
             "init_parameters": {
                 "model": "embed-english-v2.0",
                 "input_type": "search_query",
@@ -85,7 +84,7 @@ def test_to_dict_with_custom_init_parameters(self):
         )
         component_dict = embedder_component.to_dict()
         assert component_dict == {
-            "type": "cohere_haystack.embedders.text_embedder.CohereTextEmbedder",
+            "type": "haystack_integrations.components.embedders.cohere.text_embedder.CohereTextEmbedder",
             "init_parameters": {
                 "model": "embed-multilingual-v2.0",
                 "input_type": "classification",