profiler_options.py

#!/usr/bin/env python
"""Specify the options when running the data profiler."""
from __future__ import annotations

import abc
import copy
import re
import warnings
from typing import Any, Generic, TypeVar, cast

from ..labelers.base_data_labeler import BaseDataLabeler
from ..plugins.__init__ import get_plugins
from . import profiler_utils
from .json_decoder import load_option

BaseOptionT = TypeVar("BaseOptionT", bound="BaseOption")
BooleanOptionT = TypeVar("BooleanOptionT", bound="BooleanOption")
NumericalOptionsT = TypeVar("NumericalOptionsT", bound="NumericalOptions")
BaseInspectorOptionsT = TypeVar("BaseInspectorOptionsT", bound="BaseInspectorOptions")


class BaseOption(Generic[BaseOptionT]):
    """For configuring options."""

    @property
    def properties(self) -> dict[str, BooleanOption]:
        """
        Return a copy of the option properties.

        :return: dictionary of the option's properties attr: value
        :rtype: dict
        """
        return copy.deepcopy(self.__dict__)

    def _set_helper(self, options: dict[str, bool], variable_path: str) -> None:
        """
        Set all the options.

        Send in a dict that contains all of or a subset of
        the appropriate options. Set the values of the options. Will raise error
        if the formatting is improper.

        :param options: dict containing the options you want to set.
        :type options: dict
        :param variable_path: current path to variable set.
        :type variable_path: str
        :return: None
        """
        if not isinstance(options, dict):
            raise ValueError("The options must be a dictionary.")

        if not isinstance(variable_path, str):
            raise ValueError("The variable path must be a string.")

        for option in options:
            option_list = option.split(".", 1)
            option_name = option_list[0]

            is_check_all = False
            if option_name == "*":
                option_list = option_list[1].split(".", 1)
                option_name = option_list[0]
                is_check_all = True

            option_variable_path = (
                variable_path + "." + option_name if variable_path else option_name
            )
            if option_name in self.properties:
                option_prop = getattr(self, option_name)
                if isinstance(option_prop, BaseOption):
                    option_key = option_list[1]
                    option_prop._set_helper(
                        {option_key: options[option]},
                        variable_path=option_variable_path,
                    )
                elif len(option_list) > 1:
                    raise AttributeError(
                        "type object '{}' has no attribute '{}'".format(
                            option_variable_path, option_list[1]
                        )
                    )
                else:
                    setattr(self, option_name, options[option])
            elif len(option_list) > 1 or is_check_all:
                for class_option_name in self.properties:
                    class_option = getattr(self, class_option_name)
                    if isinstance(class_option, BaseOption):
                        option_variable_path = (
                            variable_path + "." + class_option_name
                            if variable_path
                            else class_option_name
                        )
                        class_option._set_helper(
                            {option: options[option]},
                            variable_path=option_variable_path,
                        )
            else:
                error_path = variable_path if variable_path else self.__class__.__name__
                raise AttributeError(
                    f"type object '{error_path}' has no attribute '{option}'"
                )

    def set(self, options: dict[str, bool]) -> None:
        """
        Set all the options.

        Send in a dict that contains all of or a subset of
        the appropriate options. Set the values of the options. Will raise error
        if the formatting is improper.

        :param options: dict containing the options you want to set.
        :type options: dict
        :return: None
        """
        if not isinstance(options, dict):
            raise ValueError("The options must be a dictionary.")
        self._set_helper(options, variable_path="")

    @abc.abstractmethod
    def _validate_helper(self, variable_path: str = "") -> list[str]:
        """
        Validate the options don't cause errors and return possible errors.

        :param variable_path: Current path to variable set.
        :type variable_path: str
        :return: List of errors (if raise_error is false)
        :rtype: list(str)
        """
        raise NotImplementedError()

    def validate(self, raise_error: bool = True) -> list[str] | None:
        """
        Validate the options do not conflict and cause errors.

        Raises error/warning if so.

        :param raise_error: Flag that raises errors if true. Returns errors if
            false.
        :type raise_error: bool
        :return: list of errors (if raise_error is false)
        :rtype: list(str)
        """
        errors = self._validate_helper()
        if raise_error and errors:
            raise ValueError("\n".join(errors))
        elif errors:
            return errors
        return None

    @classmethod
    def load_from_dict(cls, data, config: dict | None = None) -> BaseOption:
        """
        Parse attribute from json dictionary into self.

        :param data: dictionary with attributes and values.
        :type data: dict[string, Any]
        :param config: config to override loading options params from dictionary
        :type config: Dict | None

        :return: Options with attributes populated.
        :rtype: BaseOption
        """
        option = cls()

        for attr, value in data.items():
            if isinstance(value, dict) and "class" in value:
                value = load_option(value, config)
            setattr(option, attr, value)

        return option

    def __eq__(self, other: object) -> bool:
        """
        Determine equality by ensuring equality of all attributes.

        Some of the attributes may be Options objects themselves.
        """
        if not isinstance(other, self.__class__):
            return False

        return self.__dict__ == other.__dict__


class BooleanOption(BaseOption[BooleanOptionT]):
    """For setting Boolean options."""

    def __init__(self, is_enabled: bool = True) -> None:
        """
        Initialize Boolean option.

        :ivar is_enabled: boolean option to enable/disable the option.
        :vartype is_enabled: bool
        """
        self.is_enabled = is_enabled

    def _validate_helper(self, variable_path: str = "BooleanOption") -> list[str]:
        """
        Validate the options do not conflict and cause errors.

        :param variable_path: current path to variable set.
        :type variable_path: str
        :return: list of errors (if raise_error is false)
        :rtype: list(str)
        """
        if not isinstance(variable_path, str):
            raise ValueError("The variable path must be a string.")

        errors: list[str] = []
        if not isinstance(self.is_enabled, bool):
            errors = [f"{variable_path}.is_enabled must be a Boolean."]
        return errors


class HistogramAndQuantilesOption(BooleanOption["HistogramAndQuantilesOption"]):
    """For setting histogram options."""

    def __init__(
        self,
        is_enabled: bool = True,
        bin_count_or_method: str | int | list[str] = "auto",
        num_quantiles: int = 1000,
    ) -> None:
        """
        Initialize Options for histograms.

        :ivar is_enabled: boolean option to enable/disable the option.
        :vartype is_enabled: bool
        :ivar bin_count_or_method: bin count or the method with which to
            calculate histograms
        :vartype bin_count_or_method: Union[str, int, list(str)]
        :ivar num_quantiles: number of quantiles
        :vartype num_quantiles: int
        """
        self.bin_count_or_method = bin_count_or_method
        self.num_quantiles = num_quantiles
        super().__init__(is_enabled=is_enabled)

    def _validate_helper(
        self, variable_path: str = "HistogramAndQuantilesOption"
    ) -> list[str]:
        """
        Validate the options do not conflict and cause errors.

        :param variable_path: current path to variable set.
        :type variable_path: str
        :return: list of errors (if raise_error is false)
        :rtype: list(str)
        """
        errors = super()._validate_helper(variable_path=variable_path)

        if self.bin_count_or_method is not None:
            valid_methods = ["auto", "fd", "doane", "scott", "rice", "sturges", "sqrt"]

            value = self.bin_count_or_method
            if isinstance(value, str):
                value = [value]
            if isinstance(value, int) and value >= 1:
                pass  # use errors below if not a passing int
            elif (
                not isinstance(value, list)
                or len(value) < 1
                or not all([isinstance(item, str) for item in value])
                or not set(value).issubset(set(valid_methods))
            ):
                errors.append(
                    "{}.bin_count_or_method must be an integer more "
                    "than 1, a string, or list of strings from the "
                    "following: {}.".format(variable_path, valid_methods)
                )

        if self.num_quantiles is not None and (
            not isinstance(self.num_quantiles, int) or self.num_quantiles < 1
        ):
            errors.append(f"{variable_path}.num_quantiles must be a positive integer.")

        return errors


