genesis-flow 1.0.0__py3-none-any.whl

mlflow/server/auth/db/migrations/alembic.ini

@@ -0,0 +1,110 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = .
+
+# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+# Uncomment the line below if you want the files to be prepended with date and time
+# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
+# for all available tokens
+# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.
+prepend_sys_path = .
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the python-dateutil library that can be
+# installed by adding `alembic[tz]` to the pip requirements
+# string value is passed to dateutil.tz.gettz()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the
+# "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; This defaults
+# to migration/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path.
+# The path separator used here should be the separator specified by "version_path_separator" below.
+# version_locations = %(here)s/bar:%(here)s/bat:migration/versions
+
+# version path separator; As mentioned above, this is the character used to split
+# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep.
+# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas.
+# Valid values for version_path_separator are:
+#
+# version_path_separator = :
+# version_path_separator = ;
+# version_path_separator = space
+version_path_separator = os  # Use os.pathsep. Default configuration used for new projects.
+
+# set to 'true' to search source files recursively
+# in each "version_locations" directory
+# new in Alembic version 1.10
+# recursive_version_locations = false
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+sqlalchemy.url =
+
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+# hooks = black
+# black.type = console_scripts
+# black.entrypoint = black
+# black.options = -l 79 REVISION_SCRIPT_FILENAME
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

mlflow/server/auth/db/migrations/env.py

