Classes

FileProvider

iterable has_length

Inherited by

OSLFileProvider

Constructors

Properties

() file_access_types

List available types of file access.

Methods

get_item

get_item( (FileProviderId)arg2) -> FileProviderItem

Get item by ID.

set_item

set_item( (FileProviderItem)arg2) -> bool

Set item.

FileProviderId

Constructors

FileProviderId()

Properties

(str) name

Name

Methods

get_name

get_name() -> str

deprecated

FileProviderItem

Constructors

FileProviderItem()

Enums

Action
NONE
RECEIVE
SEND
LOCAL_COMPRESS_GZ
LOCAL_REMOVE

ActionPoint
NONE
LOAD
SAVE
CLOSE
RUN_STARTED
RUN_FINISHED
NODE_STARTED
NODE_FINISHED
NODE_SUCCEEDED
NODE_FAILED

Existence
DONT_CARE
REQUIRED_FOR_SUCCESS
INDICATES_FAILURE

Usage
UNDETERMINED
INPUT_FILE
OUTPUT_FILE
INTERMEDIATE_RESULT

Properties

(Action) action

Action to be performed
(ActionPoint) action_point

Point in time for the action to be performed
(bool) auto_generated

Whether file is auto-generated
(str) comment

Free text for comments
(Existence) existence

Option controlling whether the local file existence is required
(str) filename_regex

Option controlling the regular expression for filename matching
(FileProviderId) id

ID
(RelativeSplittedPath) local_path

RelativeSplittedPath on the local system
(str) name

Item name
(bool) remove_on_reset

Whether file should be removed when associated node is reset
(str) revision

Revision
(str) save_location

Save location
(bool) store_in_project

Whether to store file in project
(str) type

Access type
(Usage) usage

File usage
(bool) use_regex_for_filename

Whether to match filenames against a regular expression when checking for local files existence
(bool) wait_for_file

Whether to wait for the file after the node finished execution

Methods

get_action

get_action() -> object

deprecated

get_action_point

get_action_point() -> object

deprecated

get_id

get_id() -> FileProviderId

deprecated

get_local_path

get_local_path() -> object

deprecated

get_revision

get_revision() -> str

deprecated

get_save_location

get_save_location() -> str

deprecated

get_type

get_type() -> str

Get access type.

deprecated

get_usage

get_usage() -> object

deprecated

set_action

set_action( (object)arg2) -> None

deprecated

set_action_point

set_action_point( (object)arg2) -> None

deprecated

set_local_path

set_local_path( (object)arg2) -> None

deprecated

set_name

set_name( (str)arg2) -> None

deprecated

set_revision

set_revision( (str)arg2) -> None

deprecated

set_save_location

set_save_location( (str)arg2) -> None

deprecated

set_type

set_type( (str)arg2) -> None

Set access type.

deprecated

set_usage

set_usage( (object)arg2) -> None

deprecated

ProvidedPath

Constructors

Properties

() actual_relative_split_path

Actual RelativeSplittedPath. Takes central file registration into account.
(bool) empty

True if ProvidedPath is empty
(NoneType) file_provider_id

A FileProviderId in case a FileProviderId is contained, or None otherwise.
(RelativeSplittedPath) relative_split_path

A RelativeSplittedPath in case a RelativeSplittedPath is contained, or None otherwise.

Methods

get_actual_path

get_actual_path( (FileProvider)file_provider [, (Path)project_path [, (Path)working_dir]]) -> Path

Return the actual file path. Takes central file registration into account.

get_actual_relative_split_path

get_actual_relative_split_path( (FileProvider)arg2) -> object

deprecated

get_file_provider_id

get_file_provider_id() -> object

deprecated

get_relative_split_path

get_relative_split_path() -> object

deprecated

is_empty

is_empty() -> bool

deprecated