Modify startup for Alis 2027.1 that now ships with Python (3.12)

Author: staceyoue

python/tk_framework_alias/server/api/__init__.py

@@ -54,7 +54,7 @@ def get_module_path(module_name, alias_version):
     return module_path
 
 
-def get_alias_api_module():
+def get_alias_api_module(alias_bin_path=None):
     """
     Import the right Alias Python API module according to the criteria:
         - the version of Alias
@@ -63,12 +63,33 @@ def get_alias_api_module():
     The Alias Python API supports Python >= 3
     """
 
+    # import debugpy
+    # try:
+    #     debugpy.listen(5678)
+    #     debugpy.wait_for_client()
+    # except Exception as e:
+    #     print(e)
+
     # Determine the module name based on if running in OpenAlias or OpenModel
     # If the executable is Alias, then it is OpenAlias, else OpenModel.
     is_open_model = os.path.basename(sys.executable) != "Alias.exe"
     module_name = OPEN_MODEL_API_NAME if is_open_model else OPEN_ALIAS_API_NAME
     alias_version = get_alias_version()
-    module_path = get_module_path(module_name, alias_version)
+
+    print(f"init_api alias bin path: {alias_bin_path}")
+    # First check if Alias ships the Python API module
+    module_path = None
+    if alias_bin_path:
+        alias_api_pyd = f"{module_name}.pyd"
+        alias_python_module_path = os.path.join(alias_bin_path, alias_api_pyd)
+        print(f"init_api alias python module path: {alias_python_module_path}")
+        if os.path.exists(alias_python_module_path):
+            module_path = alias_python_module_path
+
+    if not module_path:
+        # Fallback to the framework's Python API module
+        module_path = get_module_path(module_name, alias_version)
+
     if not module_path:
         return None
 
@@ -122,6 +143,6 @@ def get_alias_api_module():
         )
     alias_dll_path = os.path.dirname(alias_bin_path)
     with os.add_dll_directory(alias_dll_path):
-        alias_api = get_alias_api_module()
+        alias_api = get_alias_api_module(alias_dll_path)
 else:
     alias_api = get_alias_api_module()

python/tk_framework_alias_utils/environment_utils.py

@@ -524,6 +524,7 @@ def get_framework_supported_python_versions():
         (3, 9),
         (3, 10),
         (3, 11),
+        (3, 12),
         (3, 13),
     ]
 

python/tk_framework_alias_utils/startup.py

@@ -16,6 +16,7 @@
 import shutil
 import zipfile
 import pprint
+import re
 import subprocess
 import zipfile
 
@@ -830,7 +831,8 @@ def ensure_plugin_ready(
         logger = logging.getLogger(__file__)
         logger.setLevel(logging.DEBUG)
 
-    alias_python_exe = None
+    alias_python_supported = False
+    server_python_exe = None
 
     if version_cmp(alias_version, "2024.0") >= 0:
         # Alias >= 2024.0
@@ -843,18 +845,23 @@ def ensure_plugin_ready(
 
         if version_cmp(alias_version, "2027.1") >= 0:
             # Alias >= 2027.1 now supports Python and ships python interpreter.
-            alias_python_exe = os.path.join(sys.executable, "Python", "python.exe")
-            if not os.path.exists(alias_python_exe):
-                alias_python_exe = None
+            alias_python_supported = True
+            alias_bin_path = os.path.dirname(alias_exec_path)
+            alias_python_dir = os.path.join(alias_bin_path, "Python")
+            if not os.path.exists(alias_python_dir):
                 raise Exception(
-                    f"Failed to find Alias Python interpreter at {alias_python_exe}"
+                    f"Could not find Alias Python directory at {alias_python_dir}"
+                )
+            for filename in os.listdir(alias_python_dir):
+                match = re.match(r"python(\d)(\d+)\.dll", filename)
+                if match:
+                    py_major_version = int(match.group(1))
+                    py_minor_version = int(match.group(2))
+                    break
+            else:
+                raise Exception(
+                    f"Could not determine Alias Python version from {alias_python_dir}"
                 )
-            result = subprocess.run(
-                [alias_python_exe, "--version"], capture_output=True, text=True
-            )
-            version_string = result.stdout.strip()  # e.g. "Python 3.12.0"
-            py_major_version = int(version_string.split(" ")[1].split(".")[0])
-            py_minor_version = int(version_string.split(" ")[1].split(".")[1])
         elif version_cmp(alias_version, "2026.0") >= 0:
             # Alias >= 2026.0 has removed dependency on Qt/PySide for the FPT plugin
             py_major_version = 3
@@ -867,14 +874,11 @@ def ensure_plugin_ready(
             py_major_version = 3
             py_minor_version = 7
 
-        install_python_packages = os.environ.get(
-            "SHOTGRID_ALIAS_INSTALL_PYTHON_PACKAGES"
-        ) in ("1", "true", "True")
+        if not alias_python_supported:
+            install_python_packages = os.environ.get(
+                "SHOTGRID_ALIAS_INSTALL_PYTHON_PACKAGES"
+            ) in ("1", "true", "True")
 
-        if alias_python_exe:
-            # Use the Alias Python interpreter
-            server_python_exe = alias_python_exe
-        else:
             # Use the framework's Python interpreter (installed for user)
             server_python_exe = ensure_python_installed(
                 py_major_version,
@@ -895,7 +899,9 @@ def ensure_plugin_ready(
     # version.
     ensure_python_packages_installed(logger=logger)
 
-    if not alias_python_exe:
+    if alias_python_supported:
+        plugin_lst_path = None
+    else:
         # For Alias < 2027.1, pre-python support we use C++ compiled plugin
         # Get the file path to the .lst file that contains the file path to the Alias Plugin to
         # load at startup with Alias.