great_expectations.rule_based_profiler.config.base

Module Contents

Classes

NotNullSchema(*, only: types.StrSequenceOrSet = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: typing.Dict = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: typing.Union[bool, types.StrSequenceOrSet] = False, unknown: str = None)

Extension of Marshmallow Schema to facilitate implicit removal of null values before serialization.

DomainBuilderConfig(class_name: str, module_name: Optional[str] = None, batch_request: Optional[Union[dict, str]] = None, **kwargs)

A convenience class for migrating away from untyped dictionaries to stronger typed objects.

DomainBuilderConfigSchema(*, only: types.StrSequenceOrSet = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: typing.Dict = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: typing.Union[bool, types.StrSequenceOrSet] = False, unknown: str = None)

Extension of Marshmallow Schema to facilitate implicit removal of null values before serialization.

ParameterBuilderConfig(name: str, class_name: str, module_name: Optional[str] = None, batch_request: Optional[Union[dict, str]] = None, **kwargs)

A convenience class for migrating away from untyped dictionaries to stronger typed objects.

ParameterBuilderConfigSchema(*, only: types.StrSequenceOrSet = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: typing.Dict = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: typing.Union[bool, types.StrSequenceOrSet] = False, unknown: str = None)

Extension of Marshmallow Schema to facilitate implicit removal of null values before serialization.

ExpectationConfigurationBuilderConfig(expectation_type: str, class_name: str, module_name: Optional[str] = None, meta: Optional[dict] = None, **kwargs)

A convenience class for migrating away from untyped dictionaries to stronger typed objects.

ExpectationConfigurationBuilderConfigSchema(*, only: types.StrSequenceOrSet = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: typing.Dict = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: typing.Union[bool, types.StrSequenceOrSet] = False, unknown: str = None)

Extension of Marshmallow Schema to facilitate implicit removal of null values before serialization.

RuleConfig(expectation_configuration_builders: List[dict], domain_builder: Optional[dict] = None, parameter_builders: Optional[List[dict]] = None)

A convenience class for migrating away from untyped dictionaries to stronger typed objects.

RuleConfigSchema(*, only: types.StrSequenceOrSet = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: typing.Dict = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: typing.Union[bool, types.StrSequenceOrSet] = False, unknown: str = None)

Extension of Marshmallow Schema to facilitate implicit removal of null values before serialization.

RuleBasedProfilerConfig(name: str, config_version: float, rules: Dict[str, dict], class_name: Optional[str] = None, module_name: Optional[str] = None, variables: Optional[Dict[str, Any]] = None, commented_map: Optional[CommentedMap] = None)

A convenience class for migrating away from untyped dictionaries to stronger typed objects.

RuleBasedProfilerConfigSchema(*, only: types.StrSequenceOrSet = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: typing.Dict = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: typing.Union[bool, types.StrSequenceOrSet] = False, unknown: str = None)

Schema classes for configurations which extend from BaseYamlConfig must extend top-level Marshmallow Schema class.

great_expectations.rule_based_profiler.config.base.logger
class great_expectations.rule_based_profiler.config.base.NotNullSchema(*, only: types.StrSequenceOrSet = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: typing.Dict = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: typing.Union[bool, types.StrSequenceOrSet] = False, unknown: str = None)

Bases: great_expectations.marshmallow__shade.Schema

Extension of Marshmallow Schema to facilitate implicit removal of null values before serialization.

The __config_class__ attribute is utilized to point a Schema to a configuration. It is the responsibility of the child class to define its own __config_class__ to ensure proper serialization/deserialization.

Reference: https://marshmallow.readthedocs.io/en/stable/extending.html

make_config(self, data: dict, **kwargs)

Hook to convert the schema object into its respective config type.

Parameters
  • data – The dictionary representation of the configuration object

  • kwargs – Marshmallow-specific kwargs required to maintain hook signature (unused herein)

Returns

An instance of configuration class, which subclasses the DictDot serialization class

Raises

NotImplementedError – If the subclass inheriting NotNullSchema fails to define a __config_class__

remove_nulls_and_keep_unknowns(self, output: dict, original: Type[DictDot], **kwargs)

Hook to clear the config object of any null values before being written as a dictionary. Additionally, it bypasses strict schema validation before writing to dict to ensure that dynamic attributes set through setattr are captured in the resulting object. It is important to note that only public attributes are captured through this process. Chetan - 20220126 - Note that if we tighten up the schema (remove the dynamic setattr behavior), the functionality to keep unknowns should also be removed.

Parameters
  • output – Processed dictionary representation of the configuration object (leaving original intact)

  • original – The dictionary representation of the configuration object

  • kwargs – Marshmallow-specific kwargs required to maintain hook signature (unused herein)

