Diagnostics

What parse, stream and validate report. See Reading for the guide.

Diagnostic

One finding about the data of a file. A value, never raised.

level property

level: int

The SNIP level of the rule: 1, 2 or 3.

origin property

origin: str

Who reported the finding: "oxedi" for the parser's own rules, the validator's name for an external finding.

code property

code: Optional[str]

The external validator's own code for the finding; None for the parser's own rules and for external findings without one.

kind property

kind: str

The name of the rule that failed, e.g. RequiredElementMissing.

rule property

rule: str

The rule that failed, as a sentence with its values.

segment property

segment: Optional[int]

The index of the segment at fault; None at the end of the stream.

element property

element: Optional[int]

The 1-based element position, when the finding has one.

component property

component: Optional[int]

The 1-based component position, when the finding has one.

path property

path: str

The open loops, outermost first, joined by /; empty at the root.

datum property

datum: bytes

The offending value as it appears in the file.