Functions api ✨ 🗃️

packages/models-library/src/models_library/api_schemas_api_server/functions.py

@@ -0,0 +1,44 @@
+from typing import Annotated, Any, Literal, TypeAlias
+
+from models_library import projects
+from pydantic import BaseModel, Field
+
+FunctionID: TypeAlias = projects.ProjectID
+
+
+class FunctionSchema(BaseModel):
+    schema_dict: dict[str, Any] | None  # JSON Schema
+
+
+class FunctionInputSchema(FunctionSchema): ...
+
+
+class FunctionOutputSchema(FunctionSchema): ...
+
+
+class Function(BaseModel):
+    uid: FunctionID | None = None
+    title: str | None = None
+    description: str | None = None
+    input_schema: FunctionInputSchema | None = None
+    output_schema: FunctionOutputSchema | None = None
+
+    # @classmethod
+    # def compose_resource_name(cls, function_key) -> api_resources.RelativeResourceName:
+    #     return api_resources.compose_resource_name("functions", function_key)
+
+
+class StudyFunction(Function):
+    function_type: Literal["study"] = "study"
+    study_url: str
+
+
+class PythonCodeFunction(Function):
+    function_type: Literal["python_code"] = "python_code"
+    code_url: str
+
+
+FunctionUnion: TypeAlias = Annotated[
+    StudyFunction | PythonCodeFunction,
+    Field(discriminator="function_type"),
+]

packages/models-library/src/models_library/api_schemas_webserver/functions_wb_schema.py

@@ -0,0 +1,132 @@
+from enum import Enum
+from typing import Annotated, Any, Literal, TypeAlias
+from uuid import UUID
+
+from models_library import projects
+from pydantic import BaseModel, Field
+
+from ..projects import ProjectID
+
+FunctionID: TypeAlias = projects.ProjectID
+FunctionJobID: TypeAlias = projects.ProjectID
+FileID: TypeAlias = UUID
+
+InputTypes: TypeAlias = FileID | float | int | bool | str | list | None
+
+
+class FunctionSchema(BaseModel):
+    schema_dict: dict[str, Any] | None  # JSON Schema
+
+
+class FunctionInputSchema(FunctionSchema): ...
+
+
+class FunctionOutputSchema(FunctionSchema): ...
+
+
+class FunctionClass(str, Enum):
+    project = "project"
+    python_code = "python_code"
+
+
+FunctionClassSpecificData: TypeAlias = dict[str, Any]
+FunctionJobClassSpecificData: TypeAlias = FunctionClassSpecificData
+
+
+# TODO, use InputTypes here, but api is throwing weird errors and asking for dict for elements  # noqa: FIX002
+FunctionInputs: TypeAlias = dict[str, Any] | None
+
+FunctionInputsList: TypeAlias = list[FunctionInputs]
+
+FunctionOutputs: TypeAlias = dict[str, Any] | None
+
+
+class FunctionBase(BaseModel):
+    uid: FunctionID | None = None
+    title: str | None = None
+    description: str | None = None
+    function_class: FunctionClass
+    input_schema: FunctionInputSchema | None = None
+    output_schema: FunctionOutputSchema | None = None
+
+
+class FunctionDB(BaseModel):
+    uuid: FunctionJobID | None = None
+    title: str | None = None
+    description: str | None = None
+    function_class: FunctionClass
+    input_schema: FunctionInputSchema | None = None
+    output_schema: FunctionOutputSchema | None = None
+    class_specific_data: FunctionClassSpecificData
+
+
+class FunctionJobDB(BaseModel):
+    uuid: FunctionJobID | None = None
+    function_uuid: FunctionID
+    title: str | None = None
+    inputs: FunctionInputs | None = None
+    outputs: FunctionOutputs | None = None
+    class_specific_data: FunctionJobClassSpecificData
+    function_class: FunctionClass
+
+
+class ProjectFunction(FunctionBase):
+    function_class: Literal[FunctionClass.project] = FunctionClass.project
+    project_id: ProjectID
+
+
+class PythonCodeFunction(FunctionBase):
+    function_class: Literal[FunctionClass.python_code] = FunctionClass.python_code
+    code_url: str
+
+
+Function: TypeAlias = Annotated[
+    ProjectFunction | PythonCodeFunction,
+    Field(discriminator="function_class"),
+]
+
+FunctionJobCollectionID: TypeAlias = projects.ProjectID
+
+
+class FunctionJobBase(BaseModel):
+    uid: FunctionJobID | None = None
+    title: str | None = None
+    description: str | None = None
+    function_uid: FunctionID
+    inputs: FunctionInputs | None = None
+    outputs: FunctionOutputs | None = None
+    function_class: FunctionClass
+
+
+class ProjectFunctionJob(FunctionJobBase):
+    function_class: Literal[FunctionClass.project] = FunctionClass.project
+    project_job_id: ProjectID
+
+
+class PythonCodeFunctionJob(FunctionJobBase):
+    function_class: Literal[FunctionClass.python_code] = FunctionClass.python_code
+    code_url: str
+
+
+FunctionJob: TypeAlias = Annotated[
+    ProjectFunctionJob | PythonCodeFunctionJob,
+    Field(discriminator="function_class"),
+]
+
+
+class FunctionJobStatus(BaseModel):
+    status: str
+
+
+class FunctionJobCollection(BaseModel):
+    """Model for a collection of function jobs"""
+
+    id: FunctionJobCollectionID
+    title: str | None
+    description: str | None
+    job_ids: list[FunctionJobID]
+    status: str
+
+
+class FunctionJobCollectionStatus(BaseModel):
+    status: list[str]