class ModeOption(BooleanOption["ModeOption"]):
    """For setting mode estimation options."""

    def __init__(self, is_enabled: bool = True, max_k_modes: int = 5) -> None:
        """Initialize Options for mode estimation.

        :ivar is_enabled: boolean option to enable/disable the option.
        :vartype is_enabled: bool
        :ivar max_k_modes: the max number of modes to return, if applicable
        :vartype max_k_modes: int
        """
        self.top_k_modes = max_k_modes
        super().__init__(is_enabled=is_enabled)

    def _validate_helper(self, variable_path: str = "ModeOption") -> list[str]:
        """
        Validate the options do not conflict and cause errors.

        :param variable_path: current path to variable set.
        :type variable_path: str
        :return: list of errors (if raise_error is false)
        :rtype: list(str)
        """
        errors = super()._validate_helper(variable_path=variable_path)

        if self.top_k_modes is not None and (
            not isinstance(self.top_k_modes, int) or self.top_k_modes < 1
        ):
            errors.append(
                "{}.top_k_modes must be either None"
                " or a positive integer".format(variable_path)
            )
        return errors


class BaseInspectorOptions(BooleanOption[BaseInspectorOptionsT]):
    """For setting Base options."""

    def __init__(self, is_enabled: bool = True) -> None:
        """
        Initialize Base options for all the columns.

        :ivar is_enabled: boolean option to enable/disable the column.
        :vartype is_enabled: bool
        """
        super().__init__(is_enabled=is_enabled)

    def _validate_helper(
        self, variable_path: str = "BaseInspectorOptions"
    ) -> list[str]:
        """
        Validate the options do not conflict and cause errors.

        :param variable_path: current path to variable set.
        :type variable_path: str
        :return: list of errors (if raise_error is false)
        :rtype: list(str)
        """
        return super()._validate_helper(variable_path)

    def is_prop_enabled(self, prop: str) -> bool:
        """
        Check to see if a property is enabled or not and returns boolean.

        :param prop: The option to check if it is enabled
        :type prop: String
        :return: Whether or not the property is enabled
        :rtype: Boolean
        """
        is_enabled = True
        if prop not in self.properties:
            raise AttributeError(
                'Property "{}" does not exist in {}.'.format(
                    prop, self.__class__.__name__
                )
            )
        option_prop = getattr(self, prop)
        if isinstance(option_prop, bool):
            is_enabled = option_prop
        elif isinstance(option_prop, BooleanOption):
            is_enabled = option_prop.is_enabled
        return is_enabled


class NumericalOptions(BaseInspectorOptions[NumericalOptionsT]):
    """For configuring options for Numerican Stats Mixin."""

    def __init__(self) -> None:
        """
        Initialize Options for the Numerical Stats Mixin.

        :ivar is_enabled: boolean option to enable/disable the column.
        :vartype is_enabled: bool
        :ivar min: boolean option to enable/disable min
        :vartype min: BooleanOption
        :ivar max: boolean option to enable/disable max
        :vartype max: BooleanOption
        :ivar mode: option to enable/disable mode and set return count
        :vartype mode: ModeOption
        :ivar median: option to enable/disable median
        :vartype median: BooleanOption
        :ivar sum: boolean option to enable/disable sum
        :vartype sum: BooleanOption
        :ivar variance: boolean option to enable/disable variance
        :vartype variance: BooleanOption
        :ivar skewness: boolean option to enable/disable skewness
        :vartype skewness: BooleanOption
        :ivar kurtosis: boolean option to enable/disable kurtosis
        :vartype kurtosis: BooleanOption
        :ivar histogram_and_quantiles: boolean option to enable/disable
            histogram_and_quantiles
        :vartype histogram_and_quantiles: BooleanOption
        :ivar bias_correction : boolean option to enable/disable existence of bias
        :vartype bias_correction: BooleanOption
        :ivar num_zeros: boolean option to enable/disable num_zeros
        :vartype num_zeros: BooleanOption
        :ivar num_negatives: boolean option to enable/disable num_negatives
        :vartype num_negatives: BooleanOption
        :ivar is_numeric_stats_enabled: boolean to enable/disable all numeric
            stats
        :vartype is_numeric_stats_enabled: bool
        """
        self.min: BooleanOption = BooleanOption(is_enabled=True)
        self.max: BooleanOption = BooleanOption(is_enabled=True)
        self.mode: ModeOption = ModeOption(is_enabled=True)
        self.median: BooleanOption = BooleanOption(is_enabled=True)
        self.sum: BooleanOption = BooleanOption(is_enabled=True)
        self.variance: BooleanOption = BooleanOption(is_enabled=True)
        self.skewness: BooleanOption = BooleanOption(is_enabled=True)
        self.kurtosis: BooleanOption = BooleanOption(is_enabled=True)
        self.median_abs_deviation: BooleanOption = BooleanOption(is_enabled=True)
        self.num_zeros: BooleanOption = BooleanOption(is_enabled=True)
        self.num_negatives: BooleanOption = BooleanOption(is_enabled=True)
        self.histogram_and_quantiles: HistogramAndQuantilesOption = (
            HistogramAndQuantilesOption()
        )
        # By default, we correct for bias
        self.bias_correction: BooleanOption = BooleanOption(is_enabled=True)
        BaseInspectorOptions.__init__(self)

    @property
    def is_numeric_stats_enabled(self) -> bool:
        """
        Return the state of numeric stats being enabled / disabled.

        If any numeric stats property is enabled it will return True,
        otherwise it will return False.

        :return: true if any numeric stats property is enabled, otherwise false
        :rtype bool:
        """
        if (
            self.min.is_enabled
            or self.max.is_enabled
            or self.mode.is_enabled
            or self.sum.is_enabled
            or self.variance.is_enabled
            or self.skewness.is_enabled
            or self.kurtosis.is_enabled
            or self.median.is_enabled
            or self.median_abs_deviation.is_enabled
            or self.histogram_and_quantiles.is_enabled
            or self.num_zeros.is_enabled
            or self.num_negatives.is_enabled
        ):
            return True
        return False

    @is_numeric_stats_enabled.setter
    def is_numeric_stats_enabled(self, value: bool) -> None:
        """
        Enable or disable all numeric stats properties.

        The properties are:
        min, max, sum, variance, skewness, kurtosis, histogram_and_quantiles,
        num_zeros, num_negatives

        :param value: boolean to enable/disable all numeric stats properties
        :type value: bool
        :return: None
        """
        self.min.is_enabled = value
        self.max.is_enabled = value
        self.mode.is_enabled = value
        self.median.is_enabled = value
        self.sum.is_enabled = value
        self.variance.is_enabled = value
        self.skewness.is_enabled = value
        self.kurtosis.is_enabled = value
        self.median_abs_deviation.is_enabled = value
        self.num_zeros.is_enabled = value
        self.num_negatives.is_enabled = value
        self.histogram_and_quantiles.is_enabled = value

    @property
    def properties(self) -> dict[str, BooleanOption]:
        """
        Include is_enabled.

            is_enabled: Turns on or off the column.
        """
        props: dict = super().properties
        props["is_numeric_stats_enabled"] = self.is_numeric_stats_enabled
        return props

    def _validate_helper(self, variable_path: str = "NumericalOptions") -> list[str]:
        """
        Validate the options do not conflict and cause errors.

        :param variable_path: current path to variable set.
        :type variable_path: str
        :return: list of errors (if raise_error is false)
        :rtype: list(str)
        """
        if not variable_path:
            variable_path = self.__class__.__name__

        errors = super()._validate_helper(variable_path=variable_path)
        for item in [
            "histogram_and_quantiles",
            "min",
            "max",
            "sum",
            "mode",
            "median",
            "variance",
            "skewness",
            "kurtosis",
            "median_abs_deviation",
            "bias_correction",
            "num_zeros",
            "num_negatives",
        ]:
            if not isinstance(self.properties[item], BooleanOption):
                errors.append(f"{variable_path}.{item} must be a BooleanOption.")
            else:
                errors += self.properties[item]._validate_helper(
                    variable_path=variable_path + "." + item
                )

        # Error checks for dependent calculations
        sum_disabled = not self.properties["sum"].is_enabled
        var_disabled = not self.properties["variance"].is_enabled
        skew_disabled = not self.properties["skewness"].is_enabled
        kurt_disabled = not self.properties["kurtosis"].is_enabled
        mad_disabled = not self.properties["median_abs_deviation"].is_enabled
        histogram_disabled = not self.properties["histogram_and_quantiles"].is_enabled
        if sum_disabled and not var_disabled:
            errors.append(
                "{}: The numeric stats must toggle on the sum "
                "if the variance is toggled on.".format(variable_path)
            )
        if (sum_disabled or var_disabled) and not skew_disabled:
            errors.append(
                "{}: The numeric stats must toggle on the "
                "sum and variance if skewness is toggled on.".format(variable_path)
            )
        if (sum_disabled or var_disabled or skew_disabled) and not kurt_disabled:
            errors.append(
                "{}: The numeric stats must toggle on sum,"
                " variance, and skewness if kurtosis is "
                "toggled on.".format(variable_path)
            )
        if histogram_disabled and not mad_disabled:
            errors.append(
                "{}: The numeric stats must toggle on histogram "
                "and quantiles if median absolute deviation is "
                "toggled on.".format(variable_path)
            )

        mode_disabled = not self.properties["mode"].is_enabled
        median_disabled = not self.properties["median"].is_enabled
        histogram_disabled = not self.properties["histogram_and_quantiles"].is_enabled
        if histogram_disabled:
            if not mode_disabled:
                errors.append(
                    "{}: The numeric stats must toggle on histogram "
                    "and quantiles if mode is "
                    "toggled on.".format(variable_path)
                )
            if not median_disabled:
                errors.append(
                    "{}: The numeric stats must toggle on histogram "
                    "and quantiles if median is "
                    "toggled on.".format(variable_path)
                )

        # warn user if all stats are disabled
        if not errors:
            if not self.is_numeric_stats_enabled:
                variable_path = (
                    variable_path + ".numeric_stats"
                    if variable_path
                    else self.__class__.__name__
                )
                warnings.warn(
                    "{}: The numeric stats are completely disabled.".format(
                        variable_path
                    )
                )
        return errors


