Repository: great-expectations/great_expectations

Issue:
Use cleaner solution for non-truncating division in python 2
Prefer `from __future__ import division` to `1.*x/y`


Discussion:
Done inline during improve_partitions push.

Resolving patch:
diff --git a/contrib/experimental/great_expectations_experimental/expectations/expect_column_values_to_be_private_ipv4_class.py b/contrib/experimental/great_expectations_experimental/expectations/expect_column_values_to_be_private_ipv4_class.py
new file mode 100644
--- /dev/null
+++ b/contrib/experimental/great_expectations_experimental/expectations/expect_column_values_to_be_private_ipv4_class.py
@@ -0,0 +1,178 @@
+"""
+This is a template for creating custom ColumnMapExpectations.
+For detailed instructions on how to use it, please see:
+    https://docs.greatexpectations.io/docs/guides/expectations/creating_custom_expectations/how_to_create_custom_column_map_expectations
+"""
+import ipaddress
+import json
+from typing import Optional
+
+from great_expectations.core.expectation_configuration import ExpectationConfiguration
+from great_expectations.exceptions import InvalidExpectationConfigurationError
+from great_expectations.execution_engine import PandasExecutionEngine
+from great_expectations.expectations.expectation import ColumnMapExpectation
+from great_expectations.expectations.metrics import (
+    ColumnMapMetricProvider,
+    column_condition_partial,
+)
+
+
+def is_private_ip_address_in_class(addr: str, ip_class) -> bool:
+    try:
+        for ic in ip_class:
+            if ic == "A":
+                if ipaddress.ip_address(addr) in ipaddress.ip_network("10.0.0.0/8"):
+                    return True
+            if ic == "B":
+                if ipaddress.ip_address(addr) in ipaddress.ip_network("172.16.0.0/12"):
+                    return True
+            if ic == "C":
+                if ipaddress.ip_address(addr) in ipaddress.ip_network("192.168.0.0/16"):
+                    return True
+        return False
+    except Exception as e:
+        return False
+
+
+# This class defines a Metric to support your Expectation.
+# For most ColumnMapExpectations, the main business logic for calculation will live in this class.
+class ColumnValuesToBePrivateIpv4Class(ColumnMapMetricProvider):
+    # This is the id string that will be used to reference your metric.
+    condition_metric_name = "column_values.private_ip_class"
+    condition_value_keys = ("ip_class",)
+
+    # This method implements the core logic for the PandasExecutionEngine
+    @column_condition_partial(engine=PandasExecutionEngine)
+    def _pandas(cls, column, ip_class, **kwargs):
+        return column.apply(lambda x: is_private_ip_address_in_class(x, ip_class))
+
+    # This method defines the business logic for evaluating your metric when using a SqlAlchemyExecutionEngine
+    # @column_condition_partial(engine=SqlAlchemyExecutionEngine)
+    # def _sqlalchemy(cls, column, _dialect, **kwargs):
+    #     raise NotImplementedError
+
+    # This method defines the business logic for evaluating your metric when using a SparkDFExecutionEngine
+    # @column_condition_partial(engine=SparkDFExecutionEngine)
+    # def _spark(cls, column, **kwargs):
+    #     raise NotImplementedError
+
+
+# This class defines the Expectation itself
+class ExpectColumnValuesToBePrivateIpv4Class(ColumnMapExpectation):
+    """Expect the provided private IP v4 address in the IP class (A, B, C) which passed in the parameters"""
+
+    # These examples will be shown in the public gallery.
+    # They will also be executed as unit tests for your Expectation.
+    examples = [
+        {
+            "data": {
+                "all_in": [
+                    "192.168.0.0",
+                    "192.168.0.1",
+                    "192.168.0.2",
+                    "192.168.0.3",
+                    "192.168.0.254",
+                ],
+                "some_other": [
+                    "213.181.199.16",
+                    "213.181.199.16",
+                    "213.181.199.16",
+                    "213.181.199.16",
+                    "142.250.180.206",
+                ],
+            },
+            "tests": [
+                {
+                    "title": "basic_positive_test",
+                    "exact_match_out": False,
+                    "include_in_gallery": True,
+                    "in": {
+                        "column": "all_in",
+                        "ip_class": ["A", "C"],
+                    },
+                    "out": {
+                        "success": True,
+                    },
+                },
+                {
+                    "title": "basic_negative_test",
+                    "exact_match_out": False,
+                    "include_in_gallery": True,
+                    "in": {
+                        "column": "some_other",
+                        "ip_class": ["A"],
+                        "mostly": 0.9,
+                    },
+                    "out": {
+                        "success": False,
+                    },
+                },
+            ],
+        }
+    ]
+
+    # This is the id string of the Metric used by this Expectation.
+    # For most Expectations, it will be the same as the `condition_metric_name` defined in your Metric class above.
+    map_metric = "column_values.private_ip_class"
+
+    # This is a list of parameter names that can affect whether the Expectation evaluates to True or False
+    success_keys = (
+        "mostly",
+        "ip_class",
+    )
+
+    # This dictionary contains default values for any parameters that should have default values
+    default_kwarg_values = {}
+
+    def validate_configuration(
+        self, configuration: Optional[ExpectationConfiguration]
+    ) -> None:
+        """
+        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.
+
+        Args:
+            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
+        """
+
+        super().validate_configuration(configuration)
+        if configuration is None:
+            configuration = self.configuration
+
+        # # Check other things in configuration.kwargs and raise Exceptions if needed
+        # try:
+        #     assert (
+        #         ...
+        #     ), "message"
+        #     assert (
+        #         ...
+        #     ), "message"
+        # except AssertionError as e:
+        #     raise InvalidExpectationConfigurationError(str(e))
+
+        return True
+
+    # This object contains metadata for display in the public Gallery
+    library_metadata = {
+        "maturity": "experimental",
+        "tags": [
+            "hackathon-22",
+            "experimental",
+            "typed-entities",
+        ],  # Tags for this Expectation in the Gallery
+        "contributors": [  # Github handles for all contributors to this Expectation.
+            "@szecsip",  # Don't forget to add your github handle here!
+        ],
+    }
+
+    success_keys = (
+        "ip_class",
+        "mostly",
+    )
+
+
+if __name__ == "__main__":
+    ExpectColumnValuesToBePrivateIpv4Class().print_diagnostic_checklist()


Test patch: