move further modules to internals

moj-analytical-services · May 20, 2024 · 1c02a03 · 1c02a03
1 parent 2f8964f
commit 1c02a03
Show file tree

Hide file tree

Showing 36 changed files with 78 additions and 1,064 deletions.
diff --git a/docs/topic_guides/comparisons/choosing_comparators.ipynb b/docs/topic_guides/comparisons/choosing_comparators.ipynb
diff --git a/scripts/generate_dialect_comparison_docs.py b/scripts/generate_dialect_comparison_docs.py
@@ -4,8 +4,8 @@
 import inspect
 from pathlib import Path
 
-from splink.comparison import Comparison
-from splink.comparison_level import ComparisonLevel
+from splink.internals.comparison import Comparison
+from splink.internals.comparison_level import ComparisonLevel
 from splink.dialect_base import DialectBase
 
 # could always pick this up dynamically,

diff --git a/splink/comparison_library.py b/splink/comparison_library.py
@@ -2,10 +2,10 @@
 
 from typing import Any, Iterable, List, Optional, Union
 
-from . import comparison_level_library as cll
-from .comparison_creator import ComparisonCreator
-from .comparison_level_creator import ComparisonLevelCreator
-from .comparison_level_library import CustomLevel, DateMetricType
+from .internals import comparison_level_library as cll
+from splink.internals.comparison_creator import ComparisonCreator
+from splink.internals.comparison_level_creator import ComparisonLevelCreator
+from splink.internals.comparison_level_library import CustomLevel, DateMetricType
 from .misc import ensure_is_iterable
 
 

diff --git a/splink/comparison_template_library.py b/splink/comparison_template_library.py
@@ -2,11 +2,11 @@
 
 from typing import List, Type, Union
 
-from . import comparison_level_library as cll
+from .internals import comparison_level_library as cll
 from splink.internals.column_expression import ColumnExpression
-from .comparison_creator import ComparisonCreator
-from .comparison_level_creator import ComparisonLevelCreator
-from .comparison_level_library import DateMetricType
+from splink.internals.comparison_creator import ComparisonCreator
+from splink.internals.comparison_level_creator import ComparisonLevelCreator
+from splink.internals.comparison_level_library import DateMetricType
 from .misc import ensure_is_iterable
 
 # alternatively we could stick an inheritance layer in these, just for typing:

diff --git a/splink/dialects.py b/splink/dialects.py
@@ -4,7 +4,7 @@
 from typing import TYPE_CHECKING, Type, TypeVar, final
 
 if TYPE_CHECKING:
-    from .comparison_level_library import (
+    from splink.internals.comparison_level_library import (
         AbsoluteTimeDifferenceLevel,
         ArrayIntersectLevel,
     )

diff --git a/splink/em_training_session.py b/splink/em_training_session.py
@@ -10,8 +10,8 @@
     probability_two_random_records_match_iteration_chart,
 )
 
-from .comparison import Comparison
-from .comparison_level import ComparisonLevel
+from splink.internals.comparison import Comparison
+from splink.internals.comparison_level import ComparisonLevel
 from .comparison_vector_values import compute_comparison_vector_values_sql
 from .constants import LEVEL_NOT_OBSERVED_TEXT
 from .database_api import DatabaseAPISubClass

diff --git a/splink/expectation_maximisation.py b/splink/expectation_maximisation.py
@@ -6,8 +6,8 @@
 
 import pandas as pd
 
-from .comparison import Comparison
-from .comparison_level import ComparisonLevel
+from splink.internals.comparison import Comparison
+from splink.internals.comparison_level import ComparisonLevel
 from .constants import LEVEL_NOT_OBSERVED_TEXT
 from .database_api import DatabaseAPISubClass
 from .input_column import InputColumn

diff --git a/splink/comparison.py → splink/internals/comparison.py b/splink/comparison.py → splink/internals/comparison.py
@@ -3,11 +3,11 @@
 from typing import TYPE_CHECKING, Any, List, Optional
 
 from .comparison_level import ComparisonLevel, _default_m_values, _default_u_values
