py_project

    Enums

    ProjectActionPoint
    PROJECT_ACTION_POINT_NONE
    PROJECT_ACTION_POINT_ANY
    PROJECT_ACTION_POINT_ON_PROJECT_OPEN
    PROJECT_ACTION_POINT_ON_PROJECT_OPENED
    PROJECT_ACTION_POINT_ON_PROJECT_SAVE
    PROJECT_ACTION_POINT_ON_PROJECT_SAVED
    PROJECT_ACTION_POINT_ON_PROJECT_ABOUT_TO_START
    PROJECT_ACTION_POINT_ON_PROJECT_STARTED
    PROJECT_ACTION_POINT_ON_PROJECT_STOP_REQUESTED
    PROJECT_ACTION_POINT_ON_PROJECT_STOPPED
    ProjectActionType
    PROJECT_ACTION_RUN_SCRIPT
    PROJECT_ACTION_RUN_SCRIPT_FILE
    ProjectFilenameEscape
    PROJECT_FE_FULL
    PROJECT_FE_RESERVED_ONLY
    ProjectRunScenario
    PROJECT_RUN_SCENARIO_PRISTINE
    PROJECT_RUN_SCENARIO_PAUSED
    PROJECT_RUN_SCENARIO_ABORTED
    PROJECT_RUN_SCENARIO_MODIFIED_ALL
    PROJECT_RUN_SCENARIO_MODIFIED_SOME
    PROJECT_RUN_SCENARIO_FINISHED
    PROJECT_RUN_SCENARIO_PARTIAL
    ProjectStatus
    PROJECT_STATUS_IDLE
    PROJECT_STATUS_PROCESSING
    PROJECT_STATUS_PAUSED
    PROJECT_STATUS_PAUSE_REQUESTED
    PROJECT_STATUS_STOPPED
    PROJECT_STATUS_STOP_REQUESTED
    PROJECT_STATUS_ABORTED
    PROJECT_STATUS_ABORT_REQUESTED
    PROJECT_STATUS_FINISHED
    ProjectWorkingDataStorage
    PROJECT_WDS_EMBEDDED
    PROJECT_WDL_EXTERNAL
    ProjectWorkingDirectoryLocation
    PROJECT_WDL_ALONGSIDE_PROJECT
    PROJECT_WDL_CUSTOM

    Classes

    OSLFileProvider

    iterable has_length

    Inherits from: FileProvider

    Constructors

    Properties

    • () file_access_types
      List available types of file access.

    Methods

    Project

    Constructors

    Properties

    • () name
      The project's name as displayed.
    • () project_dir
      The project directory. Empty string if the project has not yet been saved.
    • () project_path
      The project file path. Empty string if the project has not yet been saved.
    • () settings
      Project settings.

    Methods

    get_actions

    get_actions() -> ProjectActions


    Get defined actions for project.

    get_file_provider

    get_file_provider() -> OSLFileProvider


    Get central file registration for project.

    get_maximum_threads

    get_maximum_threads() -> int


    Get the maximum number of threads used by this project.

    get_maximum_treads deprecated

    get_protocol_file_path

    get_protocol_file_path() -> Path


    Get the path of the protocol file.

    get_root_system

    get_root_system() -> RunnableSystem


    Get root system.

    get_run_scenario

    get_run_scenario() -> ProjectRunScenario


    Get run scenario for project.

    get_state

    get_state() -> ProjectStatus


    Get state of project.

    set_actions

    set_actions( (ProjectActions)actions) -> None


    Set defined actions for project.

    set_maximum_threads

    set_maximum_threads( (int)num_threads) -> None


    Get the maximum number of threads used by this project.

    set_maximum_treads deprecated

    ProjectAction

    Inherited by

    ProjectActionRunScript ProjectActionRunScriptFile

    Constructors

    Properties

    • () name
      Action name.
    • () point
      Action point.

    Methods

    type

    type() -> ProjectActionType


    Action type.

    ProjectActionList

    iterable has_length itemsetter itemgetter

    Constructors

    Methods

    append

    append( (object)arg2) -> None



    extend

    extend( (object)arg2) -> None



    push

    push( (ProjectAction)action) -> None



    size

    size() -> int



    ProjectActionRunScript

    Inherits from: ProjectAction

    Constructors

    Properties

    • () name
      Action name.
    • () point
      Action point.
    • (str) script
      Script content to execute.

    Methods

    ProjectActionRunScriptFile

    Inherits from: ProjectAction

    Constructors

    Properties

    • () name
      Action name.
    • () point
      Action point.
    • (ProvidedPath) script
      Script file to execute.

    Methods

    ProjectActions

    Constructors

    Properties

    Methods

    contains

    contains( (str)name) -> bool


    Test if action exists.

    register

    register( (ProjectAction)action) -> bool


    Register project action.

    unique_name

    unique_name( (str)base) -> str


    Get unique action name.

    unregister

    unregister( (str)name) -> bool


    Unregister project action by name.

    ProjectSettings

    Constructors

    Properties

    • (bool) actors_ignore_predecessor_failure
      Actors ignore predecessor failure flag.
    • (bool) auto_save_enabled
      Auto save enabled flag.
    • (Path) custom_location
      Custom working directory location.
    • (ProjectFilenameEscape) filename_escape_mode
      Filename escape mode.
    • (bool) hide_number_of_message_queue_threads_warning
      Hide number of message queue threads warning flag.
    • (int) maximum_auto_relocation_depth
      Maximum auto relocation depth.
    • (int) number_of_message_queue_threads
      Number of message queue threads.
    • (ProjectActions) project_actions
      Project actions.
    • (str) project_id
      Project id.
    • (str) project_manager_id
      Project manager id.
    • (bool) purge_on_save
      Purge on save flag.
    • (str) reference_files_directory_name
      Reference files directory name.
    • (bool) remove_empty_directories_on_purge
      Remove empty directories on purge flag.
    • (str) short_description
      Project short description.
    • () show_conditional_exec_ui
      Conditional execution ui visibility flag.
    • () show_files_ui
      Files ui visibility flag.
    • () show_placeholders_ui
      Placeholders ui visibility flag.
    • () show_variables_ui
      Variables ui visibility flag.
    • (ProjectWorkingDataStorage) working_data_storage
      Working data storage mode.
    • (ProjectWorkingDirectoryLocation) working_directory_location
      Working directory location.