mlrun 1.3.3rc1__py3-none-any.whl → 1.4.0__py3-none-any.whl

mlrun/api/utils/asyncio.py

@@ -1,4 +1,4 @@
-# Copyright 2018 Iguazio
+# Copyright 2023 Iguazio
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

mlrun/api/utils/auth/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2018 Iguazio
+# Copyright 2023 Iguazio
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

mlrun/api/utils/auth/providers/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2018 Iguazio
+# Copyright 2023 Iguazio
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

mlrun/api/utils/auth/providers/base.py

@@ -1,4 +1,4 @@
-# Copyright 2018 Iguazio
+# Copyright 2023 Iguazio
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,7 +15,7 @@
 import abc
 import typing
 
-import mlrun.api.schemas
+import mlrun.common.schemas
 
 
 class Provider(abc.ABC):
@@ -23,8 +23,8 @@ class Provider(abc.ABC):
     async def query_permissions(
         self,
         resource: str,
-        action: mlrun.api.schemas.AuthorizationAction,
-        auth_info: mlrun.api.schemas.AuthInfo,
+        action: mlrun.common.schemas.AuthorizationAction,
+        auth_info: mlrun.common.schemas.AuthInfo,
         raise_on_forbidden: bool = True,
     ) -> bool:
         pass
@@ -34,13 +34,13 @@ class Provider(abc.ABC):
         self,
         resources: typing.List,
         opa_resource_extractor: typing.Callable,
-        action: mlrun.api.schemas.AuthorizationAction,
-        auth_info: mlrun.api.schemas.AuthInfo,
+        action: mlrun.common.schemas.AuthorizationAction,
+        auth_info: mlrun.common.schemas.AuthInfo,
     ) -> typing.List:
         pass
 
     @abc.abstractmethod
     def add_allowed_project_for_owner(
-        self, project_name: str, auth_info: mlrun.api.schemas.AuthInfo
+        self, project_name: str, auth_info: mlrun.common.schemas.AuthInfo
     ):
         pass

mlrun/api/utils/auth/providers/nop.py

@@ -1,4 +1,4 @@
-# Copyright 2018 Iguazio
+# Copyright 2023 Iguazio
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -14,7 +14,6 @@
 #
 import typing
 
-import mlrun.api.schemas
 import mlrun.api.utils.auth.providers.base
 import mlrun.utils.singleton
 
