great_expectations.render

Subpackages

Package Contents

Classes

AtomicDiagnosticRendererType()

Available atomic diagnostic renderer names

AtomicPrescriptiveRendererType()

Available atomic prescriptive renderer names

AtomicRendererType()

Available atomic renderer types

CollapseContent(collapse, collapse_toggle_link=None, header=None, subheader=None, styling=None, content_block_type=’collapse’, inline_link=False)

LegacyDescriptiveRendererType()

Available legacy descriptive renderer names

LegacyDiagnosticRendererType()

Available legacy diagnostic renderer names

LegacyPrescriptiveRendererType()

Available legacy prescriptive renderer names

LegacyRendererType()

Available legacy renderer types

RenderedAtomicContent(name: Union[str, AtomicDiagnosticRendererType, AtomicPrescriptiveRendererType], value: RenderedAtomicValue, value_type: Optional[str] = None)

RenderedAtomicContentSchema()

RenderedAtomicValue(schema: Optional[dict] = None, header: Optional[RenderedAtomicValue] = None, template: Optional[str] = None, params: Optional[dict] = None, header_row: Optional[List[RenderedAtomicValue]] = None, table: Optional[List[List[RenderedAtomicValue]]] = None, graph: Optional[dict] = None)

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

RenderedAtomicValueGraph(graph: Optional[dict] = None)

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

RenderedAtomicValueSchema()

RenderedBootstrapTableContent(table_data, table_columns, title_row=None, table_options=None, header=None, subheader=None, styling=None, content_block_type=’bootstrap_table’)

RenderedBulletListContent(bullet_list, header=None, subheader=None, styling=None, content_block_type=’bullet_list’)

RenderedComponentContent(content_block_type, styling=None)

RenderedContent()

RenderedContentBlockContainer(content_blocks, styling=None, content_block_type=’content_block_container’)

RenderedDocumentContent(sections, data_asset_name=None, full_data_asset_identifier=None, renderer_type=None, page_title=None, utm_medium=None, cta_footer=None, expectation_suite_name=None, batch_kwargs=None, batch_spec=None, ge_cloud_id=None)

RenderedGraphContent(graph, header=None, subheader=None, styling=None, content_block_type=’graph’)

RenderedHeaderContent(header, subheader=None, header_row=None, styling=None, content_block_type=’header’)

RenderedMarkdownContent(markdown, styling=None, content_block_type=’markdown’)

RenderedSectionContent(content_blocks, section_name=None)

RenderedStringTemplateContent(string_template, styling=None, content_block_type=’string_template’)

RenderedTableContent(table, header=None, subheader=None, header_row=None, styling=None, content_block_type=’table’, table_options=None, header_row_options=None)

RenderedTabsContent(tabs, header=None, subheader=None, styling=None, content_block_type=’tabs’)

RendererPrefix()

Available renderer prefixes

TextContent(text, header=None, subheader=None, styling=None, content_block_type=’text’)

ValueListContent(value_list, header=None, subheader=None, styling=None, content_block_type=’value_list’)

DefaultJinjaPageView(custom_styles_directory=None, custom_views_directory=None)

Defines a method for converting a document to human-consumable form

class great_expectations.render.AtomicDiagnosticRendererType

Bases: str, enum.Enum

Available atomic diagnostic renderer names

FAILED
OBSERVED_VALUE
__str__(self)

Return str(self).

class great_expectations.render.AtomicPrescriptiveRendererType

Bases: str, enum.Enum

Available atomic prescriptive renderer names

FAILED
SUMMARY
__str__(self)

Return str(self).

class great_expectations.render.AtomicRendererType

Bases: str, enum.Enum

Available atomic renderer types

PRESCRIPTIVE
DIAGNOSTIC
class great_expectations.render.CollapseContent(collapse, collapse_toggle_link=None, header=None, subheader=None, styling=None, content_block_type='collapse', inline_link=False)

Bases: great_expectations.render.components.RenderedComponentContent

to_json_dict(self)
class great_expectations.render.LegacyDescriptiveRendererType

Bases: str, enum.Enum

Available legacy descriptive renderer names

COLUMN_PROPERTIES_TABLE_DISTINCT_COUNT_ROW
COLUMN_PROPERTIES_TABLE_DISTINCT_PERCENT_ROW
COLUMN_PROPERTIES_TABLE_MISSING_COUNT_ROW
COLUMN_PROPERTIES_TABLE_MISSING_PERCENT_ROW
COLUMN_PROPERTIES_TABLE_REGEX_COUNT_ROW
EXAMPLE_VALUES_BLOCK
HISTOGRAM
QUANTILE_TABLE
STATS_TABLE_MAX_ROW
STATS_TABLE_MEAN_ROW
STATS_TABLE_MIN_ROW
VALUE_COUNTS_BAR_CHART
class great_expectations.render.LegacyDiagnosticRendererType

Bases: str, enum.Enum

Available legacy diagnostic renderer names

META_PROPERTIES
OBSERVED_VALUE
STATUS_ICON
SUMMARY
UNEXPECTED_STATEMENT
UNEXPECTED_TABLE
class great_expectations.render.LegacyPrescriptiveRendererType

Bases: str, enum.Enum

Available legacy prescriptive renderer names

SUMMARY
class great_expectations.render.LegacyRendererType

Bases: str, enum.Enum

Available legacy renderer types

ANSWER
DESCRIPTIVE
DIAGNOSTIC
PRESCRIPTIVE
QUESTION
class great_expectations.render.RenderedAtomicContent(name: Union[str, AtomicDiagnosticRendererType, AtomicPrescriptiveRendererType], value: RenderedAtomicValue, value_type: Optional[str] = None)

Bases: great_expectations.render.components.RenderedContent

__repr__(self)

