Result

Classes

ColumnResult(*, name, path, result_type, ...)
MacroArgumentResult(*, name, path, ...[, ...])
MacroResult(*, name, path, result_type, ...)
ModelResult(*, name, path, result_type, ...)
Result(*, name, path, result_type, ...[, ...])	Store information of the result from a contract execution.
SourceResult(*, name, path, result_type, ...)

class dbt_contracts.contracts.result.Result(*, name: str, path: Path | None, result_type: str, result_level: str, result_name: str, message: str, properties_path: Path | None = None, properties_start_line: int | None = None, properties_start_col: int | None = None, properties_end_line: int | None = None, properties_end_col: int | None = None, parent_id: str | None = None, parent_name: str | None = None, parent_type: str | None = None, index: int | None = None)

Bases: BaseModelConfig, Generic

Store information of the result from a contract execution.

name: str

path: Path | None

result_type: str

result_level: str

result_name: str

message: str

properties_path: Path | None

properties_start_line: int | None

properties_start_col: int | None

properties_end_line: int | None

properties_end_col: int | None

parent_id: str | None

parent_name: str | None

parent_type: str | None

index: int | None

resource_type: ClassVar[type[ItemT]]

property has_parent: bool

Was this result built using a parent item.

classmethod from_resource(item: I, parent: P = None, properties: PropertiesIO = None, **kwargs) → Self

Create a new Result from a given resource.

Parameters:

• item – The resource to log a result for.

• parent – The parent item that the given child item belongs to if available.

• properties – The properties IO handler to use when loading properties files.

Returns:

The Result instance.

as_github_annotation() → Mapping[str, str]

Format this result to a GitHub annotation. Raises an exception if the result does not have all the required parameters set to build a valid GitHub annotation.

property can_format_to_github_annotation: bool

Can this result be formatted as a valid GitHub annotation.

class dbt_contracts.contracts.result.ModelResult(*, name: str, path: Path | None, result_type: str, result_level: str, result_name: str, message: str, properties_path: Path | None = None, properties_start_line: int | None = None, properties_start_col: int | None = None, properties_end_line: int | None = None, properties_end_col: int | None = None, parent_id: str | None = None, parent_name: str | None = None, parent_type: str | None = None, index: int | None = None)

Bases: Result

resource_type

alias of ModelNode

class dbt_contracts.contracts.result.SourceResult(*, name: str, path: Path | None, result_type: str, result_level: str, result_name: str, message: str, properties_path: Path | None = None, properties_start_line: int | None = None, properties_start_col: int | None = None, properties_end_line: int | None = None, properties_end_col: int | None = None, parent_id: str | None = None, parent_name: str | None = None, parent_type: str | None = None, index: int | None = None)

Bases: Result

resource_type

alias of SourceDefinition

class dbt_contracts.contracts.result.ColumnResult(*, name: str, path: Path | None, result_type: str, result_level: str, result_name: str, message: str, properties_path: Path | None = None, properties_start_line: int | None = None, properties_start_col: int | None = None, properties_end_line: int | None = None, properties_end_col: int | None = None, parent_id: str | None = None, parent_name: str | None = None, parent_type: str | None = None, index: int | None = None)

Bases: Result, Generic

resource_type

alias of ColumnInfo

classmethod from_resource(item: ColumnInfo, parent: P = None, properties: PropertiesIO = None, **kwargs) → Self

Create a new Result from a given resource.

Parameters:

• item – The resource to log a result for.

• parent – The parent item that the given child item belongs to if available.

• properties – The properties IO handler to use when loading properties files.

Returns:

The Result instance.

class dbt_contracts.contracts.result.MacroResult(*, name: str, path: Path | None, result_type: str, result_level: str, result_name: str, message: str, properties_path: Path | None = None, properties_start_line: int | None = None, properties_start_col: int | None = None, properties_end_line: int | None = None, properties_end_col: int | None = None, parent_id: str | None = None, parent_name: str | None = None, parent_type: str | None = None, index: int | None = None)

Bases: Result

resource_type

alias of Macro

class dbt_contracts.contracts.result.MacroArgumentResult(*, name: str, path: Path | None, result_type: str, result_level: str, result_name: str, message: str, properties_path: Path | None = None, properties_start_line: int | None = None, properties_start_col: int | None = None, properties_end_line: int | None = None, properties_end_col: int | None = None, parent_id: str | None = None, parent_name: str | None = None, parent_type: str | None = None, index: int | None = None)

Bases: Result

resource_type

alias of MacroArgument

classmethod from_resource(item: MacroArgument, parent: Macro = None, properties: PropertiesIO = None, **kwargs) → Self

Create a new Result from a given resource.

Parameters:

• item – The resource to log a result for.

• parent – The parent item that the given child item belongs to if available.

• properties – The properties IO handler to use when loading properties files.

Returns:

The Result instance.