Skip to content

Commit

Permalink
Make tags workspace scoped resources
Browse files Browse the repository at this point in the history
  • Loading branch information
stefannica committed Feb 19, 2025
1 parent 0c70fce commit b965bf2
Show file tree
Hide file tree
Showing 7 changed files with 130 additions and 118 deletions.
5 changes: 4 additions & 1 deletion src/zenml/cli/tag.py
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,11 @@ def register_tag(name: str, color: Optional[ColorVariants]) -> None:
color: The color variant for UI.
"""
request_dict = remove_none_values(dict(name=name, color=color))
client = Client()
try:
tag = Client().create_tag(TagRequest(**request_dict))
tag = client.create_tag(
TagRequest(workspace=client.active_workspace.id, **request_dict)
)
except (EntityExistsError, ValueError) as e:
cli_utils.error(str(e))

Expand Down
2 changes: 2 additions & 0 deletions src/zenml/models/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,7 @@
TagFilter,
TagResponse,
TagResponseBody,
TagResponseMetadata,
TagRequest,
TagUpdate,
)
Expand Down Expand Up @@ -709,6 +710,7 @@
"TagResourceRequest",
"TagResponse",
"TagResponseBody",
"TagResponseMetadata",
"TagRequest",
"TagUpdate",
"TriggerResponse",
Expand Down
30 changes: 17 additions & 13 deletions src/zenml/models/v2/core/tag.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,19 @@

from zenml.constants import STR_FIELD_MAX_LENGTH
from zenml.enums import ColorVariants
from zenml.models.v2.base.base import (
BaseDatedResponseBody,
BaseIdentifiedResponse,
BaseRequest,
BaseResponseMetadata,
BaseResponseResources,
from zenml.models.v2.base.scoped import (
WorkspaceScopedFilter,
WorkspaceScopedRequest,
WorkspaceScopedResponse,
WorkspaceScopedResponseBody,
WorkspaceScopedResponseMetadata,
WorkspaceScopedResponseResources,
)
from zenml.models.v2.base.filter import BaseFilter

# ------------------ Request Model ------------------


class TagRequest(BaseRequest):
class TagRequest(WorkspaceScopedRequest):
"""Request model for tags."""

name: str = Field(
Expand All @@ -58,7 +58,7 @@ class TagUpdate(BaseModel):
# ------------------ Response Model ------------------


class TagResponseBody(BaseDatedResponseBody):
class TagResponseBody(WorkspaceScopedResponseBody):
"""Response body for tags."""

color: ColorVariants = Field(
Expand All @@ -70,13 +70,17 @@ class TagResponseBody(BaseDatedResponseBody):
)


class TagResponseResources(BaseResponseResources):
class TagResponseMetadata(WorkspaceScopedResponseMetadata):
"""Response metadata for tags."""


class TagResponseResources(WorkspaceScopedResponseResources):
"""Class for all resource models associated with the tag entity."""


class TagResponse(
BaseIdentifiedResponse[
TagResponseBody, BaseResponseMetadata, TagResponseResources
WorkspaceScopedResponse[
TagResponseBody, TagResponseMetadata, TagResponseResources
]
):
"""Response model for tags."""
Expand Down Expand Up @@ -118,7 +122,7 @@ def tagged_count(self) -> int:
# ------------------ Filter Model ------------------


class TagFilter(BaseFilter):
class TagFilter(WorkspaceScopedFilter):
"""Model to enable advanced filtering of all tags."""

name: Optional[str] = Field(
Expand Down
34 changes: 33 additions & 1 deletion src/zenml/zen_stores/schemas/tag_schemas.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
# permissions and limitations under the License.
"""SQLModel implementation of tag tables."""

from typing import Any, List
from typing import Any, List, Optional
from uuid import UUID

from sqlalchemy import VARCHAR, Column
Expand All @@ -27,6 +27,7 @@
TagResourceResponseBody,
TagResponse,
TagResponseBody,
TagResponseMetadata,
TagUpdate,
)
from zenml.utils.time_utils import utc_now
Expand All @@ -35,13 +36,35 @@
build_foreign_key_field,
build_index,
)
from zenml.zen_stores.schemas.user_schemas import UserSchema
from zenml.zen_stores.schemas.workspace_schemas import WorkspaceSchema


class TagSchema(NamedSchema, table=True):
"""SQL Model for tag."""

__tablename__ = "tag"

workspace_id: UUID = build_foreign_key_field(
source=__tablename__,
target=WorkspaceSchema.__tablename__,
source_column="workspace_id",
target_column="id",
ondelete="CASCADE",
nullable=False,
)
workspace: "WorkspaceSchema" = Relationship(back_populates="tags")

user_id: Optional[UUID] = build_foreign_key_field(
source=__tablename__,
target=UserSchema.__tablename__,
source_column="user_id",
target_column="id",
ondelete="SET NULL",
nullable=True,
)
user: Optional["UserSchema"] = Relationship(back_populates="tags")

color: str = Field(sa_column=Column(VARCHAR(255), nullable=False))
links: List["TagResourceSchema"] = Relationship(
back_populates="tag",
Expand All @@ -61,6 +84,8 @@ def from_request(cls, request: TagRequest) -> "TagSchema":
return cls(
name=request.name,
color=request.color.value,
workspace_id=request.workspace,
user_id=request.user,
)

def to_model(
Expand All @@ -80,15 +105,22 @@ def to_model(
Returns:
The created `TagResponse`.
"""
metadata = None
if include_metadata:
metadata = TagResponseMetadata(
workspace=self.workspace.to_model(),
)
return TagResponse(
id=self.id,
name=self.name,
body=TagResponseBody(
user=self.user.to_model() if self.user else None,
created=self.created,
updated=self.updated,
color=ColorVariants(self.color),
tagged_count=len(self.links),
),
metadata=metadata,
)

def update(self, update: TagUpdate) -> "TagSchema":
Expand Down
4 changes: 4 additions & 0 deletions src/zenml/zen_stores/schemas/user_schemas.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@
StackComponentSchema,
StackSchema,
StepRunSchema,
TagSchema,
TriggerSchema,
)

Expand Down Expand Up @@ -150,6 +151,9 @@ class UserSchema(NamedSchema, table=True):
back_populates="service_account",
sa_relationship_kwargs={"cascade": "delete"},
)
tags: List["TagSchema"] = Relationship(
back_populates="user",
)

@classmethod
def from_user_request(cls, model: UserRequest) -> "UserSchema":
Expand Down
5 changes: 5 additions & 0 deletions src/zenml/zen_stores/schemas/workspace_schemas.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
StackComponentSchema,
StackSchema,
StepRunSchema,
TagSchema,
TriggerSchema,
)

Expand Down Expand Up @@ -140,6 +141,10 @@ class WorkspaceSchema(NamedSchema, table=True):
back_populates="workspace",
sa_relationship_kwargs={"cascade": "delete"},
)
tags: List["TagSchema"] = Relationship(
back_populates="workspace",
sa_relationship_kwargs={"cascade": "delete"},
)

@classmethod
def from_request(cls, workspace: WorkspaceRequest) -> "WorkspaceSchema":
Expand Down
Loading

0 comments on commit b965bf2

Please sign in to comment.