plugins: replace Glossary type annotation with new limited types

- `ReaderGlossaryType` for `Reader` classes
- `WriterGlossaryType` for `Writer` classes

Author: ilius

pyglossary/glossary_types.py

@@ -26,6 +26,8 @@
 	"GlossaryExtendedType",
 	"GlossaryType",
 	"RawEntryType",
+	"ReaderGlossaryType",
+	"WriterGlossaryType",
 ]
 
 MultiStr: TypeAlias = "str | list[str]"
@@ -249,3 +251,81 @@ def progressbar(self) -> bool: ...
 
 	@progressbar.setter
 	def progressbar(self, enabled: bool) -> None: ...
+
+
+class GlossaryInfoCommonType(typing.Protocol):
+	def getInfo(self, key: str) -> str: ...
+
+	def setInfo(self, key: str, value: str) -> None: ...
+
+	@property
+	def sourceLang(self) -> Lang | None: ...
+
+	@property
+	def targetLang(self) -> Lang | None: ...
+
+	@property
+	def sourceLangName(self) -> str: ...
+
+	@sourceLangName.setter
+	def sourceLangName(self, langName: str) -> None: ...
+
+	@property
+	def targetLangName(self) -> str: ...
+
+	@targetLangName.setter
+	def targetLangName(self, langName: str) -> None: ...
+
+	@property
+	def author(self) -> str: ...
+
+
+class ReaderGlossaryType(GlossaryInfoCommonType):
+	def newEntry(
+		self,
+		word: MultiStr,
+		defi: str,
+		defiFormat: str = "",
+		byteProgress: tuple[int, int] | None = None,
+	) -> EntryType: ...
+
+	def newDataEntry(self, fname: str, data: bytes) -> EntryType: ...
+
+	@property
+	def progressbar(self) -> bool: ...
+
+	def setDefaultDefiFormat(self, defiFormat: str) -> None: ...
+
+	def titleTag(self, sample: str) -> str: ...
+
+
+class WriterGlossaryType(GlossaryInfoCommonType):
+	def collectDefiFormat(
+		self,
+		maxCount: int,
+	) -> dict[str, float] | None: ...
+
+	def iterInfo(self) -> Iterator[tuple[str, str]]: ...
+
+	def getExtraInfos(self, excludeKeys: list[str]) -> dict[str, str]: ...
+
+	def wordTitleStr(
+		self,
+		word: str,
+		sample: str = "",
+		class_: str = "",
+	) -> str: ...
+
+	@property
+	def tmpDataDir(self) -> str: ...
+
+	def stripFullHtml(
+		self,
+		errorHandler: Callable[[EntryType, str], None] | None = None,
+	) -> None: ...
+
+	def preventDuplicateWords(self) -> None: ...
+
+	def mergeEntriesWithSameHeadwordPlaintext(self) -> None: ...
+
+	def removeHtmlTagsAll(self) -> None: ...

pyglossary/plugins/aard2_slob/reader.py

@@ -8,7 +8,7 @@
 	from collections.abc import Iterator
 
 	from pyglossary import slob
-	from pyglossary.glossary_types import EntryType, GlossaryType
+	from pyglossary.glossary_types import EntryType, ReaderGlossaryType
 
 from pyglossary.core import exc_note, log, pip
 from pyglossary.plugins.aard2_slob.tags import (
@@ -29,7 +29,7 @@ class Reader:
 		"icu": "PyICU",  # >=1.5
 	}
 
-	def __init__(self, glos: GlossaryType) -> None:
+	def __init__(self, glos: ReaderGlossaryType) -> None:
 		self._glos = glos
 		self._clear()
 		self._re_bword = re.compile(

pyglossary/plugins/aard2_slob/writer.py

@@ -11,7 +11,7 @@
 	from collections.abc import Generator
 
 	from pyglossary import slob
-	from pyglossary.glossary_types import EntryType, GlossaryType
+	from pyglossary.glossary_types import EntryType, WriterGlossaryType
 
 from pyglossary.core import cacheDir, exc_note, log, pip
 from pyglossary.plugins.aard2_slob.tags import (
@@ -65,7 +65,7 @@ class Writer:
 		"mp4": "video/mp4",
 	}
 
-	def __init__(self, glos: GlossaryType) -> None:
+	def __init__(self, glos: WriterGlossaryType) -> None:
 		self._glos = glos
 		self._filename = ""
 		self._resPrefix = ""

pyglossary/plugins/almaany/reader.py

@@ -8,11 +8,11 @@
 	import sqlite3
 	from collections.abc import Iterator
 
-	from pyglossary.glossary_types import EntryType, GlossaryType
+	from pyglossary.glossary_types import EntryType, ReaderGlossaryType
 
 
 class Reader:
-	def __init__(self, glos: GlossaryType) -> None:
+	def __init__(self, glos: ReaderGlossaryType) -> None:
 		self._glos = glos
 		self._clear()
 

pyglossary/plugins/appledict/writer.py

@@ -42,7 +42,7 @@
 	import io
 	from collections.abc import Generator
 
-	from pyglossary.glossary_types import EntryType, GlossaryType
+	from pyglossary.glossary_types import EntryType, WriterGlossaryType
 
 
 sys.setrecursionlimit(10000)
@@ -182,7 +182,7 @@ class Writer:
 	_jing: bool = False
 	_indexes: str = ""  # FIXME: rename to indexes_lang?
 
-	def __init__(self, glos: GlossaryType) -> None:
+	def __init__(self, glos: WriterGlossaryType) -> None:
 		self._glos = glos
 		self._dirname = ""
 

pyglossary/plugins/appledict_bin/reader.py

@@ -51,7 +51,7 @@
 		HtmlProcessingInstruction,
 	)
 
