zenml-nightly 0.66.0.dev20240928__py3-none-any.whl → 0.68.1.dev20241102__py3-none-any.whl

zenml/utils/requirements_utils.py

@@ -0,0 +1,71 @@
+#  Copyright (c) ZenML GmbH 2024. All Rights Reserved.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at:
+#
+#       https://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+#  or implied. See the License for the specific language governing
+#  permissions and limitations under the License.
+"""Requirement utils."""
+
+from typing import TYPE_CHECKING, List, Set, Tuple
+
+from zenml.integrations.utils import get_integration_for_module
+
+if TYPE_CHECKING:
+    from zenml.models import ComponentResponse, StackResponse
+
+
+def get_requirements_for_stack(
+    stack: "StackResponse",
+) -> Tuple[List[str], List[str]]:
+    """Get requirements for a stack model.
+
+    Args:
+        stack: The stack for which to get the requirements.
+
+    Returns:
+        Tuple of PyPI and APT requirements of the stack.
+    """
+    pypi_requirements: Set[str] = set()
+    apt_packages: Set[str] = set()
+
+    for component_list in stack.components.values():
+        assert len(component_list) == 1
+        component = component_list[0]
+        (
+            component_pypi_requirements,
+            component_apt_packages,
+        ) = get_requirements_for_component(component=component)
+        pypi_requirements = pypi_requirements.union(
+            component_pypi_requirements
+        )
+        apt_packages = apt_packages.union(component_apt_packages)
+
+    return sorted(pypi_requirements), sorted(apt_packages)
+
+
+def get_requirements_for_component(
+    component: "ComponentResponse",
+) -> Tuple[List[str], List[str]]:
+    """Get requirements for a component model.
+
+    Args:
+        component: The component for which to get the requirements.
+
+    Returns:
+        Tuple of PyPI and APT requirements of the component.
+    """
+    integration = get_integration_for_module(
+        module_name=component.flavor.source
+    )
+
+    if integration:
+        return integration.get_requirements(), integration.APT_PACKAGES
+    else:
+        return [], []

zenml/utils/singleton.py

@@ -64,9 +64,21 @@ class SingletonMetaClass(type):
 
         return cls.__singleton_instance
 
-    def _clear(cls) -> None:
-        """Clear the singleton instance."""
-        cls.__singleton_instance = None
+    def _clear(cls, instance: Optional["SingletonMetaClass"] = None) -> None:
+        """Clear or replace the singleton instance.
+
+        Args:
+            instance: The new singleton instance.
+        """
+        cls.__singleton_instance = instance
+
+    def _instance(cls) -> Optional["SingletonMetaClass"]:
+        """Get the singleton instance.
+
+        Returns:
+            The singleton instance.
+        """
+        return cls.__singleton_instance
 
     def _exists(cls) -> bool:
         """Check if the singleton instance exists.

zenml/utils/source_utils.py

@@ -22,7 +22,16 @@ import sys
 from distutils.sysconfig import get_python_lib
 from pathlib import Path, PurePath
 from types import BuiltinFunctionType, FunctionType, ModuleType
-from typing import Any, Callable, Dict, Iterator, Optional, Type, Union, cast
+from typing import (
+    Any,
+    Callable,
+    Dict,
+    Iterator,
+    Optional,
+    Type,
+    Union,
+    cast,
+)
 from uuid import UUID
 
 from zenml.config.source import (
@@ -121,7 +130,17 @@ def load(source: Union[Source, str]) -> Any:
         # root in python path just to be sure
         import_root = get_source_root()
 
-    module = _load_module(module_name=source.module, import_root=import_root)
+    if _should_load_from_main_module(source):
+        # This source points to the __main__ module of the current process.
+        # If we were to load the module here, we would load the same python
+        # file with a different module name, which would rerun all top-level
+        # code. To avoid this, we instead load the source from the __main__
+        # module which is already loaded.
+        module = sys.modules["__main__"]
+    else:
+        module = _load_module(
+            module_name=source.module, import_root=import_root
+        )
 
     if source.attribute:
         obj = getattr(module, source.attribute)
@@ -780,3 +799,21 @@ def get_resolved_notebook_sources() -> Dict[str, str]:
         of their notebook cell.
     """
     return _resolved_notebook_sources.copy()
+
+
+def _should_load_from_main_module(source: Source) -> bool:
+    """Check whether the source should be loaded from the main module.
+
+    Args:
+        source: The source to check.
+
+    Returns:
+        If the source should be loaded from the main module instead of the
+        module defined in the source object.
+    """
+    try:
+        resolved_main_module = _resolve_module(sys.modules["__main__"])
+    except RuntimeError:
+        return False
+
+    return resolved_main_module == source.module

