Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add distance_threshold check #1718

Merged
merged 2 commits into from
Nov 10, 2023
Merged

Add distance_threshold check #1718

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9a9d0af
add distance threshold check
ThomasHepworth Nov 9, 2023
73f4ff7
Merge branch 'splink4_dev' into validate_distance_thresholds
ThomasHepworth Nov 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion splink/comparison_level_library.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,22 @@
from .dialects import SplinkDialect


def validate_distance_threshold(
lower_bound: Union[int, float],
upper_bound: Union[int, float],
distance_threshold: Union[int, float],
level_name: str,
) -> Union[int, float]:
"""Check if a distance threshold falls between two bounds."""
if lower_bound <= distance_threshold <= upper_bound:
return distance_threshold
else:
raise ValueError(
"'distance_threshold' must be between "
f"{lower_bound} and {upper_bound} for {level_name}"
)


class NullLevel(ComparisonLevelCreator):
def create_sql(self, sql_dialect: SplinkDialect) -> str:
col = self.input_column(sql_dialect)
Expand Down Expand Up @@ -83,8 +99,14 @@ def __init__(self, col_name: str, distance_threshold: Union[int, float]):
distance_threshold (Union[int, float]): The threshold to use to assess
similarity
"""

super().__init__(col_name)
self.distance_threshold = distance_threshold
self.distance_threshold = validate_distance_threshold(
lower_bound=0,
upper_bound=1,
distance_threshold=distance_threshold,
level_name=self.__class__.__name__,
)

def create_sql(self, sql_dialect: SplinkDialect) -> str:
col_l, col_r = self.input_column(sql_dialect).names_l_r()
Expand Down