plugins: replace Glossary type annotation with new limited types

ilius · Dec 31, 2024 · a9b0383 · a9b0383
1 parent 31c4e42
commit a9b0383
Show file tree

Hide file tree

Showing 61 changed files with 125 additions and 124 deletions.
diff --git a/pyglossary/plugins/aard2_slob/reader.py b/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(

diff --git a/pyglossary/plugins/aard2_slob/writer.py b/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 = ""

diff --git a/pyglossary/plugins/almaany/reader.py b/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()
 

diff --git a/pyglossary/plugins/appledict/writer.py b/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 = ""
 

diff --git a/pyglossary/plugins/appledict_bin/reader.py b/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

diff --git a/pyglossary/plugins/ayandict_sqlite/reader.py b/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()
 

diff --git a/pyglossary/plugins/ayandict_sqlite/writer.py b/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()
 

diff --git a/pyglossary/plugins/babylon_bgl/bgl_reader.py b/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 = {}

diff --git a/pyglossary/plugins/cc_kedict/reader.py b/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,

diff --git a/pyglossary/plugins/crawler_dir/reader.py b/pyglossary/plugins/crawler_dir/reader.py
@@ -16,11 +16,11 @@
 if TYPE_CHECKING:
 	from collections.abc import Generator, 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._filename = None
 		self._wordCount = 0

diff --git a/pyglossary/plugins/crawler_dir/writer.py b/pyglossary/plugins/crawler_dir/writer.py
@@ -15,13 +15,13 @@
 )
 
 if TYPE_CHECKING:
-	from pyglossary.glossary_types import GlossaryType
+	from pyglossary.glossary_types import WriterGlossaryType
 
 
 class Writer:
 	_compression: str = ""
 
-	def __init__(self, glos: GlossaryType) -> None:
+	def __init__(self, glos: WriterGlossaryType) -> None:
 		self._glos = glos
 		self._filename = None
 

diff --git a/pyglossary/plugins/csv_plugin/reader.py b/pyglossary/plugins/csv_plugin/reader.py
@@ -35,7 +35,7 @@
 	import io
 	from collections.abc import Iterable, Iterator
 
-	from pyglossary.glossary_types import EntryType, GlossaryType
+	from pyglossary.glossary_types import EntryType, ReaderGlossaryType
 
 
 class Reader:
@@ -45,7 +45,7 @@ class Reader:
 	_newline: str = "\n"
 	_delimiter: str = ","
 
-	def __init__(self, glos: GlossaryType) -> None:
+	def __init__(self, glos: ReaderGlossaryType) -> None:
 		self._glos = glos
 		self.clear()
 

diff --git a/pyglossary/plugins/csv_plugin/writer.py b/pyglossary/plugins/csv_plugin/writer.py
@@ -34,7 +34,7 @@
 	import io
 	from collections.abc import Generator
 
-	from pyglossary.glossary_types import EntryType, GlossaryType
+	from pyglossary.glossary_types import EntryType, WriterGlossaryType
 
 
 class Writer:
@@ -48,7 +48,7 @@ class Writer:
 	_enable_info: bool = True
 	_word_title: bool = False
 
-	def __init__(self, glos: GlossaryType) -> None:
+	def __init__(self, glos: WriterGlossaryType) -> None:
 		self._glos = glos
 		self._file: io.TextIOBase = nullTextIO
 

diff --git a/pyglossary/plugins/dicformids/reader.py b/pyglossary/plugins/dicformids/reader.py
@@ -13,13 +13,13 @@
 if TYPE_CHECKING:
 	from collections.abc import Iterator
 
-	from pyglossary.glossary_types import EntryType, GlossaryType
+	from pyglossary.glossary_types import EntryType, ReaderGlossaryType
 
 
 class Reader:
 	re_number = re.compile(r"\d+")
 
-	def __init__(self, glos: GlossaryType) -> None:
+	def __init__(self, glos: ReaderGlossaryType) -> None:
 		self._glos = glos
 		self._tabFileNames: list[str] = []
 		self._tabFileReader = None

diff --git a/pyglossary/plugins/dicformids/writer.py b/pyglossary/plugins/dicformids/writer.py
@@ -12,7 +12,7 @@
 if TYPE_CHECKING:
 	from collections.abc import Generator
 
