zenml-nightly 0.72.0.dev20250120__py3-none-any.whl → 0.73.0.dev20250123__py3-none-any.whl

zenml/integrations/slack/__init__.py

@@ -30,8 +30,7 @@ class SlackIntegration(Integration):
     """
 
     NAME = SLACK
-    REQUIREMENTS = ["slack-sdk>=3.16.1", "aiohttp>=3.8.1"]
-    REQUIREMENTS_IGNORED_ON_UNINSTALL = ["aiohttp"]
+    REQUIREMENTS = ["slack-sdk==3.30.0"]
 
     @classmethod
     def flavors(cls) -> List[Type[Flavor]]:

zenml/integrations/slack/alerters/slack_alerter.py

@@ -14,12 +14,12 @@
 #  or implied. See the License for the specific language governing
 #  permissions and limitations under the License.
 
-from typing import Any, Dict, List, Optional, Type, cast
+import time
+from typing import Dict, List, Optional, Type, cast
 
 from pydantic import BaseModel
 from slack_sdk import WebClient
 from slack_sdk.errors import SlackApiError
-from slack_sdk.rtm import RTMClient
 
 from zenml import get_step_context
 from zenml.alerter.base_alerter import BaseAlerter, BaseAlerterStepParameters
@@ -58,7 +58,7 @@ class SlackAlerterParameters(BaseAlerterStepParameters):
     payload: Optional[SlackAlerterPayload] = None
     include_format_blocks: Optional[bool] = True
 
-    # Allowing user to use their own custom blocks in the slack post message
+    # Allowing user to use their own custom blocks in the Slack post message
     blocks: Optional[List[Dict]] = None  # type: ignore
 
 
@@ -96,7 +96,7 @@ class SlackAlerter(BaseAlerter):
 
         Raises:
             RuntimeError: if config is not of type `BaseAlerterStepConfig`.
-            ValueError: if a slack channel was neither defined in the config
+            ValueError: if a Slack channel was neither defined in the config
                 nor in the slack alerter component.
         """
         if params and not isinstance(params, BaseAlerterStepParameters):
@@ -111,24 +111,48 @@ class SlackAlerter(BaseAlerter):
         ):
             return params.slack_channel_id
 
-        settings = cast(
-            SlackAlerterSettings,
-            self.get_settings(get_step_context().step_run),
-        )
-        if settings.slack_channel_id is not None:
+        try:
+            settings = cast(
+                SlackAlerterSettings,
+                self.get_settings(get_step_context().step_run),
+            )
+        except RuntimeError:
+            settings = None
+
+        if settings is not None and settings.slack_channel_id is not None:
             return settings.slack_channel_id
 
-        if self.config.default_slack_channel_id is not None:
-            return self.config.default_slack_channel_id
+        if self.config.slack_channel_id is not None:
+            return self.config.slack_channel_id
 
         raise ValueError(
-            "Neither the `slack_channel_id` in the runtime "
-            "configuration, nor the `default_slack_channel_id` in the alerter "
-            "stack component is specified. Please specify at least one."
+            "The `slack_channel_id` is not set either in the runtime settings, "
+            "or the component configuration of the alerter. Please specify at "
+            "least one."
         )
 
+    def _get_timeout_duration(self) -> int:
+        """Gets the timeout duration used by the ask method .
+
+        Returns:
+            number of seconds for the timeout to happen.
+        """
+        try:
+            settings = cast(
+                SlackAlerterSettings,
+                self.get_settings(get_step_context().step_run),
+            )
+        except RuntimeError:
+            settings = None
+
+        if settings is not None:
+            return settings.timeout
+
+        return self.config.timeout
+
+    @staticmethod
     def _get_approve_msg_options(
-        self, params: Optional[BaseAlerterStepParameters]
+        params: Optional[BaseAlerterStepParameters],
     ) -> List[str]:
         """Define which messages will lead to approval during ask().
 
@@ -146,8 +170,9 @@ class SlackAlerter(BaseAlerter):
             return params.approve_msg_options
         return DEFAULT_APPROVE_MSG_OPTIONS
 
+    @staticmethod
     def _get_disapprove_msg_options(
-        self, params: Optional[BaseAlerterStepParameters]
+        params: Optional[BaseAlerterStepParameters],
     ) -> List[str]:
         """Define which messages will lead to disapproval during ask().
 
