Class PackageCommitPatchData

vulnerabilities/importer.py:211–260

@dataclasses.dataclass(eq=True)
@functools.total_ordering
class PackageCommitPatchData:
    vcs_url: str
    commit_hash: str
    patch_text: Optional[str] = None
    patch_checksum: Optional[str] = dataclasses.field(init=False, default=None)

    def __post_init__(self):
        if not self.commit_hash:
            raise ValueError("Commit must have a non-empty commit_hash.")

        if not is_commit(self.commit_hash):
            raise ValueError(f"Commit must be a valid a commit_hash: {self.commit_hash}.")

        if not self.vcs_url:
            raise ValueError("Commit must have a non-empty vcs_url.")

        if self.patch_text:
            self.patch_checksum = compute_patch_checksum(self.patch_text)

    def __lt__(self, other):
        if not isinstance(other, PackageCommitPatchData):
            return NotImplemented
        return self._cmp_key() < other._cmp_key()

    # TODO: Add cache
    def _cmp_key(self):
        return (
            self.vcs_url,
            self.commit_hash,
            self.patch_text,
            self.patch_checksum,
        )

    def to_dict(self) -> dict:
        """Return a normalized dictionary representation of the commit."""
        return {
            "vcs_url": self.vcs_url,
            "commit_hash": self.commit_hash,
            "patch_text": self.patch_text,
            "patch_checksum": self.patch_checksum,
        }

    @classmethod
    def from_dict(cls, data: dict):
        """Create a PackageCommitPatchData instance from a dictionary."""
        return cls(
            vcs_url=data.get("vcs_url"),
            commit_hash=data.get("commit_hash"),
            patch_text=data.get("patch_text"),
        )


@dataclasses.dataclass(eq=True)