-	from pyglossary.glossary_types import EntryType, GlossaryType
+	from pyglossary.glossary_types import EntryType, WriterGlossaryType
 
 
 PROP_TEMPLATE = """#DictionaryForMIDs property file
@@ -49,7 +49,7 @@
 
 
 class Writer:
-	def __init__(self, glos: GlossaryType) -> None:
+	def __init__(self, glos: WriterGlossaryType) -> None:
 		self._glos = glos
 		self.linesPerDirectoryFile = 500  # 200
 		self.indexFileMaxSize = 32722  # 30000

diff --git a/pyglossary/plugins/dict_cc/reader.py b/pyglossary/plugins/dict_cc/reader.py
@@ -9,15 +9,15 @@
 	import sqlite3
 	from collections.abc import Callable, Iterator
 
-	from pyglossary.glossary_types import EntryType, GlossaryType
+	from pyglossary.glossary_types import EntryType, ReaderGlossaryType
 	from pyglossary.lxml_types import Element, T_htmlfile
 
 
 from pyglossary.core import log
 
 
 class Reader:
-	def __init__(self, glos: GlossaryType) -> None:
+	def __init__(self, glos: ReaderGlossaryType) -> None:
 		self._glos = glos
 		self._clear()
 

diff --git a/pyglossary/plugins/dict_cc_split/reader.py b/pyglossary/plugins/dict_cc_split/reader.py
@@ -8,13 +8,13 @@
 	import sqlite3
 	from collections.abc import Iterator
 
-	from pyglossary.glossary_types import EntryType, GlossaryType
+	from pyglossary.glossary_types import EntryType, ReaderGlossaryType
 
 from pyglossary.core import log
 
 
 class Reader:
-	def __init__(self, glos: GlossaryType) -> None:
+	def __init__(self, glos: ReaderGlossaryType) -> None:
 		self._glos = glos
 		self._clear()
 

diff --git a/pyglossary/plugins/dict_org/reader.py b/pyglossary/plugins/dict_org/reader.py
@@ -11,11 +11,11 @@
 if TYPE_CHECKING:
 	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._filename = ""
 		self._dictdb: DictDB | None = None

diff --git a/pyglossary/plugins/dict_org/writer.py b/pyglossary/plugins/dict_org/writer.py
@@ -11,7 +11,7 @@
 if TYPE_CHECKING:
 	from collections.abc import Generator
 
-	from pyglossary.glossary_types import EntryType, GlossaryType
+	from pyglossary.glossary_types import EntryType, WriterGlossaryType
 
 
 def installToDictd(filename: str, dictzip: bool) -> None:
@@ -56,7 +56,7 @@ class Writer:
 	_dictzip: bool = False
 	_install: bool = True
 
-	def __init__(self, glos: GlossaryType) -> None:
+	def __init__(self, glos: WriterGlossaryType) -> None:
 		self._glos = glos
 		self._filename = ""
 		self._dictdb: DictDB | None = None

diff --git a/pyglossary/plugins/dict_org_source/writer.py b/pyglossary/plugins/dict_org_source/writer.py
@@ -6,13 +6,13 @@
 if TYPE_CHECKING:
 	from collections.abc import Generator
 
-	from pyglossary.glossary_types import EntryType, GlossaryType
+	from pyglossary.glossary_types import EntryType, WriterGlossaryType
 
 
 class Writer:
 	_remove_html_all: bool = True
 
-	def __init__(self, glos: GlossaryType) -> None:
+	def __init__(self, glos: WriterGlossaryType) -> None:
 		self._glos = glos
 		self._filename = ""
 

diff --git a/pyglossary/plugins/digitalnk/reader.py b/pyglossary/plugins/digitalnk/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()
 

diff --git a/pyglossary/plugins/dikt_json/writer.py b/pyglossary/plugins/dikt_json/writer.py
@@ -15,7 +15,7 @@
 if TYPE_CHECKING:
 	from collections.abc import Generator
 
-	from pyglossary.glossary_types import EntryType, GlossaryType
+	from pyglossary.glossary_types import EntryType, WriterGlossaryType
 
 
 class Writer:
@@ -26,7 +26,7 @@ class Writer:
 
 	compressions = stdCompressions
 
-	def __init__(self, glos: GlossaryType) -> None:
+	def __init__(self, glos: WriterGlossaryType) -> None:
 		self._glos = glos
 		self._filename = None
 		glos.preventDuplicateWords()

diff --git a/pyglossary/plugins/dsl/reader.py b/pyglossary/plugins/dsl/reader.py
@@ -42,7 +42,7 @@
 	import io
 	from collections.abc import Iterator
 
-	from pyglossary.glossary_types import EntryType, GlossaryType
+	from pyglossary.glossary_types import EntryType, ReaderGlossaryType
 
 htmlEntityPattern = re.compile(r"&#?\w+;")
 
@@ -92,7 +92,7 @@ class Reader:
 	_example_color: str = "steelblue"
 	_abbrev: str = "hover"
 
-	def __init__(self, glos: GlossaryType) -> None:
+	def __init__(self, glos: ReaderGlossaryType) -> None:
 		self._glos = glos
 		self._filename = ""
 		self._dirPath = ""