wmill 1.500.0__py3-none-any.whl → 1.500.2__py3-none-any.whl

wmill/client.py

@@ -16,7 +16,12 @@ from typing import Dict, Any, Union, Literal
 import httpx
 
 from .s3_reader import S3BufferedReader, bytes_generator
-from .s3_types import Boto3ConnectionSettings, DuckDbConnectionSettings, PolarsConnectionSettings, S3Object
+from .s3_types import (
+    Boto3ConnectionSettings,
+    DuckDbConnectionSettings,
+    PolarsConnectionSettings,
+    S3Object,
+)
 
 _client: "Windmill | None" = None
 
@@ -27,7 +32,11 @@ 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") or os.environ.get("WM_BASE_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")
@@ -42,7 +51,9 @@ class Windmill:
 
         self.mocked_api = self.get_mocked_api()
 
-        assert self.workspace, f"workspace required as an argument or as WM_WORKSPACE environment variable"
+        assert self.workspace, (
+            f"workspace required as an argument or as WM_WORKSPACE environment variable"
+        )
 
     def get_mocked_api(self) -> Optional[dict]:
         mocked_path = os.environ.get("WM_MOCKED_API_FILE")
@@ -55,7 +66,10 @@ class Windmill:
                 incoming_mocked_api = json.load(f)
             mocked_api = {**mocked_api, **incoming_mocked_api}
         except Exception as e:
-            logger.warning("Error parsing mocked API file at path %s Using empty mocked API.", mocked_path)
+            logger.warning(
+                "Error parsing mocked API file at path %s Using empty mocked API.",
+                mocked_path,
+            )
             logger.debug(e)
         return mocked_api
 
@@ -165,7 +179,9 @@ class Windmill:
             timeout = timeout.total_seconds()
 
         job_id = self.run_script_async(path=path, hash_=hash_, args=args)