class IntOptions(NumericalOptions["IntOptions"]):
    """For configuring options for Int Column."""

    def __init__(self) -> None:
        """
        Initialize Options for the Int Column.

        :ivar is_enabled: boolean option to enable/disable the column.
        :vartype is_enabled: bool
        :ivar min: boolean option to enable/disable min
        :vartype min: BooleanOption
        :ivar max: boolean option to enable/disable max
        :vartype max: BooleanOption
        :ivar mode: option to enable/disable mode and set return count
        :vartype mode: ModeOption
        :ivar median: option to enable/disable median
        :vartype median: BooleanOption
        :ivar sum: boolean option to enable/disable sum
        :vartype sum: BooleanOption
        :ivar variance: boolean option to enable/disable variance
        :vartype variance: BooleanOption
        :ivar skewness: boolean option to enable/disable skewness
        :vartype skewness: BooleanOption
        :ivar kurtosis: boolean option to enable/disable kurtosis
        :vartype kurtosis: BooleanOption
        :ivar histogram_and_quantiles: boolean option to enable/disable
            histogram_and_quantiles
        :vartype histogram_and_quantiles: BooleanOption
        :ivar bias_correction : boolean option to enable/disable existence of bias
        :vartype bias_correction: BooleanOption
        :ivar num_zeros: boolean option to enable/disable num_zeros
        :vartype num_zeros: BooleanOption
        :ivar num_negatives: boolean option to enable/disable num_negatives
        :vartype num_negatives: BooleanOption
        :ivar is_numeric_stats_enabled: boolean to enable/disable all numeric
            stats
        :vartype is_numeric_stats_enabled: bool
        """
        NumericalOptions.__init__(self)

    def _validate_helper(self, variable_path: str = "IntOptions") -> list[str]:
        """
        Validate the options do not conflict and cause errors.

        :param variable_path: current path to variable set.
        :type variable_path: str
        :return: list of errors (if raise_error is false)
        :rtype: list(str)
        """
        return super()._validate_helper(variable_path)


class PrecisionOptions(BooleanOption["PrecisionOptions"]):
    """For configuring options for precision."""

    def __init__(self, is_enabled: bool = True, sample_ratio: float = None) -> None:
        """
        Initialize Options for precision.

        :ivar is_enabled: boolean option to enable/disable the column.
        :vartype is_enabled: bool
        :ivar sample_ratio: float option to determine ratio of valid
                            float samples in determining percision.
                            This ratio will override any defaults.
        :vartype sample_ratio: float
        """
        self.sample_ratio = sample_ratio
        super().__init__(is_enabled=is_enabled)

    def _validate_helper(self, variable_path: str = "PrecisionOptions") -> list[str]:
        """
        Validate the options do not conflict and cause errors.

        :param variable_path: current path to variable set.
        :type variable_path: str
        :return: list of errors (if raise_error is false)
        :rtype: List of strings
        """
        errors = super()._validate_helper(variable_path=variable_path)
        if self.sample_ratio is not None:
            if not isinstance(self.sample_ratio, float) and not isinstance(
                self.sample_ratio, int
            ):
                errors.append(f"{variable_path}.sample_ratio must be a float.")
            if (
                isinstance(self.sample_ratio, float)
                or isinstance(self.sample_ratio, int)
            ) and (self.sample_ratio < 0 or self.sample_ratio > 1.0):
                errors.append(
                    "{}.sample_ratio must be a float between 0 and 1.".format(
                        variable_path
                    )
                )

        return errors


