wip: ngettext

Author: MHajoha

questionpy/i18n.py

@@ -5,7 +5,7 @@
 from dataclasses import dataclass
 from gettext import GNUTranslations, NullTranslations
 from importlib.resources.abc import Traversable
-from typing import Literal, NewType, Protocol, TypeAlias, cast, overload
+from typing import Literal, NewType, Protocol, TypeAlias, overload
 
 from questionpy_common.environment import (
     Environment,
@@ -207,18 +207,48 @@ def __call__(self, message: str, *, defer: bool | None = None) -> str | UserStri
         """Translate the given message.
 
         Args:
-            message: Gettext `msgid`.
+            message: Gettext `msgid`. This should also be the message in its primary language, usually english.
             defer: By default, translation is deferred only when no request is being processed at the time of the
                 `gettext` call. This parameter can be explicitly set to `True` to force deferral or to `False` to never
                 defer translations. In the latter case, calling `gettext` before a request is processed
                 (e.g. during init) will raise an error.
         """
 
 
-_NGettext: TypeAlias = Callable[[str], str]
+class _NGettext(Protocol):
+    @overload
+    def __call__(self, msgid1: str, msgid2: str, n: int, *, defer: None = None) -> str | UserString: ...
+
+    @overload
+    def __call__(self, msgid1: str, msgid2: str, n: int, *, defer: Literal[True]) -> UserString: ...
+
+    @overload
+    def __call__(self, msgid1: str, msgid2: str, n: int, *, defer: Literal[False]) -> str: ...
+
+    def __call__(self, msgid1: str, msgid2: str, n: int, *, defer: bool | None = None) -> str | UserString:
+        """Translate the given message, accounting for plural forms.
+
+        Args:
+            msgid1: Message id in its (english) singular form, used if no plural form exists and `n == 1`.
+            msgid2: Message id in its (english) plural form, used if no plural form exists and `n >= 2`.
+            n: This number is passed through the plural formula of the active catalog to determine which form to use.
+            defer: By default, translation is deferred only when no request is being processed at the time of the
+                `gettext` call. This parameter can be explicitly set to `True` to force deferral or to `False` to never
+                defer translations. In the latter case, calling `gettext` before a request is processed
+                (e.g. during init) will raise an error.
+        """
+
+
+_Noop: TypeAlias = Callable[[str], str]
+class GettextFunctions(tuple[_Gettext, _Noop], _Gettext):
+    def __new__(cls, *args, **kwargs):
+
+    def __init__(self):
+        super().__init__()
+
 
 
-def get_for(module_name: str) -> tuple[_Gettext, _NGettext]:
+def get_for(module_name: str) -> tuple[_Gettext, _Noop]:
     """Initializes i18n for the package owning the given Python module and returns the gettext-family functions.
 
     Args:
@@ -240,10 +270,10 @@ def gettext(message: str, *, defer: bool | None = None) -> str | UserString:
         request_state = _require_request_state(domain, domain_state)
         return request_state.translations.gettext(message)
 
-    def ngettext(message: str) -> str:
+    def gettext_N(message: str) -> str:
         return message
 
-    return cast(_Gettext, gettext), ngettext
+    return cast(_Gettext, gettext), gettext_N
 
 
 __all__ = ["DEFAULT_CATEGORY", "GettextDomain", "domain_of", "get_for", "get_translations_of_package"]