-        return self.wait_job(job_id, timeout, verbose, cleanup, assert_result_is_not_none)
+        return self.wait_job(
+            job_id, timeout, verbose, cleanup, assert_result_is_not_none
+        )
 
     def wait_job(
         self,
@@ -191,7 +207,9 @@ class Windmill:
             timeout = timeout.total_seconds()
 
         while True:
-            result_res = self.get(f"/w/{self.workspace}/jobs_u/completed/get_result_maybe/{job_id}", True).json()
+            result_res = self.get(
+                f"/w/{self.workspace}/jobs_u/completed/get_result_maybe/{job_id}", True
+            ).json()
 
             started = result_res["started"]
             completed = result_res["completed"]
@@ -300,7 +318,9 @@ class Windmill:
                 result = variables[path]
                 return result
             except KeyError:
-                logger.info(f"MockedAPI present, but variable not found at {path}, falling back to real API")
+                logger.info(
+                    f"MockedAPI present, but variable not found at {path}, falling back to real API"
+                )
 
         """Get variable from Windmill"""
         return self.get(f"/w/{self.workspace}/variables/get_value/{path}").json()
@@ -312,7 +332,9 @@ class Windmill:
 
         """Set variable from Windmill"""
         # check if variable exists
-        r = self.get(f"/w/{self.workspace}/variables/get/{path}", raise_for_status=False)
+        r = self.get(
+            f"/w/{self.workspace}/variables/get/{path}", raise_for_status=False
+        )
         if r.status_code == 404:
             # create variable
             self.post(
@@ -344,13 +366,19 @@ class Windmill:
             except KeyError:
                 # NOTE: should mocked_api respect `none_if_undefined`?
                 if none_if_undefined:
-                    logger.info(f"resource not found at ${path}, but none_if_undefined is True, so returning None")
+                    logger.info(
+                        f"resource not found at ${path}, but none_if_undefined is True, so returning None"
+                    )
                     return None
-                logger.info(f"MockedAPI present, but resource not found at ${path}, falling back to real API")
+                logger.info(
+                    f"MockedAPI present, but resource not found at ${path}, falling back to real API"
+                )
 
         """Get resource from Windmill"""
         try:
-            return self.get(f"/w/{self.workspace}/resources/get_value_interpolated/{path}").json()
+            return self.get(
+                f"/w/{self.workspace}/resources/get_value_interpolated/{path}"
+            ).json()
         except Exception as e:
             if none_if_undefined:
                 return None
@@ -368,7 +396,9 @@ class Windmill:
             return
 
         # check if resource exists
-        r = self.get(f"/w/{self.workspace}/resources/get/{path}", raise_for_status=False)
+        r = self.get(
+            f"/w/{self.workspace}/resources/get/{path}", raise_for_status=False
+        )
         if r.status_code == 404:
             # create resource
             self.post(
@@ -422,14 +452,21 @@ class Windmill:
     def set_flow_user_state(self, key: str, value: Any) -> None:
         """Set the user state of a flow at a given key"""
         flow_id = self.get_root_job_id()
-        r = self.post(f"/w/{self.workspace}/jobs/flow/user_states/{flow_id}/{key}", json=value, raise_for_status=False)
+        r = self.post(
+            f"/w/{self.workspace}/jobs/flow/user_states/{flow_id}/{key}",
+            json=value,
+            raise_for_status=False,
+        )
         if r.status_code == 404:
             print(f"Job {flow_id} does not exist or is not a flow")
 
     def get_flow_user_state(self, key: str) -> Any:
         """Get the user state of a flow at a given key"""
         flow_id = self.get_root_job_id()
-        r = self.get(f"/w/{self.workspace}/jobs/flow/user_states/{flow_id}/{key}", raise_for_status=False)
+        r = self.get(
+            f"/w/{self.workspace}/jobs/flow/user_states/{flow_id}/{key}",
+            raise_for_status=False,
+        )
         if r.status_code == 404:
             print(f"Job {flow_id} does not exist or is not a flow")
             return None
@@ -451,11 +488,15 @@ class Windmill:
         try:
             raw_obj = self.post(
                 f"/w/{self.workspace}/job_helpers/v2/duckdb_connection_settings",
-                json={} if s3_resource_path == "" else {"s3_resource_path": s3_resource_path},
+                json={}
+                if s3_resource_path == ""
+                else {"s3_resource_path": s3_resource_path},
             ).json()
             return DuckDbConnectionSettings(raw_obj)
         except JSONDecodeError as e:
-            raise Exception("Could not generate DuckDB S3 connection settings from the provided resource") from e
+            raise Exception(
+                "Could not generate DuckDB S3 connection settings from the provided resource"
+            ) from e
 
     def get_polars_connection_settings(
         self,
@@ -468,11 +509,15 @@ class Windmill:
         try:
             raw_obj = self.post(
                 f"/w/{self.workspace}/job_helpers/v2/polars_connection_settings",
-                json={} if s3_resource_path == "" else {"s3_resource_path": s3_resource_path},
+                json={}
+                if s3_resource_path == ""
+                else {"s3_resource_path": s3_resource_path},
             ).json()
             return PolarsConnectionSettings(raw_obj)
         except JSONDecodeError as e:
-            raise Exception("Could not generate Polars S3 connection settings from the provided resource") from e
+            raise Exception(
+                "Could not generate Polars S3 connection settings from the provided resource"
+            ) from e
 
     def get_boto3_connection_settings(
         self,
@@ -485,11 +530,15 @@ class Windmill:
         try:
             s3_resource = self.post(
                 f"/w/{self.workspace}/job_helpers/v2/s3_resource_info",
-                json={} if s3_resource_path == "" else {"s3_resource_path": s3_resource_path},
+                json={}
+                if s3_resource_path == ""
+                else {"s3_resource_path": s3_resource_path},
             ).json()
             return self.__boto3_connection_settings(s3_resource)
         except JSONDecodeError as e:
-            raise Exception("Could not generate Boto3 S3 connection settings from the provided resource") from e
+            raise Exception(
+                "Could not generate Boto3 S3 connection settings from the provided resource"
+            ) from e
 
     def load_s3_file(self, s3object: S3Object, s3_resource_path: str | None) -> bytes:
         """
@@ -506,7 +555,9 @@ class Windmill:
         with self.load_s3_file_reader(s3object, s3_resource_path) as file_reader:
             return file_reader.read()
 
-    def load_s3_file_reader(self, s3object: S3Object, s3_resource_path: str | None) -> BufferedReader:
+    def load_s3_file_reader(
+        self, s3object: S3Object, s3_resource_path: str | None
+    ) -> BufferedReader:
         """
         Load a file from the workspace s3 bucket and returns the bytes stream.
 
@@ -565,7 +616,11 @@ 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
@@ -576,7 +631,10 @@ class Windmill:
             # need a vanilla client b/c content-type is not application/json here
             response = httpx.post(
                 f"{self.base_url}/w/{self.workspace}/job_helpers/upload_s3_file",
-                headers={"Authorization": f"Bearer {self.token}", "Content-Type": "application/octet-stream"},
+                headers={
+                    "Authorization": f"Bearer {self.token}",
+                    "Content-Type": "application/octet-stream",
+                },
                 params=query_params,
                 content=content_payload,
                 verify=self.verify,
@@ -587,16 +645,23 @@ class Windmill:
         return S3Object(s3=response["file_key"])
 
     def sign_s3_objects(self, s3_objects: list[S3Object]) -> list[S3Object]:
-        return self.post(f"/w/{self.workspace}/apps/sign_s3_objects", json={"s3_objects": s3_objects}).json()
+        return self.post(
+            f"/w/{self.workspace}/apps/sign_s3_objects", json={"s3_objects": s3_objects}
+        ).json()
 
     def sign_s3_object(self, s3_object: S3Object) -> S3Object:
-        return self.post(f"/w/{self.workspace}/apps/sign_s3_objects", json={"s3_objects": [s3_object]}).json()[0]
+        return self.post(
+            f"/w/{self.workspace}/apps/sign_s3_objects",
+            json={"s3_objects": [s3_object]},
+        ).json()[0]
 
     def __boto3_connection_settings(self, s3_resource) -> Boto3ConnectionSettings:
         endpoint_url_prefix = "https://" if s3_resource["useSSL"] else "http://"
         return Boto3ConnectionSettings(
             {
-                "endpoint_url": "{}{}".format(endpoint_url_prefix, s3_resource["endPoint"]),
+                "endpoint_url": "{}{}".format(
+                    endpoint_url_prefix, s3_resource["endPoint"]
+                ),
                 "region_name": s3_resource["region"],
                 "use_ssl": s3_resource["useSSL"],
                 "aws_access_key_id": s3_resource["accessKey"],
@@ -614,7 +679,9 @@ class Windmill:
 
     @property
     def state_path(self) -> str:
-        state_path = os.environ.get("WM_STATE_PATH_NEW", os.environ.get("WM_STATE_PATH"))
+        state_path = os.environ.get(
+            "WM_STATE_PATH_NEW", os.environ.get("WM_STATE_PATH")
+        )
         if state_path is None:
             raise Exception("State path not found")
         return state_path
@@ -686,7 +753,7 @@ class Windmill:
     ) -> 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
 
@@ -702,10 +769,10 @@ class Windmill:
         :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:**
@@ -759,13 +826,26 @@ class Windmill:
         Indeed, in the viewer context WM_USERNAME is set to the username of the viewer but WM_EMAIL is set to the email of the creator of the app.
         """
         return self.get(f"/w/{self.workspace}/users/username_to_email/{username}").text
-    
 
-    def send_teams_message(self, conversation_id: str, text: str, success: bool = True, card_block: dict = None):
+    def send_teams_message(
+        self,
+        conversation_id: str,
+        text: str,
+        success: bool = True,
+        card_block: dict = None,
+    ):
         """
         Send a message to a Microsoft Teams conversation with conversation_id, where success is used to style the message
         """
-        return self.post(f"/teams/activities", json={"conversation_id": conversation_id, "text": text, "success": success, "card_block": card_block})
+        return self.post(
+            f"/teams/activities",
+            json={
+                "conversation_id": conversation_id,
+                "text": text,
+                "success": success,
+                "card_block": card_block,
+            },
+        )
 
 
 def init_global_client(f):
@@ -914,7 +994,9 @@ def get_job_status(job_id: str) -> JobStatus:
 
 @init_global_client
 def get_result(job_id: str, assert_result_is_not_none=True) -> Dict[str, Any]:
-    return _client.get_result(job_id=job_id, assert_result_is_not_none=assert_result_is_not_none)
+    return _client.get_result(
+        job_id=job_id, assert_result_is_not_none=assert_result_is_not_none
+    )
 
 
 @init_global_client
@@ -949,15 +1031,21 @@ def load_s3_file(s3object: S3Object, s3_resource_path: str | None = None) -> byt
     """
     Load the entire content of a file stored in S3 as bytes
     """
-    return _client.load_s3_file(s3object, s3_resource_path if s3_resource_path != "" else None)
+    return _client.load_s3_file(
+        s3object, s3_resource_path if s3_resource_path != "" else None
+    )
 
 
 @init_global_client
-def load_s3_file_reader(s3object: S3Object, s3_resource_path: str | None = None) -> BufferedReader:
+def load_s3_file_reader(
+    s3object: S3Object, s3_resource_path: str | None = None
+) -> BufferedReader:
     """
     Load the content of a file stored in S3
     """
-    return _client.load_s3_file_reader(s3object, s3_resource_path if s3_resource_path != "" else None)
+    return _client.load_s3_file_reader(
+        s3object, s3_resource_path if s3_resource_path != "" else None
+    )
 
 
 @init_global_client
@@ -977,7 +1065,13 @@ def write_s3_file(
     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, content_type, content_disposition)
+    return _client.write_s3_file(
+        s3object,
+        file_content,
+        s3_resource_path if s3_resource_path != "" else None,
+        content_type,
+        content_disposition,
+    )
 
 
 @init_global_client
@@ -1126,6 +1220,7 @@ 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,
@@ -1144,10 +1239,14 @@ def request_interactive_slack_approval(
         dynamic_enums_json=dynamic_enums_json,
     )
 
+
 @init_global_client
-def send_teams_message(conversation_id: str, text: str, success: bool, card_block: dict = None):
+def send_teams_message(
+    conversation_id: str, text: str, success: bool, card_block: dict = None
+):
     return _client.send_teams_message(conversation_id, text, success, card_block)
 
+
 @init_global_client
 def cancel_running() -> dict:
     """Cancel currently running executions of the same script."""
@@ -1190,7 +1289,10 @@ def task(*args, **kwargs):
     from inspect import signature
 
     def f(func, tag: str | None = None):
-        if os.environ.get("WM_JOB_ID") is None or os.environ.get("MAIN_OVERRIDE") == func.__name__:
+        if (
+            os.environ.get("WM_JOB_ID") is None
+            or os.environ.get("MAIN_OVERRIDE") == func.__name__
+        ):
 
             def inner(*args, **kwargs):
                 return func(*args, **kwargs)

{wmill-1.500.0.dist-info → wmill-1.500.2.dist-info}/METADATA

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

{wmill-1.500.0.dist-info → wmill-1.500.2.dist-info}/RECORD

@@ -1,8 +1,8 @@
 wmill/__init__.py,sha256=nGZnQPezTdrBnBW1D0JqUtm75Gdf_xi3tAcPGwHRZ5A,46
-wmill/client.py,sha256=bwWDX_TKjddIlA-guczp32kT_Z0nLUGZNyZmm4LCNvM,42371
+wmill/client.py,sha256=ZtFtIqi6VKPP3fQgofylkecxVUerNffRH2mWAFDuodY,43537
 wmill/py.typed,sha256=8PjyZ1aVoQpRVvt71muvuq5qE-jTFZkK-GLHkhdebmc,26
 wmill/s3_reader.py,sha256=izHlg2Xsg0Sr_LkDDEC35VuEijJcuPBDIm-xj21KsgU,1668
 wmill/s3_types.py,sha256=S5w6fVAai5Adm1MxZoxF21R-EE5-wRfGzXBK72-FZvE,1199
-wmill-1.500.0.dist-info/METADATA,sha256=pF4mKo8SYwEfvTEA9dnHt3k8VpGXH4XbfHmp0AfxV7o,2693
-wmill-1.500.0.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
-wmill-1.500.0.dist-info/RECORD,,
+wmill-1.500.2.dist-info/METADATA,sha256=dGI7Z8klzYZpqUbnIwMhR-YvOzttZAjfioct0lsu5l4,2693
+wmill-1.500.2.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
+wmill-1.500.2.dist-info/RECORD,,