refactored naming to match checkmate

Nabil Fayak · Nabil Fayak · commit c1da59d6d19a · 2023-07-19T11:14:51.000-04:00
diff --git a/checkmate/__init__.py b/checkmate/__init__.py
@@ -0,0 +1,45 @@
+"""General datachecks directory."""
+
+from checkmate.data_checks.checks.data_check import DataCheck
+from checkmate.data_checks.datacheck_meta.data_check_message_code import (
+    DataCheckMessageCode,
+)
+from checkmate.data_checks.datacheck_meta.data_check_action import DataCheckAction
+from checkmate.data_checks.datacheck_meta.data_check_action_option import (
+    DataCheckActionOption,
+    DCAOParameterType,
+    DCAOParameterAllowedValuesType,
+)
+from checkmate.data_checks.datacheck_meta.data_check_action_code import (
+    DataCheckActionCode,
+)
+from checkmate.data_checks.checks.data_checks import DataChecks
+from checkmate.data_checks.datacheck_meta.data_check_message import (
+    DataCheckMessage,
+    DataCheckWarning,
+    DataCheckError,
+)
+from checkmate.data_checks.datacheck_meta.data_check_message_type import (
+    DataCheckMessageType,
+)
+from checkmate.data_checks.checks.id_columns_data_check import IDColumnsDataCheck
+
+from checkmate.problem_types.problem_types import ProblemTypes
+from checkmate.problem_types.utils import (
+    handle_problem_types,
+    detect_problem_type,
+    is_regression,
+    is_binary,
+    is_multiclass,
+    is_classification,
+    is_time_series,
+)
+
+from checkmate.exceptions.exceptions import (
+    DataCheckInitError,
+    MissingComponentError,
+    ValidationErrorCode,
+)
+
+from checkmate.utils.gen_utils import classproperty
+from checkmate.utils.woodwork_utils import infer_feature_types
diff --git a/checkmate/data_checks/__init__.py b/checkmate/data_checks/__init__.py
@@ -0,0 +1,27 @@
+"""Base data checks and ID column data check."""
+
+from checkmate.data_checks.checks.data_check import DataCheck
+from checkmate.data_checks.datacheck_meta.data_check_message_code import (
+    DataCheckMessageCode,
+)
+from checkmate.data_checks.datacheck_meta.data_check_action import DataCheckAction
+from checkmate.data_checks.datacheck_meta.data_check_action_option import (
+    DataCheckActionOption,
+    DCAOParameterType,
+    DCAOParameterAllowedValuesType,
+)
+from checkmate.data_checks.datacheck_meta.data_check_action_code import (
+    DataCheckActionCode,
+)
+from checkmate.data_checks.checks.data_checks import DataChecks
+from checkmate.data_checks.datacheck_meta.data_check_message import (
+    DataCheckMessage,
+    DataCheckWarning,
+    DataCheckError,
+)
+from checkmate.data_checks.datacheck_meta.data_check_message_type import (
+    DataCheckMessageType,
+)
+from checkmate.data_checks.checks.id_columns_data_check import IDColumnsDataCheck
+
+from checkmate.data_checks.datacheck_meta.utils import handle_data_check_action_code
diff --git a/checkmate/data_checks/checks/data_check.py b/checkmate/data_checks/checks/data_check.py
@@ -1,7 +1,7 @@
 """Base class for all data checks."""
 from abc import ABC, abstractmethod
 
-from datachecks.utils import classproperty
+from checkmate.utils import classproperty
 
 
 class DataCheck(ABC):
diff --git a/checkmate/data_checks/checks/data_checks.py b/checkmate/data_checks/checks/data_checks.py
@@ -1,9 +1,9 @@
 """A collection of data checks."""
 import inspect
 
-from datachecks.data_checks import DataCheck
-from datachecks.exceptions import DataCheckInitError
-from datachecks.utils import infer_feature_types
+from checkmate.data_checks import DataCheck
+from checkmate.exceptions import DataCheckInitError
+from checkmate.utils import infer_feature_types
 
 
 def _has_defaults_for_all_args(init):
diff --git a/checkmate/data_checks/checks/id_columns_data_check.py b/checkmate/data_checks/checks/id_columns_data_check.py
@@ -1,13 +1,13 @@
 """Data check that checks if any of the features are likely to be ID columns."""
 
