-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop' into pre_pr-prototype/alexsherstinsky/rule_bas…
…ed_profiler/fix_values_range_self_initializing_expectation-2022_05_09-124
- Loading branch information
Showing
3 changed files
with
224 additions
and
78 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
120 changes: 120 additions & 0 deletions
120
great_expectations/rule_based_profiler/types/data_assistant_result/plot_components.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| from dataclasses import dataclass | ||
| from typing import Optional, Union | ||
|
|
||
| import altair as alt | ||
|
|
||
|
|
||
| @dataclass(frozen=True) | ||
| class PlotComponent: | ||
| name: str | ||
| alt_type: alt.StandardType | ||
|
|
||
| @property | ||
| def title(self) -> str: | ||
| return self.name.replace("_", " ").title() | ||
|
|
||
| def generate_tooltip(self, format: str = "") -> alt.Tooltip: | ||
| """Wrapper arount alt.Tooltip creation. | ||
| Args: | ||
| format (str): Desired format within tooltip | ||
| Returns: | ||
| An instance of alt.Tooltip containing relevant information from the PlotComponent class. | ||
| """ | ||
| return alt.Tooltip( | ||
| field=self.name, | ||
| type=self.alt_type, | ||
| title=self.title, | ||
| format=format, | ||
| ) | ||
|
|
||
| def plot_on_axis(self) -> Union[alt.X, alt.Y]: | ||
| """Wrapper around alt.X/alt.Y plotting utility. | ||
| Returns: | ||
| Either an alt.X or alt.Y instance based on desired axis. | ||
| """ | ||
| raise NotImplementedError | ||
|
|
||
|
|
||
| @dataclass(frozen=True) | ||
| class MetricPlotComponent(PlotComponent): | ||
| def plot_on_axis(self) -> alt.Y: | ||
| """ | ||
| Plots metric on Y axis - see parent `PlotComponent` for more details. | ||
| """ | ||
| return alt.Y( | ||
| self.name, | ||
| type=self.alt_type, | ||
| title=self.title, | ||
| ) | ||
|
|
||
|
|
||
| @dataclass(frozen=True) | ||
| class DomainPlotComponent(PlotComponent): | ||
| subtitle: Optional[str] = None | ||
|
|
||
| @property | ||
| def title(self) -> str: | ||
| return self.name.title() | ||
|
|
||
| def plot_on_axis(self) -> alt.X: | ||
| """ | ||
| Plots domain on X axis - see parent `PlotComponent` for more details. | ||
| """ | ||
| return alt.X( | ||
| self.name, | ||
| type=self.alt_type, | ||
| title=self.title, | ||
| ) | ||
|
|
||
|
|
||
| @dataclass(frozen=True) | ||
| class BatchPlotComponent(PlotComponent): | ||
| @property | ||
| def title(self) -> str: | ||
| return self.name.replace("_", " ").title().replace("Id", "ID") | ||
|
|
||
|
|
||
| @dataclass(frozen=True) | ||
| class ExpectationKwargPlotComponent(PlotComponent): | ||
| metric_plot_component: MetricPlotComponent | ||
|
|
||
| def plot_on_axis(self) -> alt.Y: | ||
| """ | ||
| Plots domain on Y axis - see parent `PlotComponent` for more details. | ||
| """ | ||
| return alt.Y( | ||
| self.name, | ||
| type=self.metric_plot_component.alt_type, | ||
| title=self.metric_plot_component.title, | ||
| ) | ||
|
|
||
|
|
||
| def determine_plot_title( | ||
| metric_plot_component: MetricPlotComponent, | ||
| domain_plot_component: DomainPlotComponent, | ||
| ) -> alt.TitleParams: | ||
| """Determines the appropriate title for a chart based on input componentsself. | ||
| Conditionally renders a subtitle if relevant (specifically with column domain) | ||
| Args: | ||
| metric_plot_component: Plot utility corresponding to a given metric. | ||
| domain_plot_component: Plot utility corresponding to a given domain. | ||
| Returns: | ||
| An Altair TitleParam object | ||
| """ | ||
| contents: str = f"{metric_plot_component.title} per {domain_plot_component.title}" | ||
| subtitle: Optional[str] = domain_plot_component.subtitle | ||
|
|
||
| title: alt.TitleParams | ||
| if subtitle: | ||
| title = alt.TitleParams(contents, subtitle=[subtitle]) | ||
| else: | ||
| title = alt.TitleParams(contents) | ||
|
|
||
| return title |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters