fix typing for sort keys (finally)

ilius · Dec 5, 2024 · 5419402 · 5419402
1 parent 8075e2a
commit 5419402
Show file tree

Hide file tree

Showing 8 changed files with 56 additions and 64 deletions.
diff --git a/pyglossary/sort_keys.py b/pyglossary/sort_keys.py
@@ -22,12 +22,10 @@
 from typing import TYPE_CHECKING, Any, NamedTuple
 
 if TYPE_CHECKING:
-
 	from .icu_types import T_Collator, T_Locale
 	from .sort_keys_types import (
 		LocaleSortKeyMakerType,
 		SortKeyMakerType,
-		SQLiteLocaleSortKeyMakerType,
 		SQLiteSortKeyMakerType,
 	)
 
@@ -45,8 +43,8 @@
 class NamedSortKey(NamedTuple):
 	name: str
 	desc: str
-	normal: SortKeyMakerType
-	sqlite: SQLiteSortKeyMakerType
+	normal: SortKeyMakerType | None
+	sqlite: SQLiteSortKeyMakerType | None
 
 
 @dataclass(slots=True)  # not frozen because of mod
@@ -66,6 +64,7 @@ def module(self):  # noqa: ANN201
 		self.mod = mod
 		return mod
 
+	# mypy seems to have problems with @property
 	@property
 	def normal(self) -> SortKeyMakerType:
 		return self.module.normal
@@ -79,7 +78,7 @@ def locale(self) -> LocaleSortKeyMakerType | None:
 		return getattr(self.module, "locale", None)
 
 	@property
-	def sqlite_locale(self) -> SQLiteLocaleSortKeyMakerType | None:
+	def sqlite_locale(self) -> SQLiteSortKeyMakerType | None:
 		return getattr(self.module, "sqlite_locale", None)
 
 

diff --git a/pyglossary/sort_keys_types.py b/pyglossary/sort_keys_types.py
@@ -11,29 +11,15 @@
 	Any,
 ]
 
-
-RawSortKeyType: TypeAlias = Callable[
-	[bytes],
-	Any,
-]
-
 SQLiteSortKeyType: TypeAlias = list[tuple[str, str, SortKeyType]]
 
 
 class SortKeyMakerType(Protocol):
-	def __call__(
-		self,
-		sortEncoding: str,
-		**kwargs
-	) -> RawSortKeyType: ...
+	def __call__(self, sortEncoding: str = "utf-8", **kwargs) -> SortKeyType: ...
 
 
 class SQLiteSortKeyMakerType(Protocol):
-	def __call__(
-		self,
-		sortEncoding: str,
-		**kwargs
-	) -> SQLiteSortKeyType: ...
+	def __call__(self, sortEncoding: str = "utf-8", **kwargs) -> SQLiteSortKeyType: ...
 
 
 class LocaleSortKeyMakerType(Protocol):
@@ -43,13 +29,6 @@ def __call__(
 	) -> SortKeyMakerType: ...
 
 
