Skip to content
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

add method to check SHACL constraints #6

Merged
merged 1 commit into from
Aug 31, 2024
Merged
Changes from all commits
Commits
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
32 changes: 32 additions & 0 deletions src/rdf_utils/constraints.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# SPDX-License-Identifier: MPL-2.0
from typing import Dict
from rdflib import ConjunctiveGraph, Graph
import pyshacl


class ConstraintViolation(Exception):
def __init__(self, domain, message):
super().__init__(f"{domain} constraint violated: {message}")


class SHACLViolation(ConstraintViolation):
def __init__(self, violation_str: str):
super().__init__("SHACL", violation_str)


def check_shacl_constraints(graph: Graph, shacl_dict: Dict[str, str], quiet=False) -> bool:
"""
:param graph: rdfl.Graph to be checked
:param shacl_dict: mapping from SHACL path to graph format, e.g. URL -> "turtle"
:param quiet: if true will not throw an exception
"""
shacl_g = ConjunctiveGraph()
for mm_url, fmt in shacl_dict.items():
shacl_g.parse(mm_url, format=fmt)

conforms, _, report_text = pyshacl.validate(graph, shacl_graph=shacl_g, inference="rdfs")

if not conforms and not quiet:
raise SHACLViolation(report_text)

return conforms