class FloatOptions(NumericalOptions["FloatOptions"]):
    """For configuring options for Float Column."""

    def __init__(self) -> None:
        """
        Initialize Options for the Float Column.

        :ivar is_enabled: boolean option to enable/disable the column.
        :vartype is_enabled: bool
        :ivar min: boolean option to enable/disable min
        :vartype min: BooleanOption
        :ivar max: boolean option to enable/disable max
        :vartype max: BooleanOption
        :ivar mode: option to enable/disable mode and set return count
        :vartype mode: ModeOption
        :ivar median: option to enable/disable median
        :vartype median: BooleanOption
        :ivar sum: boolean option to enable/disable sum
        :vartype sum: BooleanOption
        :ivar variance: boolean option to enable/disable variance
        :vartype variance: BooleanOption
        :ivar skewness: boolean option to enable/disable skewness
        :vartype skewness: BooleanOption
        :ivar kurtosis: boolean option to enable/disable kurtosis
        :vartype kurtosis: BooleanOption
        :ivar histogram_and_quantiles: boolean option to enable/disable
            histogram_and_quantiles
        :vartype histogram_and_quantiles: BooleanOption
        :ivar bias_correction : boolean option to enable/disable existence of bias
        :vartype bias_correction: BooleanOption
        :ivar num_zeros: boolean option to enable/disable num_zeros
        :vartype num_zeros: BooleanOption
        :ivar num_negatives: boolean option to enable/disable num_negatives
        :vartype num_negatives: BooleanOption
        :ivar is_numeric_stats_enabled: boolean to enable/disable all numeric
            stats
        :vartype is_numeric_stats_enabled: bool
        """
        NumericalOptions.__init__(self)
        self.precision = PrecisionOptions(is_enabled=True)

    def _validate_helper(self, variable_path: str = "FloatOptions") -> list[str]:
        """
        Validate the options do not conflict and cause errors.

        :param variable_path: current path to variable set.
        :type variable_path: str
        :return: list of errors (if raise_error is false)
        :rtype: list(str)
        """
        errors = super()._validate_helper(variable_path=variable_path)
        if not isinstance(self.precision, PrecisionOptions):
            errors.append(f"{variable_path}.precision must be a PrecisionOptions.")
        errors += self.precision._validate_helper(variable_path + ".precision")
        return errors


class TextOptions(NumericalOptions["TextOptions"]):
    """For configuring options for Text Column."""

    def __init__(self) -> None:
        """
        Initialize Options for the Text Column.

        :ivar is_enabled: boolean option to enable/disable the column.
        :vartype is_enabled: bool
        :ivar vocab: boolean option to enable/disable vocab
        :vartype vocab: BooleanOption
        :ivar min: boolean option to enable/disable min
        :vartype min: BooleanOption
        :ivar max: boolean option to enable/disable max
        :vartype max: BooleanOption
        :ivar mode: option to enable/disable mode and set return count
        :vartype mode: ModeOption
        :ivar median: option to enable/disable median
        :vartype median: BooleanOption
        :ivar sum: boolean option to enable/disable sum
        :vartype sum: BooleanOption
        :ivar variance: boolean option to enable/disable variance
        :vartype variance: BooleanOption
        :ivar skewness: boolean option to enable/disable skewness
        :vartype skewness: BooleanOption
        :ivar kurtosis: boolean option to enable/disable kurtosis
        :vartype kurtosis: BooleanOption
        :ivar bias_correction : boolean option to enable/disable existence of bias
        :vartype bias_correction: BooleanOption
        :ivar histogram_and_quantiles: boolean option to enable/disable
            histogram_and_quantiles
        :vartype histogram_and_quantiles: BooleanOption
        :ivar num_zeros: boolean option to enable/disable num_zeros
        :vartype num_zeros: BooleanOption
        :ivar num_negatives: boolean option to enable/disable num_negatives
        :vartype num_negatives: BooleanOption
        :ivar is_numeric_stats_enabled: boolean to enable/disable all numeric
            stats
        :vartype is_numeric_stats_enabled: bool
        """
        NumericalOptions.__init__(self)
        self.vocab: BooleanOption = BooleanOption(is_enabled=True)
        self.num_zeros: BooleanOption = BooleanOption(is_enabled=False)
        self.num_negatives: BooleanOption = BooleanOption(is_enabled=False)

    def _validate_helper(self, variable_path: str = "TextOptions") -> list[str]:
        """
        Validate the options do not conflict and cause errors.

        Also validate that some options (num_zeros and num_negatives)
        are set to be disabled by default.

        :param variable_path: current path to variable set.
        :type variable_path: str
        :return: list of errors (if raise_error is false)
        :rtype: list(str)
        """
        errors = super()._validate_helper(variable_path=variable_path)
        if not isinstance(self.vocab, BooleanOption):
            errors.append(f"{variable_path}.vocab must be a BooleanOption.")
        errors += self.vocab._validate_helper(variable_path + ".vocab")

        if self.properties["num_zeros"].is_enabled:
            errors.append(
                "{}.num_zeros should always be disabled,"
                " num_zeros.is_enabled = False".format(variable_path)
            )

        if self.properties["num_negatives"].is_enabled:
            errors.append(
                "{}.num_negatives should always be disabled,"
                " num_negatives.is_enabled = False".format(variable_path)
            )
        return errors

    @property
    def is_numeric_stats_enabled(self) -> bool:
        """
        Return the state of numeric stats being enabled / disabled.

        If any numeric stats property is enabled it will return True, otherwise
        it will return False. Although it seems redundant, this method is needed
        in order for the function below, the setter function
        also called is_numeric_stats_enabled, to properly work.

        :return: true if any numeric stats property is enabled, otherwise false
        :rtype bool:
        """
        if (
            self.min.is_enabled
            or self.max.is_enabled
            or self.sum.is_enabled
            or self.mode.is_enabled
            or self.variance.is_enabled
            or self.skewness.is_enabled
            or self.kurtosis.is_enabled
            or self.median.is_enabled
            or self.median_abs_deviation.is_enabled
            or self.histogram_and_quantiles.is_enabled
        ):
            return True
        return False

    @is_numeric_stats_enabled.setter
    def is_numeric_stats_enabled(self, value: bool) -> None:
        """
        Enable or disable all numeric stats properties.

        Those properties are:
        min, max, sum, variance, skewness, kurtosis, histogram_and_quantiles,

        :param value: boolean to enable/disable all numeric stats properties
        :type value: bool
        :return: None
        """
        self.min.is_enabled = value
        self.max.is_enabled = value
        self.mode.is_enabled = value
        self.median.is_enabled = value
        self.sum.is_enabled = value
        self.variance.is_enabled = value
        self.skewness.is_enabled = value
        self.kurtosis.is_enabled = value
        self.median_abs_deviation.is_enabled = value
        self.histogram_and_quantiles.is_enabled = value


class DateTimeOptions(BaseInspectorOptions["DateTimeOptions"]):
    """For configuring options for Datetime Column."""

    def __init__(self) -> None:
        """
        Initialize Options for the Datetime Column.

        :ivar is_enabled: boolean option to enable/disable the column.
        :vartype is_enabled: bool
        """
        BaseInspectorOptions.__init__(self)

    def _validate_helper(self, variable_path: str = "DateTimeOptions") -> list[str]:
        """
        Validate the options do not conflict and cause errors.

        :param variable_path: current path to variable set.
        :type variable_path: str
        :return: list of errors (if raise_error is false)
        :rtype: list(str)
        """
        return super()._validate_helper(variable_path)


class OrderOptions(BaseInspectorOptions["OrderOptions"]):
    """For configuring options for Order Column."""

    def __init__(self) -> None:
        """
        Initialize options for the Order Column.

        :ivar is_enabled: boolean option to enable/disable the column.
        :vartype is_enabled: bool
        """
        BaseInspectorOptions.__init__(self)

    def _validate_helper(self, variable_path: str = "OrderOptions") -> list[str]:
        """
        Validate the options do not conflict and cause errors.

        :param variable_path: current path to variable set.
        :type variable_path: str
        :return: list of errors (if raise_error is false)
        :rtype: list(str)
        """
        return super()._validate_helper(variable_path)


