Skip to content

Commit

Permalink
Merge pull request #304 from ynput/resolve-fix-version-conditions
Browse files Browse the repository at this point in the history 
Resolve: fix version argument parsing
  • Loading branch information
@martastain
martastain authored Aug 1, 2024
2 parents 5716d57 + 16b11da commit 37b6cc0
Show file tree
Hide file tree
Showing 2 changed files with 121 additions and 105 deletions.
124 changes: 19 additions & 105 deletions api/resolve/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,118 +4,24 @@
from urllib.parse import parse_qs, urlparse

from fastapi import APIRouter, Query
from nxtools import logging

from ayon_server.api.dependencies import ClientSiteID, CurrentUser
from ayon_server.exceptions import BadRequestException, ServiceUnavailableException
from ayon_server.helpers.roots import get_roots_for_projects
from ayon_server.lib.postgres import Postgres
from ayon_server.types import NAME_REGEX, Field, OPModel, ProjectLevelEntityType

from ayon_server.types import NAME_REGEX, ProjectLevelEntityType

from .models import (
ParsedURIModel,
ResolvedEntityModel,
ResolvedURIModel,
ResolveRequestModel,
)
from .templating import StringTemplate

router = APIRouter(tags=["URIs"])

EXAMPLE_URI = "ayon+entity://myproject/assets/env/beach?product=layout&version=v004"


class ResolveRequestModel(OPModel):
resolve_roots: bool = Field(
False,
title="Resolve roots",
description="If x-ayon-site-id header is provided, "
"resolve representation path roots",
)
uris: list[str] = Field(
...,
title="URIs",
description="List of uris to resolve",
example=[EXAMPLE_URI],
)


class ResolvedEntityModel(OPModel):
project_name: str | None = Field(
None,
title="Project name",
example="demo_Big_Feature",
)
folder_id: str | None = Field(
None,
title="Folder id",
example="0254c370005811ee9a740242ac130004",
)
product_id: str | None = Field(
None,
title="Product id",
example="0255ce50005811ee9a740242ac130004",
)
task_id: str | None = Field(
None,
title="Task id",
example=None,
)
version_id: str | None = Field(
None,
title="Version id",
example="0256ba2c005811ee9a740242ac130004",
)
representation_id: str | None = Field(
None,
title="Representation id",
example=None,
)
workfile_id: str | None = Field(
None,
title="Workfile id",
example=None,
)
file_path: str | None = Field(
None,
title="File path",
description="Path to the file if a representation is specified",
example="/path/to/file.ma",
)
target: ProjectLevelEntityType | None = Field(
None,
title="Target entity type",
description="The deepest entity type queried",
)


class ResolvedURIModel(OPModel):
uri: str = Field(
...,
title="Resolved URI",
example="ayon+entity://demo_Big_Feature/assets/environments/01_pfueghtiaoft?product=layoutMain&version=v004&representation=ma",
)
entities: list[ResolvedEntityModel] = Field(
...,
title="Resolved entities",
example=[
{
"projectName": "demo_Big_Feature",
"folderId": "0254c370005811ee9a740242ac130004",
"productId": "0255ce50005811ee9a740242ac130004",
"taskId": None,
"versionId": "0256ba2c005811ee9a740242ac130004",
"representationId": None,
"workfileId": None,
"filePath": "/path/to/file.ma",
}
],
)


class ParsedURIModel(OPModel):
uri: str = Field(..., title="Resolved URI")
project_name: str = Field(..., title="Project name")
path: str | None = Field(None, title="Path")
product_name: str | None = Field(None, title="Product name")
task_name: str | None = Field(None, title="Task name")
version_name: str | None = Field(None, title="Version name")
representation_name: str | None = Field(None, title="Representation name")
workfile_name: str | None = Field(None, title="Workfile name")


SDF_REGEX = re.compile(r":SDF_FORMAT_ARGS.*$")

Expand All @@ -126,7 +32,7 @@ def sanitize_uri(uri: str) -> str:
return uri


def validate_name(name: str) -> None:
def validate_name(name: str | None) -> None:
if name is None:
return
if name == "*":
Expand Down Expand Up @@ -229,11 +135,17 @@ def get_product_conditions(product_name: str | None) -> list[str]:
def get_version_conditions(version_name: str | None) -> list[str]:
if version_name is None:
return []

if version_name == "*":
return []

original_version_name = version_name
if version_name.startswith("v"):
version_name = version_name[1:]

if version_name.isdigit():
return [f"v.version = {int(version_name)}"]

if version_name == "latest":
return [
"""
Expand All @@ -243,10 +155,12 @@ def get_version_conditions(version_name: str | None) -> list[str]:
)
"""
]

if version_name == "hero":
return ["v.version < 0"]

return []
logging.debug(f"Invalid version name: {original_version_name}")
return ["FALSE"]


def get_representation_conditions(representation_name: str | None) -> list[str]:
Expand Down
102 changes: 102 additions & 0 deletions api/resolve/models.py
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
from ayon_server.types import Field, OPModel, ProjectLevelEntityType

EXAMPLE_URI = "ayon+entity://myproject/assets/env/beach?product=layout&version=v004"


class ResolveRequestModel(OPModel):
resolve_roots: bool = Field(
False,
title="Resolve roots",
description="If x-ayon-site-id header is provided, "
"resolve representation path roots",
)
uris: list[str] = Field(
...,
title="URIs",
description="List of uris to resolve",
example=[EXAMPLE_URI],
)


class ResolvedEntityModel(OPModel):
project_name: str | None = Field(
None,
title="Project name",
example="demo_Big_Feature",
)
folder_id: str | None = Field(
None,
title="Folder id",
example="0254c370005811ee9a740242ac130004",
)
product_id: str | None = Field(
None,
title="Product id",
example="0255ce50005811ee9a740242ac130004",
)
task_id: str | None = Field(
None,
title="Task id",
example=None,
)
version_id: str | None = Field(
None,
title="Version id",
example="0256ba2c005811ee9a740242ac130004",
)
representation_id: str | None = Field(
None,
title="Representation id",
example=None,
)
workfile_id: str | None = Field(
None,
title="Workfile id",
example=None,
)
file_path: str | None = Field(
None,
title="File path",
description="Path to the file if a representation is specified",
example="/path/to/file.ma",
)
target: ProjectLevelEntityType | None = Field(
None,
title="Target entity type",
description="The deepest entity type queried",
)


class ResolvedURIModel(OPModel):
uri: str = Field(
...,
title="Resolved URI",
example="ayon+entity://demo_Big_Feature/assets/environments/01_pfueghtiaoft?product=layoutMain&version=v004&representation=ma",
)
entities: list[ResolvedEntityModel] = Field(
...,
title="Resolved entities",
example=[
{
"projectName": "demo_Big_Feature",
"folderId": "0254c370005811ee9a740242ac130004",
"productId": "0255ce50005811ee9a740242ac130004",
"taskId": None,
"versionId": "0256ba2c005811ee9a740242ac130004",
"representationId": None,
"workfileId": None,
"filePath": "/path/to/file.ma",
}
],
)


class ParsedURIModel(OPModel):
uri: str = Field(..., title="Resolved URI")
project_name: str = Field(..., title="Project name")
path: str | None = Field(None, title="Path")
product_name: str | None = Field(None, title="Product name")
task_name: str | None = Field(None, title="Task name")
version_name: str | None = Field(None, title="Version name")
representation_name: str | None = Field(None, title="Representation name")
workfile_name: str | None = Field(None, title="Workfile name")

0 comments on commit 37b6cc0

Please sign in to comment.