`great_expectations.core.expectation_diagnostics.supporting_types`¶

Module Contents¶

Classes¶

`Maturity`()	The four levels of maturity for features within Great Expectations
`Package`()	A package name, link to its pypi or Gallery page, and (optional) version number
`AugmentedLibraryMetadata`()	An augmented version of the Expectation.library_metadata object, used within ExpectationDiagnostics
`ExpectationDescriptionDiagnostics`()	Captures basic descriptive info about an Expectation. Used within the ExpectationDiagnostic object.
`RendererTestDiagnostics`()	Captures information from executing Renderer test cases. Used within the ExpectationRendererDiagnostics object.
`ExpectationRendererDiagnostics`()	Captures information about a specific Renderer within an Expectation. Used within the ExpectationDiagnostic object.
`ExpectationMetricDiagnostics`()	Captures information about a specific Metric dependency for an Expectation. Used within the ExpectationDiagnostic object.
`ExpectationExecutionEngineDiagnostics`()	Captures which of the three Execution Engines are supported by an Expectation. Used within the ExpectationDiagnostic object.
`ExpectationTestDiagnostics`()	Captures information from executing Expectation test cases. Used within the ExpectationDiagnostic object.
`ExpectationErrorDiagnostics`()	A convenience class for migrating away from untyped dictionaries to stronger typed objects.
`ExecutedExpectationTestCase`()	Captures information from executing Expectation test cases. Used within the ExpectationDiagnostic object.
`ExpectationDiagnosticCheckMessage`()	Summarizes the result of a diagnostic Check. Used within the ExpectationDiagnostic object.
`ExpectationDiagnosticMaturityMessages`()	A holder for ExpectationDiagnosticCheckMessages, grouping them by maturity level. Used within the ExpectationDiagnostic object.

class great_expectations.core.expectation_diagnostics.supporting_types.Maturity¶

Bases: enum.Enum

The four levels of maturity for features within Great Expectations

CONCEPT_ONLY = CONCEPT_ONLY¶

EXPERIMENTAL = EXPERIMENTAL¶

BETA = BETA¶

PRODUCTION = PRODUCTION¶

class great_expectations.core.expectation_diagnostics.supporting_types.Package¶

A package name, link to its pypi or Gallery page, and (optional) version number

text :str¶

link :str¶

version :Optional[str]¶

class great_expectations.core.expectation_diagnostics.supporting_types.AugmentedLibraryMetadata¶

Bases: great_expectations.types.SerializableDictDot

An augmented version of the Expectation.library_metadata object, used within ExpectationDiagnostics

maturity :Maturity¶

tags :List[str]¶

contributors :List[str]¶

requirements :List[str]¶

library_metadata_passed_checks :bool¶

has_full_test_suite :bool¶

manually_reviewed_code :bool¶

package :Optional[Package]¶

legacy_maturity_level_substitutions¶

classmethod from_legacy_dict(cls, dict)¶: This method is a temporary adapter to allow typing of legacy library_metadata objects, without needing to immediately clean up every object.

class great_expectations.core.expectation_diagnostics.supporting_types.ExpectationDescriptionDiagnostics¶

Bases: great_expectations.types.SerializableDictDot

Captures basic descriptive info about an Expectation. Used within the ExpectationDiagnostic object.

camel_name :str¶

snake_name :str¶

short_description :str¶

docstring :str¶

class great_expectations.core.expectation_diagnostics.supporting_types.RendererTestDiagnostics¶

Bases: great_expectations.types.SerializableDictDot

Captures information from executing Renderer test cases. Used within the ExpectationRendererDiagnostics object.

test_title :str¶

rendered_successfully :bool¶

renderered_str :Union[str, None]¶

error_message :Union[str, None]¶

stack_trace :Union[str, None]¶

class great_expectations.core.expectation_diagnostics.supporting_types.ExpectationRendererDiagnostics¶

Bases: great_expectations.types.SerializableDictDot