Returns

A cleaned dictionary that has no null values

class great_expectations.rule_based_profiler.config.base.DomainBuilderConfig(class_name: str, module_name: Optional[str] = None, batch_request: Optional[Union[dict, str]] = None, **kwargs)

Bases: great_expectations.types.DictDot

A convenience class for migrating away from untyped dictionaries to stronger typed objects.

Can be instantiated with arguments:

my_A = MyClassA(

foo=”a string”, bar=1,

)

Can be instantiated from a dictionary:

my_A = MyClassA(
**{

“foo”: “a string”, “bar”: 1,

}

)

Can be accessed using both dictionary and dot notation

my_A.foo == “a string” my_A.bar == 1

my_A[“foo”] == “a string” my_A[“bar”] == 1

Pairs nicely with @dataclass:

@dataclass() class MyClassA(DictDot):

foo: str bar: int

Can be made immutable:

@dataclass(frozen=True) class MyClassA(DictDot):

foo: str bar: int

For more examples of usage, please see test_dataclass_serializable_dot_dict_pattern.py in the tests folder.

class great_expectations.rule_based_profiler.config.base.DomainBuilderConfigSchema(*, only: types.StrSequenceOrSet = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: typing.Dict = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: typing.Union[bool, types.StrSequenceOrSet] = False, unknown: str = None)

Bases: great_expectations.rule_based_profiler.config.base.NotNullSchema

Extension of Marshmallow Schema to facilitate implicit removal of null values before serialization.

The __config_class__ attribute is utilized to point a Schema to a configuration. It is the responsibility of the child class to define its own __config_class__ to ensure proper serialization/deserialization.

Reference: https://marshmallow.readthedocs.io/en/stable/extending.html

class Meta
unknown
__config_class__
class_name
module_name
batch_request
class great_expectations.rule_based_profiler.config.base.ParameterBuilderConfig(name: str, class_name: str, module_name: Optional[str] = None, batch_request: Optional[Union[dict, str]] = None, **kwargs)

Bases: great_expectations.types.DictDot

A convenience class for migrating away from untyped dictionaries to stronger typed objects.

Can be instantiated with arguments:

my_A = MyClassA(

foo=”a string”, bar=1,

)

Can be instantiated from a dictionary:

my_A = MyClassA(
**{

“foo”: “a string”, “bar”: 1,

}

)

Can be accessed using both dictionary and dot notation

my_A.foo == “a string” my_A.bar == 1

my_A[“foo”] == “a string” my_A[“bar”] == 1

Pairs nicely with @dataclass:

@dataclass() class MyClassA(DictDot):

foo: str bar: int

Can be made immutable:

@dataclass(frozen=True) class MyClassA(DictDot):

foo: str bar: int

For more examples of usage, please see test_dataclass_serializable_dot_dict_pattern.py in the tests folder.

class great_expectations.rule_based_profiler.config.base.ParameterBuilderConfigSchema(*, only: types.StrSequenceOrSet = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: typing.Dict = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: typing.Union[bool, types.StrSequenceOrSet] = False, unknown: str = None)

Bases: great_expectations.rule_based_profiler.config.base.NotNullSchema

Extension of Marshmallow Schema to facilitate implicit removal of null values before serialization.

The __config_class__ attribute is utilized to point a Schema to a configuration. It is the responsibility of the child class to define its own __config_class__ to ensure proper serialization/deserialization.

Reference: https://marshmallow.readthedocs.io/en/stable/extending.html

class Meta
unknown
__config_class__
name
class_name
module_name
batch_request
class great_expectations.rule_based_profiler.config.base.ExpectationConfigurationBuilderConfig(expectation_type: str, class_name: str, module_name: Optional[str] = None, meta: Optional[dict] = None, **kwargs)

Bases: great_expectations.types.DictDot

A convenience class for migrating away from untyped dictionaries to stronger typed objects.

Can be instantiated with arguments:

my_A = MyClassA(

foo=”a string”, bar=1,

)

Can be instantiated from a dictionary:

my_A = MyClassA(
**{

“foo”: “a string”, “bar”: 1,

}

)

Can be accessed using both dictionary and dot notation

my_A.foo == “a string” my_A.bar == 1

my_A[“foo”] == “a string” my_A[“bar”] == 1

Pairs nicely with @dataclass:

@dataclass() class MyClassA(DictDot):

foo: str bar: int

Can be made immutable:

@dataclass(frozen=True) class MyClassA(DictDot):

foo: str bar: int

For more examples of usage, please see test_dataclass_serializable_dot_dict_pattern.py in the tests folder.