class CategoricalOptions(BaseInspectorOptions["CategoricalOptions"]):
    """For configuring options Categorical Column."""

    def __init__(
        self,
        is_enabled: bool = True,
        top_k_categories: int | None = None,
        max_sample_size_to_check_stop_condition: int | None = None,
        stop_condition_unique_value_ratio: float | None = None,
        cms: bool = False,
        cms_confidence: float | None = 0.95,
        cms_relative_error: float | None = 0.01,
        cms_max_num_heavy_hitters: int | None = 5000,
    ) -> None:
        """
        Initialize options for the Categorical Column.

        :ivar is_enabled: boolean option to enable/disable the column.
        :vartype is_enabled: bool
        :ivar top_k_categories: number of categories to be displayed when called
        :vartype top_k_categories: [None, int]
        :ivar max_sample_size_to_check_stop_condition: The maximum sample size
            before categorical stop conditions are checked
        :vartype max_sample_size_to_check_stop_condition: [None, int]
        :ivar stop_condition_unique_value_ratio: The highest ratio of unique
            values to dataset size that is to be considered a categorical type
        :vartype stop_condition_unique_value_ratio: [None, float]
        :ivar cms: boolean option for using count min sketch
        :vartype cms: bool
        :ivar cms_confidence: defines the number of hashes used in CMS.
            eg. confidence = 1 - failure probability, default 0.95
        :vartype cms_confidence: [None, float]
        :ivar cms_relative_error: defines the number of buckets used in CMS,
            default 0.01
        :vartype cms_relative_error: [None, float]
        :ivar cms_max_num_heavy_hitters: value used to define
        the threshold for minimum frequency required by a category to be counted
        :vartype cms_max_num_heavy_hitters: [None, int]
        """
        BaseInspectorOptions.__init__(self, is_enabled=is_enabled)
        self.top_k_categories = top_k_categories
        self.max_sample_size_to_check_stop_condition = (
            max_sample_size_to_check_stop_condition
        )
        self.stop_condition_unique_value_ratio = stop_condition_unique_value_ratio
        self.cms = cms
        self.cms_confidence = cms_confidence
        self.cms_relative_error = cms_relative_error
        self.cms_max_num_heavy_hitters = cms_max_num_heavy_hitters

    def _validate_helper(self, variable_path: str = "CategoricalOptions") -> list[str]:
        """
        Validate the options do not conflict and cause errors.

        :param variable_path: current path to variable set.
        :type variable_path: str
        :return: list of errors (if raise_error is false)
        :rtype: list(str)
        """
        errors = super()._validate_helper(variable_path)
        if self.top_k_categories is not None and (
            not isinstance(self.top_k_categories, int) or self.top_k_categories < 1
        ):
            errors.append(
                "{}.top_k_categories must be either None"
                " or a positive integer".format(variable_path)
            )

        if self.max_sample_size_to_check_stop_condition is not None and (
            not isinstance(self.max_sample_size_to_check_stop_condition, int)
            or self.max_sample_size_to_check_stop_condition < 0
        ):
            errors.append(
                "{}.max_sample_size_to_check_stop_condition must be either None"
                " or a non-negative integer".format(variable_path)
            )

        if self.stop_condition_unique_value_ratio is not None and (
            not isinstance(self.stop_condition_unique_value_ratio, float)
            or self.stop_condition_unique_value_ratio < 0
            or self.stop_condition_unique_value_ratio > 1.0
        ):
            errors.append(
                "{}.stop_condition_unique_value_ratio must be either None"
                " or a float between 0 and 1".format(variable_path)
            )

        if (self.max_sample_size_to_check_stop_condition is None) ^ (
            self.stop_condition_unique_value_ratio is None
        ):
            errors.append(
                "Both, {}.max_sample_size_to_check_stop_condition and "
                "{}.stop_condition_unique_value_ratio, options either need to be "
                "set or not set.".format(variable_path, variable_path)
            )

        if self.cms_confidence is not None and (
            not isinstance(self.cms_confidence, float)
            or self.cms_confidence < 0
            or self.cms_confidence > 1.0
        ):
            errors.append(
                "{}.cms_confidence must be either None"
                " or a float between 0 and 1".format(variable_path)
            )

        if self.cms_relative_error is not None and (
            not isinstance(self.cms_relative_error, float)
            or self.cms_relative_error < 0
            or self.cms_relative_error > 1.0
        ):
            errors.append(
                "{}.cms_relative_error must be either None"
                " or a float between 0 and 1".format(variable_path)
            )

        if self.cms and not isinstance(self.cms_max_num_heavy_hitters, int):
            errors.append(
                "{}.if using count min sketch, you must pass an"
                "integer value for cms_max_num_heavy_hitters".format(variable_path)
            )

        return errors


class CorrelationOptions(BaseInspectorOptions["CorrelationOptions"]):
    """For configuring options for Correlation between Columns."""

    def __init__(self, is_enabled: bool = False, columns: list[str] = None) -> None:
        """
        Initialize options for the Correlation between Columns.

        :ivar is_enabled: boolean option to enable/disable.
        :vartype is_enabled: bool
        :ivar columns: Columns considered to calculate correlation
        :vartype columns: list()
        """
        BaseInspectorOptions.__init__(self, is_enabled=is_enabled)
        self.columns = columns

    def _validate_helper(self, variable_path: str = "CorrelationOptions") -> list[str]:
        """
        Validate the options do not conflict and cause errors.

        :param variable_path: current path to variable set.
        :type variable_path: str
        :return: list of errors (if raise_error is false)
        :rtype: list(str)
        """
        errors = super()._validate_helper(variable_path=variable_path)

        if self.columns is not None and (
            not isinstance(self.columns, list)
            or len(self.columns) <= 1
            or not all(isinstance(item, str) for item in self.columns)
        ):
            errors.append(
                "{}.columns must be None "
                "or list of strings "
                "with at least two elements.".format(variable_path)
            )
        return errors


class HyperLogLogOptions(BaseOption["HyperLogLogOptions"]):
    """Options for alternative method of gathering unique row count."""

    def __init__(self, seed: int = 0, register_count: int = 15) -> None:
        """
        Initialize options for the hyperloglog method of gathering unique row count.

        :ivar is_enabled: boolean option to enable/disable.
        :vartype is_enabled: bool
        :ivar seed: seed used to set HLL hashing function
        :vartype seed: int
        :ivar register_count: number of registers is equal to 2^register_count
        :vartype register_count: int
        """
        self.seed = seed
        self.register_count = register_count

    def _validate_helper(self, variable_path: str = "HyperLogLogOptions") -> list[str]:
        """
        Validate the options do not conflict and cause errors.

        :param variable_path: current path to variable set.
        :type variable_path: str
        :return: list of errors (if raise_error is false)
        :rtype: list(str)
        """
        errors = []

        if not isinstance(self.register_count, int):
            errors.append(f"{variable_path}.register_count must be an integer.")
        elif self.register_count <= 0:
            errors.append(f"{variable_path}.register_count must be greater than 0.")
        if not isinstance(self.seed, int):
            errors.append(f"{variable_path}.seed must be an integer.")

        if isinstance(self.register_count, int) and self.register_count >= 20:
            warnings.warn(
                f"{variable_path}.register_count is greater than or equal "
                "to 20, so the row hashing object is greater than 5 MB."
            )

        return errors


