Class AffectedPackageV2

vulnerabilities/importer.py:452–598

Relate a Package URL with a range of affected versions and fixed versions. The Package URL must *not* have a version. AffectedPackage must contain either ``affected_version_range`` or ``fixed_version_range`` or ``introduced_by_commits`` or ``fixed_by_commits``.

@functools.total_ordering
@dataclasses.dataclass(eq=True)
class AffectedPackageV2:
    """
    Relate a Package URL with a range of affected versions and fixed versions.
    The Package URL must *not* have a version.
    AffectedPackage must contain either ``affected_version_range`` or ``fixed_version_range`` or ``introduced_by_commits`` or ``fixed_by_commits``.
    """

    package: PackageURL
    affected_version_range: Optional[VersionRange] = None
    fixed_version_range: Optional[VersionRange] = None
    introduced_by_commit_patches: List[PackageCommitPatchData] = dataclasses.field(
        default_factory=list
    )
    fixed_by_commit_patches: List[PackageCommitPatchData] = dataclasses.field(default_factory=list)

    def __post_init__(self):
        if self.package.version:
            raise ValueError(f"Affected Package URL {self.package!r} cannot have a version.")

        if not (
            self.affected_version_range
            or self.fixed_version_range
            or self.introduced_by_commit_patches
            or self.fixed_by_commit_patches
        ):
            raise ValueError(
                f"Affected package {self.package!r} must have either a fixed version range, "
                "an affected version range, introduced commit patches, or fixed commit patches."
            )

        if self.affected_version_range is not None and not isinstance(
            self.affected_version_range, VersionRange
        ):
            raise TypeError(
                f"affected_version_range must be VersionRange or None, got {type(self.affected_version_range)!r}"
            )

        if self.fixed_version_range is not None and not isinstance(
            self.fixed_version_range, VersionRange
        ):
            raise TypeError(
                f"fixed_version_range must be VersionRange or None, got {type(self.fixed_version_range)!r}"
            )

        if not isinstance(self.introduced_by_commit_patches, list):
            raise TypeError(
                f"introduced_by_commit_patches must be a list, got {type(self.introduced_by_commit_patches)!r}"
            )

        if not isinstance(self.fixed_by_commit_patches, list):
            raise TypeError(
                f"fixed_by_commit_patches must be a list, got {type(self.fixed_by_commit_patches)!r}"
            )

        for item in self.introduced_by_commit_patches:
            if not isinstance(item, PackageCommitPatchData):
                raise TypeError(
                    f"introduced_by_commit_patches items must be PackageCommitPatchData, got {type(item)!r}"