wmill 1.413.1__tar.gz → 1.450.1__tar.gz

{wmill-1.413.1 → wmill-1.450.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wmill
-Version: 1.413.1
+Version: 1.450.1
 Summary: A client library for accessing Windmill server wrapping the Windmill client API
 Home-page: https://windmill.dev
 License: Apache-2.0

{wmill-1.413.1 → wmill-1.450.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "wmill"
-version = "1.413.1"
+version = "1.450.1"
 description = "A client library for accessing Windmill server wrapping the Windmill client API"
 license = "Apache-2.0"
 homepage = "https://windmill.dev"

{wmill-1.413.1 → wmill-1.450.1}/wmill/client.py

@@ -9,6 +9,7 @@ import os
 import random
 import time
 import warnings
+import json
 from json import JSONDecodeError
 from typing import Dict, Any, Union, Literal
 
@@ -26,7 +27,7 @@ JobStatus = Literal["RUNNING", "WAITING", "COMPLETED"]
 
 class Windmill:
     def __init__(self, base_url=None, token=None, workspace=None, verify=True):
-        base = base_url or os.environ.get("BASE_INTERNAL_URL")
+        base = base_url or os.environ.get("BASE_INTERNAL_URL") or os.environ.get("WM_BASE_URL")
 
         self.base_url = f"{base}/api"
         self.token = token or os.environ.get("WM_TOKEN")
@@ -358,15 +359,15 @@ class Windmill:
                 "percent": value,
                 "flow_job_id": flow_id or None,
             },
-        )        
+        )
 
-    def get_progress(self, job_id: Optional[str] = None ) -> Any:
+    def get_progress(self, job_id: Optional[str] = None) -> Any:
         workspace = get_workspace()
         job_id = job_id or os.environ.get("WM_JOB_ID")
 
         r = self.get(
             f"/w/{workspace}/job_metrics/get_progress/{job_id}",
-        )        
+        )
         if r.status_code == 404:
             print(f"Job {job_id} does not exist")
             return None
