Diagnostic
Kind: Class
Domain: Core runtime
Canonical import: from cadflow import Diagnostic
Signature
class Diagnostic(severity: 'str', code: 'str', message: 'str', hint: 'str | None' = None, data: 'Mapping[str, Any]' = <factory>) -> None
Description
Diagnostic(severity: 'str', code: 'str', message: 'str', hint: 'str | None' = None, data: 'Mapping[str, Any]' = <factory>)
Other public imports
from cadflow.feedback import Diagnostic
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
severity | 'str' | yes | - | Not explicitly described in the source docstring. |
code | 'str' | yes | - | Not explicitly described in the source docstring. |
message | 'str' | yes | - | Not explicitly described in the source docstring. |
hint | 'str | None' | no | None | Not explicitly described in the source docstring. |
data | 'Mapping[str, Any]' | no | <factory> | Not explicitly described in the source docstring. |
Returns
Type: None
The source docstring does not declare additional return semantics.
Errors
The source docstring does not declare a narrower exception contract. Invalid types, values, ownership, paths, or backend state may still raise the corresponding public error.
Data fields
| Name | Type | Default |
|---|---|---|
severity | 'str' | required |
code | 'str' | required |
message | 'str' | required |
hint | 'str | None' | None |
data | 'Mapping[str, Any]' | factory |
Public members
| Member | Kind | Signature | Description |
|---|---|---|---|
to_dict | method | (self) -> 'dict[str, Any]' | See the member signature. |
Behavior and constraints
- Instances are immutable dataclass values; update workflows return a replacement value.
Import check
from cadflow import Diagnostic