Changeset View
Changeset View
Standalone View
Standalone View
swh/objstorage/api/client.py
| # Copyright (C) 2015-2022 The Software Heritage developers | # Copyright (C) 2015-2022 The Software Heritage developers | ||||
| # See the AUTHORS file at the top-level directory of this distribution | # See the AUTHORS file at the top-level directory of this distribution | ||||
| # License: GNU General Public License version 3, or any later version | # License: GNU General Public License version 3, or any later version | ||||
| # See top-level LICENSE file for more information | # See top-level LICENSE file for more information | ||||
| from typing import Iterator, Optional | |||||
| from swh.core.api import RPCClient | from swh.core.api import RPCClient | ||||
| from swh.core.utils import iter_chunks | from swh.core.utils import iter_chunks | ||||
| from swh.model import hashutil | from swh.model import hashutil | ||||
| from swh.objstorage.constants import DEFAULT_LIMIT, ID_DIGEST_LENGTH | |||||
| from swh.objstorage.exc import Error, ObjNotFoundError, ObjStorageAPIError | from swh.objstorage.exc import Error, ObjNotFoundError, ObjStorageAPIError | ||||
| from swh.objstorage.interface import ObjStorageInterface | from swh.objstorage.interface import ObjId, ObjStorageInterface | ||||
| from swh.objstorage.objstorage import DEFAULT_LIMIT, ID_DIGEST_LENGTH | |||||
| class RemoteObjStorage(RPCClient): | class RemoteObjStorage(RPCClient): | ||||
| """Proxy to a remote object storage. | """Proxy to a remote object storage. | ||||
| This class allows to connect to an object storage server via | This class allows to connect to an object storage server via | ||||
| http protocol. | http protocol. | ||||
| Attributes: | Attributes: | ||||
| url (string): The url of the server to connect. Must end | url (string): The url of the server to connect. Must end | ||||
| with a '/' | with a '/' | ||||
| session: The session to send requests. | session: The session to send requests. | ||||
| """ | """ | ||||
| api_exception = ObjStorageAPIError | api_exception = ObjStorageAPIError | ||||
| reraise_exceptions = [ObjNotFoundError, Error] | reraise_exceptions = [ObjNotFoundError, Error] | ||||
| backend_class = ObjStorageInterface | backend_class = ObjStorageInterface | ||||
| def restore(self, content, obj_id): | def restore(self: ObjStorageInterface, content: bytes, obj_id: ObjId): | ||||
| return self.add(content, obj_id, check_presence=False) | return self.add(content, obj_id, check_presence=False) | ||||
| def __iter__(self): | def __iter__(self): | ||||
| yield from self.list_content() | yield from self.list_content() | ||||
| def list_content(self, last_obj_id=None, limit=DEFAULT_LIMIT): | def list_content( | ||||
| self, | |||||
| last_obj_id: Optional[ObjId] = None, | |||||
| limit: int = DEFAULT_LIMIT, | |||||
| ) -> Iterator[ObjId]: | |||||
| params = {"limit": limit} | params = {"limit": limit} | ||||
| if last_obj_id: | if last_obj_id: | ||||
| params["last_obj_id"] = hashutil.hash_to_hex(last_obj_id) | params["last_obj_id"] = hashutil.hash_to_hex(last_obj_id) | ||||
| yield from iter_chunks( | yield from iter_chunks( | ||||
| self._get_stream("content", params=params), chunk_size=ID_DIGEST_LENGTH | self._get_stream("content", params=params), chunk_size=ID_DIGEST_LENGTH | ||||
| ) | ) | ||||