-from .misc import dedupe_preserving_order, join_list_with_commas_final_and
+from splink.misc import dedupe_preserving_order, join_list_with_commas_final_and
 
 # https://stackoverflow.com/questions/39740632/python-type-hinting-without-cyclic-imports
 if TYPE_CHECKING:
-    from .settings import ColumnInfoSettings
+    from splink.settings import ColumnInfoSettings
 
 
 class Comparison:

diff --git a/splink/comparison_creator.py → splink/internals/comparison_creator.py b/splink/comparison_creator.py → splink/internals/comparison_creator.py
@@ -6,7 +6,7 @@
 from splink.internals.column_expression import ColumnExpression
 from .comparison import Comparison
 from .comparison_level_creator import ComparisonLevelCreator
-from .exceptions import SplinkException
+from splink.exceptions import SplinkException
 
 
 class ComparisonCreator(ABC):

diff --git a/splink/comparison_helpers.py → splink/internals/comparison_helpers.py b/splink/comparison_helpers.py → splink/internals/comparison_helpers.py
diff --git a/splink/comparison_level.py → splink/internals/comparison_level.py b/splink/comparison_level.py → splink/internals/comparison_level.py
@@ -13,16 +13,16 @@
 from sqlglot.optimizer.normalize import normalize
 from sqlglot.optimizer.simplify import simplify
 
-from .constants import LEVEL_NOT_OBSERVED_TEXT
-from .input_column import InputColumn
-from .misc import (
+from splink.constants import LEVEL_NOT_OBSERVED_TEXT
+from splink.input_column import InputColumn
+from splink.misc import (
     dedupe_preserving_order,
     interpolate,
     join_list_with_commas_final_and,
     match_weight_to_bayes_factor,
 )
-from .parse_sql import get_columns_used_from_sql
-from .sql_transform import sqlglot_tree_signature
+from splink.parse_sql import get_columns_used_from_sql
+from splink.sql_transform import sqlglot_tree_signature
 
 logger = logging.getLogger(__name__)
 

diff --git a/splink/comparison_level_composition.py → ...internals/comparison_level_composition.py b/splink/comparison_level_composition.py → ...internals/comparison_level_composition.py
@@ -6,7 +6,7 @@
 
 from .comparison_creator import ComparisonLevelCreator
 from .comparison_level import ComparisonLevel
-from .dialects import SplinkDialect
+from splink.dialects import SplinkDialect
 
 
 def _ensure_is_comparison_level_creator(

diff --git a/splink/comparison_level_creator.py → splink/internals/comparison_level_creator.py b/splink/comparison_level_creator.py → splink/internals/comparison_level_creator.py
@@ -6,7 +6,7 @@
 
 from splink.internals.column_expression import ColumnExpression
 from .comparison_level import ComparisonLevel
-from .dialects import SplinkDialect
+from splink.dialects import SplinkDialect
 
 
 class ComparisonLevelCreator(ABC):

diff --git a/splink/comparison_level_library.py → splink/internals/comparison_level_library.py b/splink/comparison_level_library.py → splink/internals/comparison_level_library.py
@@ -11,8 +11,8 @@
 # import composition functions for export
 from .comparison_level_composition import And, Not, Or  # NOQA: F401
 from .comparison_level_creator import ComparisonLevelCreator
-from .comparison_level_sql import great_circle_distance_km_sql
-from .dialects import SplinkDialect
+from splink.comparison_level_sql import great_circle_distance_km_sql
+from splink.dialects import SplinkDialect
 
 # type aliases:
 T = TypeVar("T", bound=ComparisonLevelCreator)

diff --git a/splink/linker.py b/splink/linker.py
@@ -40,8 +40,8 @@
     render_splink_cluster_studio_html,
 )
 
-from .comparison import Comparison
-from .comparison_level import ComparisonLevel
+from splink.internals.comparison import Comparison
+from splink.internals.comparison_level import ComparisonLevel
 from .comparison_vector_distribution import (
     comparison_vector_distribution_sql,
 )

diff --git a/splink/m_u_records_to_parameters.py b/splink/m_u_records_to_parameters.py
@@ -3,7 +3,7 @@
 import logging
 from typing import Any, Dict, List
 
-from .comparison_level import ComparisonLevel
+from splink.internals.comparison_level import ComparisonLevel
 from .constants import LEVEL_NOT_OBSERVED_TEXT
 
 logger = logging.getLogger(__name__)

diff --git a/splink/predict.py b/splink/predict.py
@@ -4,7 +4,7 @@
 import logging
 from typing import List
 
-from .comparison import Comparison
+from splink.internals.comparison import Comparison
 from .input_column import InputColumn
 from .misc import prob_to_bayes_factor, prob_to_match_weight
 from .settings import CoreModelSettings, Settings

diff --git a/splink/settings.py b/splink/settings.py
@@ -12,8 +12,8 @@
 )
 from splink.internals.charts import m_u_parameters_chart, match_weights_chart
 
