kailash 0.1.3__py3-none-any.whl → 0.1.4__py3-none-any.whl

kailash/nodes/data/writers.py

@@ -12,9 +12,9 @@ Design Philosophy:
 5. Progress tracking and feedback
 
 Node Categories:
-- CSVWriter: Tabular data to CSV files
-- JSONWriter: Structured data to JSON files
-- TextWriter: Raw text to any text file
+- CSVWriterNode: Tabular data to CSV files
+- JSONWriterNode: Structured data to JSON files
+- TextWriterNode: Raw text to any text file
 
 Upstream Components:
 - Reader nodes: Provide data to transform
@@ -37,7 +37,7 @@ from kailash.nodes.base import Node, NodeParameter, register_node
 
 
 @register_node()
-class CSVWriter(Node):
+class CSVWriterNode(Node):
     """Writes data to a CSV file.
 
     This node handles CSV file writing with support for both dictionary
@@ -81,19 +81,18 @@ class CSVWriter(Node):
     - TypeError: Invalid data structure
     - UnicodeEncodeError: Encoding issues
 
-    Example::
-
-        # Write customer data
-        writer = CSVWriter(
-            file_path='output.csv',
-            data=[
-                {'id': 1, 'name': 'John', 'age': 30},
-                {'id': 2, 'name': 'Jane', 'age': 25}
-            ],
-            delimiter=','
-        )
-        result = writer.execute()
-        # result = {'rows_written': 2, 'file_path': 'output.csv'}
+    Example:
+        >>> # Write customer data
+        >>> writer = CSVWriterNode(
+        ...     file_path='output.csv',
+        ...     data=[
+        ...         {'id': 1, 'name': 'John', 'age': 30},
+        ...         {'id': 2, 'name': 'Jane', 'age': 25}
+        ...     ],
+        ...     delimiter=','
+        ... )
+        >>> result = writer.execute()
+        >>> # result = {'rows_written': 2, 'file_path': 'output.csv'}
     """
 
     def get_parameters(self) -> Dict[str, NodeParameter]:
@@ -218,7 +217,7 @@ class CSVWriter(Node):
 
 
 @register_node()
-class JSONWriter(Node):
+class JSONWriterNode(Node):
     """Writes data to a JSON file.
 
     This node handles JSON serialization with support for complex
@@ -262,20 +261,19 @@ class JSONWriter(Node):
     - OSError: Path or disk issues
     - JSONEncodeError: Encoding problems
 
-    Example::
-
-        # Write API response
-        writer = JSONWriter(
-            file_path='response.json',
-            data={
-                'status': 'success',
-                'results': [1, 2, 3],
-                'metadata': {'version': '1.0'}
-            },
-            indent=2
-        )
-        result = writer.execute()
-        # result = {'file_path': 'response.json'}
+    Example:
+        >>> # Write API response
+        >>> writer = JSONWriterNode(
+        ...     file_path='response.json',
+        ...     data={
+        ...         'status': 'success',
+        ...         'results': [1, 2, 3],
+        ...         'metadata': {'version': '1.0'}
+        ...     },
+        ...     indent=2
+        ... )
+        >>> result = writer.execute()
+        >>> # result = {'file_path': 'response.json'}
     """
 
     def get_parameters(self) -> Dict[str, NodeParameter]:
@@ -370,7 +368,7 @@ class JSONWriter(Node):
 
 
 @register_node()
-class TextWriter(Node):
+class TextWriterNode(Node):
     """Writes text to a file.
 
     This node provides flexible text file writing with support for
@@ -414,17 +412,16 @@ class TextWriter(Node):
     - UnicodeEncodeError: Encoding mismatch
     - MemoryError: Text too large
 
-    Example::
-
-        # Append to log file
-        writer = TextWriter(
-            file_path='app.log',
-            text='ERROR: Connection failed\\n',
-            encoding='utf-8',
-            append=True
-        )
-        result = writer.execute()
-        # result = {'file_path': 'app.log', 'bytes_written': 25}
+    Example:
+        >>> # Append to log file
+        >>> writer = TextWriterNode(
+        ...     file_path='app.log',
+        ...     text='ERROR: Connection failed\\n',
+        ...     encoding='utf-8',
+        ...     append=True
+        ... )
+        >>> result = writer.execute()
+        >>> # result = {'file_path': 'app.log', 'bytes_written': 25}
     """
 
     def get_parameters(self) -> Dict[str, NodeParameter]:

kailash/nodes/logic/__init__.py

