8000 Issue 456 add rdf parser by meretp · Pull Request #469 · spdx/tools-python · GitHub
[go: up one dir, main page]

Skip to content

Issue 456 add rdf parser #469

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 43 commits into from
Feb 22, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
18e7063
delete rdflib as optional dependency as it is required
meretp Feb 1, 2023
cf5ee6a
delete installation from rdflib as the package is a required dependency
meretp Feb 1, 2023
298255e
move helper methods to also use it for the rdf parser
meretp Feb 9, 2023
9729b96
move actor_parser.py as it is format-agnostic and will be used for js…
meretp Feb 1, 2023
96498c0
[issue-456] add creation_info parser
meretp Jan 31, 2023
024fa89
[issue-456] add graph parsing functions
meretp Feb 1, 2023
b1a47f9
[issue-456] add snippet parser
meretp Feb 1, 2023
8466d2e
[issue-456] add checksum parser
meretp Feb 2, 2023
6d1e93e
[issue-456] add external document ref parser
meretp Feb 2, 2023
7087e36
[issue-456] add file parser
meretp Feb 2, 2023
1eb803b
[issue-456] add annotation parser
meretp Feb 2, 2023
6c8fdee
[issue-456] add package parser
meretp Feb 2, 2023
625e2a9
[issue-456] add p 8000 ackage verification code parser
meretp Feb 8, 2023
198f2a6
[issue-456] add helper method in casing_tools and move the module as …
meretp Feb 8, 2023
b3e274b
[issue-456] add parser for ExternalPackageRefs
meretp Feb 8, 2023
cea02ae
[issue-456] use enum helper method for primary package purpose
meretp Feb 8, 2023
d0238be
[issue-456] use enum helper method for annotation type
meretp Feb 8, 2023
fb105dc
[issue-456] use helper method for checksum algorithm
meretp Feb 8, 2023
58783f9
[issue-456] add relationship parser
meretp Feb 8, 2023
da33b14
[issue-456] use NamespaceManager to translate external document names…
meretp Feb 9, 2023
69d16aa
[issue-456] add extracted licensing info parser
meretp Feb 9, 2023
6652e4f
[issue-456] allow no assertion in package download location
meretp Feb 8, 2023
ce17ca6
[issue-456, refactor] extract method to get a unique value, sort methods
meretp Feb 9, 2023
9737fde
[issue-456, refactor] replace str_or_no_assertion_or_none with parse …
meretp Feb 9, 2023
9df9980
[issue-456] add license expression parser
meretp Feb 9, 2023
7b61c8f
[issue-456, refactor]
meretp Feb 9, 2023
9ecc373
[issue-456] parse list of license expressions
meretp Feb 9, 2023
1b8cf82
[issue-456] also parse URIRefs with the documents namespace as prefix…
meretp Feb 9, 2023
432a39f
[issue-456] add rdf parser to cli tool
meretp Feb 9, 2023
7a27e88
[issue-456] delete RDFExample from specVersion 2.1 as the tool curren…
meretp Feb 9, 2023
03ee53c
[issue-456, refactor] use generic helper methods instead of individua…
meretp Feb 9, 2023
446757c
[issue-456] move actor_parser.py as it is format-agnostic and used fo…
meretp Feb 9, 2023
86bc68c
[issue-456, refactor] adapt type hints, delete unused imports, rename…
meretp Feb 9, 2023
47e7db0
[issue-456] add helper method to remove prefix to support Python 3.7 …
meretp Feb 9, 2023
9681339
[issue-456] allow multiple members in ConjunctiveLicenseSet and Disju…
meretp Feb 10, 2023
8f9259b
[issue-456] strip parsed values by default to prevent new lines and l…
meretp Feb 10, 2023
9eb1206
[issue-456] fix parsing of externalPackageRef
meretp Feb 10, 2023
4ec5b3c
fix helper method
meretp Feb 15, 2023
c4d04d4
[review] use helper method for enums also for FileType
meretp Feb 20, 2023
c787280
[review, refactor] strip copyright texts, delete trailing comma
meretp Feb 20, 2023
6b70dda
[review] rewrite parse_ranges
meretp Feb 20, 2023
1d728b7
[review, refactor] let Constructor handle None values and use the mor…
meretp Feb 20, 2023
1cbe629
[review] refactor helper methods
meretp Feb 20, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
[issue-456] also parse URIRefs with the documents namespace as prefix…
… as license expression (could be ListedLicense, ExtractedLicensingInfo or simple reference)

Signed-off-by: Meret Behrens <meret.behrens@tngtech.com>
  • Loading branch information