class UniqueCountOptions(BooleanOption["UniqueCountOptions"]):
    """For configuring options for unique row count."""

    def __init__(self, is_enabled: bool = True, hashing_method: str = "full") -> None:
        """
        Initialize options for unique row counts.

        :ivar is_enabled: boolean option to enable/disable.
        :vartype is_enabled: bool
        :ivar hashing_method: property to specify row hashing method ("full" | "hll")
        :vartype hashing_method: str
        """
        BooleanOption.__init__(self, is_enabled=is_enabled)
        self.hashing_method = hashing_method
        self.hll = HyperLogLogOptions()

    def _validate_helper(self, variable_path: str = "UniqueCountOptions") -> list[str]:
        """
        Validate the options do not conflict and cause errors.

        :param variable_path: current path to variable set.
        :type variable_path: str
        :return: list of errors (if raise_error is false)
        :rtype: list(str)
        """
        errors = super()._validate_helper(variable_path=variable_path)

        if not isinstance(self.hashing_method, str):
            errors.append(f"{variable_path}.full_hashing must be a String.")
        if isinstance(self.hashing_method, str) and self.hashing_method not in [
            "full",
            "hll",
        ]:
            errors.append(f"{variable_path}.hashing_method must be 'full' or 'hll'.")
        if not isinstance(self.hll, HyperLogLogOptions):
            errors.append(f"{variable_path}.hll_hashing must be a HyperLogLogOptions.")

        errors += self.hll._validate_helper(variable_path + ".hll")
        return errors


class RowStatisticsOptions(BooleanOption["RowStatisticsOptions"]):
    """For configuring options for row statistics."""

    def __init__(
        self,
        is_enabled: bool = True,
        unique_count: bool = True,
        null_count: bool = True,
    ) -> None:
        """
        Initialize options for row statistics.

        :ivar is_enabled: boolean option to enable/disable.
        :vartype is_enabled: bool
        :ivar unique_count: boolean option to enable/disable unique_count
        :vartype unique_count: bool
        ivar null_count: boolean option to enable/disable null_count
        :vartype null_count: bool
        """
        BooleanOption.__init__(self, is_enabled=is_enabled)
        self.unique_count: UniqueCountOptions = UniqueCountOptions(
            is_enabled=unique_count
        )
        self.null_count: BooleanOption = BooleanOption(is_enabled=null_count)

    def _validate_helper(
        self, variable_path: str = "RowStatisticsOptions"
    ) -> list[str]:
        """
        Validate the options do not conflict and cause errors.

        :param variable_path: current path to variable set.
        :type variable_path: str
        :return: list of errors (if raise_error is false)
        :rtype: list(str)
        """
        errors = super()._validate_helper(variable_path=variable_path)
        if not isinstance(self.unique_count, UniqueCountOptions):
            errors.append(
                f"{variable_path}.unique_count must be an UniqueCountOptions."
            )

        if not isinstance(self.null_count, BooleanOption):
            errors.append(f"{variable_path}.null_count must be an BooleanOption.")

        errors += self.unique_count._validate_helper(variable_path + ".unique_counts")
        errors += self.null_count._validate_helper(variable_path + ".null_count")
        return super()._validate_helper(variable_path)


class DataLabelerOptions(BaseInspectorOptions["DataLabelerOptions"]):
    """For configuring options for Data Labeler Column."""

    def __init__(self) -> None:
        """
        Initialize options for the Data Labeler Column.

        :ivar is_enabled: boolean option to enable/disable the column.
        :vartype is_enabled: bool
        :ivar data_labeler_dirpath: String to load data labeler
        :vartype data_labeler_dirpath: str
        :ivar max_sample_size: Int to decide sample size
        :vartype max_sample_size: int
        :ivar data_labeler_object: DataLabeler object used in profiler
        :vartype max_sample_size: BaseDataLabeler
        """
        BaseInspectorOptions.__init__(self)
        self.data_labeler_dirpath: str | None = None
        self.max_sample_size: int | None = None
        self.data_labeler_object: BaseDataLabeler | None = None

    def __deepcopy__(self, memo: dict) -> DataLabelerOptions:
        """
        Override deepcopy for data labeler object.

        Adapted from https://stackoverflow.com/questions/1500718/
        how-to-override-the-copy-deepcopy-operations-for-a-python-object/40484215
        :param memo: data object needed to copy
        :return:
        """
        cls = self.__class__
        result = cls.__new__(cls)
        memo[id(self)] = result
        for k, v in self.__dict__.items():
            if k == "data_labeler_object":
                setattr(result, k, v)
            else:
                setattr(result, k, copy.deepcopy(v, memo))
        return result

    @property
    def properties(self) -> dict:
        """
        Return a copy of the option properties.

        :return: dictionary of the option's properties attr: value
        :rtype: dict
        """
        props = {
            k: copy.deepcopy(v)
            for k, v in self.__dict__.items()
            if k != "data_labeler_object"
        }
        props["data_labeler_object"] = self.data_labeler_object
        return props

    def _validate_helper(self, variable_path: str = "DataLabelerOptions") -> list[str]:
        """
        Validate the options do not conflict and cause errors.

        :param variable_path: current path to variable set.
        :type variable_path: str
        :return: list of errors (if raise_error is false)
        :rtype: list(str)
        """
        errors = super()._validate_helper(variable_path=variable_path)

        if self.data_labeler_dirpath is not None and not isinstance(
            self.data_labeler_dirpath, str
        ):
            errors.append(f"{variable_path}.data_labeler_dirpath must be a string.")

        if self.data_labeler_object is not None and not isinstance(
            self.data_labeler_object, BaseDataLabeler
        ):
            errors.append(
                "{}.data_labeler_object must be a BaseDataLabeler "
                "object.".format(variable_path)
            )
        if (
            self.data_labeler_object is not None
            and self.data_labeler_dirpath is not None
        ):
            warnings.warn(
                "The data labeler passed in will be used,"
                " not through the directory of the default model"
            )

        if self.max_sample_size is not None and not isinstance(
            self.max_sample_size, int
        ):
            errors.append(f"{variable_path}.max_sample_size must be an integer.")
        elif self.max_sample_size is not None and self.max_sample_size <= 0:
            errors.append(f"{variable_path}.max_sample_size must be greater than 0.")
        return errors

    @classmethod
    def load_from_dict(
        cls,
        data,
        config: dict | None = None,
    ) -> DataLabelerOptions:
        """
        Parse attribute from json dictionary into self.

        :param data: dictionary with attributes and values.
        :type data: dict[string, Any]
        :param config: config to override loading options params from dictionary
        :type config: Dict | None

        :return: Profiler with attributes populated.
        :rtype: DataLabelerOptions
        """
        data_labeler_object = None
        data_labeler_load_attr = data.pop("data_labeler_object", {})
        if data_labeler_load_attr:
            data_labeler_object = profiler_utils.reload_labeler_from_options_or_get_new(
                data_labeler_load_attr, config
            )
            if data_labeler_object:
                data["data_labeler_object"] = data_labeler_object

        dl_options = cast(DataLabelerOptions, super().load_from_dict(data))
        return dl_options


