Spaces:
Running
on
Zero
Running
on
Zero
File size: 4,509 Bytes
28c256d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 |
# Copyright (c) Meta Platforms, Inc. and affiliates.
# All rights reserved.
#
# This source code is licensed under the license found in the
# LICENSE file in the root directory of this source tree.
import inspect
from typing import Optional, Type, Union
from .base import BaseStorageBackend
from .http_backend import HTTPBackend
from .lmdb_backend import LmdbBackend
from .local_backend import LocalBackend
from .memcached_backend import MemcachedBackend
from .petrel_backend import PetrelBackend
backends: dict = {}
prefix_to_backends: dict = {}
def _register_backend(name: str,
backend: Type[BaseStorageBackend],
force: bool = False,
prefixes: Union[str, list, tuple, None] = None):
"""Register a backend.
Args:
name (str): The name of the registered backend.
backend (BaseStorageBackend): The backend class to be registered,
which must be a subclass of :class:`BaseStorageBackend`.
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.
"""
global backends, prefix_to_backends
if not isinstance(name, str):
raise TypeError('the backend name should be a string, '
f'but got {type(name)}')
if not inspect.isclass(backend):
raise TypeError(f'backend should be a class, but got {type(backend)}')
if not issubclass(backend, BaseStorageBackend):
raise TypeError(
f'backend {backend} is not a subclass of BaseStorageBackend')
if name in backends and not force:
raise ValueError(f'{name} is already registered as a storage backend, '
'add "force=True" if you want to override it')
backends[name] = backend
if prefixes is not None:
if isinstance(prefixes, str):
prefixes = [prefixes]
else:
assert isinstance(prefixes, (list, tuple))
for prefix in prefixes:
if prefix in prefix_to_backends and not force:
raise ValueError(
f'{prefix} is already registered as a storage backend,'
' add "force=True" if you want to override it')
prefix_to_backends[prefix] = backend
def register_backend(name: str,
backend: Optional[Type[BaseStorageBackend]] = None,
force: bool = False,
prefixes: Union[str, list, tuple, None] = None):
"""Register a backend.
Args:
name (str): The name of the registered backend.
backend (class, optional): The backend class to be registered,
which must be a subclass of :class:`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
"""
if backend is not None:
_register_backend(name, backend, force=force, prefixes=prefixes)
return
def _register(backend_cls):
_register_backend(name, backend_cls, force=force, prefixes=prefixes)
return backend_cls
return _register
register_backend('local', LocalBackend, prefixes='')
register_backend('memcached', MemcachedBackend)
register_backend('lmdb', LmdbBackend)
# To avoid breaking backward Compatibility, 's3' is also used as a
# prefix for PetrelBackend
register_backend('petrel', PetrelBackend, prefixes=['petrel', 's3'])
register_backend('http', HTTPBackend, prefixes=['http', 'https'])
|