-from datachecks.data_checks import (
+from checkmate.data_checks import (
     DataCheck,
     DataCheckActionCode,
     DataCheckActionOption,
     DataCheckMessageCode,
     DataCheckWarning,
 )
-from datachecks.utils import infer_feature_types
+from checkmate.utils import infer_feature_types
 
 
 class IDColumnsDataCheck(DataCheck):
diff --git a/checkmate/data_checks/datacheck_meta/data_check_action.py b/checkmate/data_checks/datacheck_meta/data_check_action.py
@@ -1,9 +1,9 @@
 """Recommended action returned by a DataCheck."""
 
-from datachecks.data_checks.datacheck_meta.data_check_action_code import (
+from checkmate.data_checks.datacheck_meta.data_check_action_code import (
     DataCheckActionCode,
 )
-from datachecks.data_checks.datacheck_meta.utils import handle_data_check_action_code
+from checkmate.data_checks.datacheck_meta.utils import handle_data_check_action_code
 
 
 class DataCheckAction:
diff --git a/checkmate/data_checks/datacheck_meta/data_check_action_code.py b/checkmate/data_checks/datacheck_meta/data_check_action_code.py
@@ -1,7 +1,7 @@
 """Enum for data check action code."""
 from enum import Enum
 
-from datachecks.utils import classproperty
+from checkmate.utils import classproperty
 
 
 class DataCheckActionCode(Enum):
diff --git a/checkmate/data_checks/datacheck_meta/data_check_action_option.py b/checkmate/data_checks/datacheck_meta/data_check_action_option.py
@@ -1,11 +1,11 @@
 """Recommended action returned by a DataCheck."""
 from enum import Enum
 
-from datachecks.data_checks.datacheck_meta.data_check_action import DataCheckAction
-from datachecks.data_checks.datacheck_meta.data_check_action_code import (
+from checkmate.data_checks.datacheck_meta.data_check_action import DataCheckAction
+from checkmate.data_checks.datacheck_meta.data_check_action_code import (
     DataCheckActionCode,
 )
-from datachecks.utils import classproperty
+from checkmate.utils import classproperty
 
 
 class DataCheckActionOption:
diff --git a/checkmate/data_checks/datacheck_meta/data_check_message.py b/checkmate/data_checks/datacheck_meta/data_check_message.py
@@ -1,5 +1,5 @@
 """Messages returned by a DataCheck, tagged by name."""
-from datachecks.data_checks.datacheck_meta.data_check_message_type import (
+from checkmate.data_checks.datacheck_meta.data_check_message_type import (
     DataCheckMessageType,
 )
 
diff --git a/checkmate/data_checks/datacheck_meta/data_check_message_code.py b/checkmate/data_checks/datacheck_meta/data_check_message_code.py
diff --git a/checkmate/data_checks/datacheck_meta/data_check_message_type.py b/checkmate/data_checks/datacheck_meta/data_check_message_type.py
diff --git a/checkmate/data_checks/datacheck_meta/utils.py b/checkmate/data_checks/datacheck_meta/utils.py
@@ -1,5 +1,5 @@
 """Utility methods for the data checks in DataChecks."""
-from datachecks.data_checks.datacheck_meta.data_check_action_code import (
+from checkmate.data_checks.datacheck_meta.data_check_action_code import (
     DataCheckActionCode,
 )
 
diff --git a/checkmate/exceptions/__init__.py b/checkmate/exceptions/__init__.py
@@ -1,5 +1,5 @@
 """Exceptions used in DataChecks."""
-from datachecks.exceptions.exceptions import (
+from checkmate.exceptions.exceptions import (
     DataCheckInitError,
     MissingComponentError,
     ValidationErrorCode,
diff --git a/checkmate/exceptions/exceptions.py b/checkmate/exceptions/exceptions.py
diff --git a/checkmate/problem_types/__init__.py b/checkmate/problem_types/__init__.py
@@ -1,6 +1,6 @@
 """The supported types of machine learning problems."""
-from datachecks.problem_types.problem_types import ProblemTypes
-from datachecks.problem_types.utils import (
+from checkmate.problem_types.problem_types import ProblemTypes
+from checkmate.problem_types.utils import (
     handle_problem_types,
     detect_problem_type,
     is_regression,
diff --git a/checkmate/problem_types/problem_types.py b/checkmate/problem_types/problem_types.py
@@ -1,7 +1,7 @@
 """Enum defining the supported types of machine learning problems."""
 from enum import Enum
 
-from datachecks.utils import classproperty
+from checkmate.utils import classproperty
 
 
 class ProblemTypes(Enum):
diff --git a/checkmate/problem_types/utils.py b/checkmate/problem_types/utils.py
@@ -2,7 +2,7 @@
 import pandas as pd
 from pandas.api.types import is_numeric_dtype
 
-from datachecks.problem_types.problem_types import ProblemTypes
+from checkmate.problem_types.problem_types import ProblemTypes
 
 
 def handle_problem_types(problem_type):
diff --git a/checkmate/utils/__init__.py b/checkmate/utils/__init__.py
@@ -0,0 +1,3 @@
+"""Utility methods."""
+from checkmate.utils.gen_utils import classproperty
+from checkmate.utils.woodwork_utils import infer_feature_types
diff --git a/checkmate/utils/gen_utils.py b/checkmate/utils/gen_utils.py
diff --git a/checkmate/utils/woodwork_utils.py b/checkmate/utils/woodwork_utils.py
diff --git a/datachecks/__init__.py b/datachecks/__init__.py
diff --git a/datachecks/data_checks/__init__.py b/datachecks/data_checks/__init__.py
diff --git a/datachecks/utils/__init__.py b/datachecks/utils/__init__.py
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -20,7 +20,7 @@
 from sphinx.domains.python import PythonDomain
 from sphinx.ext.autodoc import Documenter, MethodDocumenter
 
-import datachecks
+import checkmate
 
 path = os.path.join("..", "..")
 sys.path.insert(0, os.path.abspath(path))
@@ -33,9 +33,9 @@
 author = "Alteryx, Inc."
 
 # The short X.Y version
-version = datachecks.__version__
+version = checkmate.__version__
 # The full version, including alpha/beta/rc tags
-release = datachecks.__version__
+release = checkmate.__version__
 
 
 # -- General configuration ---------------------------------------------------
diff --git a/tests/data_checks_tests/test_data_check.py b/tests/data_checks_tests/test_data_check.py
@@ -1,8 +1,8 @@
 import pandas as pd
 import pytest
 
-from datachecks.data_checks.checks.data_check import DataCheck
-from datachecks.data_checks.datacheck_meta.data_check_message import (
+from checkmate.data_checks.checks.data_check import DataCheck
+from checkmate.data_checks.datacheck_meta.data_check_message import (
     DataCheckError,
     DataCheckWarning,
 )
diff --git a/tests/data_checks_tests/test_data_check_action.py b/tests/data_checks_tests/test_data_check_action.py
@@ -1,6 +1,6 @@
 import pytest
 
-from datachecks.data_checks import DataCheckAction, DataCheckActionCode
+from checkmate.data_checks import DataCheckAction, DataCheckActionCode
 
 
 def test_data_check_action_attributes(dummy_data_check_name):
diff --git a/tests/data_checks_tests/test_data_check_action_option.py b/tests/data_checks_tests/test_data_check_action_option.py
@@ -2,12 +2,12 @@
 
 import pytest
 
-from datachecks.data_checks import (
+from checkmate.data_checks import (
     DataCheckActionCode,
     DataCheckActionOption,
     DCAOParameterType,
 )
-from datachecks.data_checks.datacheck_meta.data_check_action import DataCheckAction
+from checkmate.data_checks.datacheck_meta.data_check_action import DataCheckAction
 
 
 def test_data_check_action_option_attributes(dummy_data_check_name):
diff --git a/tests/data_checks_tests/test_data_check_message.py b/tests/data_checks_tests/test_data_check_message.py
@@ -1,6 +1,6 @@
 import pytest
 
-from datachecks.data_checks import (
+from checkmate.data_checks import (
     DataCheckActionCode,
     DataCheckActionOption,
     DataCheckError,
diff --git a/tests/data_checks_tests/test_id_columns_data_check.py b/tests/data_checks_tests/test_id_columns_data_check.py
@@ -2,7 +2,7 @@
 import pandas as pd
 import pytest
 
-from datachecks.data_checks import (
+from checkmate.data_checks import (
     DataCheckActionCode,
     DataCheckActionOption,
     DataCheckMessageCode,
diff --git a/tests/data_checks_tests/test_utils.py b/tests/data_checks_tests/test_utils.py
@@ -1,8 +1,8 @@
 import pytest
 
-from datachecks.data_checks import DataCheckActionCode
-from datachecks.data_checks.datacheck_meta.utils import handle_data_check_action_code
-from datachecks.problem_types import ProblemTypes
+from checkmate.data_checks import DataCheckActionCode
+from checkmate.data_checks.datacheck_meta.utils import handle_data_check_action_code
+from checkmate.problem_types import ProblemTypes
 
 
 def test_handle_action_code_errors():

Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,9 @@`
`1`	`1`	`"""Recommended action returned by a DataCheck."""`
`2`	`2`
`3`		`-from datachecks.data_checks.datacheck_meta.data_check_action_code import (`
	`3`	`+from checkmate.data_checks.datacheck_meta.data_check_action_code import (`
`4`	`4`	`DataCheckActionCode,`
`5`	`5`	`)`
`6`		`-from datachecks.data_checks.datacheck_meta.utils import handle_data_check_action_code`
	`6`	`+from checkmate.data_checks.datacheck_meta.utils import handle_data_check_action_code`
`7`	`7`
`8`	`8`
`9`	`9`	`class DataCheckAction:`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`"""Messages returned by a DataCheck, tagged by name."""`
`2`		`-from datachecks.data_checks.datacheck_meta.data_check_message_type import (`
	`2`	`+from checkmate.data_checks.datacheck_meta.data_check_message_type import (`
`3`	`3`	`DataCheckMessageType,`
`4`	`4`	`)`
`5`	`5`