# Copyright (C) 2020-2025 The Software Heritage developers
# See the AUTHORS file at the top-level directory of this distribution
# License: GNU General Public License version 3, or any later version
# See top-level LICENSE file for more information
from typing import Any, Dict, Iterable, Optional
from swh.model.model import (
Content,
Directory,
ExtID,
MetadataAuthority,
MetadataFetcher,
ModelObjectType,
Origin,
OriginVisit,
OriginVisitStatus,
RawExtrinsicMetadata,
Release,
Revision,
SkippedContent,
Snapshot,
)
try:
from swh.journal.writer import JournalWriterInterface, get_journal_writer
from swh.journal.writer.interface import ValueProtocol
except ImportError:
get_journal_writer = None # type: ignore
# mypy limitation, see https://github.com/python/mypy/issues/1153
[docs]
def model_object_dict_sanitizer(
object_type: str, object_dict: Dict[str, Any]
) -> Dict[str, str]:
object_dict = object_dict.copy()
if ModelObjectType(object_type) == Content.object_type:
object_dict.pop("data", None)
return object_dict
[docs]
class JournalWriter:
"""Journal writer storage collaborator. It's in charge of adding objects to
the journal.
"""
def __init__(self, journal_writer: Optional[Dict[str, Any]]):
self.journal: Optional[JournalWriterInterface] = None
if journal_writer:
if get_journal_writer is None:
raise EnvironmentError(
"You need the swh.journal package to use the "
"journal_writer feature"
)
self.journal = get_journal_writer(
value_sanitizer=model_object_dict_sanitizer, **journal_writer
)
[docs]
def write_addition(self, object_type: str, object_: ValueProtocol) -> None:
if self.journal:
self.journal.write_addition(object_type, object_)
[docs]
def write_additions(
self, object_type: str, objects: Iterable[ValueProtocol]
) -> None:
if self.journal:
self.journal.write_additions(object_type, objects)
[docs]
def content_add(self, contents: Iterable[Content]) -> None:
"""Add contents to the journal. Drop the data field if provided."""
contents = [item.evolve(data=None, get_data=None) for item in contents]
self.write_additions("content", contents)
[docs]
def content_update(self, contents: Iterable[Dict[str, Any]]) -> None:
if self.journal:
raise NotImplementedError("content_update is not supported by the journal.")
[docs]
def content_add_metadata(self, contents: Iterable[Content]) -> None:
self.content_add(contents)
[docs]
def skipped_content_add(self, contents: Iterable[SkippedContent]) -> None:
self.write_additions("skipped_content", contents)
[docs]
def directory_add(self, directories: Iterable[Directory]) -> None:
self.write_additions("directory", directories)
[docs]
def revision_add(self, revisions: Iterable[Revision]) -> None:
self.write_additions("revision", revisions)
[docs]
def release_add(self, releases: Iterable[Release]) -> None:
self.write_additions("release", releases)
[docs]
def snapshot_add(self, snapshots: Iterable[Snapshot]) -> None:
self.write_additions("snapshot", snapshots)
[docs]
def origin_visit_add(self, visits: Iterable[OriginVisit]) -> None:
self.write_additions("origin_visit", visits)
[docs]
def origin_visit_status_add(
self, visit_statuses: Iterable[OriginVisitStatus]
) -> None:
self.write_additions("origin_visit_status", visit_statuses)
[docs]
def origin_add(self, origins: Iterable[Origin]) -> None:
self.write_additions("origin", origins)
[docs]
def extid_add(self, extids: Iterable[ExtID]) -> None:
self.write_additions("extid", extids)
