nltk--nltk
3454a55636
cffconvert / validate (push) Has been cancelled
ci-workflow / pre-commit (push) Has been cancelled
ci-workflow / Minimal NLTK Download Test (macos-latest) (push) Has been cancelled
ci-workflow / Minimal NLTK Download Test (ubuntu-latest) (push) Has been cancelled
ci-workflow / Minimal NLTK Download Test (windows-latest) (push) Has been cancelled
ci-workflow / Python 3.10 on macos-latest (push) Has been cancelled
ci-workflow / Python 3.11 on macos-latest (push) Has been cancelled
ci-workflow / Python 3.12 on macos-latest (push) Has been cancelled
ci-workflow / Python 3.13 on macos-latest (push) Has been cancelled
ci-workflow / Python 3.14 on macos-latest (push) Has been cancelled
ci-workflow / Python 3.14t on macos-latest (push) Has been cancelled
ci-workflow / Python 3.10 on ubuntu-latest (push) Has been cancelled
ci-workflow / Python 3.11 on ubuntu-latest (push) Has been cancelled
ci-workflow / Python 3.12 on ubuntu-latest (push) Has been cancelled
ci-workflow / Python 3.13 on ubuntu-latest (push) Has been cancelled
ci-workflow / Python 3.14 on ubuntu-latest (push) Has been cancelled
ci-workflow / Python 3.14t on ubuntu-latest (push) Has been cancelled
ci-workflow / Python 3.10 on windows-latest (push) Has been cancelled
ci-workflow / Python 3.11 on windows-latest (push) Has been cancelled
ci-workflow / Python 3.12 on windows-latest (push) Has been cancelled
ci-workflow / Python 3.13 on windows-latest (push) Has been cancelled
ci-workflow / Python 3.14 on windows-latest (push) Has been cancelled
469 行
18 KiB
Python
469 行
18 KiB
Python
import multiprocessing
|
|
import queue
|
|
from typing import Tuple
|
|
|
|
import pytest
|
|
|
|
from nltk import pathsec
|
|
from nltk.metrics.distance import (
|
|
custom_distance,
|
|
edit_distance,
|
|
edit_distance_align,
|
|
jaro_similarity,
|
|
jaro_winkler_similarity,
|
|
)
|
|
|
|
|
|
class TestEditDistance:
|
|
@pytest.mark.parametrize(
|
|
"left,right,substitution_cost,expecteds",
|
|
[
|
|
# Allowing transpositions reduces the number of edits required.
|
|
# with transpositions:
|
|
# e.g. "abc" -T-> "cba" -D-> "ca": 2 steps
|
|
#
|
|
# without transpositions:
|
|
# e.g. "abc" -D-> "ab" -D-> "a" -I-> "ca": 3 steps
|
|
("abc", "ca", 1, (2, 3)),
|
|
("abc", "ca", 5, (2, 3)), # Doesn't *require* substitutions
|
|
# Note, a substition_cost of higher than 2 doesn't make much
|
|
# sense, as a deletion + insertion is identical, and always
|
|
# costs 2.
|
|
#
|
|
#
|
|
# Transpositions don't always reduce the number of edits required:
|
|
# with or without transpositions:
|
|
# e.g. "wants" -D-> "wats" -D-> "was" -I-> "wasp": 3 steps
|
|
("wants", "wasp", 1, (3, 3)),
|
|
("wants", "wasp", 5, (3, 3)), # Doesn't *require* substitutions
|
|
#
|
|
#
|
|
# Ought to have the same results with and without transpositions
|
|
# with or without transpositions:
|
|
# e.g. "rain" -S-> "sain" -S-> "shin" -I-> "shine": 3 steps
|
|
# (but cost 5 if substitution_cost=2)
|
|
("rain", "shine", 1, (3, 3)),
|
|
("rain", "shine", 2, (5, 5)), # Does *require* substitutions
|
|
#
|
|
#
|
|
# Several potentially interesting typos
|
|
# with transpositions:
|
|
# e.g. "acbdef" -T-> "abcdef": 1 step
|
|
#
|
|
# without transpositions:
|
|
# e.g. "acbdef" -D-> "abdef" -I-> "abcdef": 2 steps
|
|
("acbdef", "abcdef", 1, (1, 2)),
|
|
("acbdef", "abcdef", 2, (1, 2)), # Doesn't *require* substitutions
|
|
#
|
|
#
|
|
# with transpositions:
|
|
# e.g. "lnaguaeg" -T-> "languaeg" -T-> "language": 2 steps
|
|
#
|
|
# without transpositions:
|
|
# e.g. "lnaguaeg" -D-> "laguaeg" -I-> "languaeg" -D-> "languag" -I-> "language": 4 steps
|
|
("lnaguaeg", "language", 1, (2, 4)),
|
|
("lnaguaeg", "language", 2, (2, 4)), # Doesn't *require* substitutions
|
|
#
|
|
#
|
|
# with transpositions:
|
|
# e.g. "lnaugage" -T-> "lanugage" -T-> "language": 2 steps
|
|
#
|
|
# without transpositions:
|
|
# e.g. "lnaugage" -S-> "lnangage" -D-> "langage" -I-> "language": 3 steps
|
|
# (but one substitution, so a cost of 4 if substition_cost = 2)
|
|
("lnaugage", "language", 1, (2, 3)),
|
|
("lnaugage", "language", 2, (2, 4)),
|
|
# Does *require* substitutions if no transpositions
|
|
#
|
|
#
|
|
# with transpositions:
|
|
# e.g. "lngauage" -T-> "lnaguage" -T-> "language": 2 steps
|
|
# without transpositions:
|
|
# e.g. "lngauage" -I-> "lanaguage" -D-> "language": 2 steps
|
|
("lngauage", "language", 1, (2, 2)),
|
|
("lngauage", "language", 2, (2, 2)), # Doesn't *require* substitutions
|
|
#
|
|
#
|
|
# with or without transpositions:
|
|
# e.g. "wants" -S-> "sants" -S-> "swnts" -S-> "swits" -S-> "swims" -D-> "swim": 5 steps
|
|
#
|
|
# with substitution_cost=2 and transpositions:
|
|
# e.g. "wants" -T-> "santw" -D-> "sntw" -D-> "stw" -D-> "sw"
|
|
# -I-> "swi" -I-> "swim": 6 steps
|
|
#
|
|
# with substitution_cost=2 and no transpositions:
|
|
# e.g. "wants" -I-> "swants" -D-> "swant" -D-> "swan" -D-> "swa" -D-> "sw"
|
|
# -I-> "swi" -I-> "swim": 7 steps
|
|
("wants", "swim", 1, (5, 5)),
|
|
("wants", "swim", 2, (6, 7)),
|
|
#
|
|
#
|
|
# with or without transpositions:
|
|
# e.g. "kitten" -S-> "sitten" -s-> "sittin" -I-> "sitting": 3 steps
|
|
# (but cost 5 if substitution_cost=2)
|
|
("kitten", "sitting", 1, (3, 3)),
|
|
("kitten", "sitting", 2, (5, 5)),
|
|
#
|
|
# duplicated letter
|
|
# e.g. "duplicated" -D-> "duplicated"
|
|
("duplicated", "duuplicated", 1, (1, 1)),
|
|
("duplicated", "duuplicated", 2, (1, 1)),
|
|
("very duplicated", "very duuplicateed", 2, (2, 2)),
|
|
],
|
|
)
|
|
def test_with_transpositions(
|
|
self, left: str, right: str, substitution_cost: int, expecteds: tuple[int, int]
|
|
):
|
|
"""
|
|
Test `edit_distance` between two strings, given some `substitution_cost`,
|
|
and whether transpositions are allowed.
|
|
|
|
:param str left: First input string to `edit_distance`.
|
|
:param str right: Second input string to `edit_distance`.
|
|
:param int substitution_cost: The cost of a substitution action in `edit_distance`.
|
|
:param Tuple[int, int] expecteds: A tuple of expected outputs, such that `expecteds[0]` is
|
|
the expected output with `transpositions=True`, and `expecteds[1]` is
|
|
the expected output with `transpositions=False`.
|
|
"""
|
|
# Test the input strings in both orderings
|
|
for s1, s2 in ((left, right), (right, left)):
|
|
# zip with [True, False] to get the transpositions value
|
|
for expected, transpositions in zip(expecteds, [True, False]):
|
|
predicted = edit_distance(
|
|
s1,
|
|
s2,
|
|
substitution_cost=substitution_cost,
|
|
transpositions=transpositions,
|
|
)
|
|
assert predicted == expected
|
|
|
|
|
|
class TestJaroSimilarity:
|
|
"""Tests for jaro_similarity against the algorithm pseudocode."""
|
|
|
|
# ---------------------------------------------------------
|
|
# Edge cases: empty and single-character strings
|
|
# ---------------------------------------------------------
|
|
|
|
def test_both_empty(self):
|
|
"""Identical empty strings have similarity 1.0."""
|
|
assert jaro_similarity("", "") == 1.0
|
|
|
|
def test_empty_vs_nonempty(self):
|
|
"""Empty vs non-empty string has similarity 0.0."""
|
|
assert jaro_similarity("", "abc") == 0.0
|
|
assert jaro_similarity("abc", "") == 0.0
|
|
|
|
def test_single_char_identical(self):
|
|
"""Single-char identical strings have similarity 1.0.
|
|
|
|
Regression: match_bound = max(1,1)//2 - 1 = -1 caused 0
|
|
matches, returning 0.0 instead of 1.0.
|
|
"""
|
|
assert jaro_similarity("a", "a") == 1.0
|
|
|
|
def test_single_char_different(self):
|
|
assert jaro_similarity("a", "b") == 0.0
|
|
|
|
# ---------------------------------------------------------
|
|
# Known values from Wikipedia / census papers
|
|
# ---------------------------------------------------------
|
|
|
|
@pytest.mark.parametrize(
|
|
"s1,s2,expected",
|
|
[
|
|
("MARTHA", "MARHTA", 0.944),
|
|
("DWAYNE", "DUANE", 0.822),
|
|
("DIXON", "DICKSON", 0.790),
|
|
("CRATE", "TRACE", 0.733),
|
|
("billy", "billy", 1.000),
|
|
("billy", "bill", 0.933),
|
|
("billy", "susan", 0.000),
|
|
],
|
|
)
|
|
def test_known_values(self, s1, s2, expected):
|
|
assert round(jaro_similarity(s1, s2), 3) == expected
|
|
|
|
# ---------------------------------------------------------
|
|
# Symmetry: jaro(s1, s2) == jaro(s2, s1)
|
|
# ---------------------------------------------------------
|
|
|
|
@pytest.mark.parametrize(
|
|
"s1,s2",
|
|
[
|
|
("MARTHA", "MARHTA"),
|
|
("abc", ""),
|
|
("a", "b"),
|
|
("DIXON", "DICKSON"),
|
|
],
|
|
)
|
|
def test_symmetry(self, s1, s2):
|
|
assert jaro_similarity(s1, s2) == jaro_similarity(s2, s1)
|
|
|
|
# ---------------------------------------------------------
|
|
# Return type consistency
|
|
# ---------------------------------------------------------
|
|
|
|
def test_return_type_is_float(self):
|
|
"""All return paths should produce a float."""
|
|
assert isinstance(jaro_similarity("a", "a"), float)
|
|
assert isinstance(jaro_similarity("a", "b"), float)
|
|
assert isinstance(jaro_similarity("", ""), float)
|
|
assert isinstance(jaro_similarity("MARTHA", "MARHTA"), float)
|
|
|
|
|
|
class TestJaroWinklerSimilarity:
|
|
"""Tests for jaro_winkler_similarity edge cases."""
|
|
|
|
def test_both_empty(self):
|
|
assert jaro_winkler_similarity("", "") == 1.0
|
|
|
|
def test_single_char_identical(self):
|
|
assert jaro_winkler_similarity("a", "a") == 1.0
|
|
|
|
def test_single_char_different(self):
|
|
assert jaro_winkler_similarity("a", "b") == 0.0
|
|
|
|
def test_known_value(self):
|
|
assert round(jaro_winkler_similarity("MARTHA", "MARHTA"), 3) == 0.961
|
|
|
|
def test_winkler_ge_jaro(self):
|
|
"""Winkler similarity >= Jaro similarity for common prefixes."""
|
|
s1, s2 = "MARTHA", "MARHTA"
|
|
assert jaro_winkler_similarity(s1, s2) >= jaro_similarity(s1, s2)
|
|
|
|
|
|
def _alignment_has_no_substitutions(alignment):
|
|
"""Check that no step in the alignment is a diagonal move between mismatched positions."""
|
|
for k in range(len(alignment) - 1):
|
|
i1, j1 = alignment[k]
|
|
i2, j2 = alignment[k + 1]
|
|
if i2 == i1 + 1 and j2 == j1 + 1:
|
|
return False # diagonal move = substitution or match; caller must verify
|
|
return True
|
|
|
|
|
|
def _alignment_cost(alignment, s1, s2, substitution_cost):
|
|
"""Compute the total cost of an alignment."""
|
|
cost = 0
|
|
for k in range(len(alignment) - 1):
|
|
i1, j1 = alignment[k]
|
|
i2, j2 = alignment[k + 1]
|
|
if i2 == i1 + 1 and j2 == j1 + 1:
|
|
# diagonal: match or substitution
|
|
if s1[i1] != s2[j1]:
|
|
cost += substitution_cost
|
|
# else: match, cost 0
|
|
elif i2 == i1 + 1 and j2 == j1:
|
|
cost += 1 # deletion
|
|
elif i2 == i1 and j2 == j1 + 1:
|
|
cost += 1 # insertion
|
|
return cost
|
|
|
|
|
|
class TestEditDistanceAlign:
|
|
def test_default_rain_to_shine(self):
|
|
"""Docstring example: rain -> shine with default substitution_cost=1."""
|
|
result = edit_distance_align("rain", "shine")
|
|
assert result == [(0, 0), (1, 1), (2, 2), (3, 3), (4, 4), (4, 5)]
|
|
|
|
def test_identical_strings(self):
|
|
"""Identical strings should produce a pure diagonal alignment."""
|
|
result = edit_distance_align("abc", "abc")
|
|
assert result == [(0, 0), (1, 1), (2, 2), (3, 3)]
|
|
|
|
def test_empty_to_nonempty(self):
|
|
"""Empty s1 -> all insertions."""
|
|
result = edit_distance_align("", "abc")
|
|
assert result == [(0, 0), (0, 1), (0, 2), (0, 3)]
|
|
|
|
def test_nonempty_to_empty(self):
|
|
"""Non-empty s1 to empty s2 -> all deletions."""
|
|
result = edit_distance_align("abc", "")
|
|
assert result == [(0, 0), (1, 0), (2, 0), (3, 0)]
|
|
|
|
def test_both_empty(self):
|
|
result = edit_distance_align("", "")
|
|
assert result == [(0, 0)]
|
|
|
|
def test_single_char_substitution(self):
|
|
"""Single character substitution with default cost."""
|
|
result = edit_distance_align("a", "b")
|
|
assert result == [(0, 0), (1, 1)]
|
|
|
|
# --- The core bug fix: substitution_cost > 2 ---
|
|
|
|
def test_inf_sub_cost_different_chars(self):
|
|
"""Bug from issue #3017: sub_cost=inf should avoid substitution."""
|
|
result = edit_distance_align("a", "b", float("inf"))
|
|
# Must use delete + insert, NOT substitution
|
|
assert result in [
|
|
[(0, 0), (0, 1), (1, 1)], # insert then delete
|
|
[(0, 0), (1, 0), (1, 1)], # delete then insert
|
|
]
|
|
|
|
def test_inf_sub_cost_identical_strings(self):
|
|
"""With sub_cost=inf, identical strings must still use diagonal (match, cost 0)."""
|
|
result = edit_distance_align("abc", "abc", float("inf"))
|
|
assert result == [(0, 0), (1, 1), (2, 2), (3, 3)]
|
|
|
|
def test_inf_sub_cost_partial_match(self):
|
|
"""With sub_cost=inf, matching chars use diagonal, mismatched use del+ins."""
|
|
result = edit_distance_align("ab", "cb", float("inf"))
|
|
# a->del, ins->c, b=b(match)
|
|
assert result == [(0, 0), (0, 1), (1, 1), (2, 2)]
|
|
cost = _alignment_cost(result, "ab", "cb", float("inf"))
|
|
assert cost == 2 # one delete + one insert
|
|
|
|
def test_inf_sub_cost_longer_partial_match(self):
|
|
"""Longer string with inf sub_cost: matches use diagonal, mismatches use del+ins."""
|
|
result = edit_distance_align("abcd", "axcy", float("inf"))
|
|
cost = _alignment_cost(result, "abcd", "axcy", float("inf"))
|
|
assert cost == 4 # two mismatched pairs, each costs 2 (del+ins)
|
|
|
|
def test_sub_cost_2_prefers_substitution(self):
|
|
"""When sub_cost=2 (equal to del+ins), substitution is preferred per precedence."""
|
|
result = edit_distance_align("a", "b", 2)
|
|
# Diagonal is listed first in candidates, so tied cost -> diagonal wins
|
|
assert result == [(0, 0), (1, 1)]
|
|
|
|
def test_sub_cost_3_avoids_substitution(self):
|
|
"""When sub_cost=3 (more than del+ins=2), should avoid substitution."""
|
|
result = edit_distance_align("a", "b", 3)
|
|
assert result in [
|
|
[(0, 0), (0, 1), (1, 1)],
|
|
[(0, 0), (1, 0), (1, 1)],
|
|
]
|
|
|
|
# --- Alignment cost consistency ---
|
|
|
|
@pytest.mark.parametrize(
|
|
"s1,s2,sub_cost",
|
|
[
|
|
("rain", "shine", 1),
|
|
("kitten", "sitting", 1),
|
|
("abc", "def", 1),
|
|
("abc", "def", 2),
|
|
("abc", "def", float("inf")),
|
|
("abc", "abc", float("inf")),
|
|
("", "abc", 1),
|
|
("abc", "", 1),
|
|
("saturday", "sunday", 1),
|
|
],
|
|
)
|
|
def test_alignment_cost_equals_edit_distance(self, s1, s2, sub_cost):
|
|
"""The cost of the alignment path must equal the edit distance."""
|
|
alignment = edit_distance_align(s1, s2, sub_cost)
|
|
cost = _alignment_cost(alignment, s1, s2, sub_cost)
|
|
expected = edit_distance(s1, s2, substitution_cost=sub_cost)
|
|
assert cost == expected
|
|
|
|
# --- Alignment structural validity ---
|
|
|
|
@pytest.mark.parametrize(
|
|
"s1,s2,sub_cost",
|
|
[
|
|
("abc", "xyz", 1),
|
|
("abc", "xyz", float("inf")),
|
|
("hello", "world", 1),
|
|
("hello", "world", float("inf")),
|
|
],
|
|
)
|
|
def test_alignment_starts_and_ends_correctly(self, s1, s2, sub_cost):
|
|
"""Alignment must start at (0,0) and end at (len(s1), len(s2))."""
|
|
alignment = edit_distance_align(s1, s2, sub_cost)
|
|
assert alignment[0] == (0, 0)
|
|
assert alignment[-1] == (len(s1), len(s2))
|
|
|
|
@pytest.mark.parametrize(
|
|
"s1,s2,sub_cost",
|
|
[
|
|
("abc", "xyz", 1),
|
|
("abc", "xyz", float("inf")),
|
|
("rain", "shine", 1),
|
|
],
|
|
)
|
|
def test_alignment_steps_are_valid(self, s1, s2, sub_cost):
|
|
"""Each step must advance by exactly (1,1), (1,0), or (0,1)."""
|
|
alignment = edit_distance_align(s1, s2, sub_cost)
|
|
for k in range(len(alignment) - 1):
|
|
i1, j1 = alignment[k]
|
|
i2, j2 = alignment[k + 1]
|
|
di, dj = i2 - i1, j2 - j1
|
|
assert (di, dj) in [
|
|
(1, 1),
|
|
(1, 0),
|
|
(0, 1),
|
|
], f"Invalid step from {(i1,j1)} to {(i2,j2)}"
|
|
|
|
|
|
class TestCustomDistanceSandbox:
|
|
def test_enforces_pathsec_sandbox(self, tmp_path, monkeypatch):
|
|
"""``custom_distance`` must read through the pathsec sandbox (CWE-22).
|
|
|
|
Regression test ensuring it does not fall back to the builtin ``open``:
|
|
under ``ENFORCE`` a path outside the allowed roots is rejected, while an
|
|
in-root file still loads into a working distance callable.
|
|
"""
|
|
allowed = tmp_path / "data"
|
|
allowed.mkdir()
|
|
outside = tmp_path / "outside"
|
|
outside.mkdir()
|
|
monkeypatch.setattr(pathsec, "ENFORCE", True)
|
|
monkeypatch.setattr(pathsec, "_get_allowed_roots", lambda: {allowed.resolve()})
|
|
|
|
out_tsv = outside / "d.tsv"
|
|
out_tsv.write_text("a\tb\t0.5\n", encoding="utf-8")
|
|
with pytest.raises((PermissionError, ValueError)):
|
|
custom_distance(str(out_tsv))
|
|
|
|
in_tsv = allowed / "d.tsv"
|
|
in_tsv.write_text("a\tb\t0.5\n", encoding="utf-8")
|
|
dist = custom_distance(str(in_tsv))
|
|
assert dist(frozenset(["a"]), frozenset(["b"])) == 0.5
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# jaro_similarity must not be cubic on near-matching strings (CWE-770; CVE-2026-12926)
|
|
# ---------------------------------------------------------------------------
|
|
|
|
_JARO_TIMEOUT = 20
|
|
# Two near-identical strings: almost every character matches inside the window.
|
|
# The pre-fix ``j not in flagged_2`` list membership made this O(n**3) (~tens of
|
|
# seconds at this size); with a set it is the algorithm's natural O(n**2)
|
|
# (sub-second). It is CPU-only (a few KB of input), so there is no OOM risk.
|
|
_JARO_N = 8000
|
|
|
|
|
|
def _jaro_worker(result_q):
|
|
try:
|
|
jaro_similarity("a" * _JARO_N, "a" * (_JARO_N - 1) + "b")
|
|
result_q.put(("ok", None))
|
|
except BaseException as exc: # surface to the parent process
|
|
result_q.put(("error", repr(exc)))
|
|
|
|
|
|
def test_jaro_similarity_not_cubic_on_near_matches():
|
|
"""A near-matching pair must compute quickly, not in cubic time (ReDoS-style).
|
|
|
|
Runs in a spawned process with a hard timeout and reports status back via a
|
|
queue, so a regression to the cubic version is terminated (no lingering CPU)
|
|
and any worker exception is surfaced to the assertion.
|
|
"""
|
|
ctx = multiprocessing.get_context("spawn")
|
|
result_q = ctx.Queue()
|
|
proc = ctx.Process(target=_jaro_worker, args=(result_q,))
|
|
proc.start()
|
|
proc.join(_JARO_TIMEOUT)
|
|
if proc.is_alive():
|
|
proc.terminate()
|
|
proc.join()
|
|
raise AssertionError(
|
|
"jaro_similarity did not finish in time -> cubic-time DoS (CWE-770)"
|
|
)
|
|
try:
|
|
status, detail = result_q.get_nowait()
|
|
except queue.Empty:
|
|
raise AssertionError("jaro_similarity worker produced no result")
|
|
assert status == "ok", f"worker raised: {detail}"
|