## On this page

  

 

 # py\_file\_access

 Last update: 05.08.2026 

<a id="py_file_access.FileProvider"></a>

## *class* py\_file\_access.FileProvider

<a id="py_file_access.FileProvider.__init__"></a>

#### \_\_init\_\_()

Raises an exception This class cannot be instantiated from Python

<a id="py_file_access.FileProvider.__iter__"></a>

#### \_\_iter\_\_() → object

<a id="py_file_access.FileProvider.__len__"></a>

#### \_\_len\_\_() → int

<a id="py_file_access.FileProvider.file_access_types"></a>

#### *property* file\_access\_types

List available types of file access.

<a id="py_file_access.FileProvider.get_item"></a>

#### get\_item(arg2: [FileProviderId](#py_file_access.FileProviderId)) → [FileProviderItem](#py_file_access.FileProviderItem)

Get item by ID.

<a id="py_file_access.FileProvider.set_item"></a>

#### set\_item(arg2: [FileProviderItem](#py_file_access.FileProviderItem)) → bool

Set item.

<a id="py_file_access.FileProviderId"></a>

## *class* py\_file\_access.FileProviderId

<a id="py_file_access.FileProviderId.__init__"></a>

#### \_\_init\_\_()

<a id="py_file_access.FileProviderId.__str__"></a>

#### \_\_str\_\_() → str

<a id="py_file_access.FileProviderId.name"></a>

#### *property* name

Name

<a id="py_file_access.FileProviderItem"></a>

## *class* py\_file\_access.FileProviderItem

<a id="py_file_access.FileProviderItem.Action"></a>

#### *class* Action

**Enumeration**

Enumerates possible FileProviderItem action types.

<a id="py_file_access.FileProviderItem.Action.LOCAL_COMPRESS_GZ"></a>

#### LOCAL\_COMPRESS\_GZ *= py\_file\_access.Action.LOCAL\_COMPRESS\_GZ*

<a id="py_file_access.FileProviderItem.Action.LOCAL_REMOVE"></a>

#### LOCAL\_REMOVE *= py\_file\_access.Action.LOCAL\_REMOVE*

<a id="py_file_access.FileProviderItem.Action.NONE"></a>

#### NONE *= py\_file\_access.Action.NONE*

<a id="py_file_access.FileProviderItem.Action.RECEIVE"></a>

#### RECEIVE *= py\_file\_access.Action.RECEIVE*

<a id="py_file_access.FileProviderItem.Action.SEND"></a>

#### SEND *= py\_file\_access.Action.SEND*

<a id="py_file_access.FileProviderItem.ActionPoint"></a>

#### *class* ActionPoint

**Enumeration**

Enumerates possible FileProviderItem action points.

<a id="py_file_access.FileProviderItem.ActionPoint.CLOSE"></a>

#### CLOSE *= py\_file\_access.ActionPoint.CLOSE*

<a id="py_file_access.FileProviderItem.ActionPoint.LOAD"></a>

#### LOAD *= py\_file\_access.ActionPoint.LOAD*

<a id="py_file_access.FileProviderItem.ActionPoint.NODE_FAILED"></a>

#### NODE\_FAILED *= py\_file\_access.ActionPoint.NODE\_FAILED*

<a id="py_file_access.FileProviderItem.ActionPoint.NODE_FINISHED"></a>

#### NODE\_FINISHED *= py\_file\_access.ActionPoint.NODE\_FINISHED*

<a id="py_file_access.FileProviderItem.ActionPoint.NODE_STARTED"></a>

#### NODE\_STARTED *= py\_file\_access.ActionPoint.NODE\_STARTED*

<a id="py_file_access.FileProviderItem.ActionPoint.NODE_SUCCEEDED"></a>

#### NODE\_SUCCEEDED *= py\_file\_access.ActionPoint.NODE\_SUCCEEDED*

<a id="py_file_access.FileProviderItem.ActionPoint.NONE"></a>

#### NONE *= py\_file\_access.ActionPoint.NONE*

<a id="py_file_access.FileProviderItem.ActionPoint.RUN_FINISHED"></a>

#### RUN\_FINISHED *= py\_file\_access.ActionPoint.RUN\_FINISHED*

<a id="py_file_access.FileProviderItem.ActionPoint.RUN_STARTED"></a>

#### RUN\_STARTED *= py\_file\_access.ActionPoint.RUN\_STARTED*

<a id="py_file_access.FileProviderItem.ActionPoint.SAVE"></a>

#### SAVE *= py\_file\_access.ActionPoint.SAVE*

<a id="py_file_access.FileProviderItem.Existence"></a>

#### *class* Existence

**Enumeration**

Enumerates possible FileProviderItem file existence options.

<a id="py_file_access.FileProviderItem.Existence.DONT_CARE"></a>

#### DONT\_CARE *= py\_file\_access.Existence.DONT\_CARE*

