Skip to content

ontocast.check.report

Report models for the facts check.

Classes

FactsCheckFinding

Bases: BaseModel

One problem found in a facts graph.

Source code in ontocast/check/report.py
class FactsCheckFinding(BaseModel):
    """One problem found in a facts graph."""

    kind: FactsCheckKind
    severity: Literal["error", "warning"]
    message: str
    subject: str | None = None
    predicate: str | None = None
    value: str | None = None
    suggestions: list[str] = Field(default_factory=list)
    source_shape: str | None = None

Attributes

kind instance-attribute
message instance-attribute
predicate = None class-attribute instance-attribute
severity instance-attribute
source_shape = None class-attribute instance-attribute
subject = None class-attribute instance-attribute
suggestions = Field(default_factory=list) class-attribute instance-attribute
value = None class-attribute instance-attribute

FactsCheckKind

Bases: StrEnum

Kind of a finding; the value is the snake_case member name.

Source code in ontocast/check/report.py
class FactsCheckKind(StrEnum):
    """Kind of a finding; the value is the snake_case member name."""

    NON_CATALOG_VOCABULARY = "non_catalog_vocabulary"
    UNKNOWN_TERM = "unknown_term"
    DOMAIN_VIOLATION = "domain_violation"
    UNTYPED_VALUE = "untyped_value"
    INVALID_LITERAL = "invalid_literal"
    TEMPORAL_RANGE_MISMATCH = "temporal_range_mismatch"
    FUNCTIONAL_VIOLATION = "functional_violation"
    SHACL = "shacl"
    UNTYPED_INSTANCE = "untyped_instance"
    ISOLATED_INSTANCE = "isolated_instance"
    SILENT_INSTANCE = "silent_instance"
    DANGLING_REFERENCE = "dangling_reference"
    TWIN_LABELS = "twin_labels"
    CATALOG_SUBJECT = "catalog_subject"
    SCHEMA_IN_FACTS = "schema_in_facts"

Attributes

CATALOG_SUBJECT = 'catalog_subject' class-attribute instance-attribute
DANGLING_REFERENCE = 'dangling_reference' class-attribute instance-attribute
DOMAIN_VIOLATION = 'domain_violation' class-attribute instance-attribute
FUNCTIONAL_VIOLATION = 'functional_violation' class-attribute instance-attribute
INVALID_LITERAL = 'invalid_literal' class-attribute instance-attribute
ISOLATED_INSTANCE = 'isolated_instance' class-attribute instance-attribute
NON_CATALOG_VOCABULARY = 'non_catalog_vocabulary' class-attribute instance-attribute
SCHEMA_IN_FACTS = 'schema_in_facts' class-attribute instance-attribute
SHACL = 'shacl' class-attribute instance-attribute
SILENT_INSTANCE = 'silent_instance' class-attribute instance-attribute
TEMPORAL_RANGE_MISMATCH = 'temporal_range_mismatch' class-attribute instance-attribute
TWIN_LABELS = 'twin_labels' class-attribute instance-attribute
UNKNOWN_TERM = 'unknown_term' class-attribute instance-attribute
UNTYPED_INSTANCE = 'untyped_instance' class-attribute instance-attribute
UNTYPED_VALUE = 'untyped_value' class-attribute instance-attribute

FactsCheckMetrics

Bases: BaseModel

Size and shape figures of the checked graph.

Source code in ontocast/check/report.py
class FactsCheckMetrics(BaseModel):
    """Size and shape figures of the checked graph."""

    triples: int
    instances: int
    isolated: int
    untyped: int
    twin_labels: int

Attributes

instances instance-attribute
isolated instance-attribute
triples instance-attribute
twin_labels instance-attribute
untyped instance-attribute

FactsCheckReport

Bases: BaseModel

Outcome of a facts check.

counts maps kind value to severity to number of findings and is complete even when findings is truncated; findings_total is the untruncated count.

Source code in ontocast/check/report.py
class FactsCheckReport(BaseModel):
    """Outcome of a facts check.

    `counts` maps kind value to severity to number of findings and is complete
    even when `findings` is truncated; `findings_total` is the untruncated count.
    """

    findings: list[FactsCheckFinding]
    findings_total: int
    counts: dict[str, dict[str, int]]
    metrics: FactsCheckMetrics
    shacl_evaluated: bool | None
    catalog_empty: bool

Attributes

catalog_empty instance-attribute
counts instance-attribute
findings instance-attribute
findings_total instance-attribute
metrics instance-attribute
shacl_evaluated instance-attribute