Refactor Http class to utilize ParameterHelper for http_params conver…

UPDATING.md

@@ -27,6 +27,8 @@ It started after version 2.0.5 released
 * Remove attribute tenant from pydolphinscheduler.core.workflow.workflow ([#54](https://github.com/apache/dolphinscheduler-sdk-python/pull/54))
   and please change tenant name in ``config.yaml`` in ``PYDS_HOME``
 * Drop support of python3.6 and python3.7 ([#126](https://github.com/apache/dolphinscheduler-sdk-python/pull/126))
+* Deprecated old format of `http_params` in the Http class to support a new format. Users should now use the updated format.([#88])([#130])(https://github.com/apache/dolphinscheduler-sdk-python/pull/130)
+
 
 ## 4.0.0
 

src/pydolphinscheduler/tasks/http.py

@@ -22,6 +22,8 @@
 from pydolphinscheduler.constants import TaskType
 from pydolphinscheduler.core.task import Task
 from pydolphinscheduler.exceptions import PyDSParamException
+from pydolphinscheduler.core.parameter import ParameterHelper
+import warnings
 
 
 class HttpMethod:
@@ -51,7 +53,29 @@ class HttpCheckCondition:
 
 
 class Http(Task):
-    """Task HTTP object, declare behavior for HTTP task to dolphinscheduler."""
+    """Task HTTP object, declare behavior for HTTP task to dolphinscheduler.
+    Attributes:
+        _task_custom_attr (set): A set containing custom attributes specific to the Http task, 
+                                including 'url', 'http_method', 'http_params', and more.
+    Args:                            
+        :param str name: The name or identifier for the HTTP task.
+        :param str url: The URL endpoint for the HTTP request.
+        :param str http_method: The HTTP method for the request (GET, POST, etc.). Defaults to HttpMethod.GET.
+        :param dict http_params: Parameters for the HTTP request. Defaults to None.
+        :param str http_check_condition: Condition for checking the HTTP response status. 
+                                        Defaults to HttpCheckCondition.STATUS_CODE_DEFAULT.
+        :param str condition: Additional condition to evaluate if `http_check_condition` is not STATUS_CODE_DEFAULT.
+        :param int connect_timeout: Connection timeout for the HTTP request in milliseconds. Defaults to 60000.
+        :param int socket_timeout: Socket timeout for the HTTP request in milliseconds. Defaults to 60000.
+
+
+    Raises:
+        PyDSParamException: Exception raised for invalid parameters, such as unsupported HTTP methods or conditions.
+
+    Example:
+        Usage example for creating an HTTP task:
+        http_task = Http(name="http_task", url="https://api.example.com", http_method="POST", http_params={"key": "value"})
+    """
 
     _task_custom_attr = {
         "url",
@@ -68,7 +92,7 @@ def __init__(
         name: str,
         url: str,
         http_method: str | None = HttpMethod.GET,
-        http_params: str | None = None,
+        http_params: dict | None = None,
         http_check_condition: str | None = HttpCheckCondition.STATUS_CODE_DEFAULT,
         condition: str | None = None,
         connect_timeout: int | None = 60000,
@@ -82,20 +106,36 @@ def __init__(
             raise PyDSParamException(
                 "Parameter http_method %s not support.", http_method
             )
+
+        if isinstance(http_params, list):
+            warnings.warn(
+                "The `http_params` parameter currently accepts a dictionary instead of a list. Your parameter is being ignored.",
+                DeprecationWarning,
+            )
+
         self.http_method = http_method
-        self.http_params = http_params or []
-        if not hasattr(HttpCheckCondition, http_check_condition):
-            raise PyDSParamException(
+        self._http_params = http_params
+
+    @property
+    def http_params(self):
+        """Property to convert http_params using ParameterHelper when accessed."""
+        return ParameterHelper.convert_params(self._http_params, direction=Direction.IN) if self._http_params else []
+
+
+
+
+    if not hasattr(HttpCheckCondition, http_check_condition):
+        raise PyDSParamException(
                 "Parameter http_check_condition %s not support.", http_check_condition
             )
-        self.http_check_condition = http_check_condition
-        if (
-            http_check_condition != HttpCheckCondition.STATUS_CODE_DEFAULT
+    self.http_check_condition = http_check_condition
+    if (
+        http_check_condition != HttpCheckCondition.STATUS_CODE_DEFAULT
             and condition is None
         ):
-            raise PyDSParamException(
-                "Parameter condition must provider if http_check_condition not equal to STATUS_CODE_DEFAULT"
+        raise PyDSParamException(
+            "Parameter condition must provider if http_check_condition not equal to STATUS_CODE_DEFAULT"
             )
-        self.condition = condition
-        self.connect_timeout = connect_timeout
-        self.socket_timeout = socket_timeout
+    self.condition = condition
+    self.connect_timeout = connect_timeout
+    self.socket_timeout = socket_timeout

src/pydolphinscheduler/tasks/test_http_conversion.py

@@ -0,0 +1,32 @@
+from pydolphinscheduler.core.parameter import ParameterHelper, ParameterType
+from http.py import Http  # Replace 'your_module_path' with the actual path or import structure
+
+def test_http_params_conversion():
+    # Create a sample http_params dictionary
+    http_params_dict = {
+        "prop1": "value1",
+        "prop2": "value2",
+        "prop3": "value3"
+    }
+
+    # Create an instance of the Http class with http_params as a dictionary
+    http_instance = Http(
+        name="test_http",
+        url="http://www.example.com",
+        http_method="GET",
+        http_params=http_params_dict
+    )
+
+    # Print the initialized http_params attribute (should be converted to the desired format)
+    print("Converted http_params:", http_instance.http_params)
+
+    # Add any assertions or additional tests as required based on your project's logic
+    assert isinstance(http_instance.http_params, list)
+    assert len(http_instance.http_params) == len(http_params_dict)
+
+    # Add more assertions if necessary to validate the content or structure of the converted parameters
+    # For instance, check if certain properties exist or match expected values in the converted list format
+    # assert some_condition, "Assertion failed: Custom message if condition is not met"
+
+if __name__ == "__main__":
+    test_http_params_conversion()

tests/tasks/test_http.py

@@ -23,7 +23,8 @@
 
 from pydolphinscheduler.exceptions import PyDSParamException
 from pydolphinscheduler.tasks.http import Http, HttpCheckCondition, HttpMethod
-
+from pydolphinscheduler.core.parameter import ParameterHelper, ParameterType
+from http.py import Http  # Replace 'your_module_path' with the actual path or import structure
 
 @pytest.mark.parametrize(
     "class_name, attrs",
@@ -126,3 +127,30 @@ def test_http_get_define():
     ):
         http = Http(name, url)
         assert http.task_params == expect_task_params
+
+
+def test_http_params_conversion():
+    # Create a sample http_params dictionary
+    http_params_dict = {
+        "prop1": "value1",
+        "prop2": "value2",
+        "prop3": "value3"
+    }
+
+    # Create an instance of the Http class with http_params as a dictionary
+    http_instance = Http(
+        name="test_http",
+        url="http://www.example.com",
+        http_method="GET",
+        http_params=http_params_dict
+    )
+
+    # Print the initialized http_params attribute (should be converted to the desired format)
+    print("Converted http_params:", http_instance.http_params)
+
+    # Add any assertions or additional tests as required based on your project's logic
+    assert isinstance(http_instance.http_params, list)
+    assert len(http_instance.http_params) == len(http_params_dict)
+
+
+