Structured validation report

[liamhuber]

I'm not in any rush on this, but what do you think of pulling this up into semantikon @samwaseda?

https://github.com/pyiron/pyiron_workflow/blob/ca9e53ab6538dc6f4b9ff30cad7dbe08b6ea78ca/pyiron_workflow/_wfms/validation.py#L175-L182

(Ok, that doesn't render because it's from another repo, here it is for readability, renamed while I'm at it:)

@dataclasses.dataclass(frozen=True)
class ValidationReport:
    valid: bool
    graph: rdflib.ConjunctiveGraph | rdflib.Graph
    text: str

    def __repr__(self):
        return self.text

It just wraps the current tuple. I.e. we'd switch this

semantikon/semantikon/ontology.py

Line 283 in 3cf8faf

return validate(g, shacl_graph=shacl)

To something like

validation_tuple = pyshacl.validate(g, shacl_graph=shacl)
return ValidationReport(valid=validation_tuple[0], ...)

I made it because I was tired of writing things like if report[0] and print(report[2]) and wanted to read/write if report.valid and print(report).

[samwaseda]

Hmmm in principle I like the idea, but however difficult it is to read the SHACL report, since it is de facto the standard, I would like to be a bit careful to change the display. After all, we are not the ones who are going to use it, so maybe we should wait for user feedback for this??

[liamhuber]

First, it should be __str__, not __repr__, my bad.

The main things I want are for the components to be named so I don't have to keep indexing (and remembering the order), and for the printout to drop the bool (meh) and the graph (actively annoying to see, it's just a class and memory printout).

If you wanted to keep it even closer to the raw pyshacl result, we could achieve those goals while still keeping it as a tuple, and could get halfway to what I find helpful while still dropping the __str__:

import typing

class ValidationReport(typing.NamedTuple):
    valid: bool
    graph: rdflib.ConjunctiveGraph | rdflib.Graph
    text: str

    def __str__(self):
        return self.text