great_expectations.rule_based_profiler

Package Contents

Classes

RuleBasedProfiler(*, name: str, config_version: float, variables: Optional[Dict[str, Any]] = None, rules: Dict[str, CommentedMap], data_context: Optional[‘DataContext’] = None)

RuleBasedProfiler object serves to profile, or automatically evaluate a set of rules, upon a given

class great_expectations.rule_based_profiler.RuleBasedProfiler(*, name: str, config_version: float, variables: Optional[Dict[str, Any]] = None, rules: Dict[str, CommentedMap], data_context: Optional['DataContext'] = None)

RuleBasedProfiler object serves to profile, or automatically evaluate a set of rules, upon a given batch / multiple batches of data.

Feature Maturity

icon-92069b227e8811ecadad0242ac110002 Rule-Based Profiler - How-to Guide
Use YAML to configure a flexible Profiler engine, which will then generate an ExpectationSuite for a data set
Maturity: Experimental
Details:
API Stability: Low (instantiation of Profiler and the signature of the run() method will change)
Implementation Completeness: Moderate (some augmentation and/or growth in capabilities is to be expected)
Unit Test Coverage: High (but not complete – additional unit tests will be added, commensurate with the upcoming new functionality)
Integration Infrastructure/Test Coverage: N/A -> TBD
Documentation Completeness: Moderate
Bug Risk: Low/Moderate
Expectation Completeness: Moderate
icon-92069cf87e8811ecadad0242ac110002 Domain Builders - How-to Guide
Use YAML to build domains for ExpectationConfiguration generator (table, column, semantic types, etc.)
Maturity: Experimental
Details:
API Stability: Moderate
Implementation Completeness: Moderate (additional DomainBuilder classes will be developed)
Unit Test Coverage: High (but not complete – additional unit tests will be added, commensurate with the upcoming new functionality)
Integration Infrastructure/Test Coverage: N/A -> TBD
Documentation Completeness: Moderate
Bug Risk: Low/Moderate
Expectation Completeness: Moderate
icon-92069de87e8811ecadad0242ac110002 Parameter Builders - How-to Guide
Use YAML to configure single and multi batch based parameter computation modules for the use by ExpectationConfigurationBuilder classes
Maturity: Experimental
Details:
API Stability: Moderate
Implementation Completeness: Moderate (additional ParameterBuilder classes will be developed)
Unit Test Coverage: High (but not complete – additional unit tests will be added, commensurate with the upcoming new functionality)
Integration Infrastructure/Test Coverage: N/A -> TBD
Documentation Completeness: Moderate
Bug Risk: Low/Moderate
Expectation Completeness: Moderate
icon-92069eba7e8811ecadad0242ac110002 ExpectationConfiguration Builders - How-to Guide
Use YAML to configure ExpectationConfigurationBuilder classes, which emit lists of ExpectationConfiguration objects (e.g., as kwargs and meta arguments)
Maturity: Experimental
Details:
API Stability: Moderate
Implementation Completeness: Moderate (additional ExpectationConfigurationBuilder classes might be developed)
Unit Test Coverage: High (but not complete – additional unit tests will be added, commensurate with the upcoming new functionality)
Integration Infrastructure/Test Coverage: N/A -> TBD
Documentation Completeness: Moderate
Bug Risk: Low/Moderate
Expectation Completeness: Moderate
static _init_rules(rules: Dict[str, CommentedMap], variables: Dict[str, Any], data_context: Optional['DataContext'] = None)
static _init_domain_builder(domain_builder_config: CommentedMap, data_context: Optional['DataContext'] = None)
static _init_parameter_builders(parameter_builder_configs: Optional[List[CommentedMap]] = None, data_context: Optional['DataContext'] = None)
static _init_expectation_configuration_builders(expectation_configuration_builder_configs: List[CommentedMap])
run(self, *, expectation_suite_name: Optional[str] = None, include_citation: bool = True)

:param : param expectation_suite_name: A name for returned Expectation suite. :param : param include_citation: Whether or not to include the Profiler config in the metadata for the ExpectationSuite produced by the Profiler

Returns

Set of rule evaluation results in the form of an ExpectationSuite