mmengine.fileio.register_backend

mmengine.fileio.register_backend(name, backend=None, force=False, prefixes=None)

Register a backend.

Parameters:

• name (str) – The name of the registered backend.

• backend (class, optional) – The backend class to be registered, which must be a subclass of BaseStorageBackend. When this method is used as a decorator, backend is None. Defaults to None.

• force (bool) – Whether to override the backend if the name has already been registered. Defaults to False.

• prefixes (str or list[str] or tuple[str], optional) – The prefix of the registered storage backend. Defaults to None.

This method can be used as a normal method or a decorator.

Examples

>>> class NewBackend(BaseStorageBackend):
...     def get(self, filepath):
...         return filepath
...
...     def get_text(self, filepath):
...         return filepath
>>> register_backend('new', NewBackend)

>>> @register_backend('new')
... class NewBackend(BaseStorageBackend):
...     def get(self, filepath):
...         return filepath
...
...     def get_text(self, filepath):
...         return filepath