avid.common.AVIDUrlLocater.get_tool_config_file_path

avid.common.AVIDUrlLocater.get_tool_config_file_path(tool_id, workflow_root_path=None, check_existence=True)

Helper function that gets the path to the config file for the passed tool_id If workflow_root_path is set it will be also checked :param tool_id: tool_id of the action that requests the URL :param workflow_root_path: Path of the workflow. If none it will be ignored. :param check_existence: Indicates if only existing paths should be returned. If True and config path does not exist or can’t be determined, None will be returned.

The following rules will be used to determine the tool config path. 1. check the path workflowRootPath/tools/<tool_id>/avidtool.config. If it is valid, return it, else 2. 2. check get_venv_tool_config_file_path. If it is valid, return it, else 3. 3. check get_user_tool_config_file_path. If it is valid, return it, else 4. 4. return None