Refactor/future annotations

contractions/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import warnings
 
 from ._version import __version__

contractions/_version.py

@@ -1,2 +1,2 @@
-__version__ = "0.3.1"
+__version__ = "0.3.2"
 

contractions/api.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from .extension import add_custom_contraction, add_custom_dict, load_custom_from_file, load_custom_from_folder
 from .processor import expand as _expand
 from .processor import preview as _preview

contractions/bootstrap.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from .file_loader import load_dict_data, load_list_data
 from .transformer import build_apostrophe_variants, normalize_apostrophes
 

contractions/extension.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from .file_loader import load_dict_from_file, load_dict_from_folder
 from .matcher import (
     _get_basic_matcher,
@@ -31,11 +33,9 @@ def add_custom_dict(contractions_dict: dict[str, str]) -> None:
 
 
 def load_custom_from_file(filepath: str) -> None:
-    contractions_data = load_dict_from_file(filepath)
-    add_custom_dict(contractions_data)
+    add_custom_dict(load_dict_from_file(filepath))
 
 
 def load_custom_from_folder(folderpath: str) -> None:
-    contractions_data = load_dict_from_folder(folderpath)
-    add_custom_dict(contractions_data)
+    add_custom_dict(load_dict_from_folder(folderpath))
 

contractions/file_loader.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import json
 import pkgutil
 
@@ -15,7 +17,7 @@ def load_dict_data(filename: str) -> dict[str, str]:
     data = json.loads(json_bytes.decode("utf-8"))
     validate_data_type(data, dict, filename)
 
-    return cast("dict[str, str]", data)
+    return cast(dict[str, str], data)
 
 
 def load_list_data(filename: str) -> list[str]:
@@ -26,7 +28,7 @@ def load_list_data(filename: str) -> list[str]:
     data = json.loads(json_bytes.decode("utf-8"))
     validate_data_type(data, list, filename)
 
-    return cast("list[str]", data)
+    return cast(list[str], data)
 
 
 def load_dict_from_file(filepath: str) -> dict[str, str]:
@@ -36,7 +38,7 @@ def load_dict_from_file(filepath: str) -> dict[str, str]:
 
     contractions_data = json.loads(path.read_text(encoding="utf-8"))
     validate_file_contains_dict(contractions_data, filepath)
-    return cast("dict[str, str]", contractions_data)
+    return cast(dict[str, str], contractions_data)
 
 
 def load_dict_from_folder(folderpath: str) -> dict[str, str]:

contractions/matcher.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from itertools import chain
 
 from textsearch import TextSearch

contractions/processor.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from .matcher import (
     _get_basic_matcher,
     _get_leftovers_matcher,

contractions/state.py

@@ -1,4 +1,9 @@
-from textsearch import TextSearch
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:  # pragma: no cover
+    from textsearch import TextSearch
 
 
 class _State:

contractions/transformer.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from itertools import product
 
 

contractions/validation.py

@@ -1,3 +1,6 @@
+from __future__ import annotations
+
+
 def validate_string_param(value: object, param_name: str) -> None:
     if not isinstance(value, str):
         raise TypeError(f"{param_name} must be a string, got {type(value).__name__}")

pyproject.toml

@@ -155,6 +155,7 @@ ignore = [
     "PLR0913",
     "PLR2004",
     "PLR6104",
+    "TC006",
 ]
 
 [tool.ruff.lint.mccabe]