norfs.fs package

Submodules

norfs.fs.base module

class norfs.fs.base.BaseFileSystem

Bases: object

ERROR_MESSAGE = 'BaseFileSystem: operation not implemented'

dir_list(path: norfs.fs.base.Path) → Iterable[norfs.fs.base.FSObjectPath]

dir_remove(path: norfs.fs.base.Path) → None

file_read(path: norfs.fs.base.Path) → bytes

file_remove(path: norfs.fs.base.Path) → None

file_set_perms(path: norfs.fs.base.Path, policies: List[norfs.permissions.Policy]) → None

file_set_properties(path: norfs.fs.base.Path, content_type: Optional[str] = None, tags: Optional[Dict[str, str]] = None, metadata: Optional[Dict[str, str]] = None) → None

file_write(path: norfs.fs.base.Path, content: bytes) → None

parse_path(path: str) → norfs.fs.base.Path

path_exists(path: norfs.fs.base.Path) → bool

path_to_string(path: norfs.fs.base.Path) → str

path_to_uri(path: norfs.fs.base.Path) → str

class norfs.fs.base.FSObjectPath(type: norfs.fs.base.FSObjectType, path: norfs.fs.base.Path)

Bases: object

property path

property type

class norfs.fs.base.FSObjectType(value)

Bases: enum.Enum

An enumeration.

DIR = 2

FILE = 1

OTHER = 3

exception norfs.fs.base.FileSystemOperationError

Bases: Exception

exception norfs.fs.base.NotAFileError

Bases: Exception

class norfs.fs.base.Path(drive: str, *tail: str)

Bases: object

property basename

child(name: str) → norfs.fs.base.Path

property drive

property parent

property tail

norfs.fs.local module

class norfs.fs.local.LocalFileSystem

Bases: norfs.fs.base.BaseFileSystem

dir_list(path: norfs.fs.base.Path) → Iterable[norfs.fs.base.FSObjectPath]

dir_remove(path: norfs.fs.base.Path) → None

file_read(path: norfs.fs.base.Path) → bytes

file_remove(path: norfs.fs.base.Path) → None

file_set_perms(path: norfs.fs.base.Path, policies: List[norfs.permissions.Policy]) → None

Set permissions for a file.

This works as expected on a unix file system. Perm.WRITE_PERMS and Perm.READ_PERMS are ignored.

file_set_properties(path: norfs.fs.base.Path, content_type: Optional[str] = None, tags: Optional[Dict[str, str]] = None, metadata: Optional[Dict[str, str]] = None) → None

Has no effect.

file_write(path: norfs.fs.base.Path, content: bytes) → None

parse_path(path: str) → norfs.fs.base.Path

path_exists(path: norfs.fs.base.Path) → bool

path_to_string(path: norfs.fs.base.Path) → str

path_to_uri(path: norfs.fs.base.Path) → str

norfs.fs.memory module

class norfs.fs.memory.MemoryDirectory

Bases: object

get_dir(name: str) → norfs.fs.memory.MemoryDirectory

get_file(name: str) → norfs.fs.memory.MemoryFile

list_dirs() → List[str]

list_files() → List[str]

put_dir(name: str, dir_: norfs.fs.memory.MemoryDirectory) → None

put_file(name: str, file_: norfs.fs.memory.MemoryFile) → None

remove_dir(name: str) → None

remove_file(name: str) → None

class norfs.fs.memory.MemoryFile(contents: bytes)

Bases: object

property contents

class norfs.fs.memory.MemoryFileSystem(root: norfs.fs.memory.MemoryDirectory, *, separator: str = '/')

Bases: norfs.fs.base.BaseFileSystem

dir_list(path: norfs.fs.base.Path) → Iterable[norfs.fs.base.FSObjectPath]

dir_remove(path: norfs.fs.base.Path) → None

file_read(path: norfs.fs.base.Path) → bytes

file_remove(path: norfs.fs.base.Path) → None

file_set_perms(path: norfs.fs.base.Path, policies: List[norfs.permissions.Policy]) → None

Has no effect. MemoryFileSystem has no concept of permissions.

file_set_properties(path: norfs.fs.base.Path, content_type: Optional[str] = None, tags: Optional[Dict[str, str]] = None, metadata: Optional[Dict[str, str]] = None) → None

Has no effect.

file_write(path: norfs.fs.base.Path, content: bytes) → None

parse_path(path: str) → norfs.fs.base.Path

path_exists(path: norfs.fs.base.Path) → bool

path_to_string(path: norfs.fs.base.Path) → str

path_to_uri(path: norfs.fs.base.Path) → str

norfs.fs.s3 module

class norfs.fs.s3.CannedPerms

Bases: object

PRIVATE = [<norfs.permissions.Policy object>]

PUBLIC_READ = [<norfs.permissions.Policy object>, <norfs.permissions.Policy object>, <norfs.permissions.Policy object>]

class norfs.fs.s3.S3FileSystem(s3_client: Any, *, uri_protocol: str = 's3', separator: str = '/')

Bases: norfs.fs.base.BaseFileSystem

dir_list(path: norfs.fs.base.Path) → Iterable[norfs.fs.base.FSObjectPath]

dir_remove(path: norfs.fs.base.Path) → None

file_read(path: norfs.fs.base.Path) → bytes

file_remove(path: norfs.fs.base.Path) → None

file_set_perms(path: norfs.fs.base.Path, policies: List[norfs.permissions.Policy]) → None

Set ACL policies for the object.

Check norfs.fs.s3.s3_scopes and norfs.fs.s3.s3_perms to understand how norfs.permissions.Scope and norfs.permissions.Perm map to S3 Grantees and Permissions.

file_set_properties(path: norfs.fs.base.Path, content_type: Optional[str] = None, tags: Optional[Dict[str, str]] = None, metadata: Optional[Dict[str, str]] = None) → None

Set properties for the object.

file_write(path: norfs.fs.base.Path, content: bytes) → None

parse_path(path: str) → norfs.fs.base.Path

path_exists(path: norfs.fs.base.Path) → bool

path_to_string(path: norfs.fs.base.Path) → str

path_to_uri(path: norfs.fs.base.Path) → str

norfs.fs.s3.s3_perms = {<Perm.READ: 1>: 'READ', <Perm.WRITE: 2>: 'WRITE', <Perm.READ_PERMS: 4>: 'READ_ACP', <Perm.WRITE_PERMS: 5>: 'WRITE_ACP'}

Permission mapping for S3

norfs.fs.s3.s3_scopes = {<Scope.GROUP: 2>: {'Type': 'Group', 'URI': 'http://acs.amazonaws.com/groups/global/AuthenticatedUsers'}, <Scope.OTHERS: 3>: {'Type': 'Group', 'URI': 'http://acs.amazonaws.com/groups/global/AllUsers'}}

Permission scope mapping for S3

Module contents