Class AdvisoryData

vulnerabilities/importer.py:602–648

This data class expresses the contract between data sources and the import runner.

@dataclasses.dataclass(order=True)
class AdvisoryData:
    """
    This data class expresses the contract between data sources and the import runner.
    """

    aliases: List[str] = dataclasses.field(default_factory=list)
    summary: Optional[str] = ""
    affected_packages: List[AffectedPackage] = dataclasses.field(default_factory=list)
    references: List[Reference] = dataclasses.field(default_factory=list)
    date_published: Optional[datetime.datetime] = None
    weaknesses: List[int] = dataclasses.field(default_factory=list)
    url: Optional[str] = None

    def __post_init__(self):
        if self.summary:
            self.summary = clean_summary(self.summary)

    def to_dict(self):
        return {
            "aliases": self.aliases,
            "summary": self.summary,
            "affected_packages": [pkg.to_dict() for pkg in self.affected_packages],
            "references": [ref.to_dict() for ref in self.references],
            "date_published": self.date_published.isoformat() if self.date_published else None,
            "weaknesses": self.weaknesses,
            "url": self.url if self.url else "",
        }

    @classmethod
    def from_dict(cls, advisory_data):
        date_published = advisory_data["date_published"]
        transformed = {
            "aliases": advisory_data["aliases"],
            "summary": advisory_data["summary"],
            "affected_packages": [
                AffectedPackage.from_dict(pkg)
                for pkg in advisory_data["affected_packages"]
                if pkg is not None
            ],
            "references": [Reference.from_dict(ref) for ref in advisory_data["references"]],
            "date_published": (
                datetime.datetime.fromisoformat(date_published) if date_published else None
            ),
            "weaknesses": advisory_data["weaknesses"],
            "url": advisory_data.get("url") or None,
        }
        return cls(**transformed)


@dataclasses.dataclass(order=True)