zenml/utils/typing_utils.py

@@ -39,38 +39,18 @@ if hasattr(typing, "Literal"):
 
 # ----- is_none_type -----
 
-if sys.version_info[:2] == (3, 8):
 
-    def is_none_type(type_: Any) -> bool:
-        """Checks if the provided type is none type.
+def is_none_type(type_: Any) -> bool:
+    """Checks if the provided type is a none type.
 
-        Args:
-            type_: type to check.
-
-        Returns:
-            boolean indicating whether the type is none type.
-        """
-        for none_type in NONE_TYPES:
-            if type_ is none_type:
-                return True
-        # With python 3.8, specifically 3.8.10, Literal "is" checks are very
-        # flakey can change on very subtle changes like use of types in other
-        # modules, hopefully this check avoids that issue.
-        if is_literal_type(type_):  # pragma: no cover
-            return all_literal_values(type_) == (None,)
-        return False
-else:
-
-    def is_none_type(type_: Any) -> bool:
-        """Checks if the provided type is a none type.
+    Args:
+        type_: type to check.
 
-        Args:
-            type_: type to check.
+    Returns:
+        boolean indicating whether the type is a none type.
+    """
+    return type_ in NONE_TYPES
 
-        Returns:
-            boolean indicating whether the type is a none type.
-        """
-        return type_ in NONE_TYPES
 
 # ----- is_union -----
 

zenml/utils/visualization_utils.py

