Skip to content

Commit 263414b

Browse files
committed
chore: rename artifact_name to artifact_filename for clarity
Signed-off-by: Nathan Nguyen <[email protected]>
1 parent ebf8667 commit 263414b

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

src/macaron/artifact/maven.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -117,20 +117,20 @@ def from_package_url(cls, package_url: PackageURL) -> Self | None:
117117
)
118118

119119
@classmethod
120-
def from_artifact_name(
120+
def from_artifact_filename(
121121
cls,
122-
artifact_name: str,
122+
artifact_filename: str,
123123
group_id: str,
124124
version: str,
125125
) -> Self | None:
126-
"""Create a Maven artifact given an artifact name.
126+
"""Create a Maven artifact given an artifact filename.
127127
128128
The artifact type is determined based on the naming pattern of the artifact.
129129
130130
Parameters
131131
----------
132-
artifact_name : str
133-
The artifact name.
132+
artifact_filename : str
133+
The filename of the artifact.
134134
group_id : str
135135
The group id.
136136
version : str
@@ -148,7 +148,7 @@ def from_artifact_name(
148148
artifact_id="(.*)",
149149
version=version,
150150
)
151-
match_result = re.search(pattern, artifact_name)
151+
match_result = re.search(pattern, artifact_filename)
152152
if not match_result:
153153
continue
154154
artifact_id = match_result.group(1)
@@ -193,9 +193,9 @@ def get_subject_in_provenance_matching_purl(
193193

194194
maven_artifact_subject_pairs = []
195195
for subject in artifact_subjects:
196-
_, _, artifact_name = subject["name"].rpartition("/")
197-
artifact = MavenArtifact.from_artifact_name(
198-
artifact_name=artifact_name,
196+
_, _, artifact_filename = subject["name"].rpartition("/")
197+
artifact = MavenArtifact.from_artifact_filename(
198+
artifact_filename=artifact_filename,
199199
group_id=maven_artifact.group_id,
200200
version=maven_artifact.version,
201201
)

tests/artifact/test_maven.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ def test_maven_artifact_from_purl(purl_str: str, maven_artifact: MavenArtifact)
6565
[
6666
pytest.param(
6767
{
68-
"artifact_name": "jackson-annotations-2.9.9.jar",
68+
"artifact_filename": "jackson-annotations-2.9.9.jar",
6969
"group_id": "com.fasterxml.jackson",
7070
"version": "2.9.9",
7171
},
@@ -79,7 +79,7 @@ def test_maven_artifact_from_purl(purl_str: str, maven_artifact: MavenArtifact)
7979
),
8080
pytest.param(
8181
{
82-
"artifact_name": "jackson-annotations-2.9.9-javadoc.jar",
82+
"artifact_filename": "jackson-annotations-2.9.9-javadoc.jar",
8383
"group_id": "com.fasterxml.jackson",
8484
"version": "2.9.9",
8585
},
@@ -93,7 +93,7 @@ def test_maven_artifact_from_purl(purl_str: str, maven_artifact: MavenArtifact)
9393
),
9494
pytest.param(
9595
{
96-
"artifact_name": "jackson-annotations-2.9.9-sources.jar",
96+
"artifact_filename": "jackson-annotations-2.9.9-sources.jar",
9797
"group_id": "com.fasterxml.jackson",
9898
"version": "2.9.9",
9999
},
@@ -107,7 +107,7 @@ def test_maven_artifact_from_purl(purl_str: str, maven_artifact: MavenArtifact)
107107
),
108108
pytest.param(
109109
{
110-
"artifact_name": "jackson-annotations-2.9.9.pom",
110+
"artifact_filename": "jackson-annotations-2.9.9.pom",
111111
"group_id": "com.fasterxml.jackson",
112112
"version": "2.9.9",
113113
},
@@ -123,7 +123,7 @@ def test_maven_artifact_from_purl(purl_str: str, maven_artifact: MavenArtifact)
123123
)
124124
def test_maven_artifact_from_artifact_name(params: dict, maven_artifact: MavenArtifact) -> None:
125125
"""Test creating a ``MavenArtifact`` object given an artifact name."""
126-
assert MavenArtifact.from_artifact_name(**params) == maven_artifact
126+
assert MavenArtifact.from_artifact_filename(**params) == maven_artifact
127127

128128

129129
@pytest.mark.parametrize(

0 commit comments

Comments
 (0)