Captures information about a specific Renderer within an Expectation. Used within the ExpectationDiagnostic object.

name :str¶

is_supported :bool¶

is_standard :bool¶

samples :List[RendererTestDiagnostics]¶

class great_expectations.core.expectation_diagnostics.supporting_types.ExpectationMetricDiagnostics¶

Bases: great_expectations.types.SerializableDictDot

Captures information about a specific Metric dependency for an Expectation. Used within the ExpectationDiagnostic object.

name :str¶

has_question_renderer :bool¶

class great_expectations.core.expectation_diagnostics.supporting_types.ExpectationExecutionEngineDiagnostics¶

Bases: great_expectations.types.SerializableDictDot

Captures which of the three Execution Engines are supported by an Expectation. Used within the ExpectationDiagnostic object.

PandasExecutionEngine :bool¶

SqlAlchemyExecutionEngine :bool¶

SparkDFExecutionEngine :bool¶

class great_expectations.core.expectation_diagnostics.supporting_types.ExpectationTestDiagnostics¶

Bases: great_expectations.types.SerializableDictDot

Captures information from executing Expectation test cases. Used within the ExpectationDiagnostic object.

test_title :str¶

backend :str¶

test_passed :bool¶

error_message :Union[str, None]¶

stack_trace :Union[str, None]¶

class great_expectations.core.expectation_diagnostics.supporting_types.ExpectationErrorDiagnostics¶

Bases: great_expectations.types.SerializableDictDot

A convenience class for migrating away from untyped dictionaries to stronger typed objects.

Can be instantiated with arguments:

my_A = MyClassA(

foo=”a string”, bar=1,

)

Can be instantiated from a dictionary:

my_A = MyClassA(

**{
“foo”: “a string”, “bar”: 1,

}

)

Can be accessed using both dictionary and dot notation

my_A.foo == “a string” my_A.bar == 1

my_A[“foo”] == “a string” my_A[“bar”] == 1

Pairs nicely with @dataclass:

@dataclass() class MyClassA(DictDot):

foo: str bar: int

Can be made immutable:

@dataclass(frozen=True) class MyClassA(DictDot):

foo: str bar: int

For more examples of usage, please see test_dataclass_serializable_dot_dict_pattern.py in the tests folder.

error_msg :str¶

stack_trace :str¶

class great_expectations.core.expectation_diagnostics.supporting_types.ExecutedExpectationTestCase¶

Bases: great_expectations.types.SerializableDictDot

Captures information from executing Expectation test cases. Used within the ExpectationDiagnostic object.

This may turn out to be the same thing as ExpectationTestDiagnostics.

data :TestData¶

test_case :ExpectationTestCase¶

expectation_configuration :ExpectationConfiguration¶

validation_result :ExpectationValidationResult¶

error_diagnostics :ExpectationErrorDiagnostics¶

class great_expectations.core.expectation_diagnostics.supporting_types.ExpectationDiagnosticCheckMessage¶

Bases: great_expectations.types.SerializableDictDot

Summarizes the result of a diagnostic Check. Used within the ExpectationDiagnostic object.

message :str¶

passed :bool¶

doc_url :Optional[str]¶

sub_messages :List['ExpectationDiagnosticCheckMessage']¶

class great_expectations.core.expectation_diagnostics.supporting_types.ExpectationDiagnosticMaturityMessages¶

Bases: great_expectations.types.SerializableDictDot

A holder for ExpectationDiagnosticCheckMessages, grouping them by maturity level. Used within the ExpectationDiagnostic object.

experimental :List[ExpectationDiagnosticCheckMessage]¶

beta :List[ExpectationDiagnosticCheckMessage]¶

production :List[ExpectationDiagnosticCheckMessage]¶

great_expectations.core.expectation_diagnostics.supporting_types¶

Module Contents¶

Classes¶

`great_expectations.core.expectation_diagnostics.supporting_types`¶