Merge pull request #3952 from fonttools/add-ttfont-type-hints

madig · web-flow · commit 57092fd51c38 · 2025-12-02T12:16:15.000Z
Break off typing part of #3826
diff --git a/Lib/fontTools/misc/configTools.py b/Lib/fontTools/misc/configTools.py
@@ -224,7 +224,9 @@ def register_option(
 
     def __init__(
         self,
-        values: Union[AbstractConfig, Dict[Union[Option, str], Any]] = {},
+        values: Union[
+            AbstractConfig, Dict[Union[Option, str], Any], Mapping[str, Any]
+        ] = {},
         parse_values: bool = False,
         skip_unknown: bool = False,
     ):
diff --git a/Lib/fontTools/misc/fixedTools.py b/Lib/fontTools/misc/fixedTools.py
@@ -39,7 +39,7 @@
 MAX_F2DOT14 = 0x7FFF / (1 << 14)
 
 
-def fixedToFloat(value, precisionBits):
+def fixedToFloat(value: float, precisionBits: int) -> float:
     """Converts a fixed-point number to a float given the number of
     precision bits.
 
diff --git a/Lib/fontTools/misc/xmlWriter.py b/Lib/fontTools/misc/xmlWriter.py
@@ -1,5 +1,8 @@
 """xmlWriter.py -- Simple XML authoring class"""
 
+from __future__ import annotations
+
+from typing import BinaryIO, Callable, TextIO
 from fontTools.misc.textTools import byteord, strjoin, tobytes, tostr
 import sys
 import os
@@ -25,17 +28,22 @@
 class XMLWriter(object):
     def __init__(
         self,
-        fileOrPath,
-        indentwhite=INDENT,
-        idlefunc=None,
-        encoding="utf_8",
-        newlinestr="\n",
-    ):
+        fileOrPath: str | os.PathLike[str] | BinaryIO | TextIO,
+        indentwhite: str = INDENT,
+        idlefunc: Callable[[], None] | None = None,
+        encoding: str = "utf_8",
+        newlinestr: str | bytes = "\n",
+    ) -> None:
         if encoding.lower().replace("-", "").replace("_", "") != "utf8":
             raise Exception("Only UTF-8 encoding is supported.")
         if fileOrPath == "-":
             fileOrPath = sys.stdout
+        self.filename: str | os.PathLike[str] | None
         if not hasattr(fileOrPath, "write"):
+            if not isinstance(fileOrPath, (str, os.PathLike)):
+                raise TypeError(
+                    "fileOrPath must be a file path (str or PathLike) if it isn't an object with a `write` method."
+                )
             self.filename = fileOrPath
             self.file = open(fileOrPath, "wb")
             self._closeStream = True
@@ -74,8 +82,9 @@ def __enter__(self):
     def __exit__(self, exception_type, exception_value, traceback):
         self.close()
 
-    def close(self):
+    def close(self) -> None:
         if self._closeStream:
+            assert not isinstance(self.file, (str, os.PathLike))
             self.file.close()
 
     def write(self, string, indent=True):
@@ -196,7 +205,7 @@ def escape(data):
         if len(data) > maxLen:
             preview = repr(data[:maxLen])[1:-1] + "..."
         TTX_LOG.warning(
-            "Illegal XML character(s) found; replacing offending " "string %r with %r",
+            "Illegal XML character(s) found; replacing offending string %r with %r",
             preview,
             REPLACEMENT,
         )
diff --git a/Lib/fontTools/ttLib/sfnt.py b/Lib/fontTools/ttLib/sfnt.py
@@ -13,6 +13,9 @@
 a table's length changes you need to rewrite the whole file anyway.
 """
 
+from __future__ import annotations
+
+from collections.abc import KeysView
 from io import BytesIO
 from types import SimpleNamespace
 from fontTools.misc.textTools import Tag
@@ -84,7 +87,7 @@ def __init__(self, file, checkChecksums=0, fontNumber=-1):
 
         if self.sfntVersion not in ("\x00\x01\x00\x00", "OTTO", "true"):
             raise TTLibError("Not a TrueType or OpenType font (bad sfntVersion)")
-        tables = {}
+        tables: dict[Tag, DirectoryEntry] = {}
         for i in range(self.numTables):
             entry = self.DirectoryEntry()
             entry.fromFile(self.file)
@@ -96,15 +99,15 @@ def __init__(self, file, checkChecksums=0, fontNumber=-1):
         if self.flavor == "woff":
             self.flavorData = WOFFFlavorData(self)
 
-    def has_key(self, tag):
+    def has_key(self, tag: str | bytes) -> bool:
         return tag in self.tables
 
     __contains__ = has_key
 
-    def keys(self):
+    def keys(self) -> KeysView[Tag]:
         return self.tables.keys()
 
-    def __getitem__(self, tag):
+    def __getitem__(self, tag: str | bytes) -> bytes:
         """Fetch the raw table data."""
         entry = self.tables[Tag(tag)]
         data = entry.loadData(self.file)
@@ -122,10 +125,10 @@ def __getitem__(self, tag):
                 log.warning("bad checksum for '%s' table", tag)
         return data
 
-    def __delitem__(self, tag):
+    def __delitem__(self, tag: str | bytes) -> None:
         del self.tables[Tag(tag)]
 
-    def close(self):
+    def close(self) -> None:
         self.file.close()
 
     # We define custom __getstate__ and __setstate__ to make SFNTReader pickle-able
diff --git a/Lib/fontTools/ttLib/tables/_a_v_a_r.py b/Lib/fontTools/ttLib/tables/_a_v_a_r.py
@@ -1,3 +1,6 @@
+from __future__ import annotations
+
+from typing import Mapping, TYPE_CHECKING
 from fontTools.misc import sstruct
 from fontTools.misc.fixedTools import (
     fixedToFloat as fi2fl,
@@ -20,6 +23,9 @@
 
 from .otBase import BaseTTXConverter
 
+if TYPE_CHECKING:
+    from ..ttFont import TTFont
+
 
 class table__a_v_a_r(BaseTTXConverter):
     """Axis Variations table
@@ -143,8 +149,9 @@ def fromXML(self, name, attrs, content, ttFont):
         else:
             super().fromXML(name, attrs, content, ttFont)
 
-    def renormalizeLocation(self, location, font, dropZeroes=True):
-
+    def renormalizeLocation(
+        self, location: Mapping[str, float], font: TTFont, dropZeroes: bool = True
+    ) -> dict[str, float]:
         majorVersion = getattr(self, "majorVersion", 1)
 
         if majorVersion not in (1, 2):
diff --git a/Lib/fontTools/ttLib/ttFont.py b/Lib/fontTools/ttLib/ttFont.py
diff --git a/Lib/fontTools/varLib/models.py b/Lib/fontTools/varLib/models.py
