Skip to content

harbor_cli.harbor.artifact

Attributes

AttrType = TypeVar('AttrType') module-attribute

Classes

ArtifactName

Bases: NamedTuple

Source code in harbor_cli/harbor/artifact.py 
11
12
13
14
15
class ArtifactName(NamedTuple):
    domain: str | None
    project: str
    repository: str
    reference: str

Attributes

domain: str | None instance-attribute
project: str instance-attribute
repository: str instance-attribute
reference: str instance-attribute

Functions

parse_artifact_name(s: str) -> ArtifactName

Splits an artifact string into domain name (optional), project, repo, and reference (tag or digest).

Raises ValueError if the string is not in the correct format.

Parameters:

Name Type Description Default
s str

Artifact string in the form of [domain/]/{@sha256:,:}

 required

Returns:

Type Description
ArtifactName

Named tuple of domain name (optional), project, repo, and reference (tag or digest).
Source code in harbor_cli/harbor/artifact.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
def parse_artifact_name(s: str) -> ArtifactName:
    """Splits an artifact string into domain name (optional), project,
    repo, and reference (tag or digest).

    Raises ValueError if the string is not in the correct format.

    Parameters
    ----------
    s : str
        Artifact string in the form of [domain/]<project>/<repo>{@sha256:<digest>,:<tag>}

    Returns
    -------
    ArtifactName
        Named tuple of domain name (optional), project, repo, and reference (tag or digest).
    """
    parts = s.split("/")
    if len(parts) == 3:
        domain, project, rest = parts
    elif len(parts) == 2:
        project, rest = parts
        domain = None
    else:
        raise ArtifactNameFormatError(s)

    # TODO: make this more robust
    if "@" in rest:
        repo, tag_or_digest = rest.split("@")
    elif ":" in rest:
        parts = rest.split(":")
        if len(parts) != 2:
            raise ArtifactNameFormatError(s)
        repo, tag_or_digest = parts
    else:
        raise ArtifactNameFormatError(s)

    return ArtifactName(domain, project, repo, tag_or_digest)

get_artifact_architecture(artifact: Artifact) -> str | None

Source code in harbor_cli/harbor/artifact.py 
60
61
62
63
64
def get_artifact_architecture(artifact: Artifact) -> str | None:
    try:
        return str(artifact.extra_attrs["architecture"])  # type: ignore[index]
    except (TypeError, KeyError):
        return None

get_artifact_os(artifact: Artifact) -> str | None

Source code in harbor_cli/harbor/artifact.py 
67
68
69
70
71
def get_artifact_os(artifact: Artifact) -> str | None:
    try:
        return str(artifact.extra_attrs["os"])  # type: ignore[index]
    except (TypeError, KeyError):
        return None

get_artifact_severity(artifact: Artifact) -> str | None

Attempt to get the severity string for an artifact. Not every artifact has a scan overview, and not every scan overview has a severity string.

Source code in harbor_cli/harbor/artifact.py 
74
75
76
77
78
79
80
81
82
def get_artifact_severity(artifact: Artifact) -> str | None:
    """Attempt to get the severity string for an artifact.
    Not every artifact has a scan overview, and not every scan overview
    has a severity string.
    """
    try:
        return artifact.scan.severity  # type: ignore[attr-defined]
    except AttributeError:
        return None