PetrelBackend¶
- class mmeval.fileio.PetrelBackend(path_mapping: Optional[dict] = None, enable_mc: bool = True)[源代码]¶
Petrel storage backend (for internal usage).
PetrelBackend supports reading and writing data to multiple clusters. If the file path contains the cluster name, PetrelBackend will read data from specified cluster or write data to it. Otherwise, PetrelBackend will access the default cluster.
- 参数
path_mapping (dict, optional) – Path mapping dict from local path to Petrel path. When
path_mapping={'src': 'dst'}
,src
infilepath
will be replaced bydst
. Defaults to None.enable_mc (bool, optional) – Whether to enable memcached support. Defaults to True.
实际案例
>>> backend = PetrelBackend() >>> filepath1 = 'petrel://path/of/file' >>> filepath2 = 'cluster-name:petrel://path/of/file' >>> backend.get(filepath1) # get data from default cluster >>> client.get(filepath2) # get data from 'cluster-name' cluster
- exists(filepath: Union[str, pathlib.Path]) → bool[源代码]¶
Check whether a file path exists.
- 参数
filepath (str or Path) – Path to be checked whether exists.
- 返回
Return
True
iffilepath
exists,False
otherwise.- 返回类型
bool
实际案例
>>> backend = PetrelBackend() >>> filepath = 'petrel://path/of/file' >>> backend.exists(filepath) True
- get(filepath: Union[str, pathlib.Path]) → bytes[源代码]¶
Read bytes from a given
filepath
with ‘rb’ mode.- 参数
filepath (str or Path) – Path to read data.
- 返回
Return bytes read from filepath.
- 返回类型
bytes
实际案例
>>> backend = PetrelBackend() >>> filepath = 'petrel://path/of/file' >>> backend.get(filepath) b'hello world'
- get_local_path(filepath: Union[str, pathlib.Path]) → Generator[Union[str, pathlib.Path], None, None][源代码]¶
Download a file from
filepath
to a local temporary directory, and return the temporary path.get_local_path
is decorated bycontxtlib.contextmanager()
. It can be called withwith
statement, and when exists from thewith
statement, the temporary path will be released.- 参数
filepath (str or Path) – Download a file from
filepath
.- 生成器
Iterable[str] – Only yield one temporary path.
实际案例
>>> backend = PetrelBackend() >>> # After existing from the ``with`` clause, >>> # the path will be removed >>> filepath = 'petrel://path/of/file' >>> with backend.get_local_path(filepath) as path: ... # do something here
- get_text(filepath: Union[str, pathlib.Path], encoding: str = 'utf-8') → str[源代码]¶
Read text from a given
filepath
with ‘r’ mode.- 参数
filepath (str or Path) – Path to read data.
encoding (str) – The encoding format used to open the
filepath
. Defaults to ‘utf-8’.
- 返回
Expected text reading from
filepath
.- 返回类型
str
实际案例
>>> backend = PetrelBackend() >>> filepath = 'petrel://path/of/file' >>> backend.get_text(filepath) 'hello world'
- isdir(filepath: Union[str, pathlib.Path]) → bool[源代码]¶
Check whether a file path is a directory.
- 参数
filepath (str or Path) – Path to be checked whether it is a directory.
- 返回
Return
True
iffilepath
points to a directory,False
otherwise.- 返回类型
bool
实际案例
>>> backend = PetrelBackend() >>> filepath = 'petrel://path/of/dir' >>> backend.isdir(filepath) True
- isfile(filepath: Union[str, pathlib.Path]) → bool[源代码]¶
Check whether a file path is a file.
- 参数
filepath (str or Path) – Path to be checked whether it is a file.
- 返回
Return
True
iffilepath
points to a file,False
otherwise.- 返回类型
bool
实际案例
>>> backend = PetrelBackend() >>> filepath = 'petrel://path/of/file' >>> backend.isfile(filepath) True
- join_path(filepath: Union[str, pathlib.Path], *filepaths: Union[str, pathlib.Path]) → str[源代码]¶
Concatenate all file paths.
Join one or more filepath components intelligently. The return value is the concatenation of filepath and any members of *filepaths.
- 参数
filepath (str or Path) – Path to be concatenated.
- 返回
The result after concatenation.
- 返回类型
str
实际案例
>>> backend = PetrelBackend() >>> filepath = 'petrel://path/of/file' >>> backend.join_path(filepath, 'another/path') 'petrel://path/of/file/another/path' >>> backend.join_path(filepath, '/another/path') 'petrel://path/of/file/another/path'
- list_dir_or_file(dir_path: Union[str, pathlib.Path], list_dir: bool = True, list_file: bool = True, suffix: Optional[Union[str, Tuple[str]]] = None, recursive: bool = False) → Iterator[str][源代码]¶
Scan a directory to find the interested directories or files in arbitrary order.
注解
Petrel has no concept of directories but it simulates the directory hierarchy in the filesystem through public prefixes. In addition, if the returned path ends with ‘/’, it means the path is a public prefix which is a logical directory.
注解
list_dir_or_file()
returns the path relative todir_path
. In addition, the returned path of directory will not contains the suffix ‘/’ which is consistent with other backends.- 参数
dir_path (str | Path) – Path of the directory.
list_dir (bool) – List the directories. Defaults to True.
list_file (bool) – List the path of files. Defaults to True.
suffix (str or tuple[str], optional) – File suffix that we are interested in. Defaults to None.
recursive (bool) – If set to True, recursively scan the directory. Defaults to False.
- 生成器
Iterable[str] – A relative path to
dir_path
.
实际案例
>>> backend = PetrelBackend() >>> dir_path = 'petrel://path/of/dir' >>> # list those files and directories in current directory >>> for file_path in backend.list_dir_or_file(dir_path): ... print(file_path) >>> # only list files >>> for file_path in backend.list_dir_or_file(dir_path, list_dir=False): ... print(file_path) >>> # only list directories >>> for file_path in backend.list_dir_or_file(dir_path, list_file=False): ... print(file_path) >>> # only list files ending with specified suffixes >>> for file_path in backend.list_dir_or_file(dir_path, suffix='.txt'): ... print(file_path) >>> # list all files and directory recursively >>> for file_path in backend.list_dir_or_file(dir_path, recursive=True): ... print(file_path)