<a id="py_file_access.FileProviderItem.Existence.INDICATES_FAILURE"></a>

#### INDICATES\_FAILURE *= py\_file\_access.Existence.INDICATES\_FAILURE*

<a id="py_file_access.FileProviderItem.Existence.REQUIRED_FOR_SUCCESS"></a>

#### REQUIRED\_FOR\_SUCCESS *= py\_file\_access.Existence.REQUIRED\_FOR\_SUCCESS*

<a id="py_file_access.FileProviderItem.Usage"></a>

#### *class* Usage

**Enumeration**

Enumerates possible FileProviderItem usage types.

<a id="py_file_access.FileProviderItem.Usage.INPUT_FILE"></a>

#### INPUT\_FILE *= py\_file\_access.Usage.INPUT\_FILE*

<a id="py_file_access.FileProviderItem.Usage.INTERMEDIATE_RESULT"></a>

#### INTERMEDIATE\_RESULT *= py\_file\_access.Usage.INTERMEDIATE\_RESULT*

<a id="py_file_access.FileProviderItem.Usage.OUTPUT_FILE"></a>

#### OUTPUT\_FILE *= py\_file\_access.Usage.OUTPUT\_FILE*

<a id="py_file_access.FileProviderItem.Usage.UNDETERMINED"></a>

#### UNDETERMINED *= py\_file\_access.Usage.UNDETERMINED*

<a id="py_file_access.FileProviderItem.__init__"></a>

#### \_\_init\_\_()

<a id="py_file_access.FileProviderItem.action"></a>

#### *property* action

Action to be performed

<a id="py_file_access.FileProviderItem.action_point"></a>

#### *property* action\_point

Point in time for the action to be performed

<a id="py_file_access.FileProviderItem.auto_generated"></a>

#### *property* auto\_generated

Whether file is auto-generated

<a id="py_file_access.FileProviderItem.comment"></a>

#### *property* comment

Free text for comments

<a id="py_file_access.FileProviderItem.existence"></a>

#### *property* existence

Option controlling whether the local file existence is required

<a id="py_file_access.FileProviderItem.filename_regex"></a>

#### *property* filename\_regex

Option controlling the regular expression for filename matching

<a id="py_file_access.FileProviderItem.id"></a>

#### *property* id

ID

<a id="py_file_access.FileProviderItem.local_path"></a>

#### *property* local\_path

RelativeSplittedPath on the local system

<a id="py_file_access.FileProviderItem.name"></a>

#### *property* name

Item name

<a id="py_file_access.FileProviderItem.remove_on_reset"></a>

#### *property* remove\_on\_reset

Whether file should be removed when associated node is reset

<a id="py_file_access.FileProviderItem.revision"></a>

#### *property* revision

Revision

<a id="py_file_access.FileProviderItem.save_location"></a>

#### *property* save\_location

Save location

<a id="py_file_access.FileProviderItem.store_in_project"></a>

#### *property* store\_in\_project

Whether to store file in project

<a id="py_file_access.FileProviderItem.type"></a>

#### *property* type

Access type

<a id="py_file_access.FileProviderItem.usage"></a>

#### *property* usage

File usage

<a id="py_file_access.FileProviderItem.use_regex_for_filename"></a>

#### *property* use\_regex\_for\_filename

Whether to match filenames against a regular expression when checking for local files existence

<a id="py_file_access.FileProviderItem.wait_for_file"></a>

#### *property* wait\_for\_file

Whether to wait for the file after the node finished execution

<a id="py_file_access.ProvidedPath"></a>

## *class* py\_file\_access.ProvidedPath

<a id="py_file_access.ProvidedPath.__init__"></a>

#### \_\_init\_\_()

#### \_\_init\_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path))

#### \_\_init\_\_(arg2: [SplittedPath](stdcpp_python_export.md#stdcpp_python_export.SplittedPath))

#### \_\_init\_\_(arg2: [RelativeSplittedPath](stdcpp_python_export.md#stdcpp_python_export.RelativeSplittedPath))

#### \_\_init\_\_(arg2: [FileProviderId](#py_file_access.FileProviderId))

<a id="py_file_access.ProvidedPath.__str__"></a>

#### \_\_str\_\_() → str

<a id="py_file_access.ProvidedPath.actual_relative_split_path"></a>

#### *property* actual\_relative\_split\_path

Actual RelativeSplittedPath. Takes central file registration into account.

<a id="py_file_access.ProvidedPath.empty"></a>

#### *property* empty

True if ProvidedPath is empty

<a id="py_file_access.ProvidedPath.file_provider_id"></a>

#### *property* file\_provider\_id

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

<a id="py_file_access.ProvidedPath.get_actual_path"></a>

#### get\_actual\_path(file\_provider: FileProvider) → [Path](stdcpp_python_export.md#stdcpp_python_export.Path)

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

<a id="py_file_access.ProvidedPath.relative_split_path"></a>

#### *property* relative\_split\_path

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