class TextProfilerOptions(BaseInspectorOptions["TextProfilerOptions"]):
    """For configuring options for text profiler."""

    def __init__(
        self,
        is_enabled: bool = True,
        is_case_sensitive: bool = True,
        stop_words: set[str] = None,
        top_k_chars: int = None,
        top_k_words: int = None,
    ) -> None:
        """
        Construct the TextProfilerOption object with default values.

        :ivar is_enabled: boolean option to enable/disable the option.
        :vartype is_enabled: bool
        :ivar is_case_sensitive: option set for case sensitivity.
        :vartype is_case_sensitive: bool
        :ivar stop_words: option set for stop words.
        :vartype stop_words: Union[None, list(str)]
        :ivar top_k_chars: option set for number of top common characters.
        :vartype top_k_chars: Union[None, int]
        :ivar top_k_words: option set for number of top common words.
        :vartype top_k_words: Union[None, int]
        :ivar words: option set for word update.
        :vartype words: BooleanOption
        :ivar vocab: option set for vocab update.
        :vartype vocab: BooleanOption
        """
        super().__init__(is_enabled=is_enabled)
        self.is_case_sensitive = is_case_sensitive
        self.stop_words = stop_words
        self.top_k_chars = top_k_chars
        self.top_k_words = top_k_words
        self.vocab: BooleanOption = BooleanOption(is_enabled=True)
        self.words: BooleanOption = BooleanOption(is_enabled=True)

    def _validate_helper(self, variable_path: str = "TextProfilerOptions") -> list[str]:
        """
        Validate the options do not conflict and cause errors.

        :param variable_path: current path to variable set.
        :type variable_path: str
        :return: list of errors (if raise_error is false)
        :rtype: list(str)
        """
        if not variable_path:
            variable_path = self.__class__.__name__

        errors = super()._validate_helper(variable_path=variable_path)

        if not isinstance(self.is_case_sensitive, bool):
            errors.append(f"{variable_path}.is_case_sensitive must be a Boolean.")

        if self.stop_words is not None and (
            not isinstance(self.stop_words, list)
            or not all(isinstance(item, str) for item in self.stop_words)
        ):
            errors.append(
                "{}.stop_words must be None "
                "or list of strings.".format(variable_path)
            )

        if self.top_k_chars is not None and (
            not isinstance(self.top_k_chars, int) or self.top_k_chars <= 0
        ):
            errors.append(
                "{}.top_k_chars must be None "
                "or positive integer.".format(variable_path)
            )

        if self.top_k_words is not None and (
            not isinstance(self.top_k_words, int) or self.top_k_words <= 0
        ):
            errors.append(
                "{}.top_k_words must be None "
                "or positive integer.".format(variable_path)
            )

        if not isinstance(self.vocab, BooleanOption):
            errors.append(
                "{}.vocab must be a BooleanOption " "object.".format(variable_path)
            )

        if not isinstance(self.words, BooleanOption):
            errors.append(
                "{}.words must be a BooleanOption " "object.".format(variable_path)
            )

        return errors


class StructuredOptions(BaseOption["StructuredOptions"]):
    """For configuring options for structured profiler."""

    def __init__(
        self,
        null_values: dict[str, re.RegexFlag | int] = None,
        column_null_values: dict[int, dict[str, re.RegexFlag | int]] = None,
        sampling_ratio: float = 0.2,
    ) -> None:
        """
        Construct the StructuredOptions object with default values.

        :param null_values: null values we input.
        :vartype null_values: Dict[str, Union[re.RegexFlag, int]]
        :param column_null_values: column level null values we input.
        :vartype column_null_values: Dict[int, Dict[str, Union[re.RegexFlag, int]]]
        :ivar int: option set for int profiling.
        :vartype int: IntOptions
        :ivar float: option set for float profiling.
        :vartype float: FloatOptions
        :ivar datetime: option set for datetime profiling.
        :vartype datetime: DateTimeOptions
        :ivar text: option set for text profiling.
        :vartype text: TextOptions
        :ivar order: option set for order profiling.
        :vartype order: OrderOptions
        :ivar category: option set for category profiling.
        :vartype category: CategoricalOptions
        :ivar data_labeler: option set for data_labeler profiling.
        :vartype data_labeler: DataLabelerOptions
        :ivar correlation: option set for correlation profiling.
        :vartype correlation: CorrelationOptions
        :ivar chi2_homogeneity: option set for chi2_homogeneity matrix
        :vartype chi2_homogeneity: BooleanOption()
        :ivar row_statistics: option set for row statistics calculations
        :vartype row_statistics: BooleanOption()
        :ivar null_replication_metrics: option set for metrics
            calculation for replicating nan vals
        :vartype null_replication_metrics: BooleanOptions
        :ivar null_values: option set for defined null values
        :vartype null_values: Union[None, dict]
        :ivar sampling_ratio: What ratio of the input data to sample.
            Float value > 0 and <= 1
        :vartype sampling_ratio: Union[None, float]
        """
        # Option variables
        self.multiprocess: BooleanOption = BooleanOption()
        self.int: IntOptions = IntOptions()
        self.float: FloatOptions = FloatOptions()
        self.datetime: DateTimeOptions = DateTimeOptions()
        self.text: TextOptions = TextOptions()
        self.order: OrderOptions = OrderOptions()
        self.category: CategoricalOptions = CategoricalOptions()
        self.data_labeler: DataLabelerOptions = DataLabelerOptions()
        self.correlation: CorrelationOptions = CorrelationOptions()
        self.chi2_homogeneity: BooleanOption = BooleanOption(is_enabled=True)
        self.null_replication_metrics: BooleanOption = BooleanOption(is_enabled=False)
        self.row_statistics: RowStatisticsOptions = RowStatisticsOptions()
        # Non-Option variables
        self.null_values = null_values
        self.column_null_values = column_null_values
        self.sampling_ratio = sampling_ratio

    @property
    def enabled_profiles(self) -> list[str]:
        """Return a list of the enabled profilers for columns."""
        enabled_profiles = list()
        # null_values and column_null_values do not have is_enabled
        properties = self.properties
        properties.pop("null_values")
        properties.pop("column_null_values")
        properties.pop("sampling_ratio")
        for key, value in properties.items():
            if value.is_enabled:
                enabled_profiles.append(key)
        return enabled_profiles

    def _validate_helper(self, variable_path: str = "StructuredOptions") -> list[str]:
        """
        Validate the options do not conflict and cause errors.

        :param variable_path: current path to variable set.
        :type variable_path: str
        :return: list of errors (if raise_error is false)
        :rtype: list(str)
        """
        if not isinstance(variable_path, str):
            raise ValueError("The variable path must be a string.")

        errors = []

        prop_check = dict(
            [
                ("multiprocess", BooleanOption),
                ("int", IntOptions),
                ("float", FloatOptions),
                ("datetime", DateTimeOptions),
                ("text", TextOptions),
                ("order", OrderOptions),
                ("category", CategoricalOptions),
                ("data_labeler", DataLabelerOptions),
                ("correlation", CorrelationOptions),
                ("chi2_homogeneity", BooleanOption),
                ("row_statistics", RowStatisticsOptions),
                ("null_replication_metrics", BooleanOption),
            ]
        )
        properties = self.properties
        properties.pop("null_values")
        properties.pop("column_null_values")
        properties.pop("sampling_ratio")
        for column in properties:
            if not isinstance(self.properties[column], prop_check[column]):
                errors.append(
                    "{}.{} must be a(n) {}.".format(
                        variable_path, column, prop_check[column].__name__
                    )
                )
            else:
                errors += self.properties[column]._validate_helper(
                    variable_path=(
                        variable_path + "." + column if variable_path else column
                    )
                )

        if self.null_values is not None and not (
            isinstance(self.null_values, dict)
            and all(
                isinstance(key, str) and (isinstance(value, re.RegexFlag) or value == 0)
                for key, value in self.null_values.items()
            )
        ):
            errors.append(
                "{}.null_values must be either None or "
                "a dictionary that contains keys of type str "
                "and values == 0 or are instances of "
                "a re.RegexFlag".format(variable_path)
            )

        if self.column_null_values is not None and not (
            isinstance(self.column_null_values, dict)
            and all(
                isinstance(key, int)
                and isinstance(value, dict)
                and all(
                    isinstance(k, str) and (isinstance(v, re.RegexFlag) or v == 0)
                    for k, v in value.items()
                )
                for key, value in self.column_null_values.items()
            )
        ):
            errors.append(
                "{}.column_null_values must be either None or "
                "a dictionary that contains keys of type int "
                "that map to dictionaries that contains keys "
                "of type str and values == 0 or are instances of "
                "a re.RegexFlag".format(variable_path)
            )

        if self.sampling_ratio is None:
            errors.append(f"{variable_path}.sampling_ratio may not be None")

        if (
            self.sampling_ratio is not None
            and not isinstance(self.sampling_ratio, float)
            and not isinstance(self.sampling_ratio, int)
        ):
            errors.append(
                f"{variable_path}.sampling_ratio must be a float or an integer"
            )

        if (
            self.sampling_ratio is not None
            and (
                isinstance(self.sampling_ratio, float)
                or isinstance(self.sampling_ratio, int)
            )
            and not (0.0 < self.sampling_ratio <= 1.0)
        ):
            errors.append(
                "{}.sampling_ratio must be greater than 0.0 "
                "and less than or equal to 1.0".format(variable_path)
            )

        if (
            isinstance(self.category, CategoricalOptions)
            and isinstance(self.chi2_homogeneity, BooleanOption)
            and not self.category.is_enabled
            and self.chi2_homogeneity.is_enabled
        ):
            errors.append(
                "Categorical statistics must be enabled if "
                "Chi-squared test in enabled."
            )

        return errors


