Skip to content

Commit c0115ca

Browse files
armintaenzertngarmintaenzertng
committed
[issue-518] rename file_type to file_types
Signed-off-by: Armin Tänzer <armin.taenzer@tngtech.com>
1 parent 0aff1b5 commit c0115ca

File tree

13 files changed

+20
-20
lines changed

13 files changed

+20
-20
lines changed

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ document.creation_info.name = "new document name"
106106
# define a file and a DESCRIBES relationship between the file and the document
107107
checksum = Checksum(ChecksumAlgorithm.SHA1, "71c4025dd9897b364f3ebbb42c484ff43d00791c")
108108

109-
file = File(name="./fileName.py", spdx_id="SPDXRef-File", checksums=[checksum], file_type=FileType.TEXT,
109+
file = File(name="./fileName.py", spdx_id="SPDXRef-File", checksums=[checksum], file_types=[FileType.TEXT],
110110
license_concluded=get_spdx_licensing().parse("MIT and GPL-2.0"),
111111
license_comment="licenseComment", copyright_text="copyrightText")
112112

‎src/spdx/jsonschema/file_converter.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ def _get_property_value(self, file: Any, file_property: FileProperty, document:
5858
elif file_property == FileProperty.FILE_NAME:
5959
return file.name
6060
elif file_property == FileProperty.FILE_TYPES:
61-
return [file_type.name for file_type in file.file_type] or None
61+
return [file_type.name for file_type in file.file_types] or None
6262
elif file_property == FileProperty.LICENSE_COMMENTS:
6363
return file.license_comment
6464
elif file_property == FileProperty.LICENSE_CONCLUDED:

‎src/spdx/model/file.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ class File:
3939
name: str
4040
spdx_id: str
4141
checksums: List[Checksum]
42-
file_type: List[FileType] = field(default_factory=list)
42+
file_types: List[FileType] = field(default_factory=list)
4343
license_concluded: Optional[Union[LicenseExpression, SpdxNoAssertion, SpdxNone]] = None
4444
license_info_in_file: Optional[Union[List[LicenseExpression], SpdxNoAssertion, SpdxNone]] = field(
4545
default_factory=list)
@@ -55,14 +55,14 @@ class File:
5555
# - artifact of (3 properties): replace by an external package reference and a GENERATED_FROM relationship
5656
# between the file and this package
5757

58-
def __init__(self, name: str, spdx_id: str, checksums: List[Checksum], file_type: List[FileType] = None,
58+
def __init__(self, name: str, spdx_id: str, checksums: List[Checksum], file_types: List[FileType] = None,
5959
license_concluded: Optional[Union[LicenseExpression, SpdxNoAssertion, SpdxNone]] = None,
6060
license_info_in_file: Optional[Union[List[LicenseExpression], SpdxNoAssertion, SpdxNone]] = None,
6161
license_comment: Optional[str] = None,
6262
copyright_text: Optional[Union[str, SpdxNoAssertion, SpdxNone]] = None,
6363
comment: str = None, notice: Optional[str] = None,
6464
contributors: List[str] = None, attribution_texts: List[str] = None):
65-
file_type = [] if file_type is None else file_type
65+
file_types = [] if file_types is None else file_types
6666
license_info_in_file = [] if license_info_in_file is None else license_info_in_file
6767
contributors = [] if contributors is None else contributors
6868
attribution_texts = [] if attribution_texts is None else attribution_texts

‎src/spdx/parser/jsonlikedict/file_parser.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ def parse_file(self, file_dict: Dict) -> Optional[File]:
6161

6262
file = construct_or_raise_parsing_error(File, dict(name=name, spdx_id=spdx_id, checksums=checksums,
6363
attribution_texts=attribution_texts, comment=comment,
64-
copyright_text=copyright_text, file_type=file_types,
64+
copyright_text=copyright_text, file_types=file_types,
6565
contributors=file_contributors,
6666
license_comment=license_comments,
6767
license_concluded=license_concluded,

‎src/spdx/parser/rdf/file_parser.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ def parse_file(file_node: URIRef, graph: Graph, doc_namespace: str) -> File:
5656
raise_parsing_error_if_logger_has_messages(logger, "File")
5757
file = construct_or_raise_parsing_error(File, dict(name=name, spdx_id=spdx_id, checksums=checksums,
5858
attribution_texts=attribution_texts, comment=comment,
59-
copyright_text=copyright_text, file_type=file_types,
59+
copyright_text=copyright_text, file_types=file_types,
6060
contributors=file_contributors,
6161
license_comment=license_comment,
6262
license_concluded=license_concluded,

‎src/spdx/writer/rdf/file_writer.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ def add_file_to_graph(file: File, graph: Graph, doc_namespace: str,
2525
file_resource = URIRef(add_namespace_to_spdx_id(file.spdx_id, doc_namespace, external_doc_ref_to_namespace))
2626
graph.add((file_resource, RDF.type, SPDX_NAMESPACE.File))
2727
graph.add((file_resource, SPDX_NAMESPACE.fileName, Literal(file.name)))
28-
for file_type in file.file_type:
28+
for file_type in file.file_types:
2929
graph.add((file_resource, SPDX_NAMESPACE.fileType,
3030
SPDX_NAMESPACE[f"fileType_{snake_case_to_camel_case(file_type.name)}"]))
3131

‎src/spdx/writer/tagvalue/file_writer.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ def write_file(file: File, text_output: TextIO):
2121
write_value("FileName", file.name, text_output)
2222
write_value("SPDXID", file.spdx_id, text_output)
2323

24-
for file_type in file.file_type:
24+
for file_type in file.file_types:
2525
write_value("FileType", file_type.name, text_output)
2626

2727
for file_checksum in file.checksums:

‎tests/spdx/fixtures.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,17 +55,17 @@ def creation_info_fixture(spdx_version="SPDX-2.3", spdx_id="SPDXRef-DOCUMENT", n
5555
external_document_refs, license_list_version, document_comment)
5656

5757

58-
def file_fixture(name="./fileName.py", spdx_id="SPDXRef-File", checksums=None, file_type=None,
58+
def file_fixture(name="./fileName.py", spdx_id="SPDXRef-File", checksums=None, file_types=None,
5959
license_concluded=get_spdx_licensing().parse("MIT and GPL-2.0"), license_info_in_file=None,
6060
license_comment="licenseComment", copyright_text="copyrightText", comment="fileComment",
6161
notice="fileNotice", contributors=None, attribution_texts=None) -> File:
6262
checksums = [checksum_fixture()] if checksums is None else checksums
63-
file_type = [FileType.TEXT] if file_type is None else file_type
63+
file_types = [FileType.TEXT] if file_types is None else file_types
6464
license_info_in_file = [get_spdx_licensing().parse("MIT"),
6565
get_spdx_licensing().parse("GPL-2.0")] if license_info_in_file is None else license_info_in_file
6666
contributors = ["fileContributor"] if contributors is None else contributors
6767
attribution_texts = ["fileAttributionText"] if attribution_texts is None else attribution_texts
68-
return File(name=name, spdx_id=spdx_id, checksums=checksums, file_type=file_type,
68+
return File(name=name, spdx_id=spdx_id, checksums=checksums, file_types=file_types,
6969
license_concluded=license_concluded, license_info_in_file=license_info_in_file,
7070
license_comment=license_comment, copyright_text=copyright_text, comment=comment, notice=notice,
7171
contributors=contributors, attribution_texts=attribution_texts)

‎tests/spdx/jsonschema/test_file_converter.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ def test_successful_conversion(converter: FileConverter):
7373
converter.annotation_converter.convert.return_value = "mock_converted_annotation"
7474
file = File(name="name", spdx_id="spdxId",
7575
checksums=[Checksum(ChecksumAlgorithm.SHA224, "sha224"), Checksum(ChecksumAlgorithm.MD2, "md2")],
76-
file_type=[FileType.SPDX, FileType.OTHER], license_concluded=Licensing().parse("MIT and GPL-2.0"),
76+
file_types=[FileType.SPDX, FileType.OTHER], license_concluded=Licensing().parse("MIT and GPL-2.0"),
7777
license_info_in_file=[Licensing().parse("MIT"), Licensing().parse("GPL-2.0")],
7878
license_comment="licenseComment", copyright_text="copyrightText", comment="comment", notice="notice",
7979
contributors=["contributor1", "contributor2"],
@@ -104,7 +104,7 @@ def test_successful_conversion(converter: FileConverter):
104104

105105
def test_null_values(converter: FileConverter):
106106
file = file_fixture(copyright_text=None, license_concluded=None, license_comment=None, comment=None, notice=None,
107-
attribution_texts=[], checksums=[], contributors=[], file_type=[], license_info_in_file=[])
107+
attribution_texts=[], checksums=[], contributors=[], file_types=[], license_info_in_file=[])
108108
document = Document(creation_info_fixture(), files=[file])
109109

110110
converted_dict = converter.convert(file, document)

‎tests/spdx/model/test_file.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ def test_correct_initialization(checksum):
1515
assert file.name == "name"
1616
assert file.spdx_id == "id"
1717
assert file.checksums == [checksum, checksum]
18-
assert file.file_type == [FileType.OTHER, FileType.SPDX]
18+
assert file.file_types == [FileType.OTHER, FileType.SPDX]
1919
assert file.license_concluded == SpdxNone()
2020
assert file.license_info_in_file == SpdxNoAssertion()
2121
assert file.license_comment == "comment on license"
@@ -32,7 +32,7 @@ def test_correct_initialization_with_default_values(checksum):
3232
assert file.name == "name"
3333
assert file.spdx_id == "id"
3434
assert file.checksums == [checksum, checksum]
35-
assert file.file_type == []
35+
assert file.file_types == []
3636
assert file.license_concluded is None
3737
assert file.license_info_in_file == []
3838
assert file.license_comment is None
@@ -64,7 +64,7 @@ def test_wrong_type_in_checksum():
6464
@mock.patch('spdx.model.checksum.Checksum', autospec=True)
6565
def test_wrong_type_in_file_type(checksum):
6666
with pytest.raises(TypeError):
67-
File("name", "id", [checksum], file_type=FileType.OTHER)
67+
File("name", "id", [checksum], file_types=FileType.OTHER)
6868

6969

7070
@mock.patch('spdx.model.checksum.Checksum', autospec=True)

0 commit comments

Comments
 (0)