Skip to content

pre_global_tools

PreGlobalTools

Bases: PreLaunchHook

Pre-hook for openrv

Source code in client/ayon_openrv/hooks/pre_global_tools.py 
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
class PreGlobalTools(PreLaunchHook):
    """Pre-hook for openrv"""
    app_groups = ["openrv"]

    def execute(self):
        executable = self.launch_context.executable

        # We use the `rvpkg` executable next to the `rv` executable to
        # install and opt-in to the AYON plug-in packages
        rvpkg = find_rvpkg(Path(os.path.dirname(str(executable))))
        self.log.debug(f"Using package manager: {rvpkg}")
        packages_src_folder = Path(OPENRV_ROOT_DIR) / "startup" / "pkgs_source"

        # TODO: Are we sure we want to deploy the addons into a temporary
        #   RV_SUPPORT_PATH on each launch. This would create redundant temp
        #   files that remain on disk but it does allow us to ensure RV is
        #   now running with the correct version of the RV packages of this
        #   current running AYON version
        ay_support_path = Path(tempfile.mkdtemp(
            prefix="ayon_openrv_support_path_"
        ))

        # Write the AYON RV package zips directly to the support path
        # Packages/ folder then we don't need to `rvpkg -add` them afterwards
        packages_dest_folder = ay_support_path / "Packages"
        packages_dest_folder.mkdir(exist_ok=True)
        packages = ["ayon_menus", "ayon_scripteditor"]
        for package_name in packages:
            package_src = packages_src_folder / package_name
            package_dest = packages_dest_folder / "{}.zip".format(package_name)

            self.log.debug(f"Writing: {package_dest}")
            shutil.make_archive(str(package_dest), "zip", str(package_src))

        # Install and opt-in the AYON RV packages
        install_args = [rvpkg, "-only", ay_support_path, "-install", "-force"]
        install_args.extend(packages)
        optin_args = [rvpkg, "-only", ay_support_path, "-optin", "-force"]
        optin_args.extend(packages)
        run_subprocess(install_args, logger=self.log)
        run_subprocess(optin_args, logger=self.log)

        self.log.debug(f"Adding RV_SUPPORT_PATH: {ay_support_path}")
        support_path = self.launch_context.env.get("RV_SUPPORT_PATH")
        if support_path:
            support_path = os.pathsep.join([support_path,
                                            str(ay_support_path)])
        else:
            support_path = str(ay_support_path)
        self.log.debug(f"Setting RV_SUPPORT_PATH: {support_path}")
        self.launch_context.env["RV_SUPPORT_PATH"] = support_path

find_rvpkg(executable_dir)

Find the RV package manager executable next to the RV executable.

Source code in client/ayon_openrv/hooks/pre_global_tools.py 
16
17
18
19
20
21
22
23
24
def find_rvpkg(executable_dir: Path) -> Path:
    """Find the RV package manager executable next to the RV executable."""
    for name in RVPKG_NAMES:
        for filename in (name, f"{name}.exe"):
            path = executable_dir / filename
            if path.exists():
                return path
    # Fallback to `rvpkg` so a failure reports the expected executable
    return executable_dir / "rvpkg"