type annotations for units, util

Author: DenverCoder1

babel/units.py

@@ -1,13 +1,21 @@
+from __future__ import annotations
+
+import decimal
+
+from typing_extensions import Literal
+
 from babel.core import Locale
-from babel.numbers import format_decimal, LC_NUMERIC
+from babel.localedata import LocaleDataDict
+from babel.numbers import LC_NUMERIC, format_decimal
 
 
 class UnknownUnitError(ValueError):
-    def __init__(self, unit, locale):
+    def __init__(self, unit: str, locale: Locale):
         ValueError.__init__(self, f"{unit} is not a known unit in {locale}")
 
 
-def get_unit_name(measurement_unit, length='long', locale=LC_NUMERIC):
+def get_unit_name(measurement_unit: str, length: Literal["short", "long", "narrow"] = 'long',
+                  locale: Locale | str | None = LC_NUMERIC) -> str | None:
     """
     Get the display name for a measurement unit in the given locale.
 
@@ -36,7 +44,7 @@ def get_unit_name(measurement_unit, length='long', locale=LC_NUMERIC):
     return locale.unit_display_names.get(unit, {}).get(length)
 
 
-def _find_unit_pattern(unit_id, locale=LC_NUMERIC):
+def _find_unit_pattern(unit_id: str, locale: Locale | str | None = LC_NUMERIC) -> str | None:
     """
     Expand an unit into a qualified form.
 
@@ -62,7 +70,9 @@ def _find_unit_pattern(unit_id, locale=LC_NUMERIC):
             return unit_pattern
 
 
-def format_unit(value, measurement_unit, length='long', format=None, locale=LC_NUMERIC):
+def format_unit(value: float | decimal.Decimal, measurement_unit: str,
+                length: Literal["short", "long", "narrow"] = 'long', format: str | None = None,
+                locale: Locale | str | None = LC_NUMERIC) -> str:
     """Format a value of a given unit.
 
     Values are formatted according to the locale's usual pluralization rules
@@ -132,7 +142,7 @@ def format_unit(value, measurement_unit, length='long', format=None, locale=LC_N
     return f"{formatted_value} {fallback_name or measurement_unit}"  # pragma: no cover
 
 
-def _find_compound_unit(numerator_unit, denominator_unit, locale=LC_NUMERIC):
+def _find_compound_unit(numerator_unit: str, denominator_unit: str, locale: Locale | str | None = LC_NUMERIC) -> str | None:
     """
     Find a predefined compound unit pattern.
 
@@ -181,10 +191,10 @@ def _find_compound_unit(numerator_unit, denominator_unit, locale=LC_NUMERIC):
 
 
 def format_compound_unit(
-    numerator_value, numerator_unit=None,
-    denominator_value=1, denominator_unit=None,
-    length='long', format=None, locale=LC_NUMERIC
-):
+    numerator_value: float | decimal.Decimal, numerator_unit: str | None = None,
+    denominator_value: float | decimal.Decimal = 1, denominator_unit: str | None = None,
+    length: Literal["short", "long", "narrow"] = 'long', format: str | None = None,
+    locale: Locale | str | None = LC_NUMERIC) -> str | None:
     """
     Format a compound number value, i.e. "kilometers per hour" or similar.
 

babel/util.py

@@ -7,20 +7,26 @@
     :copyright: (c) 2013-2022 by the Babel Team.
     :license: BSD, see LICENSE for more details.
 """
+from __future__ import annotations
 
 import codecs
 import collections
-from datetime import timedelta, tzinfo
 import os
 import re
 import textwrap
+from collections.abc import Generator, Iterable
+from datetime import datetime as datetime_, timedelta, tzinfo
+from typing import IO, Any, TypeVar
+
 import pytz as _pytz
+
 from babel import localtime
 
 missing = object()
 
+_T = TypeVar("_T")
 
-def distinct(iterable):
+def distinct(iterable: Iterable[_T]) -> Generator[_T, None, None]:
     """Yield all items in an iterable collection that are distinct.
 
     Unlike when using sets for a similar effect, the original ordering of the
@@ -44,7 +50,7 @@ def distinct(iterable):
     br'[ \t\f]* \# .* coding[=:][ \t]*([-\w.]+)', re.VERBOSE)
 
 
-def parse_encoding(fp):
+def parse_encoding(fp: IO[bytes]) -> str | None:
     """Deduce the encoding of a source file from magic comment.
 
     It does this in the same way as the `Python interpreter`__
@@ -96,7 +102,7 @@ def parse_encoding(fp):
     r'from\s+__future__\s+import\s+\(*(.+)\)*')
 
 
-def parse_future_flags(fp, encoding='latin-1'):
+def parse_future_flags(fp: IO[bytes], encoding: str = 'latin-1') -> int:
     """Parse the compiler flags by :mod:`__future__` from the given Python
     code.
     """
@@ -128,7 +134,7 @@ def parse_future_flags(fp, encoding='latin-1'):
     return flags
 
 
-def pathmatch(pattern, filename):
+def pathmatch(pattern: str, filename: str) -> bool:
     """Extended pathname pattern matching.
 
     This function is similar to what is provided by the ``fnmatch`` module in
@@ -200,7 +206,7 @@ class TextWrapper(textwrap.TextWrapper):
     )
 
 
-def wraptext(text, width=70, initial_indent='', subsequent_indent=''):
+def wraptext(text: str, width: int = 70, initial_indent: str = '', subsequent_indent: str = '') -> list[str]:
     """Simple wrapper around the ``textwrap.wrap`` function in the standard
     library. This version does not wrap lines on hyphens in words.
 
@@ -224,25 +230,25 @@ def wraptext(text, width=70, initial_indent='', subsequent_indent=''):
 class FixedOffsetTimezone(tzinfo):
     """Fixed offset in minutes east from UTC."""
 
-    def __init__(self, offset, name=None):
+    def __init__(self, offset: float, name: str | None = None):
         self._offset = timedelta(minutes=offset)
         if name is None:
             name = 'Etc/GMT%+d' % offset
         self.zone = name
 
-    def __str__(self):
+    def __str__(self) -> str:
         return self.zone
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return f'<FixedOffset "{self.zone}" {self._offset}>'
 
-    def utcoffset(self, dt):
+    def utcoffset(self, dt: datetime_) -> timedelta:
         return self._offset
 
-    def tzname(self, dt):
+    def tzname(self, dt: datetime_) -> str:
         return self.zone
 
-    def dst(self, dt):
+    def dst(self, dt: datetime_) -> timedelta:
         return ZERO