pg.io.FileSystem

Accessible via pg.io.FileSystem.

class FileSystem

Bases: object

Interface for a file system.

Methods:

exists(path)	Returns True if a path exists.
isdir(path)	Returns True if a path is a directory.
listdir(path)	Lists all files or sub-directories.
mkdir(path[, mode])	Makes a directory based on a path.
mkdirs(path[, mode, exist_ok])	Makes a directory chain based on a path.
open(path[, mode])	Opens a file with a path.
rm(path)	Removes a file based on a path.
rmdir(path)	Removes a directory based on a path.
rmdirs(path)	Removes a directory chain based on a path.

abstract exists(path)

Returns True if a path exists.

Return type:

bool

abstract isdir(path)

Returns True if a path is a directory.

Return type:

bool

abstract listdir(path)

Lists all files or sub-directories.

Return type:

list[str]

abstract mkdir(path, mode=511)

Makes a directory based on a path.

Return type:

None

abstract mkdirs(path, mode=511, exist_ok=False)

Makes a directory chain based on a path.

Return type:

None

abstract open(path, mode='r', **kwargs)

Opens a file with a path.

Return type:

pg.io.File

abstract rm(path)

Removes a file based on a path.

Return type:

None

abstract rmdir(path)

Removes a directory based on a path.

Return type:

bool

abstract rmdirs(path)

Removes a directory chain based on a path.

Return type:

None