@@ -165,8 +190,8 @@ class SlackAlerter(BaseAlerter):
             return params.disapprove_msg_options
         return DEFAULT_DISAPPROVE_MSG_OPTIONS
 
+    @staticmethod
     def _create_blocks(
-        self,
         message: Optional[str],
         params: Optional[BaseAlerterStepParameters],
     ) -> List[Dict]:  # type: ignore
@@ -185,7 +210,8 @@ class SlackAlerter(BaseAlerter):
                 return params.blocks
             elif hasattr(params, "payload") and params.payload is not None:
                 logger.info(
-                    "No custom blocks set. Using default blocks for Slack alerter"
+                    "No custom blocks set. Using default blocks for Slack "
+                    "alerter."
                 )
                 payload = params.payload
                 return [
@@ -228,7 +254,8 @@ class SlackAlerter(BaseAlerter):
                 return []
         else:
             logger.info(
-                "params is not of type SlackAlerterParameters. Returning empty blocks."
+                "params is not of type SlackAlerterParameters. Returning empty "
+                "blocks."
             )
             return []
 
@@ -253,64 +280,95 @@ class SlackAlerter(BaseAlerter):
             response = client.chat_postMessage(
                 channel=slack_channel_id, text=message, blocks=blocks
             )
+            if not response.get("ok", False):
+                error_details = response.get("error", "Unknown error")
+                logger.error(
+                    f"Failed to send message to Slack channel. "
+                    f"Error: {error_details}. Full response: {response}"
+                )
+                return False
             return True
         except SlackApiError as error:
-            response = error.response["error"]
-            logger.error(f"SlackAlerter.post() failed: {response}")
+            error_message = error.response.get("error", "Unknown error")
+            logger.error(
+                "SlackAlerter.post() failed with Slack API error: "
+                f"{error_message}. Full response: {error.response}"
+            )
+            return False
+        except Exception as e:
+            logger.error(f"Unexpected error in SlackAlerter.post(): {str(e)}")
             return False
 
     def ask(
-        self, message: str, params: Optional[BaseAlerterStepParameters] = None
+        self, question: str, params: Optional[BaseAlerterStepParameters] = None
     ) -> bool:
         """Post a message to a Slack channel and wait for approval.
 
         Args:
-            message: Initial message to be posted.
+            question: Initial message to be posted.
             params: Optional parameters.
 
         Returns:
             True if a user approved the operation, else False
         """
-        rtm = RTMClient(token=self.config.slack_token)
         slack_channel_id = self._get_channel_id(params=params)
 
-        approved = False  # will be modified by handle()
-
-        @RTMClient.run_on(event="hello")  # type: ignore
-        def post_initial_message(**payload: Any) -> None:
-            """Post an initial message in a channel and start listening.
+        client = WebClient(token=self.config.slack_token)
+        approve_options = self._get_approve_msg_options(params)
+        disapprove_options = self._get_disapprove_msg_options(params)
 
-            Args:
-                payload: payload of the received Slack event.
-            """
-            web_client = payload["web_client"]
-            blocks = self._create_blocks(message, params)
-            web_client.chat_postMessage(
-                channel=slack_channel_id, text=message, blocks=blocks
+        try:
+            # Send message to the Slack channel
+            response = client.chat_postMessage(
+                channel=slack_channel_id,
+                text=question,
+                blocks=self._create_blocks(question, params),
             )
 
-        @RTMClient.run_on(event="message")  # type: ignore
-        def handle(**payload: Any) -> None:
-            """Listen / handle messages posted in the channel.
-
-            Args:
-                payload: payload of the received Slack event.
-            """
-            event = payload["data"]
-            if event["channel"] == slack_channel_id:
-                # approve request (return True)
-                if event["text"] in self._get_approve_msg_options(params):
-                    print(f"User {event['user']} approved on slack.")
-                    nonlocal approved
-                    approved = True
-                    rtm.stop()  # type: ignore[no-untyped-call]
-
-                # disapprove request (return False)
-                elif event["text"] in self._get_disapprove_msg_options(params):
-                    print(f"User {event['user']} disapproved on slack.")
-                    rtm.stop()  # type: ignore[no-untyped-call]
-
-        # start another thread until `rtm.stop()` is called in handle()
-        rtm.start()
-
-        return approved
+            if not response.get("ok", False):
+                error_details = response.get("error", "Unknown error")
+                logger.error(
+                    f"Failed to send the initial message to the Slack channel. "
+                    f"Error: {error_details}. Full response: {response}"
+                )
+                return False
+
+            # Retrieve timestamp of sent message
+            timestamp = response["ts"]
+
+            # Wait for a response
+            start_time = time.time()
+
+            while time.time() - start_time < self._get_timeout_duration():
+                history = client.conversations_history(
+                    channel=slack_channel_id, oldest=timestamp
+                )
+                for msg in history["messages"]:
+                    if "ts" in msg and "user" in msg:
+                        user_message = msg["text"].strip().lower()
+                        if user_message in [
+                            opt.lower() for opt in approve_options
+                        ]:
+                            logger.info("User approved the operation.")
+                            return True
+                        elif user_message in [
+                            opt.lower() for opt in disapprove_options
+                        ]:
+                            logger.info("User disapproved the operation.")
+                            return False
+
+                time.sleep(1)  # Polling interval
+
+            logger.warning("No response received within the timeout period.")
+            return False
+
+        except SlackApiError as error:
+            error_message = error.response.get("error", "Unknown error")
+            logger.error(
+                f"SlackAlerter.ask() failed with Slack API error: "
+                f"{error_message}. Full response: {error.response}"
+            )
+            return False
+        except Exception as e:
+            logger.error(f"Unexpected error in SlackAlerter.ask(): {str(e)}")
+            return False

zenml/integrations/slack/flavors/slack_alerter_flavor.py

@@ -19,6 +19,7 @@ from zenml.alerter.base_alerter import BaseAlerterConfig, BaseAlerterFlavor
 from zenml.config.base_settings import BaseSettings
 from zenml.integrations.slack import SLACK_ALERTER_FLAVOR
 from zenml.logger import get_logger
+from zenml.utils.deprecation_utils import deprecate_pydantic_attributes
 from zenml.utils.secret_utils import SecretField
 
 logger = get_logger(__name__)
@@ -32,21 +33,28 @@ class SlackAlerterSettings(BaseSettings):
 
     Attributes:
         slack_channel_id: The ID of the Slack channel to use for communication.
+        timeout: The amount of seconds to wait for the ask method.
     """
 
     slack_channel_id: Optional[str] = None
+    timeout: int = 300
 
 
-class SlackAlerterConfig(BaseAlerterConfig):
+class SlackAlerterConfig(BaseAlerterConfig, SlackAlerterSettings):
     """Slack alerter config.
 
     Attributes:
         slack_token: The Slack token tied to the Slack account to be used.
-        default_slack_channel_id: The ID of the default Slack channel to use for communication.
+        default_slack_channel_id: (deprecated) The ID of the default Slack
+            channel to use for communication.
     """
 
     slack_token: str = SecretField()
+
     default_slack_channel_id: Optional[str] = None
+    _deprecation_validator = deprecate_pydantic_attributes(
+        ("default_slack_channel_id", "slack_channel_id")
+    )
 
     @property
     def is_valid(self) -> bool:
@@ -60,9 +68,11 @@ class SlackAlerterConfig(BaseAlerterConfig):
             from slack_sdk.errors import SlackApiError
         except ImportError:
             logger.warning(
-                "Unable to validate Slack alerter credentials because the Slack integration is not installed."
+                "Unable to validate the slack alerter, because the Slack "
+                "integration is not installed."
             )
             return True
+
         client = WebClient(token=self.slack_token)
         try:
             # Check slack token validity
@@ -70,10 +80,10 @@ class SlackAlerterConfig(BaseAlerterConfig):
             if not response["ok"]:
                 return False
 
-            if self.default_slack_channel_id:
+            if self.slack_channel_id:
                 # Check channel validity
                 response = client.conversations_info(
-                    channel=self.default_slack_channel_id
+                    channel=self.slack_channel_id
                 )
             valid: bool = response["ok"]
             return valid
@@ -97,7 +107,7 @@ class SlackAlerterFlavor(BaseAlerterFlavor):
 
     @property
     def docs_url(self) -> Optional[str]:
-        """A url to point at docs explaining this flavor.
+        """A URL to point at docs explaining this flavor.
 
         Returns:
             A flavor docs url.
@@ -106,7 +116,7 @@ class SlackAlerterFlavor(BaseAlerterFlavor):
 
     @property
     def sdk_docs_url(self) -> Optional[str]:
-        """A url to point at SDK docs explaining this flavor.
+        """A URL to point at SDK docs explaining this flavor.
 
         Returns:
             A flavor SDK docs url.
@@ -115,7 +125,7 @@ class SlackAlerterFlavor(BaseAlerterFlavor):
 
     @property
     def logo_url(self) -> str:
-        """A url to represent the flavor in the dashboard.
+        """A URL to represent the flavor in the dashboard.
 
         Returns:
             The flavor logo.

zenml/integrations/whylogs/data_validators/whylogs_data_validator.py

@@ -97,7 +97,9 @@ class WhylogsDataValidator(BaseDataValidator, AuthenticationMixin):
         """
         results = why.log(pandas=dataset)
         profile = results.profile()
-        dataset_timestamp = dataset_timestamp or datetime.datetime.utcnow()
+        dataset_timestamp = dataset_timestamp or datetime.datetime.now(
+            datetime.timezone.utc
+        )
         profile.set_dataset_timestamp(dataset_timestamp=dataset_timestamp)
         return profile.view()
 

zenml/materializers/built_in_materializer.py

@@ -28,6 +28,10 @@ from typing import (
 )
 
 from zenml.artifact_stores.base_artifact_store import BaseArtifactStore
+from zenml.constants import (
+    ENV_ZENML_MATERIALIZER_ALLOW_NON_ASCII_JSON_DUMPS,
+    handle_bool_env_var,
+)
 from zenml.enums import ArtifactType, VisualizationType
 from zenml.logger import get_logger
 from zenml.materializers.base_materializer import BaseMaterializer
@@ -48,6 +52,9 @@ BASIC_TYPES = (
     str,
     type(None),
 )  # complex/bytes are not JSON serializable
+ZENML_MATERIALIZER_ALLOW_NON_ASCII_JSON_DUMPS = handle_bool_env_var(
+    ENV_ZENML_MATERIALIZER_ALLOW_NON_ASCII_JSON_DUMPS, False
+)
 
 
 class BuiltInMaterializer(BaseMaterializer):
@@ -94,7 +101,11 @@ class BuiltInMaterializer(BaseMaterializer):
         Args:
             data: The data to store.
         """
-        yaml_utils.write_json(self.data_path, data)
+        yaml_utils.write_json(
+            self.data_path,
+            data,
+            ensure_ascii=not ZENML_MATERIALIZER_ALLOW_NON_ASCII_JSON_DUMPS,
+        )
 
     def extract_metadata(
         self, data: Union[bool, float, int, str]
@@ -371,7 +382,11 @@ class BuiltInContainerMaterializer(BaseMaterializer):
 
         # If the data is serializable, just write it into a single JSON file.
         if _is_serializable(data):
-            yaml_utils.write_json(self.data_path, data)
+            yaml_utils.write_json(
+                self.data_path,
+                data,
+                ensure_ascii=not ZENML_MATERIALIZER_ALLOW_NON_ASCII_JSON_DUMPS,
+            )
             return
 
         # non-serializable dict: Handle as non-serializable list of lists.

zenml/models/v2/core/api_key.py

@@ -13,7 +13,7 @@
 #  permissions and limitations under the License.
 """Models representing API keys."""
 
-from datetime import datetime, timedelta
+from datetime import datetime, timedelta, timezone
 from typing import TYPE_CHECKING, ClassVar, List, Optional, Type, Union
 from uuid import UUID
 
@@ -319,7 +319,7 @@ class APIKeyInternalResponse(APIKeyResponse):
             and self.retain_period_minutes > 0
         ):
             # check if the previous key is still valid
-            if datetime.utcnow() - self.last_rotated < timedelta(
+            if datetime.now(timezone.utc) - self.last_rotated < timedelta(
                 minutes=self.retain_period_minutes
             ):
                 key_hash = self.previous_key

zenml/orchestrators/publish_utils.py

@@ -13,7 +13,7 @@
 #  permissions and limitations under the License.
 """Utilities to publish pipeline and step runs."""
 
-from datetime import datetime
+from datetime import datetime, timezone
 from typing import TYPE_CHECKING, Dict, List
 
 from zenml.client import Client
@@ -48,7 +48,7 @@ def publish_successful_step_run(
         step_run_id=step_run_id,
         step_run_update=StepRunUpdate(
             status=ExecutionStatus.COMPLETED,
-            end_time=datetime.utcnow(),
+            end_time=datetime.now(timezone.utc),
             outputs=output_artifact_ids,
         ),
     )
@@ -67,7 +67,7 @@ def publish_failed_step_run(step_run_id: "UUID") -> "StepRunResponse":
         step_run_id=step_run_id,
         step_run_update=StepRunUpdate(
             status=ExecutionStatus.FAILED,
-            end_time=datetime.utcnow(),
+            end_time=datetime.now(timezone.utc),
         ),
     )
 
@@ -87,7 +87,7 @@ def publish_failed_pipeline_run(
         run_id=pipeline_run_id,
         run_update=PipelineRunUpdate(
             status=ExecutionStatus.FAILED,
-            end_time=datetime.utcnow(),
+            end_time=datetime.now(timezone.utc),
         ),
     )
 

zenml/orchestrators/step_launcher.py

@@ -16,7 +16,7 @@
 import os
 import time
 from contextlib import nullcontext
-from datetime import datetime
+from datetime import datetime, timezone
 from functools import partial
 from typing import TYPE_CHECKING, Any, Callable, Dict, Tuple
 
@@ -201,7 +201,7 @@ class StepLauncher:
                         f"Failed preparing step `{self._step_name}`."
                     )
                     step_run_request.status = ExecutionStatus.FAILED
-                    step_run_request.end_time = datetime.utcnow()
+                    step_run_request.end_time = datetime.now(timezone.utc)
                     raise
                 finally:
                     step_run = Client().zen_store.create_run_step(
@@ -305,7 +305,7 @@ class StepLauncher:
             The created or existing pipeline run,
             and a boolean indicating whether the run was created or reused.
         """
-        start_time = datetime.utcnow()
+        start_time = datetime.now(timezone.utc)
         run_name = string_utils.format_name_template(
             name_template=self._deployment.run_name_template,
             substitutions=self._deployment.pipeline_configuration._get_full_substitutions(

zenml/orchestrators/step_run_utils.py

@@ -13,7 +13,7 @@
 #  permissions and limitations under the License.
 """Utilities for creating step runs."""
 
-from datetime import datetime
+from datetime import datetime, timezone
 from typing import Dict, List, Optional, Set, Tuple
 
 from zenml.client import Client
@@ -75,7 +75,7 @@ class StepRunRequestFactory:
             pipeline_run_id=self.pipeline_run.id,
             deployment=self.deployment.id,
             status=ExecutionStatus.RUNNING,
-            start_time=datetime.utcnow(),
+            start_time=datetime.now(timezone.utc),
             user=Client().active_user.id,
             workspace=Client().active_workspace.id,
         )

zenml/pipelines/pipeline_definition.py

@@ -474,7 +474,7 @@ def pipeline_(param_name: str):
     step_name()
 
 if __name__=="__main__":
-    pipeline_.with_options(config_file="config.yaml")(param_name="value2")
+    pipeline_.with_options(config_path="config.yaml")(param_name="value2")
 ```
 To avoid this consider setting pipeline parameters only in one place (config or code).
 """

zenml/pipelines/run_utils.py

@@ -1,7 +1,7 @@
 """Utility functions for running pipelines."""
 
 import time
-from datetime import datetime
+from datetime import datetime, timezone
 from typing import TYPE_CHECKING, Any, Dict, List, Optional, Set, Union
 from uuid import UUID
 
@@ -65,7 +65,7 @@ def create_placeholder_run(
 
     if deployment.schedule:
         return None
-    start_time = datetime.utcnow()
+    start_time = datetime.now(timezone.utc)
     run_request = PipelineRunRequest(
         name=string_utils.format_name_template(
             name_template=deployment.run_name_template,

zenml/service_connectors/service_connector.py

@@ -799,8 +799,8 @@ class ServiceConnector(BaseModel, metaclass=ServiceConnectorMeta):
             name=name,
             body=ServiceConnectorResponseBody(
                 user=user,
-                created=datetime.utcnow(),
-                updated=datetime.utcnow(),
+                created=datetime.now(timezone.utc),
+                updated=datetime.now(timezone.utc),
                 description=description,
                 connector_type=self.get_type(),
                 auth_method=self.auth_method,

zenml/stack/stack.py

@@ -16,7 +16,7 @@
 import itertools
 import json
 import os
-from datetime import datetime
+from datetime import datetime, timezone
 from typing import (
     TYPE_CHECKING,
     AbstractSet,
@@ -751,8 +751,8 @@ class Stack:
                 config=LocalImageBuilderConfig(),
                 user=Client().active_user.id,
                 workspace=Client().active_workspace.id,
-                created=datetime.utcnow(),
-                updated=datetime.utcnow(),
+                created=datetime.now(timezone.utc),
+                updated=datetime.now(timezone.utc),
             )
 
             self._image_builder = image_builder

zenml/stack_deployments/stack_deployment.py

@@ -197,6 +197,11 @@ class ZenMLCloudStackDeployment(BaseModel):
         # that was registered after this deployment was created.
 
         # Get all stacks created after the start date
+
+        if date_start and date_start.tzinfo:
+            date_start = date_start.astimezone(datetime.timezone.utc).replace(
+                tzinfo=None
+            )
         stacks = client.list_stacks(
             created=f"gt:{str(date_start.replace(microsecond=0))}"
             if date_start

zenml/utils/git_utils.py

@@ -16,7 +16,7 @@
 import os
 from typing import Optional
 
-from git import GitCommandError
+from git.exc import GitCommandError
 from git.repo import Repo
 
 

zenml/utils/string_utils.py

@@ -17,7 +17,7 @@ import base64
 import functools
 import random
 import string
-from datetime import datetime
+from datetime import datetime, timezone
 from typing import Any, Callable, Dict, Optional, TypeVar, cast
 
 from pydantic import BaseModel
@@ -180,7 +180,7 @@ def format_name_template(
             start_time = None
 
         if start_time is None:
-            start_time = datetime.utcnow()
+            start_time = datetime.now(timezone.utc)
         substitutions.setdefault("date", start_time.strftime("%Y_%m_%d"))
         substitutions.setdefault("time", start_time.strftime("%H_%M_%S_%f"))
 

zenml/utils/yaml_utils.py

@@ -122,6 +122,7 @@ def write_json(
     file_path: str,
     contents: Any,
     encoder: Optional[Type[json.JSONEncoder]] = None,
+    **json_dump_args: Any,
 ) -> None:
     """Write contents as JSON format to file_path.
 
@@ -129,6 +130,7 @@ def write_json(
         file_path: Path to JSON file.
         contents: Contents of JSON file.
         encoder: Custom JSON encoder to use when saving json.
+        **json_dump_args: Extra arguments to pass to json.dumps.
 
     Raises:
         FileNotFoundError: if directory does not exist.
@@ -140,10 +142,7 @@ def write_json(
             raise FileNotFoundError(f"Directory {dir_} does not exist.")
     io_utils.write_file_contents_as_string(
         file_path,
-        json.dumps(
-            contents,
-            cls=encoder,
-        ),
+        json.dumps(contents, cls=encoder, **json_dump_args),
     )