def render(self, evrs, section_name=None, column_type=None):
if section_name is None:
column = self._get_column_name(evrs)
else:
column = section_name
content_blocks = []
for content_block_function_name in self.content_block_function_names:
try:
if content_block_function_name == "_render_header":
content_blocks.append(getattr(self, content_block_function_name)(evrs, column_type))
else:
content_blocks.append(getattr(self, content_block_function_name)(evrs))
except Exception as e:
exception_message = f'''\
An unexpected Exception occurred during data docs rendering. Because of this error, certain parts of data docs will \
not be rendered properly and/or may not appear altogether. Please use the trace, included in this message, to \
diagnose and repair the underlying issue. Detailed information follows:
'''
exception_traceback = traceback.format_exc()
exception_message += f'{type(e).__name__}: "{str(e)}". Traceback: "{exception_traceback}".'
logger.error(exception_message, e, exc_info=True)
# NOTE : Some render* functions return None so we filter them out
populated_content_blocks = list(filter(None, content_blocks))
return RenderedSectionContent(**{
"section_name": column,
"content_blocks": populated_content_blocks,
})
def render(self, evrs, section_name=None, column_type=None):
if section_name is None:
column = self._get_column_name(evrs)
else:
column = section_name
content_blocks = []
for content_block_function_name in self.content_block_function_names:
try:
if content_block_function_name == "_render_header":
content_blocks.append(
getattr(self,
content_block_function_name)(evrs,
column_type))
else:
content_blocks.append(
getattr(self, content_block_function_name)(evrs))
except Exception as e:
logger.error("Exception occurred during data docs rendering: ",
e,
exc_info=True)
# NOTE : Some render* functions return None so we filter them out
populated_content_blocks = list(filter(None, content_blocks))
return RenderedSectionContent(
**{
"section_name": column,
"content_blocks": populated_content_blocks,
})
def _collect_rendered_document_content_sections(
self,
validation_results: ExpectationSuiteValidationResult,
overview_content_blocks: List[RenderedComponentContent],
collapse_content_blocks: List[RenderedTableContent],
columns: Dict[str, list],
) -> List[RenderedSectionContent]:
ordered_columns = Renderer._get_column_list_from_evrs(
validation_results)
sections = [
RenderedSectionContent(
**{
"section_name": "Overview",
"content_blocks": overview_content_blocks,
})
]
if "Table-Level Expectations" in columns:
sections += [
self._column_section_renderer.render(
validation_results=columns["Table-Level Expectations"],
evaluation_parameters=validation_results.
evaluation_parameters,
)
]
sections += [
self._column_section_renderer.render(
validation_results=columns[column],
evaluation_parameters=validation_results.evaluation_parameters,
) for column in ordered_columns
]
if self.run_info_at_end:
sections += [
RenderedSectionContent(
**{
"section_name": "Run Info",
"content_blocks": collapse_content_blocks,
})
]
return sections
def render(self, validation_results):
column = self._get_column_name(validation_results)
content_blocks = []
remaining_evrs, content_block = self._render_header(validation_results)
content_blocks.append(content_block)
remaining_evrs, content_block = self._render_table(remaining_evrs)
content_blocks.append(content_block)
return RenderedSectionContent(
**{"section_name": column, "content_blocks": content_blocks}
)
def test_render_section_page():
section = RenderedSectionContent(
**{
"section_name": None,
"content_blocks": [
RenderedHeaderContent(
**{
"content_block_type": "header",
"header": "Overview",
}
),
RenderedTableContent(
**{
"content_block_type": "table",
"header": "Dataset info",
"table": [
["Number of variables", "12"],
["Number of observations", "891"],
],
"styling": {
"classes": ["col-6", "table-responsive"],
"styles": {"margin-top": "20px"},
"body": {"classes": ["table", "table-sm"]},
},
}
),
],
}
)
rendered_doc = ge.render.view.view.DefaultMarkdownPageView().render(
RenderedDocumentContent(sections=[section])
)
rendered_doc = rendered_doc.replace(" ", "").replace("\t", "").replace("\n", "")
assert (
rendered_doc
== """
#ValidationResults
##Overview
###Datasetinfo
||||------------|------------|Numberofvariables|12Numberofobservations|891
-----------------------------------------------------------
Poweredby[GreatExpectations](https://greatexpectations.io/)
""".replace(
" ", ""
)
.replace("\t", "")
.replace("\n", "")
)
def render(self, expectations):
column = self._get_column_name(expectations)
content_blocks = []
remaining_expectations, header_block = self._render_header(
expectations)
content_blocks.append(header_block)
# remaining_expectations, content_blocks = cls._render_column_type(
# remaining_expectations, content_blocks)
remaining_expectations, bullet_block = self._render_bullet_list(
remaining_expectations)
content_blocks.append(bullet_block)
# NOTE : Some render* functions return None so we filter them out
populated_content_blocks = list(filter(None, content_blocks))
return RenderedSectionContent(section_name=column,
content_blocks=populated_content_blocks)
def render(cls, evrs, section_name=None):
content_blocks = []
# NOTE: I don't love the way this builds content_blocks as a side effect.
# The top-level API is clean and scannable, but the function internals are counterintutitive and hard to test.
# I wonder if we can enable something like jquery chaining for this. That would be concise AND testable.
# Pressing on for now...
cls._render_header(evrs, content_blocks)
cls._render_dataset_info(evrs, content_blocks)
cls._render_variable_types(evrs, content_blocks)
cls._render_warnings(evrs, content_blocks)
cls._render_expectation_types(evrs, content_blocks)
return RenderedSectionContent(**{
"section_name": section_name,
"content_blocks": content_blocks
})
def render(self, expectations):
if isinstance(expectations, dict):
expectations = ExpectationSuite(**expectations, data_context=None)
(
columns,
ordered_columns,
) = expectations.get_grouped_and_ordered_expectations_by_column()
expectation_suite_name = expectations.expectation_suite_name
overview_content_blocks = [
self._render_expectation_suite_header(),
self._render_expectation_suite_info(expectations),
]
table_level_expectations_content_block = self._render_table_level_expectations(
columns)
if table_level_expectations_content_block is not None:
overview_content_blocks.append(
table_level_expectations_content_block)
asset_notes_content_block = self._render_expectation_suite_notes(
expectations)
if asset_notes_content_block is not None:
overview_content_blocks.append(asset_notes_content_block)
sections = [
RenderedSectionContent(
**{
"section_name": "Overview",
"content_blocks": overview_content_blocks,
})
]
sections += [
self._column_section_renderer.render(expectations=columns[column])
for column in ordered_columns if column != "_nocolumn"
]
return RenderedDocumentContent(
**{
"renderer_type": "ExpectationSuitePageRenderer",
"page_title": f"Expectations / {str(expectation_suite_name)}",
"expectation_suite_name": expectation_suite_name,
"utm_medium": "expectation-suite-page",
"sections": sections,
})
def test_render_section_page():
section = RenderedSectionContent(
**{
"section_name":
None,
"content_blocks": [
RenderedComponentContent(**{
"content_block_type": "header",
"header": "Overview",
}),
RenderedComponentContent(
**{
"content_block_type":
"table",
"header":
"Dataset info",
"table": [
["Number of variables", "12"],
["Number of observations", "891"],
],
"styling": {
"classes": ["col-6", "table-responsive"],
"styles": {
"margin-top": "20px"
},
"body": {
"classes": ["table", "table-sm"]
}
}
})
]
})
rendered_doc = ge.render.view.view.DefaultJinjaSectionView().render(
RenderedComponentContentWrapper(**{
"section": section,
"section_loop": {
"index": 1
},
})) #.replace(" ", "").replace("\t", "").replace("\n", "")
print(rendered_doc)
rendered_doc = rendered_doc.replace(" ", "").replace("\t",
"").replace("\n", "")
assert rendered_doc == """<div id="section-1" class="ge-section container-fluid">
<div class="row">
<div id="content-block-1" >
<div id="content-block-1-header" >
<h3>
Overview
</h3></div>
</div>
<div id="content-block-2" class="col-6 table-responsive" style="margin-top:20px;" >
<div id="content-block-2-header" >
<h4>
Dataset info
</h4>
</div>
<table id="content-block-2-body" class="table table-sm" >
<tr>
<td id="content-block-2-cell-1-1" ><div class="table-cell-frame"><span>Number of variables</span></div></td><td id="content-block-2-cell-1-2" ><div class="table-cell-frame"><span>12</span></div></td></tr><tr>
<td id="content-block-2-cell-2-1" ><div class="table-cell-frame"><span>Number of observations</span></div></td><td id="content-block-2-cell-2-2" ><div class="table-cell-frame"><span>891</span></div></td></tr></table>
</div>
</div>
</div>""".replace(" ", "").replace("\t", "").replace("\n", "")
def test_render_section_page():
section = RenderedSectionContent(
**{
"section_name":
None,
"content_blocks": [
RenderedHeaderContent(**{
"content_block_type": "header",
"header": "Overview",
}),
RenderedTableContent(
**{
"content_block_type":
"table",
"header":
"Dataset info",
"table": [
["Number of variables", "12"],
["Number of observations", "891"],
],
"styling": {
"classes": ["col-6", "table-responsive"],
"styles": {
"margin-top": "20px"
},
"body": {
"classes": ["table", "table-sm"]
},
},
}),
],
}).to_json_dict()
rendered_doc = ge.render.view.view.DefaultJinjaSectionView().render({
"section":
section,
"section_loop": {
"index": 1
},
}) # .replace(" ", "").replace("\t", "").replace("\n", "")
print(rendered_doc)
rendered_doc = rendered_doc.replace(" ", "").replace("\t",
"").replace("\n", "")
assert (
rendered_doc ==
"""<div id="section-1" class="ge-section container-fluid mb-1 pb-1 pl-sm-3 px-0">
<div class="row" >
<div id="content-block-1" >
<div id="content-block-1-header" >
<h5>
Overview
</h5>
</div>
</div>
<div id="content-block-2" class="col-6 table-responsive" style="margin-top:20px;" >
<div id="content-block-2-header" >
<h5>
Dataset info
</h5>
</div>
<table
id="content-block-2-body"
class="table table-sm"
data-toggle="table"
>
<thead hidden>
<tr>
<th>
</th>
<th>
</th>
</tr>
</thead>
<tbody>
<tr>
<td id="content-block-2-cell-1-1" ><div class="show-scrollbars">Number of variables</div></td><td id="content-block-2-cell-1-2" ><div class="show-scrollbars">12</div></td></tr><tr>
<td id="content-block-2-cell-2-1" ><div class="show-scrollbars">Number of observations</div></td><td id="content-block-2-cell-2-2" ><div class="show-scrollbars">891</div></td></tr></tbody>
</table>
</div>
</div>
</div>""".replace(" ", "").replace("\t", "").replace("\n", ""))
def render(cls, index_links_dict):
sections = []
cta_object = index_links_dict.pop("cta_object", None)
try:
content_blocks = []
# site name header
site_name_header_block = RenderedHeaderContent(
**{
"content_block_type":
"header",
"header":
RenderedStringTemplateContent(
**{
"content_block_type": "string_template",
"string_template": {
"template": "$title_prefix | $site_name",
"params": {
"site_name": index_links_dict.get(
"site_name"),
"title_prefix": "Data Docs"
},
"styling": {
"params": {
"title_prefix": {
"tag": "strong"
}
}
},
}
}),
"styling": {
"classes": ["col-12", "ge-index-page-site-name-title"],
"header": {
"classes": ["alert", "alert-secondary"]
}
}
})
content_blocks.append(site_name_header_block)
table_rows = []
table_header_row = []
link_list_keys_to_render = []
header_dict = OrderedDict(
[["expectations_links", "Expectation Suite"],
["validations_links", "Validation Results (run_id)"]])
for link_lists_key, header in header_dict.items():
if index_links_dict.get(link_lists_key):
class_header_str = link_lists_key.replace("_", "-")
class_str = "ge-index-page-table-{}-header".format(
class_header_str)
header = RenderedStringTemplateContent(
**{
"content_block_type": "string_template",
"string_template": {
"template": header,
"params": {},
"styling": {
"classes": [class_str],
}
}
})
table_header_row.append(header)
link_list_keys_to_render.append(link_lists_key)
generator_table = RenderedTableContent(
**{
"content_block_type": "table",
"header_row": table_header_row,
"table": table_rows,
"styling": {
"classes": ["col-12", "ge-index-page-table-container"],
"styles": {
"margin-top": "10px"
},
"body": {
"classes": [
"table", "table-sm",
"ge-index-page-generator-table"
]
}
}
})
table_rows += cls._generate_links_table_rows(
index_links_dict,
link_list_keys_to_render=link_list_keys_to_render)
content_blocks.append(generator_table)
if index_links_dict.get("profiling_links"):
profiling_table_rows = []
for profiling_link_dict in index_links_dict.get(
"profiling_links"):
profiling_table_rows.append([
RenderedStringTemplateContent(
**{
"content_block_type": "string_template",
"string_template": {
"template": "$link_text",
"params": {
"link_text":
profiling_link_dict[
"expectation_suite_name"] + "." +
profiling_link_dict["batch_identifier"]
},
"tag": "a",
"styling": {
"attributes": {
"href":
profiling_link_dict["filepath"]
},
"classes": [
"ge-index-page-table-expectation-suite-link"
]
}
},
})
])
content_blocks.append(
RenderedTableContent(
**{
"content_block_type": "table",
"header_row": ["Profiling Results"],
"table": profiling_table_rows,
"styling": {
"classes":
["col-12", "ge-index-page-table-container"],
"styles": {
"margin-top": "10px"
},
"body": {
"classes": [
"table", "table-sm",
"ge-index-page-generator-table"
]
}
}
}))
section = RenderedSectionContent(
**{
"section_name": index_links_dict.get("site_name"),
"content_blocks": content_blocks
})
sections.append(section)
index_page_document = RenderedDocumentContent(
**{
"renderer_type": "SiteIndexPageRenderer",
"utm_medium": "index-page",
"sections": sections
})
if cta_object:
index_page_document.cta_footer = CallToActionRenderer.render(
cta_object)
return index_page_document
except Exception as e:
logger.error("Exception occurred during data docs rendering: ",
e,
exc_info=True)
def render(cls, index_links_dict):
sections = []
for source, generators in index_links_dict.items():
content_blocks = []
# datasource header
source_header_block = RenderedComponentContent(
**{
"content_block_type": "header",
"header": source,
"styling": {
"classes": ["col-12"],
"header": {
"classes": ["alert", "alert-secondary"]
}
}
})
content_blocks.append(source_header_block)
# generator header
for generator, data_assets in generators.items():
generator_header_block = RenderedComponentContent(
**{
"content_block_type": "header",
"header": generator,
"styling": {
"classes": ["col-12", "ml-4"],
}
})
content_blocks.append(generator_header_block)
horizontal_rule = RenderedComponentContent(
**{
"content_block_type": "string_template",
"string_template": {
"template": "",
"params": {},
"tag": "hr"
},
"styling": {
"classes": ["col-12"],
}
})
content_blocks.append(horizontal_rule)
generator_table_rows = []
generator_table_header_row = ["Data Asset"]
header_dict = OrderedDict(
[["profiling_links", "Profiling Results"],
["expectation_suite_links", "Expectation Suite"],
["validation_links", "Validation Results"]])
for link_lists_key, header in header_dict.items():
for data_asset, link_lists in data_assets.items():
if header in generator_table_header_row:
continue
if link_lists[link_lists_key]:
generator_table_header_row.append(header)
generator_table = RenderedComponentContent(
**{
"content_block_type": "table",
"header_row": generator_table_header_row,
"table": generator_table_rows,
"styling": {
"classes": ["col-12"],
"styles": {
"margin-top": "10px"
},
"body": {
"classes": ["table", "table-sm"]
}
}
})
# data_assets
for data_asset, link_lists in data_assets.items():
generator_table_rows += cls._generate_data_asset_table_section(
data_asset, link_lists)
content_blocks.append(generator_table)
section = RenderedSectionContent(**{
"section_name": source,
"content_blocks": content_blocks
})
sections.append(section)
return RenderedDocumentContent(**{
"utm_medium": "index-page",
"sections": sections
})
def render(cls, index_links_dict):
sections = []
cta_object = index_links_dict.pop("cta_object", None)
try:
content_blocks = []
# site name header
site_name_header_block = RenderedHeaderContent(
**{
"content_block_type":
"header",
"header":
RenderedStringTemplateContent(
**{
"content_block_type": "string_template",
"string_template": {
"template": "$title_prefix | $site_name",
"params": {
"site_name": index_links_dict.get(
"site_name"),
"title_prefix": "Data Docs"
},
"styling": {
"params": {
"title_prefix": {
"tag": "strong"
}
}
},
}
}),
"styling": {
"classes": ["col-12", "ge-index-page-site-name-title"],
"header": {
"classes": ["alert", "alert-secondary"]
}
}
})
content_blocks.append(site_name_header_block)
table_rows = []
table_header_row = []
link_list_keys_to_render = []
header_dict = OrderedDict(
[["expectations_links", "Expectation Suite"],
["validations_links", "Validation Results (run_id)"]])
for link_lists_key, header in header_dict.items():
if index_links_dict.get(link_lists_key):
class_header_str = link_lists_key.replace("_", "-")
class_str = "ge-index-page-table-{}-header".format(
class_header_str)
header = RenderedStringTemplateContent(
**{
"content_block_type": "string_template",
"string_template": {
"template": header,
"params": {},
"styling": {
"classes": [class_str],
}
}
})
table_header_row.append(header)
link_list_keys_to_render.append(link_lists_key)
generator_table = RenderedTableContent(
**{
"content_block_type": "table",
"header_row": table_header_row,
"table": table_rows,
"styling": {
"classes": ["col-12", "ge-index-page-table-container"],
"styles": {
"margin-top": "10px"
},
"body": {
"classes": [
"table", "table-sm",
"ge-index-page-generator-table"
]
}
}
})
table_rows += cls._generate_links_table_rows(
index_links_dict,
link_list_keys_to_render=link_list_keys_to_render)
content_blocks.append(generator_table)
if index_links_dict.get("profiling_links"):
profiling_table_rows = []
for profiling_link_dict in index_links_dict.get(
"profiling_links"):
profiling_table_rows.append([
RenderedStringTemplateContent(
**{
"content_block_type": "string_template",
"string_template": {
"template": "$link_text",
"params": {
"link_text":
profiling_link_dict[
"expectation_suite_name"] + "." +
profiling_link_dict["batch_identifier"]
},
"tag": "a",
"styling": {
"attributes": {
"href":
profiling_link_dict["filepath"]
},
"classes": [
"ge-index-page-table-expectation-suite-link"
]
}
},
})
])
content_blocks.append(
RenderedTableContent(
**{
"content_block_type": "table",
"header_row": ["Profiling Results"],
"table": profiling_table_rows,
"styling": {
"classes":
["col-12", "ge-index-page-table-container"],
"styles": {
"margin-top": "10px"
},
"body": {
"classes": [
"table", "table-sm",
"ge-index-page-generator-table"
]
}
}
}))
section = RenderedSectionContent(
**{
"section_name": index_links_dict.get("site_name"),
"content_blocks": content_blocks
})
sections.append(section)
index_page_document = RenderedDocumentContent(
**{
"renderer_type": "SiteIndexPageRenderer",
"utm_medium": "index-page",
"sections": sections
})
if cta_object:
index_page_document.cta_footer = CallToActionRenderer.render(
cta_object)
return index_page_document
except Exception as e:
exception_message = f'''\
An unexpected Exception occurred during data docs rendering. Because of this error, certain parts of data docs will \
not be rendered properly and/or may not appear altogether. Please use the trace, included in this message, to \
diagnose and repair the underlying issue. Detailed information follows:
'''
exception_traceback = traceback.format_exc()
exception_message += f'{type(e).__name__}: "{str(e)}". Traceback: "{exception_traceback}".'
logger.error(exception_message, e, exc_info=True)
def render(cls, ge_dict=None):
if ge_dict is None:
ge_dict = {}
return RenderedDocumentContent(**{
"renderer_type": "CustomValidationResultsPageRenderer",
"data_asset_name": "my_data_asset_name",
"full_data_asset_identifier": "my_datasource/my_generator/my_generator_asset",
"page_title": "My Page Title",
"sections": [
RenderedSectionContent(**{
"section_name": "Header Content Block",
"content_blocks": [
cls._get_header_content_block(header="Header Content Block", subheader="subheader")]
}),
RenderedSectionContent(**{
"section_name": "Bullet List Content Block",
"content_blocks": [
cls._get_header_content_block(header="Bullet List Content Block"),
cls._get_bullet_list_content_block(header="My Important List",
subheader="Unremarkable Subheader")
]
}),
RenderedSectionContent(**{
"section_name": "Table Content Block",
"content_blocks": [
cls._get_header_content_block(header="Table Content Block"),
cls._get_table_content_block(header="My Big Data Table"),
]
}),
RenderedSectionContent(**{
"section_name": "Value List Content Block",
"content_blocks": [
cls._get_header_content_block(header="Value List Content Block"),
cls._get_value_list_content_block(header="My Name Value List"),
]
}),
RenderedSectionContent(**{
"section_name": "Graph Content Block",
"content_blocks": [
cls._get_header_content_block(header="Graph Content Block"),
cls._get_graph_content_block(header="My Big Data Graph"),
]
}),
RenderedSectionContent(**{
"section_name": "String Template Content Block With Icon",
"content_blocks": [
cls._get_header_content_block(header="String Template Content Block With Icon"),
cls._get_string_template_content_block()
]
}),
RenderedSectionContent(**{
"section_name": "String Template Content Block With Tooltip",
"content_blocks": [
cls._get_header_content_block(header="String Template Content Block With Tooltip"),
cls._get_tooltip_string_template_content_block()
]
}),
RenderedSectionContent(**{
"section_name": "Multiple Content Block Section",
"content_blocks": [
cls._get_header_content_block(header="Multiple Content Block Section"),
cls._get_graph_content_block(header="My col-4 Graph", col=4),
cls._get_graph_content_block(header="My col-4 Graph", col=4),
cls._get_graph_content_block(header="My col-4 Graph", col=4),
cls._get_table_content_block(header="My col-6 Table", col=6),
cls._get_bullet_list_content_block(header="My col-6 List", subheader="subheader", col=6)
]
}),
]
})
def render(cls, index_links_dict):
sections = []
cta_object = index_links_dict.pop("cta_object", None)
for source, generators in index_links_dict.items():
content_blocks = []
# datasource header
source_header_block = RenderedComponentContent(
**{
"content_block_type": "header",
"header": {
"template": "$title_prefix | $source",
"params": {
"source": source,
"title_prefix": "Datasource"
},
"styling": {
"params": {
"title_prefix": {
"tag": "strong"
}
}
},
},
"styling": {
"classes":
["col-12", "ge-index-page-datasource-title"],
"header": {
"classes": ["alert", "alert-secondary"]
}
}
})
content_blocks.append(source_header_block)
# generator header
for generator, data_assets in generators.items():
generator_header_block = RenderedComponentContent(
**{
"content_block_type": "header",
"subheader": {
"template": "$title_prefix | $generator",
"params": {
"generator": generator,
"title_prefix": "Data Asset Generator"
},
"styling": {
"params": {
"title_prefix": {
"tag": "strong"
}
}
},
},
"styling": {
"classes": [
"col-12", "ml-4",
"ge-index-page-generator-title"
],
}
})
content_blocks.append(generator_header_block)
generator_table_rows = []
generator_table_header_row = [
RenderedComponentContent(
**{
"content_block_type": "string_template",
"string_template": {
"template": "Data Asset",
"params": {},
"styling": {
"classes": [
"ge-index-page-generator-table-data-asset-header"
],
}
}
})
]
link_list_keys_to_render = []
header_dict = OrderedDict(
[["profiling_links", "Profiling Results"],
["expectations_links", "Expectation Suite"],
["validations_links", "Validation Results"]])
for link_lists_key, header in header_dict.items():
for data_asset, link_lists in data_assets.items():
if header in generator_table_header_row:
continue
if link_lists.get(link_lists_key):
class_header_str = link_lists_key.replace("_", "-")
class_str = "ge-index-page-generator-table-{}-header".format(
class_header_str)
header = RenderedComponentContent(
**{
"content_block_type": "string_template",
"string_template": {
"template": header,
"params": {},
"styling": {
"classes": [class_str],
}
}
})
generator_table_header_row.append(header)
link_list_keys_to_render.append(link_lists_key)
generator_table = RenderedComponentContent(
**{
"content_block_type": "table",
"header_row": generator_table_header_row,
"table": generator_table_rows,
"styling": {
"classes": [
"col-12",
"ge-index-page-generator-table-container",
"pl-5", "pr-4"
],
"styles": {
"margin-top": "10px"
},
"body": {
"classes": [
"table", "table-sm",
"ge-index-page-generator-table"
]
}
}
})
# data_assets
for data_asset, link_lists in data_assets.items():
generator_table_rows += cls._generate_data_asset_table_section(
data_asset,
link_lists,
link_list_keys_to_render=link_list_keys_to_render)
content_blocks.append(generator_table)
section = RenderedSectionContent(**{
"section_name": source,
"content_blocks": content_blocks
})
sections.append(section)
index_page_document = RenderedDocumentContent(**{
"utm_medium": "index-page",
"sections": sections
})
if cta_object:
index_page_document["cta_footer"] = CallToActionRenderer.render(
cta_object)
return index_page_document
def render(cls, index_links_dict):
sections = []
cta_object = index_links_dict.pop("cta_object", None)
try:
content_blocks = []
# site name header
site_name_header_block = RenderedHeaderContent(
**{
"content_block_type":
"header",
"header":
RenderedStringTemplateContent(
**{
"content_block_type": "string_template",
"string_template": {
"template": "$title_prefix | $site_name",
"params": {
"site_name": index_links_dict.get(
"site_name"),
"title_prefix": "Data Docs",
},
"styling": {
"params": {
"title_prefix": {
"tag": "strong"
}
}
},
},
}),
"styling": {
"classes": ["col-12", "ge-index-page-site-name-title"],
"header": {
"classes": ["alert", "alert-secondary"]
},
},
})
content_blocks.append(site_name_header_block)
tabs = []
if index_links_dict.get("validations_links"):
tabs.append({
"tab_name":
"Validation Results",
"tab_content":
cls._generate_validation_results_link_table(
index_links_dict),
})
if index_links_dict.get("profiling_links"):
tabs.append({
"tab_name":
"Profiling Results",
"tab_content":
cls._generate_profiling_results_link_table(
index_links_dict),
})
if index_links_dict.get("expectations_links"):
tabs.append({
"tab_name":
"Expectation Suites",
"tab_content":
cls._generate_expectation_suites_link_table(
index_links_dict),
})
tabs_content_block = RenderedTabsContent(
**{
"tabs": tabs,
"styling": {
"classes": ["col-12", "ge-index-page-tabs-container"],
},
})
content_blocks.append(tabs_content_block)
section = RenderedSectionContent(
**{
"section_name": index_links_dict.get("site_name"),
"content_blocks": content_blocks,
})
sections.append(section)
index_page_document = RenderedDocumentContent(
**{
"renderer_type": "SiteIndexPageRenderer",
"utm_medium": "index-page",
"sections": sections,
})
if cta_object:
index_page_document.cta_footer = CallToActionRenderer.render(
cta_object)
return index_page_document
except Exception as e:
exception_message = f"""\
An unexpected Exception occurred during data docs rendering. Because of this error, certain parts of data docs will \
not be rendered properly and/or may not appear altogether. Please use the trace, included in this message, to \
diagnose and repair the underlying issue. Detailed information follows:
"""
exception_traceback = traceback.format_exc()
exception_message += (
f'{type(e).__name__}: "{str(e)}". Traceback: "{exception_traceback}".'
)
logger.error(exception_message)
@classmethod
def render(cls, ge_dict=None):
if ge_dict is None:
ge_dict = {}
<<<<<<< HEAD
return RenderedDocumentContent(**{
"renderer_type": "CustomValidationResultsPageRenderer",
"data_asset_name": "my_data_asset_name",
"full_data_asset_identifier": "my_datasource/my_generator/my_generator_asset",
"page_title": "My Page Title",
"sections": [
RenderedSectionContent(**{
"section_name": "Header Content Block",
"content_blocks": [
cls._get_header_content_block(header="Header Content Block", subheader="subheader")]
}),
RenderedSectionContent(**{
"section_name": "Bullet List Content Block",
"content_blocks": [
cls._get_header_content_block(header="Bullet List Content Block"),
cls._get_bullet_list_content_block(header="My Important List",
subheader="Unremarkable Subheader")
]
}),
RenderedSectionContent(**{
"section_name": "Table Content Block",
"content_blocks": [
cls._get_header_content_block(header="Table Content Block"),
cls._get_table_content_block(header="My Big Data Table"),
