FileHandler module

exception FileHandler.BadFilePathException

Bases: FileHandlerError

Raised when the file path has a wrong format

exception FileHandler.DirectoryLockedException

Bases: FileHandlerError

Raised when the FileHandler does not have access to a directory specified in the file path. Normally this is due to permission errors

class FileHandler.FileHandler(file_path: str, file_mode: FileMode = FileMode.READWRITEBYTES, create: bool = False)

Bases: object

close() → bool

printblock(offset: int, length: int)

read(amount: Optional[int] = None, readonly: bool = True) → BytesIO

readandrewind(amount: Optional[int] = None, readonly: bool = True) → BytesIO

rewind() → bool

seek(destination: int, from_offset: int = 0) → int

seek_end() → bool

setBufferSize(bufferSize: int) → int

tell() → int

truncate(size: int = 0)

write(buffer_out: BytesIO) → int

zero(length: int) → int

exception FileHandler.FileHandlerError

Bases: Exception

Generic file handler error

exception FileHandler.FileLockedException

Bases: FileHandlerError

Raised when the FileHandler can not open the file for some reason, mostly due to permission errors or the file being in use

class FileHandler.FileMode(value)

Bases: Enum

An enumeration.

APPENDANDREAD = 'a+'

APPENDBYTES = 'ab'

APPENDONLY = 'a'

APPENDREADBYTES = 'a+b'

READBYTES = 'rb'

READONLY = 'r'

READWRITE = 'r+'

READWRITEBYTES = 'r+b'

WRITEBYTES = 'wb'

WRITEONLY = 'w'

WRITEREAD = 'w+'

WRITEREADBYTES = 'w+b'

exception FileHandler.FileNotFoundException

Bases: FileHandlerError

Raised when the file does not exists

exception FileHandler.NotAFileException

Bases: FileHandlerError

Raised when attempting to open something that is not a file