@@ -41,7 +41,7 @@ def visualize_artifact(
         raise RuntimeError(
             "The `output.visualize()` method is only available in Jupyter "
             "notebooks. In all other runtime environments, please open "
-            "your ZenML dashboard using `zenml up` and view the "
+            "your ZenML dashboard using `zenml login --local` and view the "
             "visualizations by clicking on the respective artifacts in the "
             "pipeline run DAG instead."
         )

zenml/zen_server/auth.py

@@ -20,7 +20,7 @@ from urllib.parse import urlencode
 from uuid import UUID
 
 import requests
-from fastapi import Depends, HTTPException, status
+from fastapi import Depends
 from fastapi.security import (
     HTTPBasic,
     HTTPBasicCredentials,
@@ -38,7 +38,11 @@ from zenml.constants import (
     VERSION_1,
 )
 from zenml.enums import AuthScheme, OAuthDeviceStatus
-from zenml.exceptions import AuthorizationException, OAuthError
+from zenml.exceptions import (
+    AuthorizationException,
+    CredentialsNotValid,
+    OAuthError,
+)
 from zenml.logger import get_logger
 from zenml.models import (
     APIKey,
@@ -52,6 +56,7 @@ from zenml.models import (
     UserResponse,
     UserUpdate,
 )
+from zenml.zen_server.exceptions import http_exception_from_error
 from zenml.zen_server.jwt import JWTToken
 from zenml.zen_server.utils import server_config, zen_store
 
@@ -109,7 +114,7 @@ def _fetch_and_verify_api_key(
         The fetched API key.
 
     Raises:
-        AuthorizationException: If the API key could not be found, is not
+        CredentialsNotValid: If the API key could not be found, is not
             active, if it could not be verified against the supplied key value
             or if the associated service account is not active.
     """
@@ -122,7 +127,7 @@ def _fetch_and_verify_api_key(
             f"Authentication error: error retrieving API key " f"{api_key_id}"
         )
         logger.error(error)
-        raise AuthorizationException(error)
+        raise CredentialsNotValid(error)
 
     if not api_key.service_account.active:
         error = (
@@ -131,7 +136,7 @@ def _fetch_and_verify_api_key(
             f"associated with API key {api_key.name} is not active"
         )
         logger.exception(error)
-        raise AuthorizationException(error)
+        raise CredentialsNotValid(error)
 
     if not api_key.active:
         error = (
@@ -141,7 +146,7 @@ def _fetch_and_verify_api_key(
             f"{api_key.service_account.name} is not active"
         )
         logger.error(error)
-        raise AuthorizationException(error)
+        raise CredentialsNotValid(error)
 
     if key_to_verify and not api_key.verify_key(key_to_verify):
         error = (
@@ -149,7 +154,7 @@ def _fetch_and_verify_api_key(
             f"{api_key.name}"
         )
         logger.exception(error)
-        raise AuthorizationException(error)
+        raise CredentialsNotValid(error)
 
     # Update the "last used" timestamp of the API key
     store.update_internal_api_key(
@@ -188,7 +193,7 @@ def authenticate_credentials(
         The authenticated account details.
 
     Raises:
-        AuthorizationException: If the credentials are invalid.
+        CredentialsNotValid: If the credentials are invalid.
     """
     user: Optional[UserAuthModel] = None
     auth_context: Optional[AuthContext] = None
@@ -218,11 +223,11 @@ def authenticate_credentials(
         if not UserAuthModel.verify_password(password, user):
             error = "Authentication error: invalid username or password"
             logger.error(error)
-            raise AuthorizationException(error)
+            raise CredentialsNotValid(error)
         if user and not user.active:
             error = f"Authentication error: user {user.name} is not active"
             logger.error(error)
-            raise AuthorizationException(error)
+            raise CredentialsNotValid(error)
 
     elif activation_token is not None:
         if not UserAuthModel.verify_activation_token(activation_token, user):
@@ -231,17 +236,17 @@ def authenticate_credentials(
                 f"{user_name_or_id}"
             )
             logger.error(error)
-            raise AuthorizationException(error)
+            raise CredentialsNotValid(error)
 
     elif access_token is not None:
         try:
             decoded_token = JWTToken.decode_token(
                 token=access_token,
             )
-        except AuthorizationException as e:
+        except CredentialsNotValid as e:
             error = f"Authentication error: error decoding access token: {e}."
             logger.exception(error)
-            raise AuthorizationException(error)
+            raise CredentialsNotValid(error)
 
         try:
             user_model = zen_store().get_user(
@@ -253,7 +258,7 @@ def authenticate_credentials(
                 f"{decoded_token.user_id}"
             )
             logger.error(error)
-            raise AuthorizationException(error)
+            raise CredentialsNotValid(error)
 
         if not user_model.active:
             error = (
@@ -261,7 +266,7 @@ def authenticate_credentials(
                 f"active"
             )
             logger.error(error)
-            raise AuthorizationException(error)
+            raise CredentialsNotValid(error)
 
         api_key_model: Optional[APIKeyInternalResponse] = None
         if decoded_token.api_key_id:
@@ -285,7 +290,7 @@ def authenticate_credentials(
                     f"{decoded_token.device_id}"
                 )
                 logger.error(error)
-                raise AuthorizationException(error)
+                raise CredentialsNotValid(error)
 
             if (
                 device_model.user is None
@@ -296,7 +301,7 @@ def authenticate_credentials(
                     f"does not belong to user {user_model.name}"
                 )
                 logger.error(error)
-                raise AuthorizationException(error)
+                raise CredentialsNotValid(error)
 
             if device_model.status != OAuthDeviceStatus.ACTIVE:
                 error = (
@@ -304,7 +309,7 @@ def authenticate_credentials(
                     f"is not active"
                 )
                 logger.error(error)
-                raise AuthorizationException(error)
+                raise CredentialsNotValid(error)
 
             if (
                 device_model.expires
@@ -315,7 +320,7 @@ def authenticate_credentials(
                     "has expired"
                 )
                 logger.error(error)
-                raise AuthorizationException(error)
+                raise CredentialsNotValid(error)
 
             zen_store().update_internal_authorized_device(
                 device_id=device_model.id,
@@ -340,12 +345,12 @@ def authenticate_credentials(
         if server_config().auth_scheme != AuthScheme.NO_AUTH:
             error = "Authentication error: no credentials provided"
             logger.error(error)
-            raise AuthorizationException(error)
+            raise CredentialsNotValid(error)
 
     if not auth_context:
         error = "Authentication error: invalid credentials"
         logger.error(error)
-        raise AuthorizationException(error)
+        raise CredentialsNotValid(error)
 
     return auth_context
 
@@ -634,14 +639,14 @@ def authenticate_api_key(
         The authentication context reflecting the authenticated service account.
 
     Raises:
-        AuthorizationException: If the service account could not be authorized.
+        CredentialsNotValid: If the service account could not be authorized.
     """
     try:
         decoded_api_key = APIKey.decode_api_key(api_key)
     except ValueError:
         error = "Authentication error: error decoding API key"
         logger.exception(error)
-        raise AuthorizationException(error)
+        raise CredentialsNotValid(error)
 
     internal_api_key = _fetch_and_verify_api_key(
         api_key_id=decoded_api_key.id, key_to_verify=decoded_api_key.key
@@ -666,19 +671,19 @@ def http_authentication(
     Returns:
         The authentication context reflecting the authenticated user.
 
-    Raises:
-        HTTPException: If the credentials are invalid.
+    # noqa: DAR401
     """
     try:
         return authenticate_credentials(
             user_name_or_id=credentials.username, password=credentials.password
         )
-    except AuthorizationException as e:
-        raise HTTPException(
-            status_code=status.HTTP_401_UNAUTHORIZED,
-            detail=str(e),
-            headers={"WWW-Authenticate": "Basic"},
-        )
+    except CredentialsNotValid as e:
+        # We want to be very explicit here and return a CredentialsNotValid
+        # exception encoded as a 401 Unauthorized error encoded, so that the
+        # client can distinguish between a 401 error due to invalid credentials
+        # and other 401 errors and handle them accordingly by throwing away the
+        # current access token and re-authenticating.
+        raise http_exception_from_error(e)
 
 
 class CookieOAuth2TokenBearer(OAuth2PasswordBearer):
@@ -721,17 +726,17 @@ def oauth2_authentication(
     Returns:
         The authentication context reflecting the authenticated user.
 
-    Raises:
-        HTTPException: If the JWT token could not be authorized.
+    # noqa: DAR401
     """
     try:
         auth_context = authenticate_credentials(access_token=token)
-    except AuthorizationException as e:
-        raise HTTPException(
-            status_code=status.HTTP_401_UNAUTHORIZED,
-            detail=str(e),
-            headers={"WWW-Authenticate": "Bearer"},
-        )
+    except CredentialsNotValid as e:
+        # We want to be very explicit here and return a CredentialsNotValid
+        # exception encoded as a 401 Unauthorized error encoded, so that the
+        # client can distinguish between a 401 error due to invalid credentials
+        # and other 401 errors and handle them accordingly by throwing away the
+        # current access token and re-authenticating.
+        raise http_exception_from_error(e)
 
     return auth_context
 

zenml/zen_server/dashboard/assets/{404-Y50hSt65.js → 404-DT4QRUqN.js}

@@ -1 +1 @@
-import{j as e}from"./@radix-DnFH_oo1.js";import{f as s,r as t}from"./index-Ci0nJ8EZ.js";import{E as r}from"./EmptyState-Cs3DEmso.js";import{H as a}from"./help-CwN931fX.js";import{L as o}from"./@react-router-APVeuk-U.js";import"./@tanstack-QbMbTrh5.js";import"./@reactflow-ytavUpwh.js";function d(){return e.jsx("div",{className:"flex min-h-screen w-full flex-col",children:e.jsx(r,{icon:e.jsx(a,{className:"h-[120px] w-[120px] fill-neutral-300"}),children:e.jsxs("div",{className:"text-center",children:[e.jsx("h1",{className:"mb-2 text-display-xs font-semibold",children:"We can't find the page you are looking for"}),e.jsx("p",{className:"text-lg text-theme-text-secondary",children:"You can try typing a different URL or we can bring you back to your Homepage."}),e.jsx("div",{className:"mt-5 flex justify-center",children:e.jsx(s,{size:"md",asChild:!0,children:e.jsx(o,{className:"w-min self-center whitespace-nowrap",to:t.home,children:e.jsx("span",{className:"px-0.5",children:"Go to Home"})})})})]})})})}export{d as default};
+import{j as e}from"./@radix-DP6vWzyx.js";import{f as s,r as t}from"./index-QQb7wQEC.js";import{E as r}from"./EmptyState-DeK7H4pr.js";import{S as a}from"./help-Dam461dC.js";import{L as o}from"./@react-router-BMhZulnd.js";import"./@tanstack-BUCbhJyH.js";import"./@reactflow-8U9qNlMR.js";function d(){return e.jsx("div",{className:"flex min-h-screen w-full flex-col",children:e.jsx(r,{icon:e.jsx(a,{className:"h-[120px] w-[120px] fill-neutral-300"}),children:e.jsxs("div",{className:"text-center",children:[e.jsx("h1",{className:"mb-2 text-display-xs font-semibold",children:"We can't find the page you are looking for"}),e.jsx("p",{className:"text-lg text-theme-text-secondary",children:"You can try typing a different URL or we can bring you back to your Homepage."}),e.jsx("div",{className:"mt-5 flex justify-center",children:e.jsx(s,{size:"md",asChild:!0,children:e.jsx(o,{className:"w-min self-center whitespace-nowrap",to:t.home,children:e.jsx("span",{className:"px-0.5",children:"Go to Home"})})})})]})})})}export{d as default};