Return repr(self).

__str__(self)

Return str(self).

to_json_dict(self)

Returns RenderedAtomicContent as a json dictionary.

class great_expectations.render.RenderedAtomicContentSchema

Bases: marshmallow.Schema

class Meta
unknown :INCLUDE
name
value
value_type
make_rendered_atomic_content(self, data, **kwargs)
class great_expectations.render.RenderedAtomicValue(schema: Optional[dict] = None, header: Optional[RenderedAtomicValue] = None, template: Optional[str] = None, params: Optional[dict] = None, header_row: Optional[List[RenderedAtomicValue]] = None, table: Optional[List[List[RenderedAtomicValue]]] = None, graph: Optional[dict] = None)

Bases: great_expectations.types.DictDot

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.

__repr__(self)

Return repr(self).

__str__(self)

Return str(self).

to_json_dict(self)

Returns RenderedAtomicValue as a json dictionary.

class great_expectations.render.RenderedAtomicValueGraph(graph: Optional[dict] = None)

Bases: great_expectations.types.DictDot

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.

__repr__(self)

Return repr(self).

__str__(self)

Return str(self).

to_json_dict(self)

Returns RenderedAtomicValueGraph as a json dictionary.

class great_expectations.render.RenderedAtomicValueSchema

Bases: marshmallow.Schema

class Meta
unknown
schema
header
template
params
header_row
table
graph
REMOVE_KEYS_IF_NONE = ['template', 'table', 'params', 'header_row', 'table', 'graph']
create_value_obj(self, data, **kwargs)
clean_null_attrs(self, data: dict, **kwargs: dict)

Removes the attributes in RenderedAtomicValueSchema.REMOVE_KEYS_IF_NONE during serialization if their values are None.

class great_expectations.render.RenderedBootstrapTableContent(table_data, table_columns, title_row=None, table_options=None, header=None, subheader=None, styling=None, content_block_type='bootstrap_table')

Bases: great_expectations.render.components.RenderedComponentContent

to_json_dict(self)
class great_expectations.render.RenderedBulletListContent(bullet_list, header=None, subheader=None, styling=None, content_block_type='bullet_list')

Bases: great_expectations.render.components.RenderedComponentContent

to_json_dict(self)
class great_expectations.render.RenderedComponentContent(content_block_type, styling=None)

Bases: great_expectations.render.components.RenderedContent

to_json_dict(self)
class great_expectations.render.RenderedContent
to_json_dict(self)
__eq__(self, other)

Return self==value.

classmethod rendered_content_list_to_json(cls, list_, check_dicts=False)
classmethod rendered_content_dict_to_json(cls, dict_, check_list_dicts=True)
class great_expectations.render.RenderedContentBlockContainer(content_blocks, styling=None, content_block_type='content_block_container')

Bases: great_expectations.render.components.RenderedComponentContent

to_json_dict(self)
class great_expectations.render.RenderedDocumentContent(sections, data_asset_name=None, full_data_asset_identifier=None, renderer_type=None, page_title=None, utm_medium=None, cta_footer=None, expectation_suite_name=None, batch_kwargs=None, batch_spec=None, ge_cloud_id=None)

Bases: great_expectations.render.components.RenderedContent

to_json_dict(self)
class great_expectations.render.RenderedGraphContent(graph, header=None, subheader=None, styling=None, content_block_type='graph')

Bases: great_expectations.render.components.RenderedComponentContent

to_json_dict(self)
class great_expectations.render.RenderedHeaderContent(header, subheader=None, header_row=None, styling=None, content_block_type='header')

Bases: great_expectations.render.components.RenderedComponentContent

to_json_dict(self)
class great_expectations.render.RenderedMarkdownContent(markdown, styling=None, content_block_type='markdown')

Bases: great_expectations.render.components.RenderedComponentContent

to_json_dict(self)
class great_expectations.render.RenderedSectionContent(content_blocks, section_name=None)

Bases: great_expectations.render.components.RenderedContent

to_json_dict(self)
class great_expectations.render.RenderedStringTemplateContent(string_template, styling=None, content_block_type='string_template')

Bases: great_expectations.render.components.RenderedComponentContent

to_json_dict(self)
__str__(self)

Return str(self).

__eq__(self, other)

Return self==value.

class great_expectations.render.RenderedTableContent(table, header=None, subheader=None, header_row=None, styling=None, content_block_type='table', table_options=None, header_row_options=None)

Bases: great_expectations.render.components.RenderedComponentContent

to_json_dict(self)
class great_expectations.render.RenderedTabsContent(tabs, header=None, subheader=None, styling=None, content_block_type='tabs')

Bases: great_expectations.render.components.RenderedComponentContent

to_json_dict(self)
class great_expectations.render.RendererPrefix

Bases: str, enum.Enum

Available renderer prefixes

LEGACY = renderer
ATOMIC = atomic
class great_expectations.render.TextContent(text, header=None, subheader=None, styling=None, content_block_type='text')

Bases: great_expectations.render.components.RenderedComponentContent

to_json_dict(self)
class great_expectations.render.ValueListContent(value_list, header=None, subheader=None, styling=None, content_block_type='value_list')

Bases: great_expectations.render.components.RenderedComponentContent

to_json_dict(self)
class great_expectations.render.DefaultJinjaPageView(custom_styles_directory=None, custom_views_directory=None)

Bases: great_expectations.render.view.view.DefaultJinjaView

Defines a method for converting a document to human-consumable form

  • Font Awesome 5.10.1

  • Bootstrap 4.3.1

  • jQuery 3.2.1

  • Vega 5

  • Vega-Lite 4

  • Vega-Embed 6

_template = page.j2
_validate_document(self, document)
great_expectations.render.renderedAtomicValueSchema