# -*- coding: utf-8 -*- """Main entry point for OpenPype command. Bootstrapping process of OpenPype is as follows: `OPENPYPE_PATH` is checked for existence - either one from environment or from user settings. Precedence takes the one set by environment. On this path we try to find OpenPype in directories version string in their names. For example: `openpype-v3.0.1-foo` is valid name, or even `foo_3.0.2` - as long as version can be determined from its name _AND_ file `openpype/openpype/version.py` can be found inside, it is considered OpenPype installation. If no OpenPype repositories are found in `OPENPYPE_PATH` (user data dir) then **Igniter** (OpenPype setup tool) will launch its GUI. It can be used to specify `OPENPYPE_PATH` or if it is _not_ specified, current *"live"* repositories will be used to create zip file and copy it to appdata dir in user home and extract it there. Version will be determined by version specified in OpenPype module. If OpenPype repository directories are found in default install location (user data dir) or in `OPENPYPE_PATH`, it will get list of those dirs there and use latest one or the one specified with optional `--use-version` command line argument. If the one specified doesn't exist then latest available version will be used. All repositories in that dir will be added to `sys.path` and `PYTHONPATH`. If OpenPype is live (not frozen) then current version of OpenPype module will be used. All directories under `repos` will be added to `sys.path` and `PYTHONPATH`. OpenPype depends on connection to `MongoDB`_. You can specify MongoDB connection string via `OPENPYPE_MONGO` set in environment or it can be set in user settings or via **Igniter** GUI. So, bootstrapping OpenPype looks like this:: .. code-block:: bash ┌───────────────────────────────────────────────────────┐ │ Determine MongoDB connection: │ │ Use `OPENPYPE_MONGO`, system keyring `openPypeMongo` │ └──────────────────────────┬────────────────────────────┘ ┌───- Found? -─┐ YES NO │ │ │ ┌──────┴──────────────┐ │ │ Fire up Igniter GUI ├<-────────┐ │ │ and ask User │ │ │ └─────────────────────┘ │ │ │ │ │ ┌─────────────────┴─────────────────────────────────────┐ │ │ Get location of OpenPype: │ │ │ 1) Test for `OPENPYPE_PATH` environment variable │ │ │ 2) Test `openPypePath` in registry setting │ │ │ 3) Test user data directory │ │ │ ····················································· │ │ │ If running from frozen code: │ │ │ - Use latest one found in user data dir │ │ │ If running from live code: │ │ │ - Use live code and install it to user data dir │ │ │ * can be overridden with `--use-version` argument │ │ └──────────────────────────┬────────────────────────────┘ │ ┌─- Is OpenPype found? -─┐ │ YES NO │ │ │ │ │ ┌─────────────────┴─────────────┐ │ │ │ Look in `OPENPYPE_PATH`, find │ │ │ │ latest version and install it │ │ │ │ to user data dir. │ │ │ └──────────────┬────────────────┘ │ │ ┌─- Is OpenPype found? -─┐ │ │ YES NO -──────┘ │ │ ├<-───────┘ │ ┌─────────────┴────────────┐ │ Run OpenPype │ └─────═══════════════──────┘ Todo: Move or remove bootstrapping environments out of the code. Attributes: silent_commands (list): list of commands for which we won't print OpenPype logo and info header. .. _MongoDB: https://www.mongodb.com/ """ import os import re import sys import traceback import subprocess import site from pathlib import Path # OPENPYPE_ROOT is variable pointing to build (or code) directory # WARNING `OPENPYPE_ROOT` must be defined before igniter import # - igniter changes cwd which cause that filepath of this script won't lead # to right directory if not getattr(sys, 'frozen', False): # Code root defined by `start.py` directory OPENPYPE_ROOT = os.path.dirname(os.path.abspath(__file__)) else: OPENPYPE_ROOT = os.path.dirname(sys.executable) # add dependencies folder to sys.pat for frozen code frozen_libs = os.path.normpath( os.path.join(OPENPYPE_ROOT, "dependencies") ) sys.path.append(frozen_libs) sys.path.insert(0, OPENPYPE_ROOT) # add stuff from `/dependencies` to PYTHONPATH. pythonpath = os.getenv("PYTHONPATH", "") paths = pythonpath.split(os.pathsep) paths.append(frozen_libs) os.environ["PYTHONPATH"] = os.pathsep.join(paths) import blessed # noqa: E402 import certifi # noqa: E402 term = blessed.Terminal() def _print(message: str): if message.startswith("!!! "): print("{}{}".format(term.orangered2("!!! "), message[4:])) if message.startswith(">>> "): print("{}{}".format(term.aquamarine3(">>> "), message[4:])) if message.startswith("--- "): print("{}{}".format(term.darkolivegreen3("--- "), message[4:])) if message.startswith(" "): print("{}{}".format(term.darkseagreen3(" "), message[4:])) if message.startswith("*** "): print("{}{}".format(term.gold("*** "), message[4:])) if message.startswith(" - "): print("{}{}".format(term.wheat(" - "), message[4:])) if message.startswith(" . "): print("{}{}".format(term.tan(" . "), message[4:])) # if SSL_CERT_FILE is not set prior to OpenPype launch, we set it to point # to certifi bundle to make sure we have reasonably new CA certificates. if os.getenv("SSL_CERT_FILE") and \ os.getenv("SSL_CERT_FILE") != certifi.where(): _print("--- your system is set to use custom CA certificate bundle.") else: ssl_cert_file = certifi.where() os.environ["SSL_CERT_FILE"] = ssl_cert_file import igniter # noqa: E402 from igniter import BootstrapRepos # noqa: E402 from igniter.tools import ( get_openpype_path_from_db, validate_mongo_connection ) # noqa from igniter.bootstrap_repos import OpenPypeVersion # noqa: E402 bootstrap = BootstrapRepos() silent_commands = ["run", "igniter", "standalonepublisher", "extractenvironments"] def set_openpype_global_environments() -> None: """Set global OpenPype's environments.""" import acre from openpype.settings import get_environments all_env = get_environments() # TODO Global environments will be stored in "general" settings so loading # will be modified and can be done in igniter. env = acre.merge( acre.parse(all_env["global"]), dict(os.environ) ) os.environ.clear() os.environ.update(env) # Hardcoded default values os.environ["PYBLISH_GUI"] = "pyblish_pype" # Change scale factor only if is not set if "QT_AUTO_SCREEN_SCALE_FACTOR" not in os.environ: os.environ["QT_AUTO_SCREEN_SCALE_FACTOR"] = "1" def run(arguments: list, env: dict = None) -> int: """Use correct executable to run stuff. This passing arguments to correct OpenPype executable. If OpenPype is run from live sources, executable will be `python` in virtual environment. If running from frozen code, executable will be `openpype_console` or `openpype_gui`. Its equivalent in live code is `python start.py`. Args: arguments (list): Argument list to pass OpenPype. env (dict, optional): Dictionary containing environment. Returns: int: Process return code. """ if getattr(sys, 'frozen', False): interpreter = [sys.executable] else: interpreter = [sys.executable, __file__] interpreter.extend(arguments) p = subprocess.Popen(interpreter, env=env) p.wait() _print(f">>> done [{p.returncode}]") return p.returncode def set_avalon_environments(): """Set avalon specific environments. These are non modifiable environments for avalon workflow that must be set before avalon module is imported because avalon works with globals set with environment variables. """ from openpype import PACKAGE_DIR # Path to OpenPype's schema schema_path = os.path.join( os.path.dirname(PACKAGE_DIR), "schema" ) # Avalon mongo URL avalon_mongo_url = ( os.environ.get("AVALON_MONGO") or os.environ["OPENPYPE_MONGO"] ) os.environ.update({ # Mongo url (use same as OpenPype has) "AVALON_MONGO": avalon_mongo_url, "AVALON_SCHEMA": schema_path, # Mongo DB name where avalon docs are stored "AVALON_DB": "avalon", # Name of config "AVALON_CONFIG": "openpype", "AVALON_LABEL": "OpenPype" }) def set_modules_environments(): """Set global environments for OpenPype modules. This requires to have OpenPype in `sys.path`. """ from openpype.modules import ModulesManager import acre modules_manager = ModulesManager() module_envs = modules_manager.collect_global_environments() publish_plugin_dirs = modules_manager.collect_plugin_paths()["publish"] # Set pyblish plugins paths if any module want to register them if publish_plugin_dirs: publish_paths_str = os.environ.get("PYBLISHPLUGINPATH") or "" publish_paths = publish_paths_str.split(os.pathsep) _publish_paths = { os.path.normpath(path) for path in publish_paths if path } for path in publish_plugin_dirs: _publish_paths.add(os.path.normpath(path)) module_envs["PYBLISHPLUGINPATH"] = os.pathsep.join(_publish_paths) # Merge environments with current environments and update values if module_envs: parsed_envs = acre.parse(module_envs) env = acre.merge(parsed_envs, dict(os.environ)) os.environ.clear() os.environ.update(env) def _process_arguments() -> tuple: """Process command line arguments. Returns: tuple: Return tuple with specific version to use (if any) and flag to prioritize staging (if set) """ # check for `--use-version=3.0.0` argument and `--use-staging` use_version = None use_staging = False for arg in sys.argv: if arg == "--use-version": _print("!!! Please use option --use-version like:") _print(" --use-version=3.0.0") sys.exit(1) m = re.search( r"--use-version=(?P\d+\.\d+\.\d+(?:\S*)?)", arg) if m and m.group('version'): use_version = m.group('version') sys.argv.remove(arg) break if "--use-staging" in sys.argv: use_staging = True sys.argv.remove("--use-staging") # handle igniter # this is helper to run igniter before anything else if "igniter" in sys.argv: import igniter return_code = igniter.open_dialog() # this is when we want to run OpenPype without installing anything. # or we are ready to run. if return_code not in [2, 3]: sys.exit(return_code) idx = sys.argv.index("igniter") sys.argv.pop(idx) sys.argv.insert(idx, "tray") return use_version, use_staging def _determine_mongodb() -> str: """Determine mongodb connection string. First use ``OPENPYPE_MONGO`` environment variable, then system keyring. Then try to run **Igniter UI** to let user specify it. Returns: str: mongodb connection URL Raises: RuntimeError: if mongodb connection url cannot by determined. """ openpype_mongo = os.getenv("OPENPYPE_MONGO", None) if not openpype_mongo: # try system keyring try: openpype_mongo = bootstrap.secure_registry.get_item( "openPypeMongo" ) except ValueError: pass if openpype_mongo: result, msg = validate_mongo_connection(openpype_mongo) if not result: _print(msg) openpype_mongo = None if not openpype_mongo: _print("*** No DB connection string specified.") _print("--- launching setup UI ...") result = igniter.open_dialog() if result == 0: raise RuntimeError("MongoDB URL was not defined") openpype_mongo = os.getenv("OPENPYPE_MONGO") if not openpype_mongo: try: openpype_mongo = bootstrap.secure_registry.get_item( "openPypeMongo") except ValueError: raise RuntimeError("Missing MongoDB url") return openpype_mongo def _initialize_environment(openpype_version: OpenPypeVersion) -> None: version_path = openpype_version.path os.environ["OPENPYPE_VERSION"] = str(openpype_version) # set OPENPYPE_REPOS_ROOT to point to currently used OpenPype version. os.environ["OPENPYPE_REPOS_ROOT"] = os.path.normpath( version_path.as_posix() ) # inject version to Python environment (sys.path, ...) _print(">>> Injecting OpenPype version to running environment ...") bootstrap.add_paths_from_directory(version_path) # Additional sys paths related to OPENPYPE_REPOS_ROOT directory # TODO move additional paths to `boot` part when OPENPYPE_REPOS_ROOT will # point to same hierarchy from code and from frozen OpenPype additional_paths = [ os.environ["OPENPYPE_REPOS_ROOT"], # add OpenPype tools os.path.join(os.environ["OPENPYPE_REPOS_ROOT"], "openpype", "tools"), # add common OpenPype vendor # (common for multiple Python interpreter versions) os.path.join( os.environ["OPENPYPE_REPOS_ROOT"], "openpype", "vendor", "python", "common" ) ] split_paths = os.getenv("PYTHONPATH", "").split(os.pathsep) for path in additional_paths: split_paths.insert(0, path) sys.path.insert(0, path) os.environ["PYTHONPATH"] = os.pathsep.join(split_paths) def _find_frozen_openpype(use_version: str = None, use_staging: bool = False) -> Path: """Find OpenPype to run from frozen code. This will process and modify environment variables: ``PYTHONPATH``, ``OPENPYPE_VERSION``, ``OPENPYPE_REPOS_ROOT`` Args: use_version (str, optional): Try to use specified version. use_staging (bool, optional): Prefer *staging* flavor over production. Returns: Path: Path to version to be used. Raises: RuntimeError: If no OpenPype version are found or no staging version (if requested). """ version_path = None openpype_version = None openpype_versions = bootstrap.find_openpype(include_zips=True, staging=use_staging) # get local frozen version and add it to detected version so if it is # newer it will be used instead. local_version_str = bootstrap.get_version( Path(os.environ["OPENPYPE_ROOT"])) if local_version_str: local_version = OpenPypeVersion( version=local_version_str, path=Path(os.environ["OPENPYPE_ROOT"])) if local_version not in openpype_versions: openpype_versions.append(local_version) openpype_versions.sort() # if latest is currently running, ditch whole list # and run from current without installing it. if local_version == openpype_versions[-1]: os.environ["OPENPYPE_TRYOUT"] = "1" openpype_versions = [] else: _print("!!! Warning: cannot determine current running version.") if not os.getenv("OPENPYPE_TRYOUT"): try: # use latest one found (last in the list is latest) openpype_version = openpype_versions[-1] except IndexError: # no OpenPype version found, run Igniter and ask for them. _print('*** No OpenPype versions found.') _print("--- launching setup UI ...") import igniter return_code = igniter.open_dialog() if return_code == 2: os.environ["OPENPYPE_TRYOUT"] = "1" if return_code == 3: # run OpenPype after installation _print('>>> Finding OpenPype again ...') openpype_versions = bootstrap.find_openpype( staging=use_staging) try: openpype_version = openpype_versions[-1] except IndexError: _print(("!!! Something is wrong and we didn't " "found it again.")) sys.exit(1) elif return_code != 2: _print(f" . finished ({return_code})") sys.exit(return_code) if not openpype_versions: # no openpype versions found anyway, lets use then the one # shipped with frozen OpenPype if not os.getenv("OPENPYPE_TRYOUT"): _print("*** Still no luck finding OpenPype.") _print(("*** We'll try to use the one coming " "with OpenPype installation.")) version_path = _bootstrap_from_code(use_version) openpype_version = OpenPypeVersion( version=BootstrapRepos.get_version(version_path), path=version_path) _initialize_environment(openpype_version) return version_path # get path of version specified in `--use-version` local_version = bootstrap.get_version(OPENPYPE_ROOT) if use_version and use_version != local_version: # force the one user has selected openpype_version = None openpype_versions = bootstrap.find_openpype(include_zips=True, staging=use_staging) v: OpenPypeVersion found = [v for v in openpype_versions if str(v) == use_version] if found: openpype_version = sorted(found)[-1] if not openpype_version: _print(f"!!! requested version {use_version} was not found.") if openpype_versions: _print(" - found: ") for v in sorted(openpype_versions): _print(f" - {v}: {v.path}") _print(f" - local version {local_version}") sys.exit(1) # test if latest detected is installed (in user data dir) is_inside = False try: is_inside = openpype_version.path.resolve().relative_to( bootstrap.data_dir) except ValueError: # if relative path cannot be calculated, openpype version is not # inside user data dir pass if not is_inside: # install latest version to user data dir version_path = bootstrap.install_version( openpype_version, force=True) if openpype_version.path.is_file(): _print(">>> Extracting zip file ...") try: version_path = bootstrap.extract_openpype(openpype_version) except OSError as e: _print("!!! failed: {}".format(str(e))) sys.exit(1) else: # cleanup zip after extraction os.unlink(openpype_version.path) openpype_version.path = version_path _initialize_environment(openpype_version) return openpype_version.path def _bootstrap_from_code(use_version): """Bootstrap live code (or the one coming with frozen OpenPype. Args: use_version: (str): specific version to use. Returns: Path: path to sourced version. """ # run through repos and add them to `sys.path` and `PYTHONPATH` # set root _openpype_root = OPENPYPE_ROOT if getattr(sys, 'frozen', False): local_version = bootstrap.get_version(Path(_openpype_root)) _print(f" - running version: {local_version}") assert local_version else: # get current version of OpenPype local_version = bootstrap.get_local_live_version() if use_version and use_version != local_version: version_to_use = None openpype_versions = bootstrap.find_openpype(include_zips=True) v: OpenPypeVersion found = [v for v in openpype_versions if str(v) == use_version] if found: version_to_use = sorted(found)[-1] if version_to_use: # use specified if version_to_use.path.is_file(): version_to_use.path = bootstrap.extract_openpype( version_to_use) bootstrap.add_paths_from_directory(version_to_use.path) os.environ["OPENPYPE_VERSION"] = use_version version_path = version_to_use.path os.environ["OPENPYPE_REPOS_ROOT"] = (version_path / "openpype").as_posix() # noqa: E501 _openpype_root = version_to_use.path.as_posix() else: _print(f"!!! requested version {use_version} was not found.") if openpype_versions: _print(" - found: ") for v in sorted(openpype_versions): _print(f" - {v}: {v.path}") _print(f" - local version {local_version}") sys.exit(1) else: os.environ["OPENPYPE_VERSION"] = local_version version_path = Path(_openpype_root) os.environ["OPENPYPE_REPOS_ROOT"] = _openpype_root repos = os.listdir(os.path.join(_openpype_root, "repos")) repos = [os.path.join(_openpype_root, "repos", repo) for repo in repos] # add self to python paths repos.insert(0, _openpype_root) for repo in repos: sys.path.insert(0, repo) # add venv 'site-packages' to PYTHONPATH python_path = os.getenv("PYTHONPATH", "") split_paths = python_path.split(os.pathsep) # Add repos as first in list split_paths = repos + split_paths # last one should be venv site-packages # this is slightly convoluted as we can get here from frozen code too # in case when we are running without any version installed. if not getattr(sys, 'frozen', False): split_paths.append(site.getsitepackages()[-1]) # TODO move additional paths to `boot` part when OPENPYPE_ROOT will # point to same hierarchy from code and from frozen OpenPype additional_paths = [ # add OpenPype tools os.path.join(_openpype_root, "openpype", "tools"), # add common OpenPype vendor # (common for multiple Python interpreter versions) os.path.join( _openpype_root, "openpype", "vendor", "python", "common" ) ] for path in additional_paths: split_paths.insert(0, path) sys.path.insert(0, path) os.environ["PYTHONPATH"] = os.pathsep.join(split_paths) return version_path def boot(): """Bootstrap OpenPype.""" # ------------------------------------------------------------------------ # Set environment to OpenPype root path # ------------------------------------------------------------------------ os.environ["OPENPYPE_ROOT"] = OPENPYPE_ROOT # ------------------------------------------------------------------------ # Play animation # ------------------------------------------------------------------------ # from igniter.terminal_splash import play_animation # don't play for silenced commands # if all(item not in sys.argv for item in silent_commands): # play_animation() # ------------------------------------------------------------------------ # Process arguments # ------------------------------------------------------------------------ use_version, use_staging = _process_arguments() if os.getenv("OPENPYPE_VERSION"): use_staging = "staging" in os.getenv("OPENPYPE_VERSION") use_version = os.getenv("OPENPYPE_VERSION") # ------------------------------------------------------------------------ # Determine mongodb connection # ------------------------------------------------------------------------ try: openpype_mongo = _determine_mongodb() except RuntimeError as e: # without mongodb url we are done for. _print(f"!!! {e}") sys.exit(1) os.environ["OPENPYPE_MONGO"] = openpype_mongo os.environ["OPENPYPE_DATABASE_NAME"] = "openpype" # name of Pype database # Get openpype path from database and set it to environment so openpype can # find its versions there and bootstrap them. openpype_path = get_openpype_path_from_db(openpype_mongo) if not openpype_path: _print("*** Cannot get OpenPype path from database.") if not os.getenv("OPENPYPE_PATH") and openpype_path: os.environ["OPENPYPE_PATH"] = openpype_path # ------------------------------------------------------------------------ # Find OpenPype versions # ------------------------------------------------------------------------ # WARNING: Environment OPENPYPE_REPOS_ROOT may change if frozen OpenPype # is executed if getattr(sys, 'frozen', False): # find versions of OpenPype to be used with frozen code try: version_path = _find_frozen_openpype(use_version, use_staging) except RuntimeError as e: # no version to run _print(f"!!! {e}") sys.exit(1) else: version_path = _bootstrap_from_code(use_version) # set this to point either to `python` from venv in case of live code # or to `openpype` or `openpype_console` in case of frozen code os.environ["OPENPYPE_EXECUTABLE"] = sys.executable # delete OpenPype module and it's submodules from cache so it is used from # specific version modules_to_del = [ sys.modules.pop(module_name) for module_name in tuple(sys.modules) if module_name == "openpype" or module_name.startswith("openpype.") ] try: for module_name in modules_to_del: del sys.modules[module_name] except AttributeError: pass except KeyError: pass _print(">>> loading environments ...") # Avalon environments must be set before avalon module is imported _print(" - for Avalon ...") set_avalon_environments() _print(" - global OpenPype ...") set_openpype_global_environments() _print(" - for modules ...") set_modules_environments() from openpype import cli from openpype.lib import terminal as t from openpype.version import __version__ assert version_path, "Version path not defined." info = get_info() info.insert(0, f">>> Using OpenPype from [ {version_path} ]") t_width = 20 try: t_width = os.get_terminal_size().columns - 2 except (ValueError, OSError): # running without terminal pass _header = f"*** OpenPype [{__version__}] " info.insert(0, _header + "-" * (t_width - len(_header))) for i in info: # don't show for running scripts if all(item not in sys.argv for item in silent_commands): t.echo(i) try: cli.main(obj={}, prog_name="openpype") except Exception: # noqa exc_info = sys.exc_info() _print("!!! OpenPype crashed:") traceback.print_exception(*exc_info) sys.exit(1) def get_info() -> list: """Print additional information to console.""" from openpype.lib.mongo import get_default_components from openpype.lib.log import PypeLogger components = get_default_components() inf = [] if not getattr(sys, 'frozen', False): inf.append(("OpenPype variant", "staging")) else: inf.append(("OpenPype variant", "production")) inf.append( ("Running OpenPype from", os.environ.get('OPENPYPE_REPOS_ROOT')) ) inf.append(("Using mongodb", components["host"])) if os.environ.get("FTRACK_SERVER"): inf.append(("Using FTrack at", os.environ.get("FTRACK_SERVER"))) if os.environ.get('DEADLINE_REST_URL'): inf.append(("Using Deadline webservice at", os.environ.get("DEADLINE_REST_URL"))) if os.environ.get('MUSTER_REST_URL'): inf.append(("Using Muster at", os.environ.get("MUSTER_REST_URL"))) # Reinitialize PypeLogger.initialize() log_components = PypeLogger.log_mongo_url_components if log_components["host"]: inf.append(("Logging to MongoDB", log_components["host"])) inf.append((" - port", log_components["port"] or "")) inf.append((" - database", PypeLogger.log_database_name)) inf.append((" - collection", PypeLogger.log_collection_name)) inf.append((" - user", log_components["username"] or "")) if log_components["auth_db"]: inf.append((" - auth source", log_components["auth_db"])) maximum = max(len(i[0]) for i in inf) formatted = [] for info in inf: padding = (maximum - len(info[0])) + 1 formatted.append( "... {}:{}[ {} ]".format(info[0], " " * padding, info[1])) return formatted if __name__ == "__main__": boot()