Add None module

Author: YoanSallami

coverage-badge.svg

@@ -0,0 +1,2 @@
+
+::: synalinks.src.modules.core.none

docs/Synalinks API/Modules API/Core Modules/None module.md

@@ -2,6 +2,7 @@
 
 - [Input module](Input module.md)
 - [Identity module](Identity module.md)
+- [None module](None module.md)
 - [Generator module](Generator module.md)
 - [Decision module](Decision module.md)
 - [Action module](Action module.md)

docs/Synalinks API/Modules API/Core Modules/index.md

@@ -47,6 +47,7 @@ if __name__ == "__main__":
 
 - [Input module](Core Modules/Input module.md)
 - [Identity module](Core Modules/Identity module.md)
+- [None module](Core Modules/None module.md)
 - [Generator module](Core Modules/Generator module.md)
 - [Decision module](Core Modules/Decision module.md)
 - [Action module](Core Modules/Action module.md)

docs/Synalinks API/Modules API/index.md

@@ -58,6 +58,7 @@ nav:
         - Synalinks API/Modules API/Core Modules/index.md
         - Synalinks API/Modules API/Core Modules/Input module.md
         - Synalinks API/Modules API/Core Modules/Identity module.md
+        - Synalinks API/Modules API/Core Modules/None module.md
         - Synalinks API/Modules API/Core Modules/Generator module.md
         - Synalinks API/Modules API/Core Modules/Decision module.md
         - Synalinks API/Modules API/Core Modules/Action module.md

mkdocs.yml

@@ -0,0 +1,43 @@
+# License Apache 2.0: (c) 2025 Yoan Sallami (Synalinks Team)
+
+from synalinks.src import tree
+from synalinks.src.api_export import synalinks_export
+from synalinks.src.backend import JsonDataModel
+from synalinks.src.backend import SymbolicDataModel
+from synalinks.src.modules.module import Module
+
+
+@synalinks_export(["synalinks.modules.NoneModule", "synalinks.NoneModule"])
+class NoneModule(Module):
+    """None module.
+
+    This module should be used as a placeholder when no operation is to be
+    performed and the output should be None.
+    
+    This module is useful to implement stop conditions when combined with a conditional
+    branch or as placeholder (like the Identity) before implementing guards that leverage
+    the xor operation.
+
+    Args:
+        **kwargs (keyword arguments): The default module's arguments
+    """
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+        self.built = True
+
+    async def call(self, inputs):
+        if isinstance(inputs, (JsonDataModel, SymbolicDataModel)):
+            return None
+        return tree.map_structure(
+            lambda x: None,
+            inputs,
+        )
+        
+    async def compute_output_spec(self, inputs):
+        if isinstance(inputs, (JsonDataModel, SymbolicDataModel)):
+            return inputs.clone()
+        return tree.map_structure(
+            lambda x: x.clone(),
+            inputs,
+        )

synalinks/src/modules/core/none.py

@@ -0,0 +1,119 @@
+# License Apache 2.0: (c) 2025 Yoan Sallami (Synalinks Team)
+
+from synalinks.src import testing
+from synalinks.src.backend import DataModel
+from synalinks.src.modules.core.none import NoneModule
+from synalinks.src.modules.core.input_module import Input
+from synalinks.src.programs.program import Program
+
+
+class NoneModuleTest(testing.TestCase):
+    async def test_single_inputs(self):
+        class Query(DataModel):
+            query: str
+
+        inputs = Input(data_model=Query)
+        outputs = await NoneModule()(inputs)
+
+        program = Program(
+            inputs=inputs,
+            outputs=outputs,
+        )
+
+        result = await program(Query(query="a"))
+        
+        self.assertEqual(result, None)
+
+    async def test_tuple_inputs(self):
+        class Query(DataModel):
+            query: str
+
+        inputs = (
+            Input(data_model=Query),
+            Input(data_model=Query),
+            Input(data_model=Query),
+        )
+        outputs = await NoneModule()(inputs)
+
+        program = Program(
+            inputs=inputs,
+            outputs=outputs,
+        )
+
+        result = await program(
+            (
+                Query(query="a"),
+                Query(query="b"),
+                Query(query="c"),
+            )
+        )
+
+        self.assertEqual(result[0], None)
+        self.assertEqual(result[1], None)
+        self.assertEqual(result[2], None)
+
+    async def test_list_inputs(self):
+        class Query(DataModel):
+            query: str
+
+        inputs = [
+            Input(data_model=Query),
+            Input(data_model=Query),
+            Input(data_model=Query),
+        ]
+        outputs = await NoneModule()(inputs)
+
+        program = Program(
+            inputs=inputs,
+            outputs=outputs,
+        )
+
+        result = await program(
+            [
+                Query(query="a"),
+                Query(query="b"),
+                Query(query="c"),
+            ]
+        )
+
+        self.assertEqual(result[0], None)
+        self.assertEqual(result[1], None)
+        self.assertEqual(result[2], None)
+
+    async def test_dict_inputs(self):
+        class Query(DataModel):
+            query: str
+
+        inputs = {
+            "a": Input(data_model=Query),
+            "b": Input(data_model=Query),
+            "c": Input(data_model=Query),
+        }
+        outputs = await NoneModule()(inputs)
+
+        program = Program(
+            inputs=inputs,
+            outputs=outputs,
+        )
+
+        result = await program(
+            {
+                "a": Query(query="a"),
+                "b": Query(query="b"),
+                "c": Query(query="c"),
+            }
+        )
+
+        expected_json_a = {
+            "query": "a",
+        }
+        expected_json_b = {
+            "query": "b",
+        }
+        expected_json_c = {
+            "query": "c",
+        }
+
+        self.assertEqual(result["a"], None)
+        self.assertEqual(result["b"], None)
+        self.assertEqual(result["c"], None)

synalinks/src/modules/core/none_test.py

@@ -3,7 +3,7 @@
 from synalinks.src.api_export import synalinks_export
 
 # Unique source of truth for the version number.
-__version__ = "0.2.021"
+__version__ = "0.2.022"
 
 
 @synalinks_export("synalinks.version")