meretp committed Feb 22, 2023
commit 1b8cf8277d9e851f8ced2bbe121acd215361229b
9 changes: 5 additions & 4 deletions src/spdx/parser/rdf/file_parser.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,14 @@ def parse_file(file_node: URIRef, graph: Graph, doc_namespace: str) -> File:
file_types.append(convert_uri_ref_to_file_type(file_type_ref))
except KeyError:
logger.append(f"Invalid FileType: {file_type_ref}")
license_concluded = parse_literal_or_no_assertion_or_none(logger, graph, file_node, SPDX_NAMESPACE.licenseConcluded,
parsing_method=lambda x: parse_license_expression(x,
graph))
license_concluded = parse_literal_or_no_assertion_or_none(
logger, graph, file_node, SPDX_NAMESPACE.licenseConcluded,
parsing_method=lambda x: parse_license_expression(x, graph, doc_namespace))
license_info_in_file = []
for (_, _, license_info_from_files_node) in graph.triples((file_node, SPDX_NAMESPACE.licenseInfoInFile, None)):
license_info_in_file.append(
get_correct_typed_value(logger, license_info_from_files_node, lambda x: parse_license_expression(x, graph)))
get_correct_typed_value(logger, license_info_from_files_node,
lambda x: parse_license_expression(x, graph, doc_namespace)))
license_comment = parse_literal(logger, graph, file_node, SPDX_NAMESPACE.licenseComments)
copyright_text = parse_literal_or_no_assertion_or_none(logger, graph, file_node, SPDX_NAMESPACE.copyrightText,
parsing_method=str)
Expand Down
13 changes: 7 additions & 6 deletions src/spdx/parser/rdf/license_expression_parser.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,33 +16,36 @@
from spdx.rdfschema.namespace import SPDX_NAMESPACE, LICENSE_NAMESPACE


def parse_license_expression(license_expression_node: Node, graph: Graph) -> LicenseExpression:
def parse_license_expression(license_expression_node: Node, graph: Graph, doc_namespace: str) -> LicenseExpression:
spdx_licensing = get_spdx_licensing()
expression = ""
if license_expression_node.startswith(LICENSE_NAMESPACE):
expression = license_expression_node.removeprefix(LICENSE_NAMESPACE)
return spdx_licensing.parse(expression)
if license_expression_node.startswith(doc_namespace):
expression = license_expression_node.fragment
return spdx_licensing.parse(expression)

node_type = graph.value(license_expression_node, RDF.type)
if node_type == SPDX_NAMESPACE.ConjunctiveLicenseSet:
members = dict()
for index, (_, _, member_node) in enumerate(
graph.triples((license_expression_node, SPDX_NAMESPACE.member, None))):
members[index] = parse_license_expression(member_node, graph)
members[index] = parse_license_expression(member_node, graph, doc_namespace)
if len(members) > 2:
raise SPDXParsingError([f"A ConjunctiveLicenseSet can only have two members."])
expression = f"{members[0]} AND {members[1]}"
if node_type == SPDX_NAMESPACE.DisjunctiveLicenseSet:
members = dict()
for index, (_, _, member_node) in enumerate(
graph.triples((license_expression_node, SPDX_NAMESPACE.member, None))):
members[index] = parse_license_expression(member_node, graph)
members[index] = parse_license_expression(member_node, graph, doc_namespace)
if len(members) > 2:
raise SPDXParsingError([f"A DisjunctiveLicenseSet can only have two members."])
expression = f"{members[0]} OR {members[1]}"
if node_type == SPDX_NAMESPACE.WithExceptionOperator:
license_expression = parse_license_expression(graph.value(license_expression_node, SPDX_NAMESPACE.member),
graph)
graph, doc_namespace)
exception = parse_license_exception(graph.value(license_expression_node, SPDX_NAMESPACE.licenseException),
graph)
expression = f"{license_expression} WITH {exception}"
Expand All @@ -56,5 +59,3 @@ def parse_license_exception(exception_node: Node, graph: Graph) -> str:
else:
exception = graph.value(exception_node, SPDX_NAMESPACE.licenseExceptionId).toPython()
return exception