packages/postgres-database/src/simcore_postgres_database/migration/versions/93dbd49553ae_add_function_tables.py

@@ -0,0 +1,133 @@
+"""Add function tables
+
+Revision ID: 93dbd49553ae
+Revises: cf8f743fd0b7
+Create Date: 2025-04-16 09:32:48.976846+00:00
+
+"""
+
+import sqlalchemy as sa
+from alembic import op
+from sqlalchemy.dialects import postgresql
+
+# revision identifiers, used by Alembic.
+revision = "93dbd49553ae"
+down_revision = "cf8f743fd0b7"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table(
+        "function_job_collections",
+        sa.Column("uuid", postgresql.UUID(as_uuid=True), nullable=False),
+        sa.Column("name", sa.String(), nullable=True),
+        sa.PrimaryKeyConstraint("uuid", name="function_job_collections_pk"),
+    )
+    op.create_index(
+        op.f("ix_function_job_collections_uuid"),
+        "function_job_collections",
+        ["uuid"],
+        unique=False,
+    )
+    op.create_table(
+        "functions",
+        sa.Column("uuid", postgresql.UUID(as_uuid=True), nullable=False),
+        sa.Column("title", sa.String(), nullable=True),
+        sa.Column("function_class", sa.String(), nullable=True),
+        sa.Column("description", sa.String(), nullable=True),
+        sa.Column("input_schema", sa.JSON(), nullable=True),
+        sa.Column("output_schema", sa.JSON(), nullable=True),
+        sa.Column("system_tags", sa.JSON(), nullable=True),
+        sa.Column("user_tags", sa.JSON(), nullable=True),
+        sa.Column("class_specific_data", sa.JSON(), nullable=True),
+        sa.PrimaryKeyConstraint("uuid", name="functions_pk"),
+    )
+    op.create_index(op.f("ix_functions_uuid"), "functions", ["uuid"], unique=False)
+    op.create_table(
+        "function_jobs",
+        sa.Column("uuid", postgresql.UUID(as_uuid=True), nullable=False),
+        sa.Column("title", sa.String(), nullable=True),
+        sa.Column("function_uuid", postgresql.UUID(as_uuid=True), nullable=False),
+        sa.Column("function_class", sa.String(), nullable=True),
+        sa.Column("status", sa.String(), nullable=True),
+        sa.Column("inputs", sa.JSON(), nullable=True),
+        sa.Column("outputs", sa.JSON(), nullable=True),
+        sa.Column("class_specific_data", sa.JSON(), nullable=True),
+        sa.ForeignKeyConstraint(
+            ["function_uuid"],
+            ["functions.uuid"],
+            name="fk_functions_to_function_jobs_to_function_uuid",
+            onupdate="CASCADE",
+            ondelete="CASCADE",
+        ),
+        sa.PrimaryKeyConstraint("uuid", name="function_jobs_pk"),
+    )
+    op.create_index(
+        op.f("ix_function_jobs_function_uuid"),
+        "function_jobs",
+        ["function_uuid"],
+        unique=False,
+    )
+    op.create_index(
+        op.f("ix_function_jobs_uuid"), "function_jobs", ["uuid"], unique=False
+    )
+    op.create_table(
+        "function_job_collections_to_function_jobs",
+        sa.Column(
+            "function_job_collection_uuid", postgresql.UUID(as_uuid=True), nullable=True
+        ),
+        sa.Column("function_job_uuid", postgresql.UUID(as_uuid=True), nullable=True),
+        sa.ForeignKeyConstraint(
+            ["function_job_collection_uuid"],
+            ["function_job_collections.uuid"],
+            name="fk_func_job_coll_to_func_jobs_to_func_job_coll_uuid",
+            onupdate="CASCADE",
+            ondelete="CASCADE",
+        ),
+        sa.ForeignKeyConstraint(
+            ["function_job_uuid"],
+            ["function_jobs.uuid"],
+            name="fk_func_job_coll_to_func_jobs_to_func_job_uuid",
+            onupdate="CASCADE",
+            ondelete="CASCADE",
+        ),
+    )
+    op.drop_index("idx_projects_last_change_date_desc", table_name="projects")
+    op.create_index(
+        "idx_projects_last_change_date_desc",
+        "projects",
+        ["last_change_date"],
+        unique=False,
+        postgresql_using="btree",
+        postgresql_ops={"last_change_date": "DESC"},
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_index(
+        "idx_projects_last_change_date_desc",
+        table_name="projects",
+        postgresql_using="btree",
+        postgresql_ops={"last_change_date": "DESC"},
+    )
+    op.create_index(
+        "idx_projects_last_change_date_desc",
+        "projects",
+        [sa.text("last_change_date DESC")],
+        unique=False,
+    )
+    op.drop_table("function_job_collections_to_function_jobs")
+    op.drop_index(op.f("ix_function_jobs_uuid"), table_name="function_jobs")
+    op.drop_index(op.f("ix_function_jobs_function_uuid"), table_name="function_jobs")
+    op.drop_table("function_jobs")
+    op.drop_index(op.f("ix_functions_uuid"), table_name="functions")
+    op.drop_table("functions")
+    op.drop_index(
+        op.f("ix_function_job_collections_uuid"), table_name="function_job_collections"
+    )
+    op.drop_table("function_job_collections")
+    # ### end Alembic commands ###