@@ -26,8 +25,8 @@ class Provider(
     async def query_permissions(
         self,
         resource: str,
-        action: mlrun.api.schemas.AuthorizationAction,
-        auth_info: mlrun.api.schemas.AuthInfo,
+        action: mlrun.common.schemas.AuthorizationAction,
+        auth_info: mlrun.common.schemas.AuthInfo,
         raise_on_forbidden: bool = True,
     ) -> bool:
         return True
@@ -36,12 +35,12 @@ class Provider(
         self,
         resources: typing.List,
         opa_resource_extractor: typing.Callable,
-        action: mlrun.api.schemas.AuthorizationAction,
-        auth_info: mlrun.api.schemas.AuthInfo,
+        action: mlrun.common.schemas.AuthorizationAction,
+        auth_info: mlrun.common.schemas.AuthInfo,
     ) -> typing.List:
         return resources
 
     def add_allowed_project_for_owner(
-        self, project_name: str, auth_info: mlrun.api.schemas.AuthInfo
+        self, project_name: str, auth_info: mlrun.common.schemas.AuthInfo
     ):
         pass

mlrun/api/utils/auth/providers/opa.py

@@ -1,4 +1,4 @@
-# Copyright 2018 Iguazio
+# Copyright 2023 Iguazio
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -21,9 +21,9 @@ import typing
 
 import humanfriendly
 
-import mlrun.api.schemas
 import mlrun.api.utils.auth.providers.base
 import mlrun.api.utils.projects.remotes.leader
+import mlrun.common.schemas
 import mlrun.errors
 import mlrun.utils.helpers
 import mlrun.utils.singleton
@@ -66,23 +66,23 @@ class Provider(
     async def query_permissions(
         self,
         resource: str,
-        action: mlrun.api.schemas.AuthorizationAction,
-        auth_info: mlrun.api.schemas.AuthInfo,
+        action: mlrun.common.schemas.AuthorizationAction,
+        auth_info: mlrun.common.schemas.AuthInfo,
         raise_on_forbidden: bool = True,
     ) -> bool:
 
         # store is not really a verb in our OPA manifest, we map it to 2 query permissions requests (create & update)
-        if action == mlrun.api.schemas.AuthorizationAction.store:
+        if action == mlrun.common.schemas.AuthorizationAction.store:
             results = await asyncio.gather(
                 self.query_permissions(
                     resource,
-                    mlrun.api.schemas.AuthorizationAction.create,
+                    mlrun.common.schemas.AuthorizationAction.create,
                     auth_info,
                     raise_on_forbidden,
                 ),
                 self.query_permissions(
                     resource,
-                    mlrun.api.schemas.AuthorizationAction.update,
+                    mlrun.common.schemas.AuthorizationAction.update,
                     auth_info,
                     raise_on_forbidden,
                 ),
@@ -113,11 +113,11 @@ class Provider(
         self,
         resources: typing.List,
         opa_resource_extractor: typing.Callable,
-        action: mlrun.api.schemas.AuthorizationAction,
-        auth_info: mlrun.api.schemas.AuthInfo,
+        action: mlrun.common.schemas.AuthorizationAction,
+        auth_info: mlrun.common.schemas.AuthInfo,
     ) -> typing.List:
         # store is not really a verb in our OPA manifest, we map it to 2 query permissions requests (create & update)
-        if action == mlrun.api.schemas.AuthorizationAction.store:
+        if action == mlrun.common.schemas.AuthorizationAction.store:
             raise NotImplementedError("Store action is not supported in filtering")
         if self._is_request_from_leader(auth_info.projects_role):
             return resources
@@ -149,7 +149,7 @@ class Provider(
         return allowed_resources
 
     def add_allowed_project_for_owner(
-        self, project_name: str, auth_info: mlrun.api.schemas.AuthInfo
+        self, project_name: str, auth_info: mlrun.common.schemas.AuthInfo
     ):
         if (
             not auth_info.user_id
@@ -168,7 +168,7 @@ class Provider(
         self._allowed_project_owners_cache[auth_info.user_id] = allowed_projects
 
     def _check_allowed_project_owners_cache(
-        self, resource: str, auth_info: mlrun.api.schemas.AuthInfo
+        self, resource: str, auth_info: mlrun.common.schemas.AuthInfo
     ):
         # Cache shouldn't be big, simply clean it on get instead of scheduling it
         self._clean_expired_records_from_cache()
@@ -199,7 +199,7 @@ class Provider(
             del self._allowed_project_owners_cache[user_id]
 
     def _is_request_from_leader(
-        self, projects_role: typing.Optional[mlrun.api.schemas.ProjectsRole]
+        self, projects_role: typing.Optional[mlrun.common.schemas.ProjectsRole]
     ):
         if projects_role and projects_role.value == self._leader_name:
             return True
@@ -241,8 +241,8 @@ class Provider(
     @staticmethod
     def _generate_permission_request_body(
         resource: str,
-        action: mlrun.api.schemas.AuthorizationAction,
-        auth_info: mlrun.api.schemas.AuthInfo,
+        action: mlrun.common.schemas.AuthorizationAction,
+        auth_info: mlrun.common.schemas.AuthInfo,
     ) -> dict:
         body = {
             "input": {
@@ -256,8 +256,8 @@ class Provider(
     @staticmethod
     def _generate_filter_request_body(
         resources: typing.List[str],
-        action: mlrun.api.schemas.AuthorizationAction,
-        auth_info: mlrun.api.schemas.AuthInfo,
+        action: mlrun.common.schemas.AuthorizationAction,
+        auth_info: mlrun.common.schemas.AuthInfo,
     ) -> dict:
         body = {
             "input": {

mlrun/api/utils/auth/verifier.py

@@ -1,4 +1,4 @@
-# Copyright 2018 Iguazio
+# Copyright 2023 Iguazio
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -19,10 +19,10 @@ import typing
 import fastapi
 
 import mlrun
-import mlrun.api.schemas
 import mlrun.api.utils.auth.providers.nop
 import mlrun.api.utils.auth.providers.opa
 import mlrun.api.utils.clients.iguazio
+import mlrun.common.schemas
 import mlrun.utils.singleton
 
 
@@ -41,11 +41,11 @@ class AuthVerifier(metaclass=mlrun.utils.singleton.Singleton):
 
     async def filter_project_resources_by_permissions(
         self,
-        resource_type: mlrun.api.schemas.AuthorizationResourceTypes,
+        resource_type: mlrun.common.schemas.AuthorizationResourceTypes,
         resources: typing.List,
         project_and_resource_name_extractor: typing.Callable,
-        auth_info: mlrun.api.schemas.AuthInfo,
-        action: mlrun.api.schemas.AuthorizationAction = mlrun.api.schemas.AuthorizationAction.read,
+        auth_info: mlrun.common.schemas.AuthInfo,
+        action: mlrun.common.schemas.AuthorizationAction = mlrun.common.schemas.AuthorizationAction.read,
     ) -> typing.List:
         def _generate_opa_resource(resource):
             project_name, resource_name = project_and_resource_name_extractor(resource)
@@ -60,8 +60,8 @@ class AuthVerifier(metaclass=mlrun.utils.singleton.Singleton):
     async def filter_projects_by_permissions(
         self,
         project_names: typing.List[str],
-        auth_info: mlrun.api.schemas.AuthInfo,
-        action: mlrun.api.schemas.AuthorizationAction = mlrun.api.schemas.AuthorizationAction.read,
+        auth_info: mlrun.common.schemas.AuthInfo,
+        action: mlrun.common.schemas.AuthorizationAction = mlrun.common.schemas.AuthorizationAction.read,
     ) -> typing.List:
         return await self.filter_by_permissions(
             project_names,
@@ -72,11 +72,11 @@ class AuthVerifier(metaclass=mlrun.utils.singleton.Singleton):
 
     async def query_project_resources_permissions(
         self,
-        resource_type: mlrun.api.schemas.AuthorizationResourceTypes,
+        resource_type: mlrun.common.schemas.AuthorizationResourceTypes,
         resources: typing.List,
         project_and_resource_name_extractor: typing.Callable,
-        action: mlrun.api.schemas.AuthorizationAction,
-        auth_info: mlrun.api.schemas.AuthInfo,
+        action: mlrun.common.schemas.AuthorizationAction,
+        auth_info: mlrun.common.schemas.AuthInfo,
         raise_on_forbidden: bool = True,
     ) -> bool:
         project_resources = [
@@ -102,11 +102,11 @@ class AuthVerifier(metaclass=mlrun.utils.singleton.Singleton):
 
     async def query_project_resource_permissions(
         self,
-        resource_type: mlrun.api.schemas.AuthorizationResourceTypes,
+        resource_type: mlrun.common.schemas.AuthorizationResourceTypes,
         project_name: str,
         resource_name: str,
-        action: mlrun.api.schemas.AuthorizationAction,
-        auth_info: mlrun.api.schemas.AuthInfo,
+        action: mlrun.common.schemas.AuthorizationAction,
+        auth_info: mlrun.common.schemas.AuthInfo,
         raise_on_forbidden: bool = True,
     ) -> bool:
         return await self.query_permissions(
@@ -121,8 +121,8 @@ class AuthVerifier(metaclass=mlrun.utils.singleton.Singleton):
     async def query_project_permissions(
         self,
         project_name: str,
-        action: mlrun.api.schemas.AuthorizationAction,
-        auth_info: mlrun.api.schemas.AuthInfo,
+        action: mlrun.common.schemas.AuthorizationAction,
+        auth_info: mlrun.common.schemas.AuthInfo,
         raise_on_forbidden: bool = True,
     ) -> bool:
         return await self.query_permissions(
@@ -134,9 +134,9 @@ class AuthVerifier(metaclass=mlrun.utils.singleton.Singleton):
 
     async def query_global_resource_permissions(
         self,
-        resource_type: mlrun.api.schemas.AuthorizationResourceTypes,
-        action: mlrun.api.schemas.AuthorizationAction,
-        auth_info: mlrun.api.schemas.AuthInfo,
+        resource_type: mlrun.common.schemas.AuthorizationResourceTypes,
+        action: mlrun.common.schemas.AuthorizationAction,
+        auth_info: mlrun.common.schemas.AuthInfo,
         raise_on_forbidden: bool = True,
     ) -> bool:
         return await self.query_resource_permissions(
@@ -149,10 +149,10 @@ class AuthVerifier(metaclass=mlrun.utils.singleton.Singleton):
 
     async def query_resource_permissions(
         self,
-        resource_type: mlrun.api.schemas.AuthorizationResourceTypes,
+        resource_type: mlrun.common.schemas.AuthorizationResourceTypes,
         resource_name: str,
-        action: mlrun.api.schemas.AuthorizationAction,
-        auth_info: mlrun.api.schemas.AuthInfo,
+        action: mlrun.common.schemas.AuthorizationAction,
+        auth_info: mlrun.common.schemas.AuthInfo,
         raise_on_forbidden: bool = True,
     ) -> bool:
         return await self.query_permissions(
@@ -165,8 +165,8 @@ class AuthVerifier(metaclass=mlrun.utils.singleton.Singleton):
     async def query_permissions(
         self,
         resource: str,
-        action: mlrun.api.schemas.AuthorizationAction,
-        auth_info: mlrun.api.schemas.AuthInfo,
+        action: mlrun.common.schemas.AuthorizationAction,
+        auth_info: mlrun.common.schemas.AuthInfo,
         raise_on_forbidden: bool = True,
     ) -> bool:
         return await self._auth_provider.query_permissions(
@@ -177,8 +177,8 @@ class AuthVerifier(metaclass=mlrun.utils.singleton.Singleton):
         self,
         resources: typing.List,
         opa_resource_extractor: typing.Callable,
-        action: mlrun.api.schemas.AuthorizationAction,
-        auth_info: mlrun.api.schemas.AuthInfo,
+        action: mlrun.common.schemas.AuthorizationAction,
+        auth_info: mlrun.common.schemas.AuthInfo,
     ) -> typing.List:
         return await self._auth_provider.filter_by_permissions(
             resources,
@@ -188,14 +188,14 @@ class AuthVerifier(metaclass=mlrun.utils.singleton.Singleton):
         )
 
     def add_allowed_project_for_owner(
-        self, project_name: str, auth_info: mlrun.api.schemas.AuthInfo
+        self, project_name: str, auth_info: mlrun.common.schemas.AuthInfo
     ):
         self._auth_provider.add_allowed_project_for_owner(project_name, auth_info)
 
     async def authenticate_request(
         self, request: fastapi.Request
-    ) -> mlrun.api.schemas.AuthInfo:
-        auth_info = mlrun.api.schemas.AuthInfo()
+    ) -> mlrun.common.schemas.AuthInfo:
+        auth_info = mlrun.common.schemas.AuthInfo()
         header = request.headers.get("Authorization", "")
         if self._basic_auth_configured():
             if not header.startswith(self._basic_prefix):
@@ -228,10 +228,10 @@ class AuthVerifier(metaclass=mlrun.utils.singleton.Singleton):
             auth_info.username = request.headers["x-remote-user"]
 
         projects_role_header = request.headers.get(
-            mlrun.api.schemas.HeaderNames.projects_role
+            mlrun.common.schemas.HeaderNames.projects_role
         )
         auth_info.projects_role = (
-            mlrun.api.schemas.ProjectsRole(projects_role_header)
+            mlrun.common.schemas.ProjectsRole(projects_role_header)
             if projects_role_header
             else None
         )
@@ -248,7 +248,7 @@ class AuthVerifier(metaclass=mlrun.utils.singleton.Singleton):
 
     async def generate_auth_info_from_session(
         self, session: str
-    ) -> mlrun.api.schemas.AuthInfo:
+    ) -> mlrun.common.schemas.AuthInfo:
         if not self._iguazio_auth_configured():
             raise NotImplementedError(
                 "Session is currently supported only for iguazio authentication mode"
@@ -273,13 +273,15 @@ class AuthVerifier(metaclass=mlrun.utils.singleton.Singleton):
 
     @staticmethod
     def _generate_resource_string_from_project_name(project_name: str):
-        return mlrun.api.schemas.AuthorizationResourceTypes.project.to_resource_string(
-            project_name, ""
+        return (
+            mlrun.common.schemas.AuthorizationResourceTypes.project.to_resource_string(
+                project_name, ""
+            )
         )
 
     @staticmethod
     def _generate_resource_string_from_project_resource(
-        resource_type: mlrun.api.schemas.AuthorizationResourceTypes,
+        resource_type: mlrun.common.schemas.AuthorizationResourceTypes,
         project_name: str,
         resource_name: str,
     ):

mlrun/api/utils/background_tasks.py

@@ -1,4 +1,4 @@
-# Copyright 2018 Iguazio
+# Copyright 2023 Iguazio
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -22,10 +22,10 @@ import fastapi
 import fastapi.concurrency
 import sqlalchemy.orm
 
-import mlrun.api.schemas
 import mlrun.api.utils.helpers
 import mlrun.api.utils.singletons.db
 import mlrun.api.utils.singletons.project_member
+import mlrun.common.schemas
 import mlrun.errors
 import mlrun.utils.singleton
 from mlrun.utils import logger
@@ -41,13 +41,13 @@ class ProjectBackgroundTasksHandler(metaclass=mlrun.utils.singleton.Singleton):
         timeout: int = None,  # in seconds
         *args,
         **kwargs,
-    ) -> mlrun.api.schemas.BackgroundTask:
+    ) -> mlrun.common.schemas.BackgroundTask:
         name = str(uuid.uuid4())
         mlrun.api.utils.singletons.db.get_db().store_background_task(
             db_session,
             name,
             project,
-            mlrun.api.schemas.BackgroundTaskState.running,
+            mlrun.common.schemas.BackgroundTaskState.running,
             timeout,
         )
         background_tasks.add_task(
@@ -66,7 +66,7 @@ class ProjectBackgroundTasksHandler(metaclass=mlrun.utils.singleton.Singleton):
         db_session: sqlalchemy.orm.Session,
         name: str,
         project: str,
-    ) -> mlrun.api.schemas.BackgroundTask:
+    ) -> mlrun.common.schemas.BackgroundTask:
         return mlrun.api.utils.singletons.db.get_db().get_background_task(
             db_session, name, project
         )
@@ -93,21 +93,21 @@ class ProjectBackgroundTasksHandler(metaclass=mlrun.utils.singleton.Singleton):
                 db_session,
                 name,
                 project=project,
-                state=mlrun.api.schemas.BackgroundTaskState.failed,
+                state=mlrun.common.schemas.BackgroundTaskState.failed,
             )
         else:
             mlrun.api.utils.singletons.db.get_db().store_background_task(
                 db_session,
                 name,
                 project=project,
-                state=mlrun.api.schemas.BackgroundTaskState.succeeded,
+                state=mlrun.common.schemas.BackgroundTaskState.succeeded,
             )
 
 
 class InternalBackgroundTasksHandler(metaclass=mlrun.utils.singleton.Singleton):
     def __init__(self):
         self._internal_background_tasks: typing.Dict[
-            str, mlrun.api.schemas.BackgroundTask
+            str, mlrun.common.schemas.BackgroundTask
         ] = {}
 
     @mlrun.api.utils.helpers.ensure_running_on_chief
@@ -117,7 +117,7 @@ class InternalBackgroundTasksHandler(metaclass=mlrun.utils.singleton.Singleton):
         function,
         *args,
         **kwargs,
-    ) -> mlrun.api.schemas.BackgroundTask:
+    ) -> mlrun.common.schemas.BackgroundTask:
         name = str(uuid.uuid4())
         # sanity
         if name in self._internal_background_tasks:
@@ -138,7 +138,7 @@ class InternalBackgroundTasksHandler(metaclass=mlrun.utils.singleton.Singleton):
     def get_background_task(
         self,
         name: str,
-    ) -> mlrun.api.schemas.BackgroundTask:
+    ) -> mlrun.common.schemas.BackgroundTask:
         """
         :return: returns the background task object and bool whether exists
         """
@@ -160,17 +160,17 @@ class InternalBackgroundTasksHandler(metaclass=mlrun.utils.singleton.Singleton):
                 f"Failed during background task execution: {function.__name__}, exc: {traceback.format_exc()}"
             )
             self._update_background_task(
-                name, mlrun.api.schemas.BackgroundTaskState.failed
+                name, mlrun.common.schemas.BackgroundTaskState.failed
             )
         else:
             self._update_background_task(
-                name, mlrun.api.schemas.BackgroundTaskState.succeeded
+                name, mlrun.common.schemas.BackgroundTaskState.succeeded
             )
 
     def _update_background_task(
         self,
         name: str,
-        state: mlrun.api.schemas.BackgroundTaskState,
+        state: mlrun.common.schemas.BackgroundTaskState,
     ):
         background_task = self._internal_background_tasks[name]
         background_task.status.state = state
@@ -183,31 +183,31 @@ class InternalBackgroundTasksHandler(metaclass=mlrun.utils.singleton.Singleton):
         # in order to keep things simple we don't persist the internal background tasks to the DB
         # If for some reason get is called and the background task doesn't exist, it means that probably we got
         # restarted, therefore we want to return a failed background task so the client will retry (if needed)
-        return mlrun.api.schemas.BackgroundTask(
-            metadata=mlrun.api.schemas.BackgroundTaskMetadata(
+        return mlrun.common.schemas.BackgroundTask(
+            metadata=mlrun.common.schemas.BackgroundTaskMetadata(
                 name=name, project=project
             ),
-            spec=mlrun.api.schemas.BackgroundTaskSpec(),
-            status=mlrun.api.schemas.BackgroundTaskStatus(
-                state=mlrun.api.schemas.BackgroundTaskState.failed
+            spec=mlrun.common.schemas.BackgroundTaskSpec(),
+            status=mlrun.common.schemas.BackgroundTaskStatus(
+                state=mlrun.common.schemas.BackgroundTaskState.failed
             ),
         )
 
     @staticmethod
     def _generate_background_task(
         name: str, project: typing.Optional[str] = None
-    ) -> mlrun.api.schemas.BackgroundTask:
+    ) -> mlrun.common.schemas.BackgroundTask:
         now = datetime.datetime.utcnow()
-        metadata = mlrun.api.schemas.BackgroundTaskMetadata(
+        metadata = mlrun.common.schemas.BackgroundTaskMetadata(
             name=name,
             project=project,
             created=now,
             updated=now,
         )
-        spec = mlrun.api.schemas.BackgroundTaskSpec()
-        status = mlrun.api.schemas.BackgroundTaskStatus(
-            state=mlrun.api.schemas.BackgroundTaskState.running
+        spec = mlrun.common.schemas.BackgroundTaskSpec()
+        status = mlrun.common.schemas.BackgroundTaskStatus(
+            state=mlrun.common.schemas.BackgroundTaskState.running
         )
-        return mlrun.api.schemas.BackgroundTask(
+        return mlrun.common.schemas.BackgroundTask(
             metadata=metadata, spec=spec, status=status
         )