change import paths (#253)

deepset-ai · Jan 22, 2024 · 3bd9afe · 3bd9afe
1 parent f8efcfe
commit 3bd9afe
Show file tree

Hide file tree

Showing 10 changed files with 49 additions and 32 deletions.
diff --git a/integrations/instructor_embedders/instructor_embedders_haystack/__init__.py b/integrations/instructor_embedders/instructor_embedders_haystack/__init__.py
diff --git a/integrations/instructor_embedders/pyproject.toml b/integrations/instructor_embedders/pyproject.toml
@@ -54,6 +54,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/instructor_embedders"
 
+[tool.hatch.build.targets.wheel]
+packages = ["src/haystack_integrations"]
+
 [tool.hatch.version]
 source = "vcs"
 tag-pattern = 'integrations\/instructor_embedders-v(?P<version>.*)'
@@ -81,7 +84,7 @@ dependencies = [
   "ruff>=0.0.243",
 ]
 [tool.hatch.envs.lint.scripts]
-typing = "mypy --install-types --non-interactive {args:instructor_embedders_haystack tests}"
+typing = "mypy --install-types --non-interactive --explicit-package-bases {args:src/ tests}"
 style = [
   "ruff {args:.}",
   "black --check --diff {args:.}",
@@ -99,7 +102,6 @@ all = [
 [tool.coverage.run]
 branch = true
 parallel = true
-omit = ["instructor_embedders/__about__.py"]
 
 [tool.coverage.report]
 exclude_lines = ["no cov", "if __name__ == .__main__.:", "if TYPE_CHECKING:"]
@@ -152,7 +154,7 @@ unfixable = [
 known-first-party = ["instructor_embedders"]
 
 [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
@@ -172,6 +174,7 @@ module = [
   "instructor_embedders_haystack.*",
   "InstructorEmbedding.*",
   "haystack.*",
+  "haystack_integrations.*",
   "pytest.*",
   "numpy.*",
 ]

diff --git a/...embedders/src/haystack_integrations/components/embedders/instructor_embedders/__init__.py b/...embedders/src/haystack_integrations/components/embedders/instructor_embedders/__init__.py
@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: 2023-present deepset GmbH <[email protected]>
+#
+# SPDX-License-Identifier: Apache-2.0
+from .instructor_document_embedder import InstructorDocumentEmbedder
+from .instructor_text_embedder import InstructorTextEmbedder
+
+__all__ = ["InstructorDocumentEmbedder", "InstructorTextEmbedder"]
diff --git a/...rs_haystack/embedding_backend/__init__.py → ...r_embedders/embedding_backend/__init__.py b/...rs_haystack/embedding_backend/__init__.py → ...r_embedders/embedding_backend/__init__.py
diff --git a/...k/embedding_backend/instructor_backend.py → ...s/embedding_backend/instructor_backend.py b/...k/embedding_backend/instructor_backend.py → ...s/embedding_backend/instructor_backend.py
diff --git a/..._haystack/instructor_document_embedder.py → ...embedders/instructor_document_embedder.py b/..._haystack/instructor_document_embedder.py → ...embedders/instructor_document_embedder.py
@@ -5,7 +5,7 @@
 
 from haystack import Document, component, default_from_dict, default_to_dict
 
-from instructor_embedders_haystack.embedding_backend.instructor_backend import _InstructorEmbeddingBackendFactory
+from .embedding_backend.instructor_backend import _InstructorEmbeddingBackendFactory
 
 
 @component

diff --git a/...ders_haystack/instructor_text_embedder.py → ...tor_embedders/instructor_text_embedder.py b/...ders_haystack/instructor_text_embedder.py → ...tor_embedders/instructor_text_embedder.py
@@ -5,7 +5,7 @@
 
 from haystack import component, default_from_dict, default_to_dict
 
-from instructor_embedders_haystack.embedding_backend.instructor_backend import _InstructorEmbeddingBackendFactory
+from .embedding_backend.instructor_backend import _InstructorEmbeddingBackendFactory
 
 
 @component

diff --git a/integrations/instructor_embedders/tests/test_instructor_backend.py b/integrations/instructor_embedders/tests/test_instructor_backend.py
@@ -1,9 +1,13 @@
 from unittest.mock import patch
 
-from instructor_embedders_haystack.embedding_backend.instructor_backend import _InstructorEmbeddingBackendFactory
+from haystack_integrations.components.embedders.instructor_embedders.embedding_backend.instructor_backend import (
+    _InstructorEmbeddingBackendFactory,
+)
 
 
-@patch("instructor_embedders_haystack.embedding_backend.instructor_backend.INSTRUCTOR")
+@patch(
+    "haystack_integrations.components.embedders.instructor_embedders.embedding_backend.instructor_backend.INSTRUCTOR"
+)
 def test_factory_behavior(mock_instructor):  # noqa: ARG001
     embedding_backend = _InstructorEmbeddingBackendFactory.get_embedding_backend(
         model_name_or_path="hkunlp/instructor-large", device="cpu"
@@ -20,7 +24,9 @@ def test_factory_behavior(mock_instructor):  # noqa: ARG001
     _InstructorEmbeddingBackendFactory._instances = {}
 
 
-@patch("instructor_embedders_haystack.embedding_backend.instructor_backend.INSTRUCTOR")
+@patch(
+    "haystack_integrations.components.embedders.instructor_embedders.embedding_backend.instructor_backend.INSTRUCTOR"
+)
 def test_model_initialization(mock_instructor):
     _InstructorEmbeddingBackendFactory.get_embedding_backend(
         model_name_or_path="hkunlp/instructor-base", device="cpu", use_auth_token="huggingface_auth_token"
@@ -32,7 +38,9 @@ def test_model_initialization(mock_instructor):
     _InstructorEmbeddingBackendFactory._instances = {}
 
 
-@patch("instructor_embedders_haystack.embedding_backend.instructor_backend.INSTRUCTOR")
+@patch(
+    "haystack_integrations.components.embedders.instructor_embedders.embedding_backend.instructor_backend.INSTRUCTOR"
+)
 def test_embedding_function_with_kwargs(mock_instructor):  # noqa: ARG001
     embedding_backend = _InstructorEmbeddingBackendFactory.get_embedding_backend(
         model_name_or_path="hkunlp/instructor-base"

diff --git a/integrations/instructor_embedders/tests/test_instructor_document_embedder.py b/integrations/instructor_embedders/tests/test_instructor_document_embedder.py
@@ -3,8 +3,7 @@
 import numpy as np
 import pytest
 from haystack import Document
-
-from instructor_embedders_haystack.instructor_document_embedder import InstructorDocumentEmbedder
+from haystack_integrations.components.embedders.instructor_embedders import InstructorDocumentEmbedder
 
 
 class TestInstructorDocumentEmbedder:
@@ -55,7 +54,7 @@ def test_to_dict(self):
         embedder = InstructorDocumentEmbedder(model="hkunlp/instructor-base")
         embedder_dict = embedder.to_dict()
         assert embedder_dict == {
-            "type": "instructor_embedders_haystack.instructor_document_embedder.InstructorDocumentEmbedder",
+            "type": "haystack_integrations.components.embedders.instructor_embedders.instructor_document_embedder.InstructorDocumentEmbedder",  #  noqa
             "init_parameters": {
                 "model": "hkunlp/instructor-base",
                 "device": "cpu",
@@ -86,7 +85,7 @@ def test_to_dict_with_custom_init_parameters(self):
         )
         embedder_dict = embedder.to_dict()
         assert embedder_dict == {
-            "type": "instructor_embedders_haystack.instructor_document_embedder.InstructorDocumentEmbedder",
+            "type": "haystack_integrations.components.embedders.instructor_embedders.instructor_document_embedder.InstructorDocumentEmbedder",  #  noqa
             "init_parameters": {
                 "model": "hkunlp/instructor-base",
                 "device": "cuda",
@@ -105,7 +104,7 @@ def test_from_dict(self):
         Test deserialization of InstructorDocumentEmbedder from a dictionary, using default initialization parameters.
         """
         embedder_dict = {
-            "type": "instructor_embedders_haystack.instructor_document_embedder.InstructorDocumentEmbedder",
+            "type": "haystack_integrations.components.embedders.instructor_embedders.instructor_document_embedder.InstructorDocumentEmbedder",  #  noqa
             "init_parameters": {
                 "model": "hkunlp/instructor-base",
                 "device": "cpu",
@@ -134,7 +133,7 @@ def test_from_dict_with_custom_init_parameters(self):
         Test deserialization of InstructorDocumentEmbedder from a dictionary, using custom initialization parameters.
         """
         embedder_dict = {
-            "type": "instructor_embedders_haystack.instructor_document_embedder.InstructorDocumentEmbedder",
+            "type": "haystack_integrations.components.embedders.instructor_embedders.instructor_document_embedder.InstructorDocumentEmbedder",  #  noqa
             "init_parameters": {
                 "model": "hkunlp/instructor-base",
                 "device": "cuda",
@@ -158,7 +157,9 @@ def test_from_dict_with_custom_init_parameters(self):
         assert embedder.meta_fields_to_embed == ["test_field"]
         assert embedder.embedding_separator == " | "
 
-    @patch("instructor_embedders_haystack.instructor_document_embedder._InstructorEmbeddingBackendFactory")
+    @patch(
+        "haystack_integrations.components.embedders.instructor_embedders.instructor_document_embedder._InstructorEmbeddingBackendFactory"
+    )
     def test_warmup(self, mocked_factory):
         """
         Test for checking embedder instances after warm-up.
@@ -170,7 +171,9 @@ def test_warmup(self, mocked_factory):
             model_name_or_path="hkunlp/instructor-base", device="cpu", use_auth_token=None
         )
 
-    @patch("instructor_embedders_haystack.instructor_document_embedder._InstructorEmbeddingBackendFactory")
+    @patch(
+        "haystack_integrations.components.embedders.instructor_embedders.instructor_document_embedder._InstructorEmbeddingBackendFactory"
+    )
     def test_warmup_does_not_reload(self, mocked_factory):
         """
         Test for checking backend instances after multiple warm-ups.

diff --git a/integrations/instructor_embedders/tests/test_instructor_text_embedder.py b/integrations/instructor_embedders/tests/test_instructor_text_embedder.py
@@ -2,8 +2,7 @@
 
 import numpy as np
 import pytest
-
-from instructor_embedders_haystack.instructor_text_embedder import InstructorTextEmbedder
+from haystack_integrations.components.embedders.instructor_embedders import InstructorTextEmbedder
 
 
 class TestInstructorTextEmbedder:
@@ -48,7 +47,7 @@ def test_to_dict(self):
         embedder = InstructorTextEmbedder(model="hkunlp/instructor-base")
         embedder_dict = embedder.to_dict()
         assert embedder_dict == {
-            "type": "instructor_embedders_haystack.instructor_text_embedder.InstructorTextEmbedder",
+            "type": "haystack_integrations.components.embedders.instructor_embedders.instructor_text_embedder.InstructorTextEmbedder",  # noqa
             "init_parameters": {
                 "model": "hkunlp/instructor-base",
                 "device": "cpu",
@@ -75,7 +74,7 @@ def test_to_dict_with_custom_init_parameters(self):
         )
         embedder_dict = embedder.to_dict()
         assert embedder_dict == {
-            "type": "instructor_embedders_haystack.instructor_text_embedder.InstructorTextEmbedder",
+            "type": "haystack_integrations.components.embedders.instructor_embedders.instructor_text_embedder.InstructorTextEmbedder",  # noqa
             "init_parameters": {
                 "model": "hkunlp/instructor-base",
                 "device": "cuda",
@@ -92,7 +91,7 @@ def test_from_dict(self):
         Test deserialization of InstructorTextEmbedder from a dictionary, using default initialization parameters.
         """
         embedder_dict = {
-            "type": "instructor_embedders_haystack.instructor_text_embedder.InstructorTextEmbedder",
+            "type": "haystack_integrations.components.embedders.instructor_embedders.instructor_text_embedder.InstructorTextEmbedder",  # noqa
             "init_parameters": {
                 "model": "hkunlp/instructor-base",
                 "device": "cpu",
@@ -117,7 +116,7 @@ def test_from_dict_with_custom_init_parameters(self):
         Test deserialization of InstructorTextEmbedder from a dictionary, using custom initialization parameters.
         """
         embedder_dict = {
-            "type": "instructor_embedders_haystack.instructor_text_embedder.InstructorTextEmbedder",
+            "type": "haystack_integrations.components.embedders.instructor_embedders.instructor_text_embedder.InstructorTextEmbedder",  # noqa
             "init_parameters": {
                 "model": "hkunlp/instructor-base",
                 "device": "cuda",
@@ -137,7 +136,9 @@ def test_from_dict_with_custom_init_parameters(self):
         assert embedder.progress_bar is False
         assert embedder.normalize_embeddings is True
 
-    @patch("instructor_embedders_haystack.instructor_text_embedder._InstructorEmbeddingBackendFactory")
+    @patch(
+        "haystack_integrations.components.embedders.instructor_embedders.instructor_text_embedder._InstructorEmbeddingBackendFactory"
+    )
     def test_warmup(self, mocked_factory):
         """
         Test for checking embedder instances after warm-up.
@@ -149,7 +150,9 @@ def test_warmup(self, mocked_factory):
             model_name_or_path="hkunlp/instructor-base", device="cpu", use_auth_token=None
         )
 
-    @patch("instructor_embedders_haystack.instructor_text_embedder._InstructorEmbeddingBackendFactory")
+    @patch(
+        "haystack_integrations.components.embedders.instructor_embedders.instructor_text_embedder._InstructorEmbeddingBackendFactory"
+    )
     def test_warmup_does_not_reload(self, mocked_factory):
         """
         Test for checking backend instances after multiple warm-ups.