Source code for schrodinger.utils.maestro_scripts_path

"""
A module of maestro scripts path related APIs.
"""

from schrodinger.infra import mm

# Constants for use with get_maestro_scripts_path()
(USER_SCRIPTS_MENU_PATH, USER_SCRIPTS_INSTALL_DIR_PATH, STD_SCRIPTS_MENU_PATH,
 STD_SCRIPTS_INSTALL_DIR_PATH) = (
     mm.MaestroScriptsPathType_USER_SCRIPTS_MENU_PATH,
     mm.MaestroScriptsPathType_USER_SCRIPTS_INSTALL_DIR_PATH,
     mm.MaestroScriptsPathType_STD_SCRIPTS_MENU_PATH,
     mm.MaestroScriptsPathType_STD_SCRIPTS_INSTALL_DIR_PATH)


[docs]def get_maestro_scripts_path(path_type):
    """
    This function returns the maestro scripts specific path.
    If an invalid path_type is specified, then a TypeError is thrown.

    Valid path types are:

    - USER_SCRIPTS_MENU_PATH

        - Linux/Mac: $HOME/.schrodinger/{RELEASE_DIR}/maestro/scriptsx.mnu
        - Windows: AppData/Schrodinger/{RELEASE_DIR}/maestro/scriptsx.mnu

    - USER_SCRIPTS_INSTALL_DIR_PATH

        -  Linux/Mac: $HOME/.schrodinger/{RELEASE_DIR}/scriptsx
        -  Windows: AppData/Schrodinger/{RELEASE_DIR}/scriptsx

    - STD_SCRIPTS_MENU_PATH

        - $SCHRODINGER/mmshare-vX.Y/python/common/scriptsx.mnu

    - STD_SCRIPTS_INSTALL_DIR_PATH

        - $SCHRODINGER/mmshare-vX.Y/python/common

    :type path_type: constant

    :rtype: str
    :return: Maestro scripts path
    """

    return mm.mmfile_get_maestro_scripts_path(path_type)