From 5a0f0ce22fb900e19681e720a4a080750dd5d010 Mon Sep 17 00:00:00 2001
From: ZanSara <sara.zanzottera@deepset.ai>
Date: Wed, 20 Dec 2023 10:03:22 +0000
Subject: [PATCH] feat: `Multiplexer` (#6592)

* move functions

* tests

* reno

* add component

* reno

* add tests

* mypy

* pylint

* logger

* module name
---
 haystack/components/others/__init__.py        |  3 +
 haystack/components/others/multiplexer.py     | 69 +++++++++++++++++++
 .../notes/multiplexer-a7b1259bd20c144c.yaml   |  3 +
 test/components/others/test_multiplexer.py    | 32 +++++++++
 4 files changed, 107 insertions(+)
 create mode 100644 haystack/components/others/__init__.py
 create mode 100644 haystack/components/others/multiplexer.py
 create mode 100644 releasenotes/notes/multiplexer-a7b1259bd20c144c.yaml
 create mode 100644 test/components/others/test_multiplexer.py

diff --git a/haystack/components/others/__init__.py b/haystack/components/others/__init__.py
new file mode 100644
index 000000000..cac8782cd
--- /dev/null
+++ b/haystack/components/others/__init__.py
@@ -0,0 +1,3 @@
+from haystack.components.others.multiplexer import Multiplexer
+
+__all__ = ["Multiplexer"]
diff --git a/haystack/components/others/multiplexer.py b/haystack/components/others/multiplexer.py
new file mode 100644
index 000000000..8c6917218
--- /dev/null
+++ b/haystack/components/others/multiplexer.py
@@ -0,0 +1,69 @@
+import sys
+import logging
+from typing import Any, Dict
+
+from haystack.core.component.types import Variadic
+from haystack import component, default_to_dict, default_from_dict
+from haystack.components.routers.conditional_router import serialize_type, deserialize_type
+
+if sys.version_info < (3, 10):
+    from typing_extensions import TypeAlias
+else:
+    from typing import TypeAlias
+
+
+logger = logging.getLogger(__name__)
+
+
+@component
+class Multiplexer:
+    """
+    This component is used to distribute a single value to many components that may need it.
+    It can take such value from different sources (the user's input, or another component), so
+    it's only input is of Variadic type.
+
+    The type of the expected input (and therefore of the output as well) must be given at init time.
+
+    Example usage:
+
+    ```python
+    >>> mp = Multiplexer(str)
+    >>> mp.run(value=["hello"])
+    {"value" : "hello"}
+
+    >>> mp = Multiplexer(int)
+    >>> mp.run(value=[3])
+    {"value": 3}
+    ```
+
+    This component won't handle several inputs at the same time: it always only expects one.
+    If more than one input is received when run is invoked, it will raise a ValueError.
+
+    ```python
+    >>> mp = Multiplexer(int)
+    >>> mp.run([2, 4])
+    ValueError: Multiplexer expects only one input, but 2 were received.
+
+    >>> mp = Multiplexer(int)
+    >>> mp.run([2, None])
+    ValueError: Multiplexer expects only one input, but 2 were received.
+    ```
+    """
+
+    def __init__(self, type_: TypeAlias):
+        self.type_ = type_
+        component.set_input_types(self, value=Variadic[type_])
+        component.set_output_types(self, value=type_)
+
+    def to_dict(self):
+        return default_to_dict(self, type_=serialize_type(self.type_))
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "Multiplexer":
+        data["init_parameters"]["type_"] = deserialize_type(data["init_parameters"]["type_"])
+        return default_from_dict(cls, data)
+
+    def run(self, **kwargs):
+        if (inputs_count := len(kwargs["value"])) != 1:
+            raise ValueError(f"Multiplexer expects only one input, but {inputs_count} were received.")
+        return {"value": kwargs["value"][0]}
diff --git a/releasenotes/notes/multiplexer-a7b1259bd20c144c.yaml b/releasenotes/notes/multiplexer-a7b1259bd20c144c.yaml
new file mode 100644
index 000000000..2ef1fbaa4
--- /dev/null
+++ b/releasenotes/notes/multiplexer-a7b1259bd20c144c.yaml
@@ -0,0 +1,3 @@
+features:
+  - |
+    Add `Multiplexer`. For an example of its usage, see https://github.com/deepset-ai/haystack/pull/6420.
diff --git a/test/components/others/test_multiplexer.py b/test/components/others/test_multiplexer.py
new file mode 100644
index 000000000..3488b61c2
--- /dev/null
+++ b/test/components/others/test_multiplexer.py
@@ -0,0 +1,32 @@
+import pytest
+
+from haystack.components.others import Multiplexer
+
+
+class TestMultiplexer:
+    def test_one_value(self):
+        multiplexer = Multiplexer(int)
+        output = multiplexer.run(value=[2])
+        assert output == {"value": 2}
+
+    def test_one_value_of_wrong_type(self):
+        # Multiplexer does not type check the input
+        multiplexer = Multiplexer(int)
+        output = multiplexer.run(value=["hello"])
+        assert output == {"value": "hello"}
+
+    def test_one_value_of_none_type(self):
+        # Multiplexer does not type check the input
+        multiplexer = Multiplexer(int)
+        output = multiplexer.run(value=[None])
+        assert output == {"value": None}
+
+    def test_more_values_of_expected_type(self):
+        multiplexer = Multiplexer(int)
+        with pytest.raises(ValueError, match="Multiplexer expects only one input, but 3 were received."):
+            multiplexer.run(value=[2, 3, 4])
+
+    def test_no_values(self):
+        multiplexer = Multiplexer(int)
+        with pytest.raises(ValueError, match="Multiplexer expects only one input, but 0 were received."):
+            multiplexer.run(value=[])