`FileScope`#

class ansys.tools.variableinterop.file_scope.FileScope#

Bases: contextlib.AbstractContextManager, abc.ABC

Provides an abstract base for file scopes.

A file scope helps a program manage the disk space used for file storage and enables it to clean up caches and space in a reliable way. FileValue instances (except for ansys.tools.variableinterop.EMPTY_FILE) should always be created by a FileScope instance. FileValue instances created by a FileScope instance are not valid once the FileScope instance has been closed.

This abstract base class contains the logic to be a context manager for use in with blocks. Any derived class’s close method is automatically called when the with block is exited.

Overview#

Abstract methods

`close`	Close the `FileScope` instance, cleaning up any files it contains.
`read_from_file`	Read the contents of a file and create a new `FileValue` object backed by a
`from_api_object`	Create a `FileScope` instance from a map of API strings.

Special methods

__exit__

Raise any exception triggered within the runtime context.

Import detail#

from ansys.tools.variableinterop.file_scope import FileScope

Method detail#

FileScope.__exit__(__exc_type: Type[BaseException] | None, __exc_value: BaseException | None, __traceback: types.TracebackType | None) → bool | None#: Raise any exception triggered within the runtime context.

abstractmethod FileScope.close() → None#: Close the FileScope instance, cleaning up any files it contains.

abstractmethod FileScope.read_from_file(to_read: os.PathLike, mime_type: str | None = None, encoding: str | None = None) → ansys.tools.variableinterop.file_value.FileValue#

Read the contents of a file and create a new FileValue object backed by a file in this scope.

Parameters:

to_readPathLike: Path to the file to read.
mime_typeOptional[str], optional: MIME type of the file. The default is None, which indicates that the file does not have a MIME type or that the type is not known.
encodingOptional[str], optional: Encoding of the file. The default is None, which indicates that the file does not have a text encoding (for example, because it is a binary file.)

Returns:

FileValue: New FileValue object with the contents of the specified file, backed by this scope.

abstractmethod FileScope.from_api_object(api_object: Dict[str, str | None], load_context: ansys.tools.variableinterop.isave_context.ILoadContext) → ansys.tools.variableinterop.file_value.FileValue#

Create a FileScope instance from a map of API strings.

Parameters:

api_objectDict[str, Optional[str]]: Map of API strings that define the scope.
load_contextILoadContext: Load context to read the file contents from.