# need to be able to parse a ListedLicense as in spdx-spec example
17 changes: 8 additions & 9 deletions src/spdx/parser/rdf/package_parser.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,19 +60,18 @@ def parse_package(package_node: URIRef, graph: Graph, doc_namespace: str) -> Pac
for (_, _, external_package_ref_node) in graph.triples((package_node, SPDX_NAMESPACE.externalRef, None)):
external_package_refs.append(parse_external_package_ref(external_package_ref_node, graph))
files_analyzed = bool(graph.value(package_node, SPDX_NAMESPACE.filesAnalyzed, default=True))
license_concluded = parse_literal_or_no_assertion_or_none(logger, graph, package_node,
SPDX_NAMESPACE.licenseConcluded,
parsing_method=lambda x: parse_license_expression(x,
graph))
license_declared = parse_literal_or_no_assertion_or_none(logger, graph, package_node,
SPDX_NAMESPACE.licenseDeclared,
parsing_method=lambda x: parse_license_expression(x,
graph))
license_concluded = parse_literal_or_no_assertion_or_none(
logger, graph, package_node, SPDX_NAMESPACE.licenseConcluded,
parsing_method=lambda x: parse_license_expression(x, graph, doc_namespace))
license_declared = parse_literal_or_no_assertion_or_none(
logger, graph, package_node, SPDX_NAMESPACE.licenseDeclared,
parsing_method=lambda x: parse_license_expression(x, graph, doc_namespace))
license_info_from_files = []
for (_, _, license_info_from_files_node) in graph.triples(
(package_node, SPDX_NAMESPACE.licenseInfoFromFiles, None)):
license_info_from_files.append(
get_correct_typed_value(logger, license_info_from_files_node, lambda x: parse_license_expression(x, graph)))
get_correct_typed_value(logger, license_info_from_files_node,
lambda x: parse_license_expression(x, graph, doc_namespace)))
license_comment = parse_literal(logger, graph, package_node, SPDX_NAMESPACE.licenseComments)
comment = parse_literal(logger, graph, package_node, RDFS.comment)
summary = parse_literal(logger, graph, package_node, SPDX_NAMESPACE.summary)
Expand Down
10 changes: 5 additions & 5 deletions src/spdx/parser/rdf/snippet_parser.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,15 @@ def parse_snippet(snippet_node: URIRef, graph: Graph, doc_namespace: str) -> Sni
file_spdx_id = parse_spdx_id(file_spdx_id_uri, doc_namespace, graph)
byte_range = parse_ranges(snippet_node, graph, POINTER_NAMESPACE.ByteOffsetPointer, POINTER_NAMESPACE.offset)
line_range = parse_ranges(snippet_node, graph, POINTER_NAMESPACE.LineCharPointer, POINTER_NAMESPACE.lineNumber)
license_concluded = parse_literal_or_no_assertion_or_none(logger, graph, snippet_node,
SPDX_NAMESPACE.licenseConcluded,
parsing_method=lambda x: parse_license_expression(x,
graph))
license_concluded = parse_literal_or_no_assertion_or_none(
logger, graph, snippet_node, SPDX_NAMESPACE.licenseConcluded,
parsing_method=lambda x: parse_license_expression(x, graph, doc_namespace))
license_info_in_snippet = []
for (_, _, license_info_in_snippet_node) in graph.triples(
(snippet_node, SPDX_NAMESPACE.licenseInfoInSnippet, None)):
license_info_in_snippet.append(
get_correct_typed_value(logger, license_info_in_snippet_node, lambda x: parse_license_expression(x, graph)))
get_correct_typed_value(logger, license_info_in_snippet_node,
lambda x: parse_license_expression(x, graph, doc_namespace)))
license_comment = parse_literal(logger, graph, snippet_node, SPDX_NAMESPACE.licenseComments)
copyright_text = parse_literal_or_no_assertion_or_none(logger, graph, snippet_node, SPDX_NAMESPACE.copyrightText,
parsing_method=str)
Expand Down
26 changes: 18 additions & 8 deletions tests/spdx/parser/rdf/test_license_expression_parser.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,11 @@
# See the License for the specific language governing permissions and
# limitations under the License.
import os
from unittest import TestCase

from license_expression import get_spdx_licensing
from rdflib import Graph, RDF, URIRef
from spdx.parser.rdf import rdf_parser

from spdx.parser.rdf.license_expression_parser import parse_license_expression
from spdx.rdfschema.namespace import SPDX_NAMESPACE
Expand All @@ -23,16 +25,24 @@ def test_license_expression_parser():
package_node = graph.value(predicate=RDF.type, object=SPDX_NAMESPACE.Package)
license_expression_node = graph.value(subject=package_node, predicate=SPDX_NAMESPACE.licenseConcluded)

license_expression = parse_license_expression(license_expression_node, graph)
license_expression = parse_license_expression(license_expression_node, graph, "https://some.namespace#")

assert license_expression == get_spdx_licensing().parse("GPL-2.0 AND MIT")

def test_license_expression_parser_with_writer():
license_expression = get_spdx_licensing().parse("GPL-2.0 WITH exception")
graph = Graph()
add_license_expression_to_graph(license_expression, graph, URIRef("test"), URIRef("predicate"), "anyURI")

expression_noe = graph.value(URIRef("test"), URIRef("predicate"))
license_expression_parsed = parse_license_expression(expression_noe,graph)
def test_license_expression_parser_with_coupled_licenses():
doc = rdf_parser.parse_from_file(
os.path.join(os.path.dirname(__file__), "../../data/formats/SPDXRdfExample-v2.3.spdx.rdf.xml"))

assert license_expression_parsed == license_expression
packages_by_spdx_id = {package.spdx_id: package for package in doc.packages}
files_by_spdx_id = {file.spdx_id: file for file in doc.files}

assert packages_by_spdx_id["SPDXRef-Package"].license_declared == get_spdx_licensing().parse(
"LGPL-2.0-only AND LicenseRef-3")
assert packages_by_spdx_id["SPDXRef-Package"].license_concluded == get_spdx_licensing().parse(
"LGPL-2.0-only OR LicenseRef-3")
TestCase().assertCountEqual(packages_by_spdx_id["SPDXRef-Package"].license_info_from_files,
[get_spdx_licensing().parse("GPL-2.0"), get_spdx_licensing().parse("LicenseRef-1"),
get_spdx_licensing().parse("LicenseRef-2")])

assert files_by_spdx_id["SPDXRef-JenaLib"].license_concluded == get_spdx_licensing().parse("LicenseRef-1")
0