fix: action parameter breaking change (#46)

Signed-off-by: develop-cs <43383361+develop-cs@users.noreply.github.com>

Author: develop-cs

.pre-commit-config.yaml

@@ -26,7 +26,7 @@ repos:
       - id: check-added-large-files
         args: [--maxkb=500]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.11.2
+    rev: v0.11.4
     hooks:
       - id: ruff
         args: [--fix]
@@ -43,7 +43,7 @@ repos:
     hooks:
       - id: gitleaks
   - repo: https://github.com/pypa/pip-audit
-    rev: v2.8.0
+    rev: v2.9.0
     hooks:
       - id: pip-audit
         args: [--skip-editable]

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.10.1] - April, 2025
+
+### Fixes
+
+* Unintentional breaking change on the action function parameter `input_data` (now deprecated).
+
 ## [0.10.0] - April, 2025
 
 ### Features

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "arta"
-version = "0.10.0"
+version = "0.10.1"
 requires-python = ">3.8.0"
 description = "A Python Rules Engine - Make rule handling simple"
 readme = "README.md"

src/arta/rule.py

@@ -8,6 +8,7 @@
 import inspect
 import re
 from typing import Any, Callable
+from warnings import warn
 
 from arta.condition import BaseCondition, StandardCondition
 from arta.exceptions import ConditionExecutionError, RuleExecutionError
@@ -111,6 +112,18 @@ def apply(
                 if arg_spec.varkw is not None:
                     parameters["input_data"] = input_data
 
+                # Backward compatibility case (now deprecated)
+                if "input_data" in arg_spec.args or "input_data" in arg_spec.kwonlyargs:
+                    warn(
+                        (
+                            "Using 'input_data' directly as an action function parameter is deprecated. "
+                            "Use '**kwargs' instead. See how at https://maif.github.io/arta/value_sharing/"
+                        ),
+                        DeprecationWarning,
+                        stacklevel=2,
+                    )
+                    parameters["input_data"] = input_data
+
                 # Run action
                 rule_results["action_result"] = self._action(**parameters)
 

tests/examples/code/actions.py

@@ -30,7 +30,7 @@ def send_email(mail_to: str, mail_content: str, meal: str) -> bool:
     return is_ok
 
 
-def concatenate_list(list_str: list[Any], **extra: Any) -> str:
+def concatenate_list(list_str: list[Any], input_data: dict[str, Any]) -> str:
     """Demo function: return the concatenation of a list of string using input_data (two levels max)."""
     list_str = [str(element) for element in list_str]
     return "".join(list_str)
@@ -41,7 +41,7 @@ def do_nothing(**kwargs: Any) -> None:
     pass
 
 
-def compute_sum(value1: float, value2: float, **kwargs: Any) -> float:
+def compute_sum(value1: float, value2: float, **extra: Any) -> float:
     """Demo function: return sum of two values."""
     return value1 + value2
 

tests/test_example_code/test_actions.py

@@ -51,7 +51,7 @@ def test_send_email(mail_to, mail_content, meal, expected):
 
 def test_concatenate_list():
     """Action function unit test."""
-    result = actions.concatenate_list(["a", "b", "c"])
+    result = actions.concatenate_list(["a", "b", "c"], {})
     assert result == "abc"