@@ -1,7 +1,13 @@
 """Logic operation nodes for the Kailash SDK."""
 
-from kailash.nodes.logic.async_operations import AsyncMerge, AsyncSwitch
-from kailash.nodes.logic.operations import Merge, Switch
+from kailash.nodes.logic.async_operations import AsyncMergeNode, AsyncSwitchNode
+from kailash.nodes.logic.operations import MergeNode, SwitchNode
 from kailash.nodes.logic.workflow import WorkflowNode
 
-__all__ = ["Switch", "Merge", "AsyncSwitch", "AsyncMerge", "WorkflowNode"]
+__all__ = [
+    "SwitchNode",
+    "MergeNode",
+    "AsyncSwitchNode",
+    "AsyncMergeNode",
+    "WorkflowNode",
+]

kailash/nodes/logic/async_operations.py

@@ -13,14 +13,14 @@ from kailash.nodes.base_async import AsyncNode
 
 
 @register_node()
-class AsyncMerge(AsyncNode):
+class AsyncMergeNode(AsyncNode):
     """Asynchronously merges multiple data sources.
 
     Note: We implement run() to fulfill the Node abstract base class requirement,
     but it's just a pass-through to async_run().
 
 
-    This node extends the standard Merge node with asynchronous execution capabilities,
+    This node extends the standard MergeNode with asynchronous execution capabilities,
     making it more efficient for:
 
     1. Combining large datasets from parallel branches
@@ -28,13 +28,13 @@ class AsyncMerge(AsyncNode):
     3. Processing streaming data in chunks
     4. Aggregating results from various API calls
 
-    The merge operation supports the same types as the standard Merge node:
+    The merge operation supports the same types as the standard MergeNode:
     concat (list concatenation), zip (parallel iteration), and merge_dict
     (dictionary merging with optional key-based joining).
 
     Usage example:
-        # Create an AsyncMerge node in a workflow
-        async_merge = AsyncMerge(merge_type="merge_dict", key="id")
+        # Create an AsyncMergeNode in a workflow
+        async_merge = AsyncMergeNode(merge_type="merge_dict", key="id")
         workflow.add_node("data_combine", async_merge)
 
         # Connect multiple data sources
@@ -44,7 +44,7 @@ class AsyncMerge(AsyncNode):
     """
 
     def get_parameters(self) -> Dict[str, NodeParameter]:
