pyarrow.fs.FileSystemHandler

class pyarrow.fs.FileSystemHandler

Bases: ABC

An abstract class exposing methods to implement PyFileSystem’s behavior.

__init__(*args, **kwargs)

Methods

__init__(*args, **kwargs)
copy_file(self, src, dest)	Implement PyFileSystem.copy_file(...).
create_dir(self, path, recursive)	Implement PyFileSystem.create_dir(...).
delete_dir(self, path)	Implement PyFileSystem.delete_dir(...).
delete_dir_contents(self, path[, missing_dir_ok])	Implement PyFileSystem.delete_dir_contents(...).
delete_file(self, path)	Implement PyFileSystem.delete_file(...).
delete_root_dir_contents(self)	Implement PyFileSystem.delete_dir_contents("/", accept_root_dir=True).
get_file_info(self, paths)	Implement PyFileSystem.get_file_info(paths).
get_file_info_selector(self, selector)	Implement PyFileSystem.get_file_info(selector).
get_type_name(self)	Implement PyFileSystem.type_name.
move(self, src, dest)	Implement PyFileSystem.move(...).
normalize_path(self, path)	Implement PyFileSystem.normalize_path(...).
open_append_stream(self, path, metadata)	Implement PyFileSystem.open_append_stream(...).
open_input_file(self, path)	Implement PyFileSystem.open_input_file(...).
open_input_stream(self, path)	Implement PyFileSystem.open_input_stream(...).
open_output_stream(self, path, metadata)	Implement PyFileSystem.open_output_stream(...).

abstract copy_file(self, src, dest)

Implement PyFileSystem.copy_file(…).

Parameters:

srcstr

path of what should be copied.

deststr

path of where it should be copied to.

abstract create_dir(self, path, recursive)

Implement PyFileSystem.create_dir(…).

Parameters:

pathstr

path of the directory.

recursivebool

if the parent directories should be created too.

abstract delete_dir(self, path)

Implement PyFileSystem.delete_dir(…).

Parameters:

pathstr

path of the directory.

abstract delete_dir_contents(self, path, missing_dir_ok=False)

Implement PyFileSystem.delete_dir_contents(…).

Parameters:

pathstr

path of the directory.

missing_dir_okbool

if False an error should be raised if path does not exist

abstract delete_file(self, path)

Implement PyFileSystem.delete_file(…).

Parameters:

pathstr

path of the file.

abstract delete_root_dir_contents(self)

Implement PyFileSystem.delete_dir_contents(“/”, accept_root_dir=True).

abstract get_file_info(self, paths)

Implement PyFileSystem.get_file_info(paths).

Parameters:

pathslist of str

paths for which we want to retrieve the info.

abstract get_file_info_selector(self, selector)

Implement PyFileSystem.get_file_info(selector).

Parameters:

selectorFileSelector

selector for which we want to retrieve the info.

abstract get_type_name(self)

Implement PyFileSystem.type_name.

abstract move(self, src, dest)

Implement PyFileSystem.move(…).

Parameters:

srcstr

path of what should be moved.

deststr

path of where it should be moved to.

abstract normalize_path(self, path)

Implement PyFileSystem.normalize_path(…).

Parameters:

pathstr

path of what should be normalized.

abstract open_append_stream(self, path, metadata)

Implement PyFileSystem.open_append_stream(…).

Parameters:

pathstr

path of what should be opened.

metadatamapping

Mapping of string keys to string values. Some filesystems support storing metadata along the file (such as “Content-Type”).

abstract open_input_file(self, path)

Implement PyFileSystem.open_input_file(…).

Parameters:

pathstr

path of what should be opened.

abstract open_input_stream(self, path)

Implement PyFileSystem.open_input_stream(…).

Parameters:

pathstr

path of what should be opened.

abstract open_output_stream(self, path, metadata)

Implement PyFileSystem.open_output_stream(…).

Parameters:

pathstr

path of what should be opened.

metadatamapping

Mapping of string keys to string values. Some filesystems support storing metadata along the file (such as “Content-Type”).