class UnstructuredOptions(BaseOption["UnstructuredOptions"]):
    """For configuring options for unstructured profiler."""

    def __init__(self) -> None:
        """
        Construct the UnstructuredOptions object with default values.

        :ivar text: option set for text profiling.
        :vartype text: TextProfilerOptions
        :ivar data_labeler: option set for data_labeler profiling.
        :vartype data_labeler: DataLabelerOptions
        """
        self.text = TextProfilerOptions()
        self.data_labeler = DataLabelerOptions()

    @property
    def enabled_profiles(self) -> list[str]:
        """Return a list of the enabled profilers."""
        enabled_profiles = list()
        for key, value in self.properties.items():
            if value.is_enabled:
                enabled_profiles.append(key)
        return enabled_profiles

    def _validate_helper(self, variable_path: str = "UnstructuredOptions") -> list[str]:
        """
        Validate the options do not conflict and cause errors.

        :param variable_path: current path to variable set.
        :type variable_path: str
        :return: list of errors (if raise_error is false)
        :rtype: list(str)
        """
        if not isinstance(variable_path, str):
            raise ValueError("The variable path must be a string.")

        errors = []

        prop_check = dict(
            [("text", TextProfilerOptions), ("data_labeler", DataLabelerOptions)]
        )

        for prop in self.properties:
            if not isinstance(self.properties[prop], prop_check[prop]):
                errors.append(
                    "{}.{} must be a(n) {}.".format(
                        variable_path, prop, prop_check[prop].__name__
                    )
                )
            else:
                errors += self.properties[prop]._validate_helper(
                    variable_path=(
                        variable_path + "." + prop if variable_path else prop
                    )
                )
        return errors


class ProfilerOptions(BaseOption["ProfilerOptions"]):
    """For configuring options for profiler."""

    def __init__(self, presets: str = None) -> None:
        """
        Initialize the ProfilerOptions object.

        :ivar structured_options: option set for structured dataset profiling.
        :vartype structured_options: StructuredOptions
        :ivar unstructured_options: option set for unstructured dataset profiling.
        :vartype unstructured_options: UnstructuredOptions
        :ivar presets: A pre-configured mapping of a string name to group of options:
            "complete", "data_types", "numeric_stats_disabled",
            and "lower_memory_sketching". Default: None
        :vartype presets: Optional[str]
        """
        self.structured_options = StructuredOptions()
        self.unstructured_options = UnstructuredOptions()
        self.presets = presets
        option_plugins = get_plugins("option_preset")
        if self.presets:
            if self.presets == "complete":
                self._complete_presets()
            elif self.presets == "data_types":
                self._data_types_presets()
            elif self.presets == "numeric_stats_disabled":
                self._numeric_stats_disabled_presets()
            elif self.presets == "lower_memory_sketching":
                self._lower_memory_sketching_presets()
            elif option_plugins is not None and self.presets in option_plugins:
                option_plugins[self.presets](self)
            else:
                raise ValueError("The preset entered is not a valid preset.")

    def _complete_presets(self) -> None:
        self.set({"*.is_enabled": True})

    def _data_types_presets(self) -> None:
        self.set({"*.is_enabled": False})
        self.set({"*.data_labeler.is_enabled": True})

    def _numeric_stats_disabled_presets(self) -> None:
        self.set({"*.int.is_numeric_stats_enabled": False})
        self.set({"*.float.is_numeric_stats_enabled": False})
        self.set({"structured_options.text.is_numeric_stats_enabled": False})

    def _lower_memory_sketching_presets(self) -> None:
        self.set({"row_statistics.unique_count.hashing_method": "hll"})
        self.set(
            {
                (
                    "structured_options.category."
                    "max_sample_size_to_check_stop_condition"
                ): 5000
            }
        )
        self.set({"structured_options.category.stop_condition_unique_value_ratio": 0.5})

    def _validate_helper(self, variable_path: str = "ProfilerOptions") -> list[str]:
        """
        Validate the options do not conflict and cause errors.

        :param variable_path: current path to variable set.
        :type variable_path: str
        :return: list of errors (if raise_error is false)
        :rtype: list(str)
        """
        if not isinstance(variable_path, str):
            raise ValueError("The variable path must be a string.")

        errors = []
        if not isinstance(self.structured_options, StructuredOptions):
            errors.append(
                "{}.structured_options must be a StructuredOptions.".format(
                    variable_path
                )
            )

        errors += self.structured_options._validate_helper(
            variable_path=variable_path + ".structured_options"
        )

        if not isinstance(self.unstructured_options, UnstructuredOptions):
            errors.append(
                "{}.unstructured_options must be an UnstructuredOptions.".format(
                    variable_path
                )
            )

        errors += self.unstructured_options._validate_helper(
            variable_path=variable_path + ".unstructured_options"
        )

        return errors

    def set(self, options: dict[str, Any]) -> None:
        """
        Overwrite BaseOption.set.

        We do this because the type (unstructured/structured) may
        need to be specified if the same options exist within both
        self.structured_options and self.unstructured_options

        :param options: Dictionary of options to set
        :type options: dict
        :Return: None
        """
        if not isinstance(options, dict):
            raise ValueError("The options must be a dictionary.")

        # Options that need further specification
        overlap_options = {
            "data_labeler_object",
            "data_labeler_dirpath",
            "text.is_enabled",
            "text.vocab",
        }

        # Specification needed for overlap_options above
        option_specifications = {"*", "structured_options", "unstructured_options"}

        # Function to see if any overlap options present in option being set
        def overlap_opt_set(opt: str) -> bool:
            for overlap_opt in overlap_options:
                if overlap_opt in opt:
                    return True
            return False

        overlap_dict = dict()
        for option in options:
            # Tried to set an overlap option without specifying struct/unstruct
            if option.split(".")[0] not in option_specifications and overlap_opt_set(
                option
            ):
                overlap_dict[option] = options[option]

        if overlap_dict:
            raise ValueError(
                f"Attempted to set options {overlap_dict} in "
                f"ProfilerOptions without specifying whether "
                f"to set them for StructuredOptions or "
                f"UnstructuredOptions."
            )

        # Set options as normal if none were overlapping
        self._set_helper(options, variable_path="")