-	from pyglossary.glossary_types import EntryType, GlossaryType
+	from pyglossary.glossary_types import EntryType, ReaderGlossaryType
 	from pyglossary.lxml_types import Element
 
 	from .appledict_properties import AppleDictProperties
@@ -82,8 +82,8 @@ class Reader:
 		".strings",
 	}
 
-	def __init__(self, glos: GlossaryType) -> None:
-		self._glos: GlossaryType = glos
+	def __init__(self, glos: ReaderGlossaryType) -> None:
+		self._glos: ReaderGlossaryType = glos
 		self._dictDirPath = ""
 		self._contentsPath = ""
 		self._file: io.BufferedIOBase = nullBinaryIO

pyglossary/plugins/ayandict_sqlite/reader.py

@@ -9,11 +9,11 @@
 	import sqlite3
 	from collections.abc import Iterator
 
-	from pyglossary.glossary_types import EntryType, GlossaryType
+	from pyglossary.glossary_types import EntryType, ReaderGlossaryType
 
 
 class Reader:
-	def __init__(self, glos: GlossaryType) -> None:
+	def __init__(self, glos: ReaderGlossaryType) -> None:
 		self._glos = glos
 		self._clear()
 

pyglossary/plugins/ayandict_sqlite/writer.py

@@ -9,7 +9,7 @@
 	import sqlite3
 	from collections.abc import Generator
 
-	from pyglossary.glossary_types import EntryType, GlossaryType
+	from pyglossary.glossary_types import EntryType, WriterGlossaryType
 	from pyglossary.xdxf.transform import XdxfTransformer
 
 from pyglossary.core import log
@@ -18,7 +18,7 @@
 class Writer:
 	_fuzzy: int = True
 
-	def __init__(self, glos: GlossaryType) -> None:
+	def __init__(self, glos: WriterGlossaryType) -> None:
 		self._glos = glos
 		self._clear()
 

pyglossary/plugins/babylon_bgl/bgl_reader.py

@@ -63,7 +63,7 @@
 if TYPE_CHECKING:
 	from collections.abc import Iterator
 
-	from pyglossary.glossary_types import EntryType, GlossaryType
+	from pyglossary.glossary_types import EntryType, ReaderGlossaryType
 
 __all__ = ["BGLGzipFile", "BglReader", "Block", "FileOffS", "optionsProp", "tmpDir"]
 
@@ -342,7 +342,7 @@ class BglReader:
 	selected encoding, so the user may fix the encoding if needed.
 	"""
 
-	def __init__(self, glos: GlossaryType) -> None:  # no more arguments
+	def __init__(self, glos: ReaderGlossaryType) -> None:  # no more arguments
 		self._glos = glos
 		self._filename = ""
 		self.info = {}

pyglossary/plugins/cc_kedict/reader.py

@@ -11,7 +11,7 @@
 
 	import lxml
 
-	from pyglossary.glossary_types import EntryType, GlossaryType
+	from pyglossary.glossary_types import EntryType, ReaderGlossaryType
 
 from pyglossary.core import exc_note, log, pip
 from pyglossary.text_reader import TextGlossaryReader
@@ -29,7 +29,7 @@ class YamlReader(TextGlossaryReader):
 
 	def __init__(  # noqa: PLR0913
 		self,
-		glos: GlossaryType,
+		glos: ReaderGlossaryType,
 		spellKey: str = "",
 		posKey: str = "",
 		synsKey: str = "",
@@ -272,7 +272,7 @@ class Reader:
 		"lxml": "lxml",
 	}
 
-	def __init__(self, glos: GlossaryType) -> None:
+	def __init__(self, glos: ReaderGlossaryType) -> None:
 		self._glos = glos
 		self._yaml = YamlReader(
 			glos,