-from .comparison import Comparison
-from .comparison_level import ComparisonLevel
+from splink.internals.comparison import Comparison
+from splink.internals.comparison_level import ComparisonLevel
 from .input_column import InputColumn
 from .misc import dedupe_preserving_order, prob_to_bayes_factor, prob_to_match_weight
 from .parse_sql import get_columns_used_from_sql

diff --git a/splink/settings_creator.py b/splink/settings_creator.py
@@ -9,7 +9,7 @@
 from splink.internals.blocking_rule_creator import BlockingRuleCreator
 from splink.internals.blocking_rule_creator_utils import to_blocking_rule_creator
 
-from .comparison_creator import ComparisonCreator
+from splink.internals.comparison_creator import ComparisonCreator
 from .comparison_library import CustomComparison
 from .settings import Settings
 

diff --git a/splink/settings_validation/log_invalid_columns.py b/splink/settings_validation/log_invalid_columns.py
@@ -7,7 +7,7 @@
 import sqlglot
 import sqlglot.expressions
 
-from ..comparison import Comparison
+from splink.internals.comparison import Comparison
 from ..parse_sql import parse_columns_in_sql
 from .settings_column_cleaner import (
     SettingsColumnCleaner,

diff --git a/splink/waterfall_chart.py b/splink/waterfall_chart.py
@@ -4,7 +4,7 @@
 from copy import deepcopy
 from typing import Any, Dict
 
-from .comparison import Comparison
+from splink.internals.comparison import Comparison
 from .misc import prob_to_bayes_factor
 
 

diff --git a/tests/literal_utils.py b/tests/literal_utils.py
@@ -3,8 +3,8 @@
 
 import pytest
 
-from splink.comparison_creator import ComparisonCreator
-from splink.comparison_level_creator import ComparisonLevelCreator
+from splink.internals.comparison_creator import ComparisonCreator
+from splink.internals.comparison_level_creator import ComparisonLevelCreator
 
 
 class ComparisonLevelTestSpec:

diff --git a/tests/test_columns_selected.py b/tests/test_columns_selected.py
@@ -4,7 +4,7 @@
 
 import pandas as pd
 
-import splink.comparison_level_library as cll
+import splink.internals.comparison_level_library as cll
 from splink.duckdb.database_api import DuckDBAPI
 from splink.linker import Linker
 

diff --git a/tests/test_comparison_level.py b/tests/test_comparison_level.py
@@ -1,6 +1,6 @@
 from pytest import mark, raises
 
-from splink.comparison_level import ComparisonLevel
+from splink.internals.comparison_level import ComparisonLevel
 
 from .decorator import mark_with_dialects_excluding
 

diff --git a/tests/test_comparison_level_composition.py b/tests/test_comparison_level_composition.py
@@ -1,7 +1,7 @@
 import pandas as pd
 import pytest
 
-import splink.comparison_level_library as cll
+import splink.internals.comparison_level_library as cll
 from splink.input_column import _get_dialect_quotes
 
 from .decorator import mark_with_dialects_excluding

diff --git a/tests/test_comparison_level_lib.py b/tests/test_comparison_level_lib.py
@@ -1,6 +1,6 @@
 import pandas as pd
 
-import splink.comparison_level_library as cll
+import splink.internals.comparison_level_library as cll
 
 from .decorator import mark_with_dialects_excluding
 

diff --git a/tests/test_compound_comparison_levels.py b/tests/test_compound_comparison_levels.py
@@ -1,6 +1,6 @@
 import pandas as pd
 
-import splink.comparison_level_library as cll
+import splink.internals.comparison_level_library as cll
 import splink.comparison_library as cl
 from splink.duckdb.database_api import DuckDBAPI
 from splink.linker import Linker

diff --git a/tests/test_date_levels_and_comparisons.py b/tests/test_date_levels_and_comparisons.py
@@ -2,7 +2,7 @@
 
 import pytest
 
-import splink.comparison_level_library as cll
+import splink.internals.comparison_level_library as cll
 import splink.comparison_library as cl
 import splink.comparison_template_library as ctl
 from splink.internals.column_expression import ColumnExpression

diff --git a/tests/test_disable_tf_exact_match_detection.py b/tests/test_disable_tf_exact_match_detection.py
@@ -1,7 +1,7 @@
 import pandas as pd
 import pytest
 
-import splink.comparison_level_library as cll
+import splink.internals.comparison_level_library as cll
 from splink import DuckDBAPI, Linker, SettingsCreator
 
 

diff --git a/tests/test_full_example_duckdb.py b/tests/test_full_example_duckdb.py
@@ -6,7 +6,7 @@
 import pyarrow.parquet as pq
 import pytest
 
-import splink.comparison_level_library as cll
+import splink.internals.comparison_level_library as cll
 import splink.comparison_library as cl
 from splink.blocking_analysis import count_comparisons_from_blocking_rule
 from splink.duckdb.database_api import DuckDBAPI

diff --git a/tests/test_full_example_spark.py b/tests/test_full_example_spark.py
@@ -5,7 +5,7 @@
 import pytest
 from pyspark.sql.types import StringType, StructField, StructType
 
-import splink.comparison_level_library as cll
+import splink.internals.comparison_level_library as cll
 import splink.comparison_library as cl
 from splink.exploratory import completeness_chart, profile_columns
 from splink.linker import Linker

diff --git a/tests/test_km_distance_level.py b/tests/test_km_distance_level.py
@@ -1,6 +1,6 @@
 import pandas as pd
 
-import splink.comparison_level_library as cll
+import splink.internals.comparison_level_library as cll
 import splink.comparison_library as cl
 from splink.duckdb.database_api import DuckDBAPI
 from splink.linker import Linker

diff --git a/tests/test_new_comparison_levels.py b/tests/test_new_comparison_levels.py
@@ -3,7 +3,7 @@
 import pandas as pd
 import pytest
 
-import splink.comparison_level_library as cll
+import splink.internals.comparison_level_library as cll
 import splink.comparison_library as cl
 import splink.comparison_template_library as ctl
 from splink.internals.column_expression import ColumnExpression

diff --git a/tests/test_new_db_api.py b/tests/test_new_db_api.py
@@ -1,6 +1,6 @@
 import os
 
-import splink.comparison_level_library as cll
+import splink.internals.comparison_level_library as cll
 import splink.comparison_library as cl
 from splink import block_on
 from splink.blocking_analysis import (

diff --git a/tests/test_regex_param.py b/tests/test_regex_param.py
@@ -1,7 +1,7 @@
 import pandas as pd
 import pytest
 
-import splink.comparison_level_library as cll
+import splink.internals.comparison_level_library as cll
 from splink.internals.column_expression import ColumnExpression
 
 from .decorator import mark_with_dialects_excluding

diff --git a/tests/test_spark_udfs.py b/tests/test_spark_udfs.py
@@ -1,6 +1,6 @@
 import pandas as pd
 
-import splink.comparison_level_library as cll
+import splink.internals.comparison_level_library as cll
 from splink.linker import Linker
 from tests.decorator import mark_with_dialects_including