Changeset View
Changeset View
Standalone View
Standalone View
swh/journal/writer/stream.py
| # Copyright (C) 2021 The Software Heritage developers | # Copyright (C) 2021-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 | ||||
| import logging | import logging | ||||
| from typing import Any, BinaryIO, Callable, Dict, Generic, List, TypeVar | from typing import Any, BinaryIO, Callable, Dict, Iterable | ||||
| from swh.journal.serializers import value_to_kafka | from swh.journal.serializers import value_to_kafka | ||||
| from . import ValueProtocol | from .interface import ValueProtocol | ||||
| logger = logging.getLogger(__name__) | logger = logging.getLogger(__name__) | ||||
| TValue = TypeVar("TValue", bound=ValueProtocol) | class StreamJournalWriter: | ||||
| class StreamJournalWriter(Generic[TValue]): | |||||
| """A simple JournalWriter which serializes objects in a stream | """A simple JournalWriter which serializes objects in a stream | ||||
| Might be used to serialize a storage in a file to generate a test dataset. | Might be used to serialize a storage in a file to generate a test dataset. | ||||
| """ | """ | ||||
| def __init__( | def __init__( | ||||
| self, | self, | ||||
| output_stream: BinaryIO, | output_stream: BinaryIO, | ||||
| value_sanitizer: Callable[[str, Dict[str, Any]], Dict[str, Any]], | value_sanitizer: Callable[[str, Dict[str, Any]], Dict[str, Any]], | ||||
| ): | ): | ||||
| # Share the list of objects across processes, for RemoteAPI tests. | # Share the list of objects across processes, for RemoteAPI tests. | ||||
| self.output = output_stream | self.output = output_stream | ||||
| self.value_sanitizer = value_sanitizer | self.value_sanitizer = value_sanitizer | ||||
| def write_addition( | def write_addition(self, object_type: str, object_: ValueProtocol) -> None: | ||||
| self, object_type: str, object_: TValue, privileged: bool = False | |||||
| ) -> None: | |||||
| object_.unique_key() # Check this does not error, to mimic the kafka writer | object_.unique_key() # Check this does not error, to mimic the kafka writer | ||||
| dict_ = self.value_sanitizer(object_type, object_.to_dict()) | dict_ = self.value_sanitizer(object_type, object_.to_dict()) | ||||
| self.output.write(value_to_kafka((object_type, dict_))) | self.output.write(value_to_kafka((object_type, dict_))) | ||||
| write_update = write_addition | |||||
| def write_additions( | def write_additions( | ||||
| self, object_type: str, objects: List[TValue], privileged: bool = False | self, object_type: str, objects: Iterable[ValueProtocol] | ||||
| ) -> None: | ) -> None: | ||||
| for object_ in objects: | for object_ in objects: | ||||
| self.write_addition(object_type, object_, privileged) | self.write_addition(object_type, object_) | ||||
| def flush(self) -> None: | |||||
| self.output.flush() | |||||