-        """Define parameters for the AsyncMerge node."""
+        """Define parameters for the AsyncMergeNode."""
         # Reuse parameters from SyncMerge
         return {
             "data1": NodeParameter(
@@ -107,7 +107,7 @@ class AsyncMerge(AsyncNode):
         }
 
     def get_output_schema(self) -> Dict[str, NodeParameter]:
-        """Define the output schema for AsyncMerge."""
+        """Define the output schema for AsyncMergeNode."""
         return {
             "merged_data": NodeParameter(
                 name="merged_data",
@@ -155,7 +155,7 @@ class AsyncMerge(AsyncNode):
 
         # Check if we have at least one valid input
         if not data_inputs:
-            self.logger.warning("No valid data inputs provided to AsyncMerge node")
+            self.logger.warning("No valid data inputs provided to AsyncMergeNode")
             return {"merged_data": None}
 
         # If only one input was provided, return it directly
@@ -207,7 +207,7 @@ class AsyncMerge(AsyncNode):
         # This will be properly wrapped by the execute() method
         # which will call it in a sync context
         raise RuntimeError(
-            "AsyncMerge.run() was called directly. Use execute() or execute_async() instead."
+            "AsyncMergeNode.run() was called directly. Use execute() or execute_async() instead."
         )
 
     async def _async_concat(self, data_inputs: List[Any], chunk_size: int) -> Any:
@@ -349,25 +349,25 @@ class AsyncMerge(AsyncNode):
 
 
 @register_node()
-class AsyncSwitch(AsyncNode):
+class AsyncSwitchNode(AsyncNode):
     """Asynchronously routes data to different outputs based on conditions.
 
     Note: We implement run() to fulfill the Node abstract base class requirement,
     but it's just a pass-through to async_run().
 
-    This node extends the standard Switch node with asynchronous execution capabilities,
+    This node extends the standard SwitchNode with asynchronous execution capabilities,
     making it more efficient for:
 
     1. Processing conditional routing with I/O-bound condition evaluation
     2. Handling large datasets that need to be routed based on complex criteria
     3. Integrating with other asynchronous nodes in a workflow
 
-    The basic functionality is the same as the synchronous Switch node but optimized
+    The basic functionality is the same as the synchronous SwitchNode but optimized
     for asynchronous execution.
     """
 
     def get_parameters(self) -> Dict[str, NodeParameter]:
-        """Define parameters for the AsyncSwitch node."""
+        """Define parameters for the AsyncSwitchNode."""
         return {
             "input_data": NodeParameter(
                 name="input_data",
@@ -603,7 +603,7 @@ class AsyncSwitch(AsyncNode):
         # This will be properly wrapped by the execute() method
         # which will call it in a sync context
         raise RuntimeError(
-            "AsyncSwitch.run() was called directly. Use execute() or execute_async() instead."
+            "AsyncSwitchNode.run() was called directly. Use execute() or execute_async() instead."
         )
 
     async def _evaluate_condition(

kailash/nodes/logic/operations.py

@@ -11,7 +11,7 @@ from kailash.nodes.base import Node, NodeParameter, register_node
 
 
 @register_node()
-class Switch(Node):
+class SwitchNode(Node):
     """Routes data to different outputs based on conditions.
 
     The Switch node enables conditional branching in workflows by evaluating
@@ -23,25 +23,21 @@ class Switch(Node):
     3. Dynamic workflow paths based on data values
 
     The outputs of Switch nodes are typically connected to different processing
-    nodes, and those branches can be rejoined later using a Merge node.
-
-    Example usage::
-
-        # Simple boolean condition
-        switch_node = Switch(condition_field="status", operator="==", value="success")
-        workflow.add_node("router", switch_node)
-        workflow.connect("router", "success_handler", {"true_output": "input"})
-        workflow.connect("router", "error_handler", {"false_output": "input"})
-
-        # Multi-case switching
-        switch_node = Switch(
-            condition_field="status",
-            cases=["success", "warning", "error"]
-        )
-        workflow.connect("router", "success_handler", {"case_success": "input"})
-        workflow.connect("router", "warning_handler", {"case_warning": "input"})
-        workflow.connect("router", "error_handler", {"case_error": "input"})
-        workflow.connect("router", "default_handler", {"default": "input"})
+    nodes, and those branches can be rejoined later using a MergeNode.
+
+    Example usage:
+        >>> # Simple boolean condition
+        >>> switch_node = SwitchNode(condition_field="status", operator="==", value="success")
+        >>> switch_node.metadata.name
+        'SwitchNode'
+
+        >>> # Multi-case switching
+        >>> switch_node = SwitchNode(
+        ...     condition_field="status",
+        ...     cases=["success", "warning", "error"]
+        ... )
+        >>> 'cases' in switch_node.get_parameters()
+        True
     """
 
     def get_parameters(self) -> Dict[str, NodeParameter]:
@@ -360,7 +356,7 @@ class Switch(Node):
 
 
 @register_node()
-class Merge(Node):
+class MergeNode(Node):
     """Merges multiple data sources.
 
     This node can combine data from multiple input sources in various ways,
@@ -368,7 +364,7 @@ class Merge(Node):
 
     1. Combining results from parallel branches in a workflow
     2. Joining related data sets
-    3. Combining outputs after conditional branching with the Switch node
+    3. Combining outputs after conditional branching with the SwitchNode
     4. Aggregating collections of data
 
     The merge operation is determined by the merge_type parameter, which supports

kailash/nodes/mcp/client.py

@@ -22,7 +22,7 @@ class MCPClient(Node):
     - Input parameters for resource requests and tool calls
 
     Downstream Consumers:
-    - LLMAgent nodes that need context from MCP servers
+    - LLMAgentNode nodes that need context from MCP servers
     - Workflow nodes that orchestrate multi-step MCP interactions
     - Data processing nodes that consume MCP resources
 
@@ -53,38 +53,34 @@ class MCPClient(Node):
     - Logs connection events and errors for debugging
 
     Examples:
-
-        Connect to an MCP server and list resources::
-
-        client = MCPClient()
-        result = client.run(
-            server_config={
-                "name": "filesystem-server",
-                "command": "python",
-                "args": ["-m", "mcp_filesystem"]
-            },
-            operation="list_resources"
-        )
-
-        Fetch a specific resource:
-
-        resource = client.run(
-            server_config=server_config,
-            operation="read_resource",
-            resource_uri="file:///path/to/document.txt"
-        )
-
-        Call a tool on the server:
-
-        tool_result = client.run(
-            server_config=server_config,
-            operation="call_tool",
-            tool_name="create_file",
-            tool_arguments={
-                "path": "/path/to/new_file.txt",
-                "content": "Hello, World!"
-            }
-        )
+        >>> # Connect to an MCP server and list resources
+        >>> client = MCPClient()
+        >>> result = client.run(
+        ...     server_config={
+        ...         "name": "filesystem-server",
+        ...         "command": "python",
+        ...         "args": ["-m", "mcp_filesystem"]
+        ...     },
+        ...     operation="list_resources"
+        ... )
+
+        >>> # Fetch a specific resource
+        >>> resource = client.run(
+        ...     server_config=server_config,
+        ...     operation="read_resource",
+        ...     resource_uri="file:///path/to/document.txt"
+        ... )
+
+        >>> # Call a tool on the server
+        >>> tool_result = client.run(
+        ...     server_config=server_config,
+        ...     operation="call_tool",
+        ...     tool_name="create_file",
+        ...     tool_arguments={
+        ...         "path": "/path/to/new_file.txt",
+        ...         "content": "Hello, World!"
+        ...     }
+        ... )
     """
 
     def get_parameters(self) -> Dict[str, NodeParameter]:

kailash/nodes/transform/formatters.py

@@ -90,7 +90,7 @@ Context:
 
 Please provide a comprehensive answer based on the information provided above."""
 
-        # Create messages list for LLMAgent
+        # Create messages list for LLMAgentNode
         messages = [{"role": "user", "content": prompt}]
 
         return {"formatted_prompt": prompt, "messages": messages, "context": context}

kailash/tracking/metrics_collector.py

@@ -88,13 +88,12 @@ class MetricsCollector:
     metrics during node execution, with support for both process-level and
     system-level monitoring.
 
-    Usage::
-
-        collector = MetricsCollector()
-        with collector.collect() as metrics:
-            # Execute node code here
-            pass
-        performance_data = metrics.result()
+    Usage:
+        >>> collector = MetricsCollector()
+        >>> with collector.collect() as metrics:
+        ...     # Execute node code here
+        ...     pass
+        >>> performance_data = metrics.result()
     """
 
     def __init__(self, sampling_interval: float = 0.1):

kailash/utils/export.py

@@ -88,8 +88,8 @@ class NodeMapper:
             resources=ResourceSpec(cpu="100m", memory="256Mi"),
         )
 
-        self.mappings["CSVReader"] = ContainerMapping(
-            python_node="CSVReader",
+        self.mappings["CSVReaderNode"] = ContainerMapping(
+            python_node="CSVReaderNode",
             container_image="kailash/csv-reader:latest",
             command=["python", "-m", "kailash.nodes.data.csv_reader"],
             resources=ResourceSpec(cpu="100m", memory="512Mi"),

kailash/utils/templates.py

@@ -352,7 +352,7 @@ See `workflows/example_workflow.py` for a basic workflow example.
         # Create example workflow
         workflow_content = '''"""Example workflow for data processing."""
 from kailash.workflow import Workflow
-from kailash.nodes.data import CSVReader, CSVWriter
+from kailash.nodes.data import CSVReaderNode, CSVWriterNode
 from kailash.nodes.transform import Filter, Sort
 from kailash.nodes.logic import Aggregator
 
@@ -363,11 +363,11 @@ workflow = Workflow(
 )
 
 # Add nodes
-workflow.add_node("reader", CSVReader(), file_path="examples/examples/data/input.csv")
+workflow.add_node("reader", CSVReaderNode(), file_path="examples/examples/data/input.csv")
 workflow.add_node("filter", Filter(), field="value", operator=">", value=100)
 workflow.add_node("sort", Sort(), field="value", reverse=True)
 workflow.add_node("aggregate", Aggregator(), group_by="category", operation="sum")
-workflow.add_node("writer", CSVWriter(), file_path="outputs/results.csv")
+workflow.add_node("writer", CSVWriterNode(), file_path="outputs/results.csv")
 
 # Connect nodes
 workflow.connect("reader", "filter", {"data": "data"})
@@ -471,9 +471,9 @@ Thumbs.db
         # Add data processing workflow
         workflow_content = '''"""Data processing pipeline workflow."""
 from kailash.workflow import Workflow
-from kailash.nodes.data import CSVReader, JSONReader, JSONWriter
+from kailash.nodes.data import CSVReaderNode, JSONReaderNode, JSONWriterNode
 from kailash.nodes.transform import Filter, Map, Sort
-from kailash.nodes.logic import Aggregator, Merge
+from kailash.nodes.logic import Aggregator, MergeNode
 
 # Create workflow
 workflow = Workflow(
@@ -482,20 +482,20 @@ workflow = Workflow(
 )
 
 # Data ingestion
-workflow.add_node("csv_reader", CSVReader(), file_path="examples/examples/data/sales_data.csv")
-workflow.add_node("json_reader", JSONReader(), file_path="examples/examples/data/product_data.json")
+workflow.add_node("csv_reader", CSVReaderNode(), file_path="examples/examples/data/sales_data.csv")
+workflow.add_node("json_reader", JSONReaderNode(), file_path="examples/examples/data/product_data.json")
 
 # Transform data
 workflow.add_node("filter_sales", Filter(), field="amount", operator=">", value=1000)
 workflow.add_node("calculate_profit", Map(), field="amount", operation="multiply", value=0.2)
-workflow.add_node("merge_data", Merge(), merge_type="merge_dict", key="product_id")
+workflow.add_node("merge_data", MergeNode(), merge_type="merge_dict", key="product_id")
 
 # Aggregate results
 workflow.add_node("group_by_category", Aggregator(), group_by="category", operation="sum")
 workflow.add_node("sort_results", Sort(), field="value", reverse=True)
 
 # Export results
-workflow.add_node("write_json", JSONWriter(), file_path="outputs/analysis_results.json")
+workflow.add_node("write_json", JSONWriterNode(), file_path="outputs/analysis_results.json")
 
 # Connect pipeline
 workflow.connect("csv_reader", "filter_sales", {"data": "data"})
@@ -537,7 +537,7 @@ workflow.connect("sort_results", "write_json", {"sorted_data": "data"})
         # Add ML workflow
         workflow_content = '''"""Machine learning pipeline workflow."""
 from kailash.workflow import Workflow
-from kailash.nodes.data import CSVReader, JSONWriter
+from kailash.nodes.data import CSVReaderNode, JSONWriterNode
 from kailash.nodes.transform import Filter, Map
 from kailash.nodes.ai import (
     TextClassifier,
@@ -553,7 +553,7 @@ workflow = Workflow(
 )
 
 # Data ingestion
-workflow.add_node("read_data", CSVReader(), file_path="examples/examples/data/text_data.csv")
+workflow.add_node("read_data", CSVReaderNode(), file_path="examples/examples/data/text_data.csv")
 
 # Preprocessing
 workflow.add_node("extract_text", Map(), field="content")
@@ -567,10 +567,10 @@ workflow.add_node("extract_entities", NamedEntityRecognizer(),
 workflow.add_node("summarize", TextSummarizer(), max_length=100)
 
 # Combine results
-workflow.add_node("merge_results", Merge(), merge_type="merge_dict")
+workflow.add_node("merge_results", MergeNode(), merge_type="merge_dict")
 
 # Export results
-workflow.add_node("save_results", JSONWriter(), file_path="outputs/ml_results.json")
+workflow.add_node("save_results", JSONWriterNode(), file_path="outputs/ml_results.json")
 
 # Connect pipeline
 workflow.connect("read_data", "extract_text", {"data": "data"})
@@ -604,7 +604,7 @@ workflow.connect("merge_results", "save_results", {"merged_data": "data"})
         # Add API workflow
         workflow_content = '''"""API integration workflow."""
 from kailash.workflow import Workflow
-from kailash.nodes.data import JSONReader, JSONWriter
+from kailash.nodes.data import JSONReaderNode, JSONWriterNode
 from kailash.nodes.transform import Map, Filter
 from kailash.nodes.logic import Conditional
 from kailash.nodes.ai import ChatAgent, FunctionCallingAgent
@@ -616,7 +616,7 @@ workflow = Workflow(
 )
 
 # Read configuration
-workflow.add_node("read_config", JSONReader(), file_path="examples/examples/data/api_config.json")
+workflow.add_node("read_config", JSONReaderNode(), file_path="examples/examples/data/api_config.json")
 
 # Process with AI agent
 workflow.add_node("chat_agent", ChatAgent(),
@@ -644,7 +644,7 @@ workflow.add_node("process_success", Map(), operation="identity")
 workflow.add_node("handle_error", Map(), operation="identity")
 
 # Save results
-workflow.add_node("save_results", JSONWriter(), file_path="outputs/api_results.json")
+workflow.add_node("save_results", JSONWriterNode(), file_path="outputs/api_results.json")
 
 # Connect workflow
 workflow.connect("read_config", "chat_agent", {"data": "messages"})