great_expectations.expectations.core.expect_table_column_count_to_equal
¶
Module Contents¶
Classes¶
|
Expect the number of columns to equal a value. |
-
class
great_expectations.expectations.core.expect_table_column_count_to_equal.
ExpectTableColumnCountToEqual
(configuration: Optional[ExpectationConfiguration] = None)¶ Bases:
great_expectations.expectations.expectation.TableExpectation
Expect the number of columns to equal a value.
expect_table_column_count_to_equal is a [Table Expectation](https://docs.greatexpectations.io/docs/guides/expectations/creating_custom_expectations/how_to_create_custom_table_expectations).
- Parameters
value (int) – The expected number of columns.
- Other Parameters
result_format (str or None) – Which output mode to use: BOOLEAN_ONLY, BASIC, COMPLETE, or SUMMARY. For more detail, see [result_format](https://docs.greatexpectations.io/docs/reference/expectations/result_format).
include_config (boolean) – If True, then include the expectation config as part of the result object.
catch_exceptions (boolean or None) – If True, then catch exceptions and include them as part of the result object. For more detail, see [catch_exceptions](https://docs.greatexpectations.io/docs/reference/expectations/standard_arguments/#catch_exceptions).
meta (dict or None) – A JSON-serializable dictionary (nesting allowed) that will be included in the output without modification. For more detail, see [meta](https://docs.greatexpectations.io/docs/reference/expectations/standard_arguments/#meta).
- Returns
//docs.greatexpectations.io/docs/terms/validation_result)
Exact fields vary depending on the values passed to result_format, include_config, catch_exceptions, and meta.
- Return type
An [ExpectationSuiteValidationResult](https
See also
[expect_table_column_count_to_be_between](https://greatexpectations.io/expectations/expect_table_column_count_to_be_between)
-
library_metadata
¶
-
metric_dependencies
= ['table.column_count']¶
-
success_keys
= ['value']¶
-
default_kwarg_values
¶
-
args_keys
= ['value']¶ A Metric Decorator for the Column Count
-
validate_configuration
(self, configuration: Optional[ExpectationConfiguration])¶ Validates that a configuration has been set, and sets a configuration if it has yet to be set. Ensures that necessary configuration arguments have been provided for the validation of the expectation.
- Parameters
configuration (OPTIONAL[ExpectationConfiguration]) – An optional Expectation Configuration entry that will be used to configure the expectation
- Returns
None. Raises InvalidExpectationConfigurationError if the config is not validated successfully
-
classmethod
_atomic_prescriptive_template
(cls, configuration: Optional[ExpectationConfiguration] = None, result: Optional[ExpectationValidationResult] = None, runtime_configuration: Optional[dict] = None, **kwargs)¶ Template function that contains the logic that is shared by AtomicPrescriptiveRendererType.SUMMARY and LegacyRendererType.PRESCRIPTIVE.
-
classmethod
_prescriptive_renderer
(cls, configuration: Optional[ExpectationConfiguration] = None, result: Optional[ExpectationValidationResult] = None, runtime_configuration: Optional[dict] = None, **kwargs)¶
-
_validate
(self, configuration: ExpectationConfiguration, metrics: Dict, runtime_configuration: Optional[dict] = None, execution_engine: Optional[ExecutionEngine] = None)¶