great_expectations.core.config_peer

Module Contents

Classes

ConfigOutputModes()

Generic enumeration.

ConfigPeer()

A ConfigPeer is an object, whose subclasses can be instantiated using instantiate_class_from_config() (located in

great_expectations.core.config_peer.logger
class great_expectations.core.config_peer.ConfigOutputModes

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

TYPED = typed
COMMENTED_MAP = commented_map
YAML = yaml
DICT = dict
JSON_DICT = json_dict
great_expectations.core.config_peer.ConfigOutputModeType
class great_expectations.core.config_peer.ConfigPeer

Bases: abc.ABC

A ConfigPeer is an object, whose subclasses can be instantiated using instantiate_class_from_config() (located in great_expectations/util.py). Its immediate descendant subclass must use a subclass of BaseYamlConfig as an argument to its constructor, and the subsequent descendants must use only primitive types as their constructor arguments, wherever keys correspond to the keys of the “BaseYamlConfig” configuration object counterpart. The name ConfigPeer means: Every immediate descendant subclass must have Marshmallow Schema validated configuration class as its peer.

# TODO: <Alex>2/11/2022</Alex> When – as part of a potential future architecture update – serialization is decoupled from configuration, the configuration objects, persistable as YAML files, will no longer inherit from the BaseYamlConfig class. Rather, any form of serialization (YAML, JSON, SQL Database Tables, Pickle, etc.) will apply as peers, independent of the configuration classes themselves. Hence, as part of this change, ConfigPeer will cease being the superclass of business objects (such as BaseDataContext, BaseCheckpoint, and BaseRuleBasedProfiler). Instead, every persistable business object will contain a reference to its corresponding peer class, supporting the ConfigPeer interfaces.

property config(self)
get_config(self, mode: ConfigOutputModeType = ConfigOutputModes.TYPED, **kwargs)
__repr__(self)

Return repr(self).