-class SQLiteLocaleSortKeyMakerType(Protocol):
-	def __call__(
-		self,
-		collator: T_Collator,  # noqa: F821
-	) -> SQLiteSortKeyType: ...
-
-
 __all__ = [
 	"LocaleSortKeyMakerType",
 	"SQLiteSortKeyType",

diff --git a/pyglossary/sort_modules/ebook.py b/pyglossary/sort_modules/ebook.py
@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 
 if TYPE_CHECKING:
 	from pyglossary.sort_keys_types import SortKeyType, SQLiteSortKeyType
@@ -17,8 +17,8 @@ def normal(
 ) -> SortKeyType:
 	length = options.get("group_by_prefix_length", 2)
 
-	# FIXME: return bytes
-	def sortKey(words: list[str]) -> tuple[str, str]:
+	# FIXME: return bytes?
+	def sortKey(words: list[str]) -> Any:
 		word = words[0]
 		if not word:
 			return "", ""
@@ -42,7 +42,7 @@ def getPrefix(words: list[str]) -> str:
 			return "SPECIAL"
 		return prefix
 
-	def headword(words: list[str]) -> bytes:
+	def headword(words: list[str]) -> Any:
 		return words[0].encode(sortEncoding, errors="replace")
 
 	_type = "TEXT" if sortEncoding == "utf-8" else "BLOB"

diff --git a/pyglossary/sort_modules/headword.py b/pyglossary/sort_modules/headword.py
@@ -1,14 +1,13 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 
 if TYPE_CHECKING:
-	from collections.abc import Callable
-
 	from pyglossary.icu_types import T_Collator
 	from pyglossary.sort_keys_types import (
 		SortKeyMakerType,
 		SortKeyType,
+		SQLiteSortKeyMakerType,
 		SQLiteSortKeyType,
 	)
 
@@ -17,7 +16,7 @@
 
 
 def normal(sortEncoding: str = "utf-8", **_options) -> SortKeyType:
-	def sortKey(words: list[str]) -> bytes:
+	def sortKey(words: list[str]) -> Any:
 		return words[0].encode(sortEncoding, errors="replace")
 
 	return sortKey
@@ -28,17 +27,17 @@ def locale(
 ) -> SortKeyMakerType:
 	cSortKey = collator.getSortKey
 
-	def sortKey(words: list[str]) -> bytes:
+	def sortKey(words: list[str]) -> Any:
 		return cSortKey(words[0])
 
-	def warpper(_sortEncoding: str = "utf-8", **_options) -> SortKeyType:
+	def warpper(sortEncoding: str = "utf-8", **_options) -> SortKeyType:  # noqa: ARG001
 		return sortKey
 
 	return warpper
 
 
 def sqlite(sortEncoding: str = "utf-8", **_options) -> SQLiteSortKeyType:
-	def sortKey(words: list[str]) -> bytes:
+	def sortKey(words: list[str]) -> Any:
 		return words[0].encode(sortEncoding, errors="replace")
 
 	return [
@@ -52,10 +51,13 @@ def sortKey(words: list[str]) -> bytes:
 
 def sqlite_locale(
 	collator: T_Collator,  # noqa: F821
-) -> Callable[..., SQLiteSortKeyType]:
+) -> SQLiteSortKeyMakerType:
 	cSortKey = collator.getSortKey
 
-	def sortKey(words: list[str]) -> bytes:
+	def sortKey(words: list[str]) -> Any:
 		return cSortKey(words[0])
 
-	return lambda **_options: [("sortkey", "BLOB", sortKey)]
+	def wrapper(sortEncoding="", **_options):  # noqa: ARG001
+		return [("sortkey", "BLOB", sortKey)]
+
+	return wrapper
diff --git a/pyglossary/sort_modules/headword_bytes_lower.py b/pyglossary/sort_modules/headword_bytes_lower.py
@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 
 if TYPE_CHECKING:
 	from pyglossary.sort_keys_types import SortKeyType, SQLiteSortKeyType
@@ -13,7 +13,7 @@ def normal(
 	sortEncoding: str = "utf-8",
 	**_options,
 ) -> SortKeyType:
-	def sortKey(words: list[str]) -> bytes:
+	def sortKey(words: list[str]) -> Any:
 		return words[0].encode(sortEncoding, errors="replace").lower()
 
 	return sortKey
@@ -26,7 +26,7 @@ def sortKey(words: list[str]) -> bytes:
 
 
 def sqlite(sortEncoding: str = "utf-8", **_options) -> SQLiteSortKeyType:
-	def sortKey(words: list[str]) -> bytes:
+	def sortKey(words: list[str]) -> Any:
 		return words[0].encode(sortEncoding, errors="replace").lower()
 
 	return [

diff --git a/pyglossary/sort_modules/headword_lower.py b/pyglossary/sort_modules/headword_lower.py
@@ -1,14 +1,13 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 
 if TYPE_CHECKING:
-	from collections.abc import Callable
-
 	from pyglossary.icu_types import T_Collator
 	from pyglossary.sort_keys_types import (
 		SortKeyMakerType,
 		SortKeyType,
+		SQLiteSortKeyMakerType,
 		SQLiteSortKeyType,
 	)
 
@@ -17,7 +16,7 @@
 
 
 def normal(sortEncoding: str = "utf-8", **_options) -> SortKeyType:
-	def sortKey(words: list[str]) -> bytes:
+	def sortKey(words: list[str]) -> Any:
 		# assert isinstance(words, list)  # OK
 		return words[0].lower().encode(sortEncoding, errors="replace")
 
@@ -29,11 +28,11 @@ def locale(
 ) -> SortKeyMakerType:
 	cSortKey = collator.getSortKey
 
-	def sortKey(words: list[str]) -> bytes:
+	def sortKey(words: list[str]) -> Any:
 		# assert isinstance(words, list)  # OK
 		return cSortKey(words[0].lower())
 
-	def warpper(_sortEncoding: str = "utf-8", **_options) -> SortKeyType:
+	def warpper(sortEncoding: str = "utf-8", **_options) -> SortKeyType:  # noqa: ARG001
 		return sortKey
 
 	return warpper
@@ -43,7 +42,7 @@ def sqlite(
 	sortEncoding: str = "utf-8",
 	**_options,
 ) -> SQLiteSortKeyType:
-	def sortKey(words: list[str]) -> bytes:
+	def sortKey(words: list[str]) -> Any:
 		return words[0].lower().encode(sortEncoding, errors="replace")
 
 	return [
@@ -57,10 +56,13 @@ def sortKey(words: list[str]) -> bytes:
 
 def sqlite_locale(
 	collator: T_Collator,  # noqa: F821
-) -> Callable[..., SQLiteSortKeyType]:
+) -> SQLiteSortKeyMakerType:
 	cSortKey = collator.getSortKey
 
-	def sortKey(words: list[str]) -> bytes:
+	def sortKey(words: list[str]) -> Any:
 		return cSortKey(words[0].lower())
 
-	return lambda **_options: [("sortkey", "BLOB", sortKey)]
+	def wrapper(sortEncoding="", **_options):  # noqa: ARG001
+		return [("sortkey", "BLOB", sortKey)]
+
+	return wrapper
diff --git a/pyglossary/sort_modules/random.py b/pyglossary/sort_modules/random.py
@@ -1,12 +1,16 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 
 if TYPE_CHECKING:
 	from collections.abc import Callable
 
 	from pyglossary.icu_types import T_Collator
-	from pyglossary.sort_keys_types import SortKeyType, SQLiteSortKeyType
+	from pyglossary.sort_keys_types import (
+		SortKeyMakerType,
+		SortKeyType,
+		SQLiteSortKeyType,
+	)
 
 
 desc = "Random"
@@ -19,11 +23,17 @@ def normal(**_options) -> SortKeyType:
 
 
 def locale(
-	_collator: T_Collator,  # noqa: F821
-) -> SortKeyType:
+	collator: T_Collator,  # noqa: ARG001  # noqa: F821
+) -> SortKeyMakerType:
 	from random import random
 
-	return lambda **_options: lambda _words: random()
+	def sortKey(words: list[str]) -> Any:  # noqa: ARG001
+		return random()
+
+	def warpper(sortEncoding: str = "utf-8", **_options) -> SortKeyType:  # noqa: ARG001
+		return sortKey
+
+	return warpper
 
 
 def sqlite(**_options) -> SQLiteSortKeyType:

diff --git a/pyglossary/sort_modules/stardict.py b/pyglossary/sort_modules/stardict.py
@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 
 if TYPE_CHECKING:
 	from pyglossary.sort_keys_types import SortKeyType, SQLiteSortKeyType
@@ -10,18 +10,18 @@
 
 
 def normal(sortEncoding: str = "utf-8", **_options) -> SortKeyType:
-	def sortKey(words: list[str]) -> tuple[bytes, bytes]:
+	def sortKey(words: list[str]) -> Any:
 		b_word = words[0].encode(sortEncoding, errors="replace")
 		return (b_word.lower(), b_word)
 
 	return sortKey
 
 
 def sqlite(sortEncoding: str = "utf-8", **_options) -> SQLiteSortKeyType:
-	def headword_lower(words: list[str]) -> bytes:
+	def headword_lower(words: list[str]) -> Any:
 		return words[0].encode(sortEncoding, errors="replace").lower()
 
-	def headword(words: list[str]) -> bytes:
+	def headword(words: list[str]) -> Any:
 		return words[0].encode(sortEncoding, errors="replace")
 
 	_type = "TEXT" if sortEncoding == "utf-8" else "BLOB"