Skip to content

launcher_show_in_kitsu

ShowInKitsu

Bases: LauncherAction

Source code in client/ayon_kitsu/plugins/launcher/launcher_show_in_kitsu.py
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
class ShowInKitsu(LauncherAction):
    name = "showinkitsu"
    label = "Show in Kitsu"
    icon = "external-link-square"
    color = "#e0e1e1"
    order = 10

    @staticmethod
    def get_kitsu_addon():
        return AddonsManager().get("kitsu")

    def is_compatible(self, selection):
        return selection.is_project_selected

    def process(self, selection, **kwargs):
        # Context inputs
        project_name = selection.project_name
        project = ayon_api.get_project(project_name)
        if not project:
            raise RuntimeError(f"Project {project_name} not found.")

        # Define URL
        url = self.get_url(
            project,
            selection.folder_entity if selection.is_folder_selected else None,
            selection.task_entity if selection.is_task_selected else None,
        )

        # Open URL in webbrowser
        self.log.info(f"Opening URL: {url}")
        webbrowser.open(
            url,
            # Try in new tab
            new=2,
        )

    def get_url(
        self,
        project: dict,
        folder: dict = None,
        task: dict = None,
    ) -> str:
        """Get the URL for the project, folder, or task.

        Args:
            project (dict): The project data.
            folder (dict): The folder data.
            task (dict): The task data.

        Returns:
            str: The URL for the project, folder, or task.
        """
        if not (project_kitsu_id := project["data"].get("kitsuProjectId")):
            raise RuntimeError(
                f"Project {project['name']} has no connected kitsu id."
            )
        project_url = Path(
            gazu.project.get_project_url({"id": project_kitsu_id})
        )

        if task:
            if not (task_id := task.get("kitsuId")):
                raise RuntimeError(
                    f"Task {task['name']} has no connected kitsu entity."
                )

            return gazu.task.get_task_url(
                {"project_id": project_kitsu_id, "id": task_id}
            )
        elif folder:
            folder_type = folder["folderType"]
            folder_path = Path(folder["path"])
            if not (kitsu_id := folder["data"].get("kitsuId")):
                raise RuntimeError(
                    f"Folder {folder['name']} has no connected kitsu entity."
                )

            if folder_type == "Folder":
                if len(folder_path.parents) == 1:  # Root folder
                    return f"{project_url.parent}/{folder['name']}"
                elif len(folder_path.parents) == 2:  # Asset type
                    return self._get_asset_type_url(
                        project_kitsu_id, folder["label"]
                    )
                else:  # Asset
                    return gazu.asset.get_asset_url(
                        {"project_id": project_kitsu_id, "id": kitsu_id}
                    )
            elif folder_type == "Sequence":
                return self._get_sequence_url(
                    project, project_kitsu_id, kitsu_id, folder_path
                )
            elif folder_type == "Episode":
                return gazu.shot.get_episode_url(
                    {"project_id": project_kitsu_id, "id": kitsu_id}
                )
            elif folder_type == "Shot":
                return gazu.shot.get_shot_url(
                    {"project_id": project_kitsu_id, "id": kitsu_id}
                )
            else:
                return (
                    f"{project_url.parent}/{folder_type.lower()}s/{kitsu_id}"
                )
        else:
            return project_url.as_posix()

    def _get_asset_type_url(
        self, project_kitsu_id: str, folder_label: str
    ) -> str:
        """Get the URL for the asset type page.

        Meant to be replaced by gazu.asset.get_asset_type_url when available.
        See https://github.com/cgwire/gazu/issues/392
        """
        project_url = Path(
            gazu.project.get_project_url({"id": project_kitsu_id})
        )
        return (
            f"{project_url.parent}/episodes/all/assets"
            f"?search=+type=[{folder_label}]"
        )

    def _get_sequence_url(
        self,
        project: dict,
        project_kitsu_id: str,
        kitsu_id: str,
        folder_path: Path,
    ) -> str:
        """Get the URL for the sequence page.

        Meant to be replaced by gazu.shot.get_sequence_url when available.
        See https://github.com/cgwire/gazu/issues/392
        """
        if folder_path.parts[1] == "episodes":
            episode_folder = ayon_api.get_folder_by_path(
                project["name"], folder_path.parents[0].as_posix()
            )
            episode_url = Path(
                gazu.shot.get_episode_url(
                    {
                        "project_id": project_kitsu_id,
                        "id": episode_folder["data"].get("kitsuId"),
                    }
                )
            )
            return f"{episode_url.parent}/sequences/{kitsu_id}"
        else:
            project_url = Path(
                gazu.project.get_project_url({"id": project_kitsu_id})
            )
            return f"{project_url.parent}/sequences/{kitsu_id}"

get_url(project, folder=None, task=None)

Get the URL for the project, folder, or task.

Parameters:

Name Type Description Default
project dict

The project data.

required
folder dict

The folder data.

None
task dict

The task data.

None

Returns:

Name Type Description
str str

The URL for the project, folder, or task.

Source code in client/ayon_kitsu/plugins/launcher/launcher_show_in_kitsu.py
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
def get_url(
    self,
    project: dict,
    folder: dict = None,
    task: dict = None,
) -> str:
    """Get the URL for the project, folder, or task.

    Args:
        project (dict): The project data.
        folder (dict): The folder data.
        task (dict): The task data.

    Returns:
        str: The URL for the project, folder, or task.
    """
    if not (project_kitsu_id := project["data"].get("kitsuProjectId")):
        raise RuntimeError(
            f"Project {project['name']} has no connected kitsu id."
        )
    project_url = Path(
        gazu.project.get_project_url({"id": project_kitsu_id})
    )

    if task:
        if not (task_id := task.get("kitsuId")):
            raise RuntimeError(
                f"Task {task['name']} has no connected kitsu entity."
            )

        return gazu.task.get_task_url(
            {"project_id": project_kitsu_id, "id": task_id}
        )
    elif folder:
        folder_type = folder["folderType"]
        folder_path = Path(folder["path"])
        if not (kitsu_id := folder["data"].get("kitsuId")):
            raise RuntimeError(
                f"Folder {folder['name']} has no connected kitsu entity."
            )

        if folder_type == "Folder":
            if len(folder_path.parents) == 1:  # Root folder
                return f"{project_url.parent}/{folder['name']}"
            elif len(folder_path.parents) == 2:  # Asset type
                return self._get_asset_type_url(
                    project_kitsu_id, folder["label"]
                )
            else:  # Asset
                return gazu.asset.get_asset_url(
                    {"project_id": project_kitsu_id, "id": kitsu_id}
                )
        elif folder_type == "Sequence":
            return self._get_sequence_url(
                project, project_kitsu_id, kitsu_id, folder_path
            )
        elif folder_type == "Episode":
            return gazu.shot.get_episode_url(
                {"project_id": project_kitsu_id, "id": kitsu_id}
            )
        elif folder_type == "Shot":
            return gazu.shot.get_shot_url(
                {"project_id": project_kitsu_id, "id": kitsu_id}
            )
        else:
            return (
                f"{project_url.parent}/{folder_type.lower()}s/{kitsu_id}"
            )
    else:
        return project_url.as_posix()