class great_expectations.rule_based_profiler.config.base.ExpectationConfigurationBuilderConfigSchema(*, only: types.StrSequenceOrSet = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: typing.Dict = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: typing.Union[bool, types.StrSequenceOrSet] = False, unknown: str = None)

Bases: great_expectations.rule_based_profiler.config.base.NotNullSchema

Extension of Marshmallow Schema to facilitate implicit removal of null values before serialization.

The __config_class__ attribute is utilized to point a Schema to a configuration. It is the responsibility of the child class to define its own __config_class__ to ensure proper serialization/deserialization.

Reference: https://marshmallow.readthedocs.io/en/stable/extending.html

class Meta
unknown
__config_class__
class_name
module_name
expectation_type
meta
class great_expectations.rule_based_profiler.config.base.RuleConfig(expectation_configuration_builders: List[dict], domain_builder: Optional[dict] = None, parameter_builders: Optional[List[dict]] = None)

Bases: great_expectations.types.DictDot

A convenience class for migrating away from untyped dictionaries to stronger typed objects.

Can be instantiated with arguments:

my_A = MyClassA(

foo=”a string”, bar=1,

)

Can be instantiated from a dictionary:

my_A = MyClassA(
**{

“foo”: “a string”, “bar”: 1,

}

)

Can be accessed using both dictionary and dot notation

my_A.foo == “a string” my_A.bar == 1

my_A[“foo”] == “a string” my_A[“bar”] == 1

Pairs nicely with @dataclass:

@dataclass() class MyClassA(DictDot):

foo: str bar: int

Can be made immutable:

@dataclass(frozen=True) class MyClassA(DictDot):

foo: str bar: int

For more examples of usage, please see test_dataclass_serializable_dot_dict_pattern.py in the tests folder.

class great_expectations.rule_based_profiler.config.base.RuleConfigSchema(*, only: types.StrSequenceOrSet = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: typing.Dict = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: typing.Union[bool, types.StrSequenceOrSet] = False, unknown: str = None)

Bases: great_expectations.rule_based_profiler.config.base.NotNullSchema

Extension of Marshmallow Schema to facilitate implicit removal of null values before serialization.

The __config_class__ attribute is utilized to point a Schema to a configuration. It is the responsibility of the child class to define its own __config_class__ to ensure proper serialization/deserialization.

Reference: https://marshmallow.readthedocs.io/en/stable/extending.html

class Meta
unknown
__config_class__
domain_builder
parameter_builders
expectation_configuration_builders
class great_expectations.rule_based_profiler.config.base.RuleBasedProfilerConfig(name: str, config_version: float, rules: Dict[str, dict], class_name: Optional[str] = None, module_name: Optional[str] = None, variables: Optional[Dict[str, Any]] = None, commented_map: Optional[CommentedMap] = None)

Bases: great_expectations.data_context.types.base.BaseYamlConfig

A convenience class for migrating away from untyped dictionaries to stronger typed objects.

Can be instantiated with arguments:

my_A = MyClassA(

foo=”a string”, bar=1,

)

Can be instantiated from a dictionary:

my_A = MyClassA(
**{

“foo”: “a string”, “bar”: 1,

}

)

Can be accessed using both dictionary and dot notation

my_A.foo == “a string” my_A.bar == 1

my_A[“foo”] == “a string” my_A[“bar”] == 1

Pairs nicely with @dataclass:

@dataclass() class MyClassA(DictDot):

foo: str bar: int

Can be made immutable:

@dataclass(frozen=True) class MyClassA(DictDot):

foo: str bar: int

For more examples of usage, please see test_dataclass_serializable_dot_dict_pattern.py in the tests folder.

classmethod get_config_class(cls)
classmethod get_schema_class(cls)
class great_expectations.rule_based_profiler.config.base.RuleBasedProfilerConfigSchema(*, only: types.StrSequenceOrSet = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: typing.Dict = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: typing.Union[bool, types.StrSequenceOrSet] = False, unknown: str = None)

Bases: great_expectations.marshmallow__shade.Schema

Schema classes for configurations which extend from BaseYamlConfig must extend top-level Marshmallow Schema class. Schema classes for their constituent configurations which extend DictDot leve must extend NotNullSchema class.

class Meta
unknown
name
class_name
module_name
config_version
variables
rules
great_expectations.rule_based_profiler.config.base.expectationConfigurationBuilderConfigSchema
great_expectations.rule_based_profiler.config.base.parameterBuilderConfigSchema
great_expectations.rule_based_profiler.config.base.domainBuilderConfigSchema
great_expectations.rule_based_profiler.config.base.ruleConfigSchema
great_expectations.rule_based_profiler.config.base.ruleBasedProfilerConfigSchema