bootstrap.py

# Copyright (c) 2013 Shotgun Software Inc.
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
# Source Code License included in this distribution package. See LICENSE.
# By accessing, using, copying or modifying this work you indicate your
# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
# not expressly granted therein are reserved by Shotgun Software Inc.

from __future__ import print_function
import os
import sys
import optparse

import pickle


def main():
    # parse command line arguments
    #
    # The arguments for this bootstrap are put together in the launch_python hook.
    opts = parse_args()

    # load the utilities module
    #
    # The path to the utilities module is passed on from the launch_python hook
    # and the methods from the utility module should be used to start the
    # desktop engine and run the Qt event loop for the engine.
    utilities = None
    try:
        sys.path.append(os.path.dirname(opts.utilities))
        (module_name, _) = os.path.splitext(os.path.basename((opts.utilities)))
        utilities = __import__(module_name)

        # load up the pickle file with the data payload
        #
        # The pickle file comes from the app launching this instance of the
        # desktop engine.  It contains the information needed to connect
        # back to that app and let it serve as the GUI proxy for the engine.
        with open(opts.data, "rb") as fh:
            data = pickle.load(fh)

        # launch the engine
        #
        # Use the methods from the utility module (passing in the data from the
        # data pickle) to start the engine and the Qt event loop.
        engine = utilities.start_engine(data)
        result = utilities.start_app(engine)
        os._exit(result)
    except Exception:
        if utilities is not None:
            # send the error back to the GUI proxy
            #
            # Use the utilities module to send the error message back to the app
            # acting as the GUI proxy for this engine.
            utilities.handle_error(data)
        # Reraise the error
        raise


def parse_args():
    # parse and verify args
    #
    # See the launch_python hook for details of what these arguments are.
    parser = optparse.OptionParser()
    parser.add_option("-d", "--data", help="pickle file with startup data")
    parser.add_option(
        "-u",
        "--utilities",
        help="path to the python module that defines startup utilities",
    )
    (opts, args) = parser.parse_args()

    if opts.data is None:
        print("Data not specified")
        parser.print_help()
        return -1

    if not os.path.exists(opts.data):
        print("Data file not found.")
        return -1

    if opts.utilities is None:
        print("Utilities not specified")
        parser.print_help()
        return -1

    if not os.path.exists(opts.utilities):
        print("Utilities file not found.")
        return -1

    return opts


if __name__ == "__main__":
    result = main()
    sys.exit(result)