great_expectations.expectations.core.expect_column_values_to_match_regex

Module Contents

Classes

ExpectColumnValuesToMatchRegex(configuration: Optional[ExpectationConfiguration] = None)

Expect column entries to be strings that match a given regular expression.

class great_expectations.expectations.core.expect_column_values_to_match_regex.ExpectColumnValuesToMatchRegex(configuration: Optional[ExpectationConfiguration] = None)

Bases: great_expectations.expectations.expectation.ColumnMapExpectation

Expect column entries to be strings that match a given regular expression.

Valid matches can be found anywhere in the string, for example “[at]+” will identify the following strings as expected: “cat”, “hat”, “aa”, “a”, and “t”, and the following strings as unexpected: “fish”, “dog”.

expect_column_values_to_match_regex is a column_map_expectation.

Parameters
  • column (str) – The column name.

  • regex (str) – The regular expression the column entries should match.

Keyword Arguments

mostly (None or a float between 0 and 1) – Return “success”: True if at least mostly fraction of values match the expectation. For more detail, see mostly.

Other Parameters
  • result_format (str or None) – Which output mode to use: BOOLEAN_ONLY, BASIC, COMPLETE, or SUMMARY. For more detail, see result_format.

  • include_config (boolean) – If True, then include the expectation config as part of the result object. For more detail, see include_config.

  • 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.

  • meta (dict or None) – A JSON-serializable dictionary (nesting allowed) that will be included in the output without modification. For more detail, see meta.

Returns

An ExpectationSuiteValidationResult

Exact fields vary depending on the values passed to result_format and include_config, catch_exceptions, and meta.

See also

expect_column_values_to_not_match_regex

expect_column_values_to_match_regex_list

library_metadata
map_metric = column_values.match_regex
success_keys = ['regex', 'mostly']
default_kwarg_values
examples
validate_configuration(self, configuration: Optional[ExpectationConfiguration])
classmethod _question_renderer(cls, configuration, result=None, language=None, runtime_configuration=None)
classmethod _answer_renderer(cls, configuration=None, result=None, language=None, runtime_configuration=None)
classmethod _prescriptive_renderer(cls, configuration=None, result=None, language=None, runtime_configuration=None, **kwargs)