@@ -472,7 +473,13 @@ class Windmill:
             print(file_reader.read())
         '''
         """
-        reader = S3BufferedReader(f"{self.workspace}", self.client, s3object["s3"], s3_resource_path, s3object["storage"] if "storage" in s3object else None)
+        reader = S3BufferedReader(
+            f"{self.workspace}",
+            self.client,
+            s3object["s3"],
+            s3_resource_path,
+            s3object["storage"] if "storage" in s3object else None,
+        )
         return reader
 
     def write_s3_file(
@@ -480,6 +487,8 @@ class Windmill:
         s3object: S3Object | None,
         file_content: BufferedReader | bytes,
         s3_resource_path: str | None,
+        content_type: str | None = None,
+        content_disposition: str | None = None,
     ) -> S3Object:
         """
         Write a file to the workspace S3 bucket
@@ -511,8 +520,12 @@ class Windmill:
             query_params["file_key"] = s3object["s3"]
         if s3_resource_path is not None and s3_resource_path != "":
             query_params["s3_resource_path"] = s3_resource_path
-        if s3object is not None and  "storage" in s3object and s3object["storage"] is not None:
+        if s3object is not None and "storage" in s3object and s3object["storage"] is not None:
             query_params["storage"] = s3object["storage"]
+        if content_type is not None:
+            query_params["content_type"] = content_type
+        if content_disposition is not None:
+            query_params["content_disposition"] = content_disposition
 
         try:
             # need a vanilla client b/c content-type is not application/json here
@@ -611,6 +624,83 @@ class Windmill:
             params={"approver": approver},
         ).json()
 
+    def request_interactive_slack_approval(
+        self,
+        slack_resource_path: str,
+        channel_id: str,
+        message: str = None,
+        approver: str = None,
+        default_args_json: dict = None,
+        dynamic_enums_json: dict = None,
+    ) -> None:
+        """
+        Sends an interactive approval request via Slack, allowing optional customization of the message, approver, and form fields.
+        
+        **[Enterprise Edition Only]** To include form fields in the Slack approval request, use the "Advanced -> Suspend -> Form" functionality.
+        Learn more at: https://www.windmill.dev/docs/flows/flow_approval#form
+
+        :param slack_resource_path: The path to the Slack resource in Windmill.
+        :type slack_resource_path: str
+        :param channel_id: The Slack channel ID where the approval request will be sent.
+        :type channel_id: str
+        :param message: Optional custom message to include in the Slack approval request.
+        :type message: str, optional
+        :param approver: Optional user ID or name of the approver for the request.
+        :type approver: str, optional
+        :param default_args_json: Optional dictionary defining or overriding the default arguments for form fields.
+        :type default_args_json: dict, optional
+        :param dynamic_enums_json: Optional dictionary overriding the enum default values of enum form fields.
+        :type dynamic_enums_json: dict, optional
+        
+        :raises Exception: If the function is not called within a flow or flow preview.
+        :raises Exception: If the required flow job or flow step environment variables are not set.
+        
+        :return: None
+
+        **Usage Example:**
+            >>> client.request_interactive_slack_approval(
+            ...     slack_resource_path="/u/alex/my_slack_resource",
+            ...     channel_id="admins-slack-channel",
+            ...     message="Please approve this request",
+            ...     approver="approver123",
+            ...     default_args_json={"key1": "value1", "key2": 42},
+            ...     dynamic_enums_json={"foo": ["choice1", "choice2"], "bar": ["optionA", "optionB"]},
+            ... )
+
+        **Notes:**
+        - This function must be executed within a Windmill flow or flow preview.
+        - The function checks for required environment variables (`WM_FLOW_JOB_ID`, `WM_FLOW_STEP_ID`) to ensure it is run in the appropriate context.
+        """
+        workspace = self.workspace
+        flow_job_id = os.environ.get("WM_FLOW_JOB_ID")
+
+        if not flow_job_id:
+            raise Exception(
+                "You can't use 'request_interactive_slack_approval' function in a standalone script or flow step preview. Please use it in a flow or a flow preview."
+            )
+
+        # Only include non-empty parameters
+        params = {}
+        if message:
+            params["message"] = message
+        if approver:
+            params["approver"] = approver
+        if slack_resource_path:
+            params["slack_resource_path"] = slack_resource_path
+        if channel_id:
+            params["channel_id"] = channel_id
+        if os.environ.get("WM_FLOW_STEP_ID"):
+            params["flow_step_id"] = os.environ.get("WM_FLOW_STEP_ID")
+        if default_args_json:
+            params["default_args_json"] = json.dumps(default_args_json)
+        if dynamic_enums_json:
+            params["dynamic_enums_json"] = json.dumps(dynamic_enums_json)
+
+        self.get(
+            f"/w/{workspace}/jobs/slack_approval/{os.environ.get('WM_JOB_ID', 'NO_JOB_ID')}",
+            params=params,
+        )
+
     def username_to_email(self, username: str) -> str:
         """
         Get email from workspace username
@@ -817,11 +907,19 @@ def write_s3_file(
     s3object: S3Object | None,
     file_content: BufferedReader | bytes,
     s3_resource_path: str | None = None,
+    content_type: str | None = None,
+    content_disposition: str | None = None,
 ) -> S3Object:
     """
     Upload a file to S3
+
+    Content type will be automatically guessed from path extension if left empty
+
+    See MDN for content_disposition: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition
+    and content_type: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type
+
     """
-    return _client.write_s3_file(s3object, file_content, s3_resource_path if s3_resource_path != "" else None)
+    return _client.write_s3_file(s3object, file_content, s3_resource_path if s3_resource_path != "" else None, content_type, content_disposition)
 
 
 @init_global_client
@@ -865,6 +963,7 @@ def set_state(value: Any) -> None:
     """
     return _client.set_state(value)
 
+
 @init_global_client
 def set_progress(value: int, job_id: Optional[str] = None) -> None:
     """
@@ -872,6 +971,7 @@ def set_progress(value: int, job_id: Optional[str] = None) -> None:
     """
     return _client.set_progress(value, job_id)
 
+
 @init_global_client
 def get_progress(job_id: Optional[str] = None) -> Any:
     """
@@ -950,6 +1050,23 @@ def get_state_path() -> str:
 def get_resume_urls(approver: str = None) -> dict:
     return _client.get_resume_urls(approver)
 
+@init_global_client
+def request_interactive_slack_approval(
+    slack_resource_path: str,
+    channel_id: str,
+    message: str = None,
+    approver: str = None,
+    default_args_json: dict = None,
+    dynamic_enums_json: dict = None,
+) -> None:
+    return _client.request_interactive_slack_approval(
+        slack_resource_path=slack_resource_path,
+        channel_id=channel_id,
+        message=message,
+        approver=approver,
+        default_args_json=default_args_json,
+        dynamic_enums_json=dynamic_enums_json,
+    )
 
 @init_global_client
 def cancel_running() -> dict: