1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
|
import glob
import os
import os.path as op
import pathlib
import re
from typing import Any, Dict, Iterable, Optional, Set, Tuple
import pytest
from codespell_lib._codespell import (
_builtin_dictionaries,
supported_languages,
word_regex_def,
)
spellers = {}
root = pathlib.Path(__file__).parent.parent
try:
import aspell # type: ignore[import]
_test_data_dir = op.join(op.dirname(__file__), "..", "tests", "data")
for lang in supported_languages:
_wordlist = op.join(_test_data_dir, f"{lang}-additional.wordlist")
if op.isfile(_wordlist):
spellers[lang] = aspell.Speller(
("lang", lang), ("size", "80"), ("wordlists", _wordlist)
)
else:
spellers[lang] = aspell.Speller(("lang", lang), ("size", "80"))
except ImportError as e:
if os.getenv("REQUIRE_ASPELL", "false").lower() == "true":
msg = (
"Cannot run complete tests without aspell when "
f"REQUIRE_ASPELL=true. Got error during import:\n{e}"
)
raise RuntimeError(msg) from e
global_err_dicts: Dict[str, Dict[str, Any]] = {}
global_pairs: Set[Tuple[str, str]] = set()
# Filename, should be seen as errors in aspell or not
_data_dir = op.join(op.dirname(__file__), "..", "data")
_fnames_in_aspell = [
(op.join(_data_dir, f"dictionary{d[2]}.txt"), d[3:5], d[5:7])
for d in _builtin_dictionaries
]
fname_params = pytest.mark.parametrize(
("fname", "in_aspell", "in_dictionary"), _fnames_in_aspell
)
def test_dictionaries_exist() -> None:
"""Test consistency of dictionaries."""
doc_fnames = {op.basename(f[0]) for f in _fnames_in_aspell}
got_fnames = {op.basename(f) for f in glob.glob(op.join(_data_dir, "*.txt"))}
assert doc_fnames == got_fnames
@fname_params
def test_dictionary_formatting(
fname: str,
in_aspell: Tuple[bool, bool],
in_dictionary: Tuple[Iterable[str], Iterable[str]],
) -> None:
"""Test that all dictionary entries are valid."""
errors = []
with open(fname, encoding="utf-8") as fid:
for line in fid:
err, rep = line.split("->")
err = err.lower()
rep = rep.rstrip("\n")
try:
_check_err_rep(err, rep, in_aspell, fname, in_dictionary)
except AssertionError as exp:
errors.append(str(exp).split("\n", maxsplit=1)[0])
if errors:
msg = "\n" + "\n".join(errors)
raise AssertionError(msg)
@pytest.mark.parametrize(
"filename",
[
*(root / "data").rglob("dictionary*.txt"),
*(root / "tests/data").rglob("*.wordlist"),
],
)
def test_dictionary_sorting(filename: pathlib.Path) -> None:
relative_path = filename.relative_to(root)
previous_line = None
with filename.open(encoding="utf-8") as file:
for current_line in file:
current_line = current_line.strip().lower()
if previous_line is not None:
assert previous_line < current_line, f"{relative_path} is not sorted"
previous_line = current_line
def _check_aspell(
phrase: str,
msg: str,
in_aspell: Optional[bool],
fname: str,
languages: Iterable[str],
) -> None:
if not spellers: # if no spellcheckers exist
return # cannot check
if in_aspell is None:
return # don't check
if " " in phrase:
for word in phrase.split():
_check_aspell(word, msg, in_aspell, fname, languages)
return # stop normal checking as we've done each word above
this_in_aspell = any(
spellers[lang].check(phrase.encode(spellers[lang].ConfigKeys()["encoding"][1]))
for lang in languages
)
end = f"be in aspell dictionaries ({', '.join(languages)}) for dictionary {fname}"
if in_aspell: # should be an error in aspell
assert this_in_aspell, f"{msg} should {end}"
else: # shouldn't be
assert not this_in_aspell, f"{msg} should not {end}"
whitespace = re.compile(r"\s")
start_whitespace = re.compile(r"^\s")
start_comma = re.compile(r"^,")
whitespace_comma = re.compile(r"\s,")
comma_whitespaces = re.compile(r",\s\s")
comma_without_space = re.compile(r",[^ ]")
whitespace_end = re.compile(r"\s+$")
single_comma = re.compile(r"^[^,]*,\s*$")
def _check_err_rep(
err: str,
rep: str,
in_aspell: Tuple[Optional[bool], Optional[bool]],
fname: str,
languages: Tuple[Iterable[str], Iterable[str]],
) -> None:
assert whitespace.search(err) is None, f"error {err!r} has whitespace"
assert "," not in err, f"error {err!r} has a comma"
assert len(rep) > 0, f"error {err}: correction {rep!r} must be non-empty"
assert not start_whitespace.match(rep), (
f"error {err}: correction {rep!r} cannot start with whitespace"
)
_check_aspell(err, f"error {err!r}", in_aspell[0], fname, languages[0])
prefix = f"error {err}: correction {rep!r}"
for regex, msg in (
(start_comma, "%s starts with a comma"),
(
whitespace_comma,
"%s contains a whitespace character followed by a comma",
),
(
comma_whitespaces,
"%s contains a comma followed by multiple whitespace characters",
),
(comma_without_space, "%s contains a comma *not* followed by a space"),
(whitespace_end, "%s has a trailing space"),
(single_comma, "%s has a single entry but contains a trailing comma"),
):
assert not regex.search(rep), msg % (prefix,)
del msg
if rep.count(","):
assert rep.endswith(","), (
f'error {err}: multiple corrections must end with trailing ","'
)
reps = [r.strip() for r in rep.split(",")]
reps = [r for r in reps if len(r)]
for r in reps:
assert err != r.lower(), f"error {err!r} corrects to itself amongst others"
_check_aspell(
r,
f"error {err}: correction {r!r}",
in_aspell[1],
fname,
languages[1],
)
# aspell dictionary is case sensitive, so pass the original case into there
# we could ignore the case, but that would miss things like days of the
# week which we want to be correct
reps = [r.lower() for r in reps]
assert len(set(reps)) == len(reps), (
f'error {err}: corrections "{rep}" are not (lower-case) unique'
)
@pytest.mark.parametrize(
("err", "rep", "match"),
[
("a a", "bar", "has whitespace"),
("a,a", "bar", "has a comma"),
("a", "", "non-empty"),
("a", " bar", "start with whitespace"),
("a", ",bar", "starts with a comma"),
("a", "bar,bat", ".*not.*followed by a space"),
("a", "bar ", "trailing space"),
("a", "b ,ar", "contains a whitespace.*followed by a comma"),
("a", "bar,", "single entry.*comma"),
("a", "bar, bat", 'must end with trailing ","'),
("a", "a, bar,", "corrects to itself amongst others"),
("a", "a", "corrects to itself"),
("a", "bar, Bar,", "unique"),
],
)
def test_error_checking(err: str, rep: str, match: str) -> None:
"""Test that our error checking works."""
with pytest.raises(AssertionError, match=match):
_check_err_rep(
err,
rep,
(None, None),
"dummy",
(supported_languages, supported_languages),
)
@pytest.mark.skipif(not spellers, reason="requires aspell-en")
@pytest.mark.parametrize(
("err", "rep", "err_aspell", "rep_aspell", "match"),
[
# This doesn't raise any exceptions, so skip for now:
# pytest.param('a', 'uvw, bar,', None, None, 'should be in aspell'),
("abcdef", "uvwxyz, bar,", True, None, "should be in aspell"),
("a", "uvwxyz, bar,", False, None, "should not be in aspell"),
("a", "abcdef, uvwxyz,", None, True, "should be in aspell"),
("abcdef", "uvwxyz, bar,", True, True, "should be in aspell"),
("abcdef", "uvwxyz, bar,", False, True, "should be in aspell"),
("a", "bar, back,", None, False, "should not be in aspell"),
("a", "bar, back, Wednesday,", None, False, "should not be in aspell"),
("abcdef", "ghijkl, uvwxyz,", True, False, "should be in aspell"),
("abcdef", "uvwxyz, bar,", False, False, "should not be in aspell"),
# Multi-word corrections
# One multi-word, both parts
("a", "abcdef uvwxyz", None, True, "should be in aspell"),
("a", "bar back", None, False, "should not be in aspell"),
("a", "bar back Wednesday", None, False, "should not be in aspell"),
# Second multi-word, both parts
(
"a",
"bar back, abcdef uvwxyz, bar,",
None,
True,
"should be in aspell",
),
(
"a",
"abcdef uvwxyz, bar back, ghijkl,",
None,
False,
"should not be in aspell",
),
# One multi-word, second part
("a", "bar abcdef", None, True, "should be in aspell"),
("a", "abcdef back", None, False, "should not be in aspell"),
],
)
def test_error_checking_in_aspell(
err: str,
rep: str,
err_aspell: Optional[bool],
rep_aspell: Optional[bool],
match: str,
) -> None:
"""Test that our error checking works with aspell."""
with pytest.raises(AssertionError, match=match):
_check_err_rep(
err,
rep,
(err_aspell, rep_aspell),
"dummy",
(supported_languages, supported_languages),
)
# allow some duplicates, like "m-i-n-i-m-i-s-e", or "c-a-l-c-u-l-a-t-a-b-l-e"
# correction in left can appear as typo in right
allowed_dups = {
("dictionary.txt", "dictionary_code.txt"),
("dictionary.txt", "dictionary_en-GB_to_en-US.txt"),
("dictionary.txt", "dictionary_names.txt"),
("dictionary.txt", "dictionary_rare.txt"),
("dictionary.txt", "dictionary_usage.txt"),
("dictionary_code.txt", "dictionary_rare.txt"),
("dictionary_rare.txt", "dictionary_en-GB_to_en-US.txt"),
("dictionary_rare.txt", "dictionary_usage.txt"),
}
@fname_params
@pytest.mark.dependency(name="dictionary loop")
def test_dictionary_looping(
fname: str,
in_aspell: Tuple[bool, bool],
in_dictionary: Tuple[bool, bool],
) -> None:
"""Test that all dictionary entries are valid."""
this_err_dict = {}
short_fname = op.basename(fname)
word_regex = re.compile(word_regex_def)
with open(fname, encoding="utf-8") as fid:
for line in fid:
err, rep = line.split("->")
err = err.lower()
assert err not in this_err_dict, (
f"error {err!r} already exists in {short_fname}"
)
rep = rep.rstrip("\n")
reps = [r.strip() for r in rep.lower().split(",")]
reps = [r for r in reps if len(r)]
this_err_dict[err] = reps
# 1. check the dict against itself (diagonal)
for err, reps in this_err_dict.items():
assert word_regex.fullmatch(err), (
f"error {err!r} does not match default word regex '{word_regex_def}'"
)
for r in reps:
assert r not in this_err_dict, (
f"error {err}: correction {r} is an error itself "
f"in the same dictionary file {short_fname}"
)
pair = (short_fname, short_fname)
assert pair not in global_pairs
global_pairs.add(pair)
for other_fname, other_err_dict in global_err_dicts.items():
# error duplication (eventually maybe we should just merge?)
for err in this_err_dict:
assert err not in other_err_dict, (
f"error {err!r} in dictionary {short_fname} "
f"already exists in dictionary {other_fname}"
)
# 2. check corrections in this dict against other dicts (upper)
pair = (short_fname, other_fname)
if pair not in allowed_dups:
for err, reps in this_err_dict.items():
assert err not in other_err_dict, (
f"error {err!r} in dictionary {short_fname} "
f"already exists in dictionary {other_fname}"
)
for r in reps:
assert r not in other_err_dict, (
f"error {err}: correction {r} from dictionary {short_fname} "
f"is an error itself in dictionary {other_fname}"
)
assert pair not in global_pairs
global_pairs.add(pair)
# 3. check corrections in other dicts against this dict (lower)
pair = (other_fname, short_fname)
if pair not in allowed_dups:
for err in other_err_dict:
for r in other_err_dict[err]:
assert r not in this_err_dict, (
f"error {err}: correction {r} from dictionary {other_fname} "
f"is an error itself in dictionary {short_fname}"
)
assert pair not in global_pairs
global_pairs.add(pair)
global_err_dicts[short_fname] = this_err_dict
@pytest.mark.dependency(depends=["dictionary loop"])
def test_ran_all() -> None:
"""Test that all pairwise tests ran."""
for f1, _, _ in _fnames_in_aspell:
f1 = op.basename(f1)
for f2, _, _ in _fnames_in_aspell:
f2 = op.basename(f2)
assert (f1, f2) in global_pairs
assert len(global_pairs) == len(_fnames_in_aspell) ** 2
|