Skip to content

server

CoreAddon

Bases: BaseServerAddon

Source code in server/__init__.py
 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
163
164
165
166
167
168
169
170
171
172
173
174
175
class CoreAddon(BaseServerAddon):
    settings_model = CoreSettings

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

    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
        )

    async def get_simple_actions(
        self,
        project_name: str | None = None,
        variant: str = "production",
    ) -> list[SimpleActionManifest]:
        """Return a list of simple actions provided by the addon"""
        output = []

        if project_name:
            # Add 'Create Project Folder Structure' action to folders.
            output.append(
                SimpleActionManifest(
                    identifier="core.createprojectstructure",
                    label="Create Project Folder Structure",
                    icon={
                        "type": "material-symbols",
                        "name": "create_new_folder",
                    },
                    order=100,
                    entity_type="project",
                    entity_subtypes=None,
                    allow_multiselection=False,
                )
            )
            output.append(
                SimpleActionManifest(
                    identifier="core.delivery.version",
                    label="Deliver versions (launcher action)",
                    icon={
                        "type": "material-symbols",
                        "name": "create_new_folder",
                    },
                    order=100,
                    entity_type="version",
                    entity_subtypes=None,
                    allow_multiselection=True,
                )
            )
            output.append(
                SimpleActionManifest(
                    identifier="core.delivery.list",
                    label="Deliver versions (launcher action)",
                    icon={
                        "type": "material-symbols",
                        "name": "create_new_folder",
                    },
                    order=100,
                    entity_type="list",
                    entity_subtypes=[
                        "version:review-session",
                        "version:generic",
                    ],
                    allow_multiselection=False,
                )
            )

        return output

    async def execute_action(
        self,
        executor: ActionExecutor,
    ) -> ExecuteResponseModel:
        """Execute webactions."""

        project_name = executor.context.project_name

        if executor.identifier == "core.createprojectstructure":
            if not project_name:
                logger.error(
                    f"Can't execute {executor.identifier} because"
                    " of missing project name."
                )
                # Works since AYON server 1.8.3
                if hasattr(executor, "get_simple_response"):
                    return await executor.get_simple_response(
                        "Missing project name", success=False
                    )
                return

            args = [
                "create-project-structure", "--project", project_name,
            ]
            # Works since AYON server 1.8.3
            if hasattr(executor, "get_launcher_response"):
                return await executor.get_launcher_response(args)

            return await executor.get_launcher_action_response(args)

        if executor.identifier == "core.delivery.version":
            selected_versions = await executor.context.get_entities()
            if not selected_versions:
                return await executor.get_server_action_response(
                    message="No versions available in selection.",
                    success=False
                )
            version_ids = [version.id for version in selected_versions]
            event_id = await dispatch_event(
                topic="delivery.requested",
                project=project_name,
                payload={"version_ids": version_ids},
                finished=True,
            )
            args = [
                "deliver", "--project", project_name,
                "--event_id", event_id,
            ]

            return await executor.get_launcher_response(args)

        if executor.identifier == "core.delivery.list":
            if not executor.context.entity_ids:
                return await executor.get_server_action_response(
                    message="No list selected.",
                    success=False
                )

            selected_list = executor.context.entity_ids[0]
            event_id = await dispatch_event(
                topic="delivery.requested",
                project=project_name,
                payload={"list_id": selected_list},
                finished=True,
            )
            args = [
                "deliver", "--project", project_name,
                "--event_id", event_id,
            ]

            return await executor.get_launcher_response(args)

        logger.debug(f"Unknown action: {executor.identifier}")

        if hasattr(executor, "get_simple_response"):
            return await executor.get_simple_response(
                "Unknown action", success=False
            )

execute_action(executor) async

Execute webactions.

Source code in server/__init__.py
 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
163
164
165
166
167
168
169
170
171
172
173
174
175
async def execute_action(
    self,
    executor: ActionExecutor,
) -> ExecuteResponseModel:
    """Execute webactions."""

    project_name = executor.context.project_name

    if executor.identifier == "core.createprojectstructure":
        if not project_name:
            logger.error(
                f"Can't execute {executor.identifier} because"
                " of missing project name."
            )
            # Works since AYON server 1.8.3
            if hasattr(executor, "get_simple_response"):
                return await executor.get_simple_response(
                    "Missing project name", success=False
                )
            return

        args = [
            "create-project-structure", "--project", project_name,
        ]
        # Works since AYON server 1.8.3
        if hasattr(executor, "get_launcher_response"):
            return await executor.get_launcher_response(args)

        return await executor.get_launcher_action_response(args)

    if executor.identifier == "core.delivery.version":
        selected_versions = await executor.context.get_entities()
        if not selected_versions:
            return await executor.get_server_action_response(
                message="No versions available in selection.",
                success=False
            )
        version_ids = [version.id for version in selected_versions]
        event_id = await dispatch_event(
            topic="delivery.requested",
            project=project_name,
            payload={"version_ids": version_ids},
            finished=True,
        )
        args = [
            "deliver", "--project", project_name,
            "--event_id", event_id,
        ]

        return await executor.get_launcher_response(args)

    if executor.identifier == "core.delivery.list":
        if not executor.context.entity_ids:
            return await executor.get_server_action_response(
                message="No list selected.",
                success=False
            )

        selected_list = executor.context.entity_ids[0]
        event_id = await dispatch_event(
            topic="delivery.requested",
            project=project_name,
            payload={"list_id": selected_list},
            finished=True,
        )
        args = [
            "deliver", "--project", project_name,
            "--event_id", event_id,
        ]

        return await executor.get_launcher_response(args)

    logger.debug(f"Unknown action: {executor.identifier}")

    if hasattr(executor, "get_simple_response"):
        return await executor.get_simple_response(
            "Unknown action", success=False
        )

get_simple_actions(project_name=None, variant='production') async

Return a list of simple actions provided by the addon

Source code in server/__init__.py
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
async def get_simple_actions(
    self,
    project_name: str | None = None,
    variant: str = "production",
) -> list[SimpleActionManifest]:
    """Return a list of simple actions provided by the addon"""
    output = []

    if project_name:
        # Add 'Create Project Folder Structure' action to folders.
        output.append(
            SimpleActionManifest(
                identifier="core.createprojectstructure",
                label="Create Project Folder Structure",
                icon={
                    "type": "material-symbols",
                    "name": "create_new_folder",
                },
                order=100,
                entity_type="project",
                entity_subtypes=None,
                allow_multiselection=False,
            )
        )
        output.append(
            SimpleActionManifest(
                identifier="core.delivery.version",
                label="Deliver versions (launcher action)",
                icon={
                    "type": "material-symbols",
                    "name": "create_new_folder",
                },
                order=100,
                entity_type="version",
                entity_subtypes=None,
                allow_multiselection=True,
            )
        )
        output.append(
            SimpleActionManifest(
                identifier="core.delivery.list",
                label="Deliver versions (launcher action)",
                icon={
                    "type": "material-symbols",
                    "name": "create_new_folder",
                },
                order=100,
                entity_type="list",
                entity_subtypes=[
                    "version:review-session",
                    "version:generic",
                ],
                allow_multiselection=False,
            )
        )

    return output