Skip to content

server

Traypublisher

Bases: BaseServerAddon

Source code in server/__init__.py 
 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
class Traypublisher(BaseServerAddon):
    settings_model = TraypublisherSettings

    async def get_default_settings(self):
        settings_model_cls = self.get_settings_model()
        return settings_model_cls(**DEFAULT_TRAYPUBLISHER_SETTING)

    async def get_simple_actions(
        self,
        project_name: str | None = None,
        variant: str = "production",
    ) -> list["SimpleActionManifest"]:
        if not project_name:
            return []
        icon = {
            "type": "material-symbols",
            "name": "upload_2",
            "color": "#ffffff",
        }
        kwargs = {
            "label": "Tray Publisher",
            "category": "Desktop tools",
            "icon": icon,
            "order": 100,
            "entity_subtypes": None,
            "allow_multiselection": False,
        }
        return [
            SimpleActionManifest(
                identifier="traypublisher.project",
                entity_type="project",
                **kwargs
            ),
            SimpleActionManifest(
                identifier="traypublisher.folder",
                entity_type="folder",
                **kwargs
            ),
            SimpleActionManifest(
                identifier="traypublisher.task",
                entity_type="task",
                **kwargs
            ),
        ]

    async def execute_action(
        self,
        executor: "ActionExecutor",
    ) -> "ExecuteResponseModel":
        """Execute an action provided by the addon."""
        context = executor.context

        project_name = context.project_name
        args = [
            "addon", "traypublisher", "launch",
            "--project", project_name,
        ]

        if executor.identifier == "traypublisher.folder":
            folder_id = context.entity_ids[0]
            folder = await FolderEntity.load(project_name, folder_id)
            args.extend(["--folder-path", folder.path])

        elif executor.identifier == "traypublisher.task":
            task_id = context.entity_ids[0]
            task = await TaskEntity.load(project_name, task_id)
            folder = await FolderEntity.load(project_name, task.folder_id)
            args.extend([
                "--folder-path", folder.path,
                "--task-name", task.name,
            ])

        return await executor.get_launcher_action_response(args=args)

    async def convert_settings_overrides(
        self,
        source_version: str,
        overrides: dict[str, Any],
    ) -> dict[str, Any]:
        convert_settings_overrides(source_version, overrides)
        # Use super conversion
        return await super().convert_settings_overrides(
            source_version, overrides)

execute_action(executor) async

Execute an action provided by the addon.

Source code in server/__init__.py 
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
async def execute_action(
    self,
    executor: "ActionExecutor",
) -> "ExecuteResponseModel":
    """Execute an action provided by the addon."""
    context = executor.context

    project_name = context.project_name
    args = [
        "addon", "traypublisher", "launch",
        "--project", project_name,
    ]

    if executor.identifier == "traypublisher.folder":
        folder_id = context.entity_ids[0]
        folder = await FolderEntity.load(project_name, folder_id)
        args.extend(["--folder-path", folder.path])

    elif executor.identifier == "traypublisher.task":
        task_id = context.entity_ids[0]
        task = await TaskEntity.load(project_name, task_id)
        folder = await FolderEntity.load(project_name, task.folder_id)
        args.extend([
            "--folder-path", folder.path,
            "--task-name", task.name,
        ])

    return await executor.get_launcher_action_response(args=args)