Skip to main content
Version: 1.0 prerelease

RuleBasedProfilerResult

class great_expectations.rule_based_profiler.RuleBasedProfilerResult(fully_qualified_parameter_names_by_domain: Dict[great_expectations.core.domain.Domain, List[str]], parameter_values_for_fully_qualified_parameter_names_by_domain: Optional[Dict[great_expectations.core.domain.Domain, Dict[str, great_expectations.rule_based_profiler.parameter_container.ParameterNode]]], expectation_configurations: List[great_expectations.expectations.expectation_configuration.ExpectationConfiguration], citation: dict, rule_domain_builder_execution_time: Dict[str, float], rule_execution_time: Dict[str, float], rule_exception_tracebacks: Dict[str, Optional[str]], catch_exceptions: bool = False)#

RuleBasedProfilerResult is an immutable dataclass object which holds the results of executing the RuleBasedProfiler.run() method.

Properties represents the configuration of the Rule-Based Profiler (effective configuration if run via a DataAssistant or auto-initializing expectation), with all run-time overrides properly reconciled.

Parameters:

  • fully_qualified_parameter_names_by_domain – dict of Domain keys and a list of their parameter names.

  • parameter_values_for_fully_qualified_parameter_names_by_domain – dict of Domain and nested ParameterNode mappings.

  • expectation_configurations – List of ExpectationConfiguration objects.

  • citation – dict of citations.

  • catch_exceptions (boolean) – Defaults to False. If True, then catch exceptions and include them as part of the result object. For more detail, see [catch_exceptions](Standard Arguments).

get_expectation_suite(expectation_suite_name: str)→ great_expectations.core.expectation_suite.ExpectationSuite#

Retrieve the ExpectationSuite generated during the RuleBasedProfiler run.

Parameters:

expectation_suite_name – The name of the desired ExpectationSuite.

Returns:

ExpectationSuite

to_json_dict()→ dict[str, JSONValues]#

Returns the RuleBasedProfilerResult as a JSON-serializable dictionary.

Returns:

Dictionary containing only JSON compatible python primitives.