@@ -0,0 +1,76 @@
+from logging.config import fileConfig
+
+from alembic import context
+from sqlalchemy import engine_from_config, pool
+
+from mlflow.server.auth.db.models import Base
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+if config.config_file_name is not None:
+    fileConfig(config.config_file_name)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+target_metadata = Base.metadata
+
+# other values from the config, defined by the needs of env.py,
+# can be acquired:
+# my_important_option = config.get_main_option("my_important_option")
+# ... etc.
+
+
+def run_migrations_offline() -> None:
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well.  By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+
+    """
+    url = config.get_main_option("sqlalchemy.url")
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        dialect_opts={"paramstyle": "named"},
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online() -> None:
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+    connectable = engine_from_config(
+        config.get_section(config.config_ini_section, {}),
+        prefix="sqlalchemy.",
+        poolclass=pool.NullPool,
+    )
+
+    with connectable.connect() as connection:
+        context.configure(connection=connection, target_metadata=target_metadata)
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

mlflow/server/auth/db/migrations/versions/8606fa83a998_initial_migration.py

@@ -0,0 +1,51 @@
+"""initial_migration
+
+Revision ID: 8606fa83a998
+Revises:
+Create Date: 2023-07-07 23:30:50.921970
+
+"""
+
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = "8606fa83a998"
+down_revision = None
+branch_labels = None
+depends_on = None
+
+
+def upgrade() -> None:
+    op.create_table(
+        "users",
+        sa.Column("id", sa.Integer(), nullable=False, primary_key=True),
+        sa.Column("username", sa.String(length=255), nullable=True),
+        sa.Column("password_hash", sa.String(length=255), nullable=True),
+        sa.Column("is_admin", sa.Boolean(), nullable=True),
+        sa.UniqueConstraint("username"),
+    )
+    op.create_table(
+        "experiment_permissions",
+        sa.Column("id", sa.Integer(), nullable=False, primary_key=True),
+        sa.Column("experiment_id", sa.String(length=255), nullable=False),
+        sa.Column("user_id", sa.Integer(), nullable=False),
+        sa.Column("permission", sa.String(length=255), nullable=True),
+        sa.ForeignKeyConstraint(["user_id"], ["users.id"], name="fk_user_id"),
+        sa.UniqueConstraint("experiment_id", "user_id", name="unique_experiment_user"),
+    )
+    op.create_table(
+        "registered_model_permissions",
+        sa.Column("id", sa.Integer(), nullable=False, primary_key=True),
+        sa.Column("name", sa.String(length=255), nullable=False),
+        sa.Column("user_id", sa.Integer(), nullable=False),
+        sa.Column("permission", sa.String(length=255), nullable=True),
+        sa.ForeignKeyConstraint(["user_id"], ["users.id"], name="fk_user_id"),
+        sa.UniqueConstraint("name", "user_id", name="unique_name_user"),
+    )
+
+
+def downgrade() -> None:
+    op.drop_table("registered_model_permissions")
+    op.drop_table("experiment_permissions")
+    op.drop_table("users")

mlflow/server/auth/db/models.py

@@ -0,0 +1,67 @@
+from sqlalchemy import (
+    Boolean,
+    Column,
+    ForeignKey,
+    Integer,
+    String,
+    UniqueConstraint,
+)
+from sqlalchemy.orm import declarative_base, relationship
+
+from mlflow.server.auth.entities import ExperimentPermission, RegisteredModelPermission, User
+
+Base = declarative_base()
+
+
+class SqlUser(Base):
+    __tablename__ = "users"
+    id = Column(Integer(), primary_key=True)
+    username = Column(String(255), unique=True)
+    password_hash = Column(String(255))
+    is_admin = Column(Boolean, default=False)
+    experiment_permissions = relationship("SqlExperimentPermission", backref="users")
+    registered_model_permissions = relationship("SqlRegisteredModelPermission", backref="users")
+
+    def to_mlflow_entity(self):
+        return User(
+            id_=self.id,
+            username=self.username,
+            password_hash=self.password_hash,
+            is_admin=self.is_admin,
+            experiment_permissions=[p.to_mlflow_entity() for p in self.experiment_permissions],
+            registered_model_permissions=[
+                p.to_mlflow_entity() for p in self.registered_model_permissions
+            ],
+        )
+
+
+class SqlExperimentPermission(Base):
+    __tablename__ = "experiment_permissions"
+    id = Column(Integer(), primary_key=True)
+    experiment_id = Column(String(255), nullable=False)
+    user_id = Column(Integer, ForeignKey("users.id"), nullable=False)
+    permission = Column(String(255))
+    __table_args__ = (UniqueConstraint("experiment_id", "user_id", name="unique_experiment_user"),)
+
+    def to_mlflow_entity(self):
+        return ExperimentPermission(
+            experiment_id=self.experiment_id,
+            user_id=self.user_id,
+            permission=self.permission,
+        )
+
+
+class SqlRegisteredModelPermission(Base):
+    __tablename__ = "registered_model_permissions"
+    id = Column(Integer(), primary_key=True)
+    name = Column(String(255), nullable=False)
+    user_id = Column(Integer, ForeignKey("users.id"), nullable=False)
+    permission = Column(String(255))
+    __table_args__ = (UniqueConstraint("name", "user_id", name="unique_name_user"),)
+
+    def to_mlflow_entity(self):
+        return RegisteredModelPermission(
+            name=self.name,
+            user_id=self.user_id,
+            permission=self.permission,
+        )

mlflow/server/auth/db/utils.py

@@ -0,0 +1,37 @@
+from pathlib import Path
+
+from alembic.command import upgrade
+from alembic.config import Config
+from alembic.migration import MigrationContext
+from alembic.script import ScriptDirectory
+from sqlalchemy.engine.base import Engine
+
+
+def _get_alembic_dir() -> str:
+    return Path(__file__).parent / "migrations"
+
+
+def _get_alembic_config(url: str) -> Config:
+    alembic_dir = _get_alembic_dir()
+    alembic_ini_path = alembic_dir / "alembic.ini"
+    alembic_cfg = Config(alembic_ini_path)
+    alembic_cfg.set_main_option("script_location", str(alembic_dir))
+    url = url.replace("%", "%%")  # Same as here: https://github.com/mlflow/mlflow/issues/1487
+    alembic_cfg.set_main_option("sqlalchemy.url", url)
+    return alembic_cfg
+
+
+def migrate(engine: Engine, revision: str) -> None:
+    alembic_cfg = _get_alembic_config(engine.url.render_as_string(hide_password=False))
+    with engine.begin() as conn:
+        alembic_cfg.attributes["connection"] = conn
+        upgrade(alembic_cfg, revision)
+
+
+def migrate_if_needed(engine: Engine, revision: str) -> None:
+    alembic_cfg = _get_alembic_config(engine.url.render_as_string(hide_password=False))
+    script_dir = ScriptDirectory.from_config(alembic_cfg)
+    with engine.begin() as conn:
+        context = MigrationContext.configure(conn)
+        if context.get_current_revision() != script_dir.get_current_head():
+            upgrade(alembic_cfg, revision)

mlflow/server/auth/entities.py

@@ -0,0 +1,165 @@
+class User:
+    def __init__(
+        self,
+        id_,
+        username,
+        password_hash,
+        is_admin,
+        experiment_permissions=None,
+        registered_model_permissions=None,
+    ):
+        self._id = id_
+        self._username = username
+        self._password_hash = password_hash
+        self._is_admin = is_admin
+        self._experiment_permissions = experiment_permissions
+        self._registered_model_permissions = registered_model_permissions
+
+    @property
+    def id(self):
+        return self._id
+
+    @property
+    def username(self):
+        return self._username
+
+    @property
+    def password_hash(self):
+        return self._password_hash
+
+    @property
+    def is_admin(self):
+        return self._is_admin
+
+    @is_admin.setter
+    def is_admin(self, is_admin):
+        self._is_admin = is_admin
+
+    @property
+    def experiment_permissions(self):
+        return self._experiment_permissions
+
+    @experiment_permissions.setter
+    def experiment_permissions(self, experiment_permissions):
+        self._experiment_permissions = experiment_permissions
+
+    @property
+    def registered_model_permissions(self):
+        return self._registered_model_permissions
+
+    @registered_model_permissions.setter
+    def registered_model_permissions(self, registered_model_permissions):
+        self._registered_model_permissions = registered_model_permissions
+
+    def to_json(self):
+        return {
+            "id": self.id,
+            "username": self.username,
+            "is_admin": self.is_admin,
+            "experiment_permissions": [p.to_json() for p in self.experiment_permissions],
+            "registered_model_permissions": [
+                p.to_json() for p in self.registered_model_permissions
+            ],
+        }
+
+    @classmethod
+    def from_json(cls, dictionary):
+        return cls(
+            id_=dictionary["id"],
+            username=dictionary["username"],
+            password_hash="REDACTED",
+            is_admin=dictionary["is_admin"],
+            experiment_permissions=[
+                ExperimentPermission.from_json(p) for p in dictionary["experiment_permissions"]
+            ],
+            registered_model_permissions=[
+                RegisteredModelPermission.from_json(p)
+                for p in dictionary["registered_model_permissions"]
+            ],
+        )
+
+
+class ExperimentPermission:
+    def __init__(
+        self,
+        experiment_id,
+        user_id,
+        permission,
+    ):
+        self._experiment_id = experiment_id
+        self._user_id = user_id
+        self._permission = permission
+
+    @property
+    def experiment_id(self):
+        return self._experiment_id
+
+    @property
+    def user_id(self):
+        return self._user_id
+
+    @property
+    def permission(self):
+        return self._permission
+
+    @permission.setter
+    def permission(self, permission):
+        self._permission = permission
+
+    def to_json(self):
+        return {
+            "experiment_id": self.experiment_id,
+            "user_id": self.user_id,
+            "permission": self.permission,
+        }
+
+    @classmethod
+    def from_json(cls, dictionary):
+        return cls(
+            experiment_id=dictionary["experiment_id"],
+            user_id=dictionary["user_id"],
+            permission=dictionary["permission"],
+        )
+
+
+class RegisteredModelPermission:
+    def __init__(
+        self,
+        name,
+        user_id,
+        permission,
+    ):
+        self._name = name
+        self._user_id = user_id
+        self._permission = permission
+
+    @property
+    def name(self):
+        return self._name
+
+    @property
+    def user_id(self):
+        return self._user_id
+
+    @property
+    def permission(self):
+        return self._permission
+
+    @permission.setter
+    def permission(self, permission):
+        self._permission = permission
+
+    def to_json(self):
+        return {
+            "name": self.name,
+            "user_id": self.user_id,
+            "permission": self.permission,
+        }
+
+    @classmethod
+    def from_json(cls, dictionary):
+        return cls(
+            name=dictionary["name"],
+            user_id=dictionary["user_id"],
+            permission=dictionary["permission"],
+        )

mlflow/server/auth/logo.py

@@ -0,0 +1,14 @@
+# ruff: noqa: E501
+MLFLOW_LOGO = """
+<svg width="109" height="40" viewBox="0 0 109 40" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M0 31.0316V15.5024H3.54258V17.4699C4.43636 15.8756 6.38278 15.045 8.13589 15.045C10.178 15.045 11.9636 15.9713 12.7943 17.7895C14.0096 15.7474 15.8278 15.045 17.8373 15.045C20.6469 15.045 23.3263 16.8325 23.3263 20.9493V31.0316H19.7531V21.5541C19.7531 19.7359 18.8268 18.3636 16.7522 18.3636C14.8057 18.3636 13.5292 19.8947 13.5292 21.8086V31.0297H9.89282V21.5541C9.89282 19.7684 8.99522 18.3732 6.88995 18.3732C4.91292 18.3732 3.66699 19.8412 3.66699 21.8182V31.0392Z" fill="#333333"/>
+<path d="M27.8546 31.0316V7.92917H31.5579V31.0316Z" fill="#333333"/>
+<path d="M30.0708 39.4871C30.9033 39.7187 31.6517 39.8699 33.2402 39.8699C36.1933 39.8699 39.6765 38.2048 40.5933 33.5311L44.3789 14.7923H50.0076L50.6947 11.6746H45.0086L45.7741 7.95023C46.3598 5.05837 47.9598 3.59234 50.5282 3.59234C51.1962 3.59234 51.0086 3.64975 51.6038 3.76267L52.4268 0.570327C51.6344 0.333006 50.9244 0.191379 49.378 0.191379C47.7454 0.166831 46.1514 0.688934 44.8497 1.67463C43.4086 2.78851 42.4574 4.42487 42.023 6.53779L40.9569 11.6746H35.9234L35.5119 14.7943H40.3349L36.8593 32.1206C36.4765 34.0861 35.3588 36.4364 32.1512 36.4364C31.4239 36.4364 31.688 36.3809 31.0297 36.2737Z" fill="#0194E2"/>
+<path d="M53.3416 30.9053H49.6402L54.7139 7.59616H58.4153Z" fill="#0194E2"/>
+<path d="M71.8067 16.4766C68.5762 14.2161 64.1778 14.6606 61.4649 17.5216C58.7519 20.3826 58.5416 24.7984 60.9703 27.9043L63.3952 26.1244C62.1915 24.6312 61.9471 22.5815 62.7658 20.8471C63.5845 19.1127 65.3224 17.9987 67.2402 17.979V19.8737Z" fill="#43C9ED"/>
+<path d="M62.6179 29.4717C65.8484 31.7322 70.2468 31.2877 72.9597 28.4267C75.6727 25.5657 75.883 21.1499 73.4543 18.044L71.0294 19.8239C72.2331 21.3171 72.4775 23.3668 71.6588 25.1012C70.8401 26.8356 69.1022 27.9496 67.1844 27.9693V26.0746Z" fill="#0194E2"/>
+<path d="M78.0919 15.4928H82.1359L82.9588 26.1053L88.7177 15.4928L92.5569 15.5483L94.0651 26.1053L99.1387 15.4928L102.84 15.5483L95.1617 31.0412H91.4603L89.6765 19.9349L83.7818 31.0412H79.9426Z" fill="#0194E2"/>
+<path d="M105.072 15.7684H104.306V15.5024H106.151V15.7741H105.386V18.0172H105.072Z" fill="#0194E2"/>
+<path d="M106.614 15.5024H106.997L107.479 16.8421C107.541 17.0143 107.598 17.1904 107.657 17.3665H107.675C107.734 17.1904 107.788 17.0143 107.847 16.8421L108.325 15.5024H108.708V18.0172H108.41V16.6297C108.41 16.4096 108.434 16.1072 108.45 15.8832H108.434L108.243 16.4574L107.768 17.7608H107.56L107.079 16.4593L106.888 15.8852H106.873C106.89 16.1091 106.915 16.4115 106.915 16.6316V18.0191H106.624Z" fill="#0194E2"/>
+</svg>
+"""

mlflow/server/auth/permissions.py

@@ -0,0 +1,65 @@
+from dataclasses import dataclass
+
+from mlflow import MlflowException
+from mlflow.protos.databricks_pb2 import INVALID_PARAMETER_VALUE
+
+
+@dataclass
+class Permission:
+    name: str
+    can_read: bool
+    can_update: bool
+    can_delete: bool
+    can_manage: bool
+
+
+READ = Permission(
+    name="READ",
+    can_read=True,
+    can_update=False,
+    can_delete=False,
+    can_manage=False,
+)
+
+EDIT = Permission(
+    name="EDIT",
+    can_read=True,
+    can_update=True,
+    can_delete=False,
+    can_manage=False,
+)
+
+MANAGE = Permission(
+    name="MANAGE",
+    can_read=True,
+    can_update=True,
+    can_delete=True,
+    can_manage=True,
+)
+
+NO_PERMISSIONS = Permission(
+    name="NO_PERMISSIONS",
+    can_read=False,
+    can_update=False,
+    can_delete=False,
+    can_manage=False,
+)
+
+ALL_PERMISSIONS = {
+    READ.name: READ,
+    EDIT.name: EDIT,
+    MANAGE.name: MANAGE,
+    NO_PERMISSIONS.name: NO_PERMISSIONS,
+}
+
+
+def get_permission(permission: str) -> Permission:
+    return ALL_PERMISSIONS[permission]
+
+
+def _validate_permission(permission: str):
+    if permission not in ALL_PERMISSIONS:
+        raise MlflowException(
+            f"Invalid permission '{permission}'. Valid permissions are: {tuple(ALL_PERMISSIONS)}",
+            INVALID_PARAMETER_VALUE,
+        )

mlflow/server/auth/routes.py

@@ -0,0 +1,18 @@
+from mlflow.server.handlers import _get_rest_path
+
+HOME = "/"
+SIGNUP = "/signup"
+CREATE_USER = _get_rest_path("/mlflow/users/create")
+CREATE_USER_UI = _get_rest_path("/mlflow/users/create-ui")
+GET_USER = _get_rest_path("/mlflow/users/get")
+UPDATE_USER_PASSWORD = _get_rest_path("/mlflow/users/update-password")
+UPDATE_USER_ADMIN = _get_rest_path("/mlflow/users/update-admin")
+DELETE_USER = _get_rest_path("/mlflow/users/delete")
+CREATE_EXPERIMENT_PERMISSION = _get_rest_path("/mlflow/experiments/permissions/create")
+GET_EXPERIMENT_PERMISSION = _get_rest_path("/mlflow/experiments/permissions/get")
+UPDATE_EXPERIMENT_PERMISSION = _get_rest_path("/mlflow/experiments/permissions/update")
+DELETE_EXPERIMENT_PERMISSION = _get_rest_path("/mlflow/experiments/permissions/delete")
+CREATE_REGISTERED_MODEL_PERMISSION = _get_rest_path("/mlflow/registered-models/permissions/create")
+GET_REGISTERED_MODEL_PERMISSION = _get_rest_path("/mlflow/registered-models/permissions/get")
+UPDATE_REGISTERED_MODEL_PERMISSION = _get_rest_path("/mlflow/registered-models/permissions/update")
+DELETE_REGISTERED_MODEL_PERMISSION = _get_rest_path("/mlflow/registered-models/permissions/delete")