Improve typing

.github/workflows/fluent.runtime.yml

@@ -58,7 +58,7 @@ jobs:
           python -m pip install wheel
           python -m pip install --upgrade pip
           python -m pip install .
-          python -m pip install flake8==6 mypy==1 types-babel types-pytz
+          python -m pip install flake8==6 mypy==1.1.1 types-babel types-pytz
       - name: Install latest fluent.syntax
         working-directory: ./fluent.syntax
         run: |

.github/workflows/fluent.syntax.yml

@@ -52,7 +52,7 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           python -m pip install .
-          python -m pip install flake8==6 mypy==1
+          python -m pip install flake8==6 mypy==1.1.1
       - name: flake8
         working-directory: ./fluent.syntax
         run: |

fluent.runtime/fluent/runtime/__init__.py

@@ -2,8 +2,7 @@
 from fluent.syntax.ast import Resource
 
 from .bundle import FluentBundle
-from .fallback import FluentLocalization, AbstractResourceLoader, FluentResourceLoader
-
+from .fallback import AbstractResourceLoader, FluentLocalization, FluentResourceLoader
 
 __all__ = [
     'FluentLocalization',

fluent.runtime/fluent/runtime/builtins.py

@@ -1,8 +1,10 @@
 from typing import Any, Callable, Dict
+from typing_extensions import Final
+
 from .types import FluentType, fluent_date, fluent_number
 
-NUMBER = fluent_number
-DATETIME = fluent_date
+NUMBER: Final = fluent_number
+DATETIME: Final = fluent_date
 
 
 BUILTINS: Dict[str, Callable[[Any], FluentType]] = {

fluent.runtime/fluent/runtime/bundle.py

@@ -1,9 +1,9 @@
+from typing import TYPE_CHECKING, Any, Callable, Dict, List, Sequence, Tuple, Union, cast
+from typing_extensions import Literal
+
 import babel
 import babel.numbers
 import babel.plural
-from typing import Any, Callable, Dict, List, TYPE_CHECKING, Tuple, Union, cast
-from typing_extensions import Literal
-
 from fluent.syntax import ast as FTL
 
 from .builtins import BUILTINS
@@ -12,6 +12,8 @@
 from .utils import native_to_fluent
 
 if TYPE_CHECKING:
+    from _typeshed import SupportsItems, SupportsKeysAndGetItem
+
     from .types import FluentNone, FluentType
 
 PluralCategory = Literal['zero', 'one', 'two', 'few', 'many', 'other']
@@ -33,8 +35,8 @@ class FluentBundle:
     """
 
     def __init__(self,
-                 locales: List[str],
-                 functions: Union[Dict[str, Callable[[Any], 'FluentType']], None] = None,
+                 locales: Sequence[str],
+                 functions: Union['SupportsKeysAndGetItem[str, Callable[[Any], FluentType]]', None] = None,
                  use_isolating: bool = True):
         self.locales = locales
         self._functions = {**BUILTINS, **(functions or {})}
@@ -79,10 +81,10 @@ def _lookup(self, entry_id: str, term: bool = False) -> Message:
 
     def format_pattern(self,
                        pattern: Pattern,
-                       args: Union[Dict[str, Any], None] = None
+                       args: Union['SupportsItems[str, Any]', None] = None
                        ) -> Tuple[Union[str, 'FluentNone'], List[Exception]]:
         if args is not None:
-            fluent_args = {
+            fluent_args: Dict[str, Any] = {
                 argname: native_to_fluent(argvalue)
                 for argname, argvalue in args.items()
             }

fluent.runtime/fluent/runtime/fallback.py

@@ -1,13 +1,16 @@
 import codecs
 import os
-from typing import Any, Callable, Dict, Generator, List, TYPE_CHECKING, Type, Union, cast
+from typing import TYPE_CHECKING, Any, Callable, Iterable, Iterator, List, Sequence, Type, Union, cast
 
 from fluent.syntax import FluentParser
 
 from .bundle import FluentBundle
 
 if TYPE_CHECKING:
+    from _typeshed import SupportsItems, SupportsKeysAndGetItem
+
     from fluent.syntax.ast import Resource
+
     from .types import FluentType
 
 
@@ -21,12 +24,12 @@ class FluentLocalization:
 
     def __init__(
         self,
-        locales: List[str],
-        resource_ids: List[str],
+        locales: Sequence[str],
+        resource_ids: Iterable[str],
         resource_loader: 'AbstractResourceLoader',
         use_isolating: bool = False,
         bundle_class: Type[FluentBundle] = FluentBundle,
-        functions: Union[Dict[str, Callable[[Any], 'FluentType']], None] = None,
+        functions: Union['SupportsKeysAndGetItem[str, Callable[[Any], FluentType]]', None] = None,
     ):
         self.locales = locales
         self.resource_ids = resource_ids
@@ -37,7 +40,7 @@ def __init__(
         self._bundle_cache: List[FluentBundle] = []
         self._bundle_it = self._iterate_bundles()
 
-    def format_value(self, msg_id: str, args: Union[Dict[str, Any], None] = None) -> str:
+    def format_value(self, msg_id: str, args: Union['SupportsItems[str, Any]', None] = None) -> str:
         for bundle in self._bundles():
             if not bundle.has_message(msg_id):
                 continue
@@ -48,12 +51,12 @@ def format_value(self, msg_id: str, args: Union[Dict[str, Any], None] = None) ->
             return cast(str, val)  # Never FluentNone when format_pattern called externally
         return msg_id
 
-    def _create_bundle(self, locales: List[str]) -> FluentBundle:
+    def _create_bundle(self, locales: Sequence[str]) -> FluentBundle:
         return self.bundle_class(
             locales, functions=self.functions, use_isolating=self.use_isolating
         )
 
-    def _bundles(self) -> Generator[FluentBundle, None, None]:
+    def _bundles(self) -> Iterator[FluentBundle]:
         bundle_pointer = 0
         while True:
             if bundle_pointer == len(self._bundle_cache):
@@ -64,7 +67,7 @@ def _bundles(self) -> Generator[FluentBundle, None, None]:
             yield self._bundle_cache[bundle_pointer]
             bundle_pointer += 1
 
-    def _iterate_bundles(self) -> Generator[FluentBundle, None, None]:
+    def _iterate_bundles(self) -> Iterator[FluentBundle]:
         for first_loc in range(0, len(self.locales)):
             locs = self.locales[first_loc:]
             for resources in self.resource_loader.resources(locs[0], self.resource_ids):
@@ -79,7 +82,7 @@ class AbstractResourceLoader:
     Interface to implement for resource loaders.
     """
 
-    def resources(self, locale: str, resource_ids: List[str]) -> Generator[List['Resource'], None, None]:
+    def resources(self, locale: str, resource_ids: Iterable[str]) -> Iterator[List['Resource']]:
         """
         Yield lists of FluentResource objects, corresponding to
         each of the resource_ids.
@@ -101,14 +104,14 @@ class FluentResourceLoader(AbstractResourceLoader):
     different roots.
     """
 
-    def __init__(self, roots: Union[str, List[str]]):
+    def __init__(self, roots: Union[str, Iterable[str]]):
         """
         Create a resource loader. The roots may be a string for a single
         location on disk, or a list of strings.
         """
-        self.roots = [roots] if isinstance(roots, str) else roots
+        self.roots: Iterable[str] = [roots] if isinstance(roots, str) else roots
 
-    def resources(self, locale: str, resource_ids: List[str]) -> Generator[List['Resource'], None, None]:
+    def resources(self, locale: str, resource_ids: Iterable[str]) -> Iterator[List['Resource']]:
         for root in self.roots:
             resources: List[Any] = []
             for resource_id in resource_ids:

fluent.runtime/fluent/runtime/prepare.py

@@ -1,5 +1,7 @@
-from typing import Any, Dict, List
+from typing import Any, Dict, Sequence
+
 from fluent.syntax import ast as FTL
+
 from . import resolver
 
 
@@ -29,7 +31,7 @@ def compile_Placeable(self, _: Any, expression: Any, **kwargs: Any) -> Any:
             return expression
         return resolver.Placeable(expression=expression, **kwargs)
 
-    def compile_Pattern(self, _: Any, elements: List[Any], **kwargs: Any) -> Any:
+    def compile_Pattern(self, _: Any, elements: Sequence[Any], **kwargs: Any) -> Any:
         if len(elements) == 1 and isinstance(elements[0], resolver.Placeable):
             # Don't isolate isolated placeables
             return resolver.NeverIsolatingPlaceable(elements[0].expression)

fluent.runtime/fluent/runtime/resolver.py

@@ -1,10 +1,12 @@
-import attr
 import contextlib
-from typing import Any, Dict, Generator, List, Set, TYPE_CHECKING, Union, cast
+from typing import TYPE_CHECKING, Any, Dict, Iterable, Iterator, List, Mapping, Sequence, Set, Union, cast
+from typing_extensions import Final, Self
 
+import attr
 from fluent.syntax import ast as FTL
+
 from .errors import FluentCyclicReferenceError, FluentFormatError, FluentReferenceError
-from .types import FluentType, FluentNone, FluentInt, FluentFloat
+from .types import FluentFloat, FluentInt, FluentNone, FluentType
 from .utils import reference_to_id, unknown_reference_error_obj
 
 if TYPE_CHECKING:
@@ -27,7 +29,7 @@
 
 
 # Prevent expansion of too long placeables, for memory DOS protection
-MAX_PART_LENGTH = 2500
+MAX_PART_LENGTH: Final = 2500
 
 
 @attr.s
@@ -56,7 +58,7 @@ class ResolverEnvironment:
     current: CurrentEnvironment = attr.ib(factory=CurrentEnvironment)
 
     @contextlib.contextmanager
-    def modified(self, **replacements: Any) -> Generator['ResolverEnvironment', None, None]:
+    def modified(self, **replacements: Any) -> Iterator[Self]:
         """
         Context manager that modifies the 'current' attribute of the
         environment, restoring the old data at the end.
@@ -68,7 +70,9 @@ def modified(self, **replacements: Any) -> Generator['ResolverEnvironment', None
         yield self
         self.current = old_current
 
-    def modified_for_term_reference(self, args: Union[Dict[str, Any], None] = None) -> Any:
+    def modified_for_term_reference(self,
+                                    args: Union[Mapping[str, Any], None] = None
+                                    ) -> 'contextlib._GeneratorContextManager[Self]':
         return self.modified(args=args if args is not None else {},
                              error_for_missing_arg=False)
 
@@ -99,7 +103,7 @@ class Message(FTL.Entry, BaseResolver):
     def __init__(self,
                  id: 'Identifier',
                  value: Union['Pattern', None] = None,
-                 attributes: Union[List['Attribute'], None] = None,
+                 attributes: Union[Iterable['Attribute'], None] = None,
                  comment: Any = None,
                  **kwargs: Any):
         super().__init__(**kwargs)
@@ -116,7 +120,7 @@ class Term(FTL.Entry, BaseResolver):
     def __init__(self,
                  id: 'Identifier',
                  value: 'Pattern',
-                 attributes: Union[List['Attribute'], None] = None,
+                 attributes: Union[Iterable['Attribute'], None] = None,
                  comment: Any = None,
                  **kwargs: Any):
         super().__init__(**kwargs)
@@ -129,7 +133,7 @@ class Pattern(FTL.Pattern, BaseResolver):
     # Prevent messages with too many sub parts, for CPI DOS protection
     MAX_PARTS = 1000
 
-    elements: List[Union['TextElement', 'Placeable']]  # type: ignore
+    elements: Sequence[Union['TextElement', 'Placeable']]
 
     def __init__(self, *args: Any, **kwargs: Any):
         super().__init__(*args, **kwargs)
@@ -198,14 +202,14 @@ def __call__(self, env: ResolverEnvironment) -> str:
 
 
 class NumberLiteral(FTL.NumberLiteral, BaseResolver):
-    value: Union[FluentFloat, FluentInt]  # type: ignore
+    value: Union[FluentFloat, FluentInt]  # type: ignore[assignment]
 
     def __init__(self, value: str, **kwargs: Any):
         super().__init__(value, **kwargs)
-        if '.' in cast(str, self.value):
-            self.value = FluentFloat(self.value)
+        if '.' in value:
+            self.value = FluentFloat(value)
         else:
-            self.value = FluentInt(self.value)
+            self.value = FluentInt(value)
 
     def __call__(self, env: ResolverEnvironment) -> Union[FluentFloat, FluentInt]:
         return self.value
@@ -285,7 +289,7 @@ class Attribute(FTL.Attribute, BaseResolver):
 
 class SelectExpression(FTL.SelectExpression, BaseResolver):
     selector: 'InlineExpression'
-    variants: List['Variant']  # type: ignore
+    variants: Sequence['Variant']
 
     def __call__(self, env: ResolverEnvironment) -> Union[str, FluentNone]:
         key = self.selector(env)
@@ -340,8 +344,8 @@ def __call__(self, env: ResolverEnvironment) -> str:
 
 
 class CallArguments(FTL.CallArguments, BaseResolver):
-    positional: List[Union['InlineExpression', Placeable]]  # type: ignore
-    named: List['NamedArgument']  # type: ignore
+    positional: Sequence[Union['InlineExpression', Placeable]]
+    named: Sequence['NamedArgument']
 
 
 class FunctionReference(FTL.FunctionReference, BaseResolver):