modelrunner.storage.access_modes module

exception AccessError[source]

Bases: RuntimeError

An error indicating that an access credential was not present.

class AccessMode(name, description, file_mode, read=False, set_attrs=False, insert=False, overwrite=False, dynamic_append=False)[source]

Bases: object

Determines access modes for storages.

Parameters:

name (str)
description (str)
file_mode (Literal['r', 'x', 'a', 'w'])
read (bool)
set_attrs (bool)
insert (bool)
overwrite (bool)
dynamic_append (bool)

description: str

dynamic_append: bool = False

file_mode: Literal['r', 'x', 'a', 'w']

insert: bool = False

name: str

overwrite: bool = False

classmethod parse(obj_or_name)[source]

Gets access mode from various formats.

Parameters:: obj_or_name (str or AccessMode) – An AccessMode object or the name of a registered access mode
Returns:: the access mode object
Return type:: AccessMode

read: bool = False

set_attrs: bool = False