great_expectations.data_context.store.html_site_store

Module Contents

Classes

HtmlSiteStore(store_backend=None, runtime_environment=None)

A HtmlSiteStore facilitates publishing rendered documentation built from Expectation Suites, Profiling Results, and Validation Results.

great_expectations.data_context.store.html_site_store.logger
class great_expectations.data_context.store.html_site_store.HtmlSiteStore(store_backend=None, runtime_environment=None)

A HtmlSiteStore facilitates publishing rendered documentation built from Expectation Suites, Profiling Results, and Validation Results.

Feature Maturity

icon-9f35546495bc11ecb09f0242ac110002 HTML Site Store - Filesystem - How-to Guide
For publishing rendered documentation built from Expectation Suites, Profiling Results, and Validation Results on the Filesystem
Maturity: Production
Details:
API Stability: Mostly Stable (profiling)
Implementation Completeness: Complete
Unit Test Coverage: Complete
Integration Infrastructure/Test Coverage: N/A
Documentation Completeness: Partial
Bug Risk: Low
icon-9f35575295bc11ecb09f0242ac110002 HTML Site Store - S3 - How-to Guide
For publishing rendered documentation built from Expectation Suites, Profiling Results, and Validation Results on S3
Maturity: Beta
Details:
API Stability: Mostly Stable (profiling)
Implementation Completeness: Complete
Unit Test Coverage: Complete
Integration Infrastructure/Test Coverage: Minimal
Documentation Completeness: Complete
Bug Risk: Moderate
icon-9f3558f695bc11ecb09f0242ac110002 HTMLSiteStore - GCS - How-to Guide
For publishing rendered documentation built from Expectation Suites, Profiling Results, and Validation Results on GCS
Maturity: Beta
Details:
API Stability: Mostly Stable (profiling)
Implementation Completeness: Complete
Unit Test Coverage: Complete
Integration Infrastructure/Test Coverage: Minimal
Documentation Completeness: Partial (needs auth)
Bug Risk: Moderate (resource URL may have bugs)
icon-9f355a7295bc11ecb09f0242ac110002 HTMLSiteStore - Azure - How-to Guide
For publishing rendered documentation built from Expectation Suites, Profiling Results, and Validation Results on Azure Blob Storage
Maturity: N/A
Details:
API Stability: Mostly Stable (profiling)
Implementation Completeness: Minimal
Unit Test Coverage: Minimal
Integration Infrastructure/Test Coverage: Minimal
Documentation Completeness: Minimal
Bug Risk: Moderate
_key_class
get(self, key)
set(self, key, serialized_value)
get_url_for_resource(self, resource_identifier=None, only_if_exists=True)

Return the URL of the HTML document that renders a resource (e.g., an expectation suite or a validation result).

Parameters

resource_identifier – ExpectationSuiteIdentifier, ValidationResultIdentifier or any other type’s identifier. The argument is optional - when not supplied, the method returns the URL of the index page.

Returns

URL (string)

_validate_key(self, key)
list_keys(self)
write_index_page(self, page)

This third param_store has a special method, which uses a zero-length tuple as a key.

clean_site(self)
copy_static_assets(self, static_assets_source_dir=None)

Copies static assets, using a special “static_assets” backend store that accepts variable-length tuples as keys, with no filepath_template.

_unzip_assets(self, assets_full_path: str, unzip_directory: str)

This function receives an assets_full_path parameter, (e.g. “/home/joe/libs/my_python_libs.zip/great_expectations/render/view/static”) and an unzip_directory parameter (e.g. “/tmp/extract_statics_here”)

If assets_full_path is a folder inside a zip, then said folder is extracted (unzipped) to the unzip_directory and this function returns True. Otherwise, this function returns False

property config(self)
self_check(self, pretty_print: bool = True)