Skip to content

collect_deadline_job_env_vars

CollectDeadlineJobEnvVars

Bases: ContextPlugin

Collect set of environment variables to submit with deadline jobs

Source code in client/ayon_deadline/plugins/publish/global/collect_deadline_job_env_vars.py
 8
 9
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
class CollectDeadlineJobEnvVars(pyblish.api.ContextPlugin):
    """Collect set of environment variables to submit with deadline jobs"""
    order = pyblish.api.CollectorOrder
    label = "Deadline Farm Environment Variables"
    targets = ["local"]

    ENV_KEYS = [
        # applications addon
        "AYON_APP_NAME",

        # ftrack addon
        "FTRACK_API_KEY",
        "FTRACK_API_USER",
        "FTRACK_SERVER",

        # kitsu addon
        "KITSU_SERVER",
        "KITSU_LOGIN",
        "KITSU_PWD",

        # Shotgrid / Flow addon
        "OPENPYPE_SG_USER",

        # Not sure how this is usefull for farm, scared to remove
        "PYBLISHPLUGINPATH",

        # NOTE still required by GlobalPreLoadJob.py, but might not be set by
        #   ayon-core anymore
        "AYON_DEFAULT_SETTINGS_VARIANT",
    ]

    def process(self, context):
        env = context.data.setdefault(FARM_JOB_ENV_DATA_KEY, {})
        for key in self.ENV_KEYS:
            # Skip already set keys
            if key in env:
                continue
            value = os.getenv(key)
            if value:
                self.log.debug(f"Setting job env: {key}: {value}")
                env[key] = value