93 lines
3.0 KiB
Python
93 lines
3.0 KiB
Python
|
from __future__ import annotations
|
||
|
|
|
||
|
|
import logging
|
||
|
|
import os
|
||
|
|
from typing import TYPE_CHECKING, Sequence
|
||
|
|
|
||
|
|
from jinja2.ext import Extension, InternationalizationExtension
|
||
|
|
|
||
|
|
from mkdocs.config.base import ValidationError
|
||
|
|
|
||
|
|
if TYPE_CHECKING:
|
||
|
|
import jinja2
|
||
|
|
|
||
|
|
try:
|
||
|
|
from babel.core import Locale, UnknownLocaleError
|
||
|
|
from babel.support import NullTranslations, Translations
|
||
|
|
|
||
|
|
has_babel = True
|
||
|
|
except ImportError: # pragma: no cover
|
||
|
|
from mkdocs.utils.babel_stub import Locale, UnknownLocaleError # type: ignore
|
||
|
|
|
||
|
|
has_babel = False
|
||
|
|
|
||
|
|
|
||
|
|
log = logging.getLogger(__name__)
|
||
|
|
base_path = os.path.dirname(os.path.abspath(__file__))
|
||
|
|
|
||
|
|
|
||
|
|
class NoBabelExtension(InternationalizationExtension): # pragma: no cover
|
||
|
|
def __init__(self, environment):
|
||
|
|
Extension.__init__(self, environment)
|
||
|
|
environment.extend(
|
||
|
|
install_null_translations=self._install_null,
|
||
|
|
newstyle_gettext=False,
|
||
|
|
)
|
||
|
|
|
||
|
|
|
||
|
|
def parse_locale(locale: str) -> Locale:
|
||
|
|
try:
|
||
|
|
return Locale.parse(locale, sep='_')
|
||
|
|
except (ValueError, UnknownLocaleError, TypeError) as e:
|
||
|
|
raise ValidationError(f'Invalid value for locale: {e}')
|
||
|
|
|
||
|
|
|
||
|
|
def install_translations(
|
||
|
|
env: jinja2.Environment, locale: Locale, theme_dirs: Sequence[str]
|
||
|
|
) -> None:
|
||
|
|
if has_babel:
|
||
|
|
env.add_extension('jinja2.ext.i18n')
|
||
|
|
translations = _get_merged_translations(theme_dirs, 'locales', locale)
|
||
|
|
if translations is not None:
|
||
|
|
env.install_gettext_translations(translations) # type: ignore[attr-defined]
|
||
|
|
else:
|
||
|
|
env.install_null_translations() # type: ignore[attr-defined]
|
||
|
|
if locale.language != 'en':
|
||
|
|
log.warning(
|
||
|
|
f"No translations could be found for the locale '{locale}'. "
|
||
|
|
'Defaulting to English.'
|
||
|
|
)
|
||
|
|
else: # pragma: no cover
|
||
|
|
# no babel installed, add dummy support for trans/endtrans blocks
|
||
|
|
env.add_extension(NoBabelExtension)
|
||
|
|
env.install_null_translations() # type: ignore[attr-defined]
|
||
|
|
|
||
|
|
|
||
|
|
def _get_merged_translations(
|
||
|
|
theme_dirs: Sequence[str], locales_dir: str, locale: Locale
|
||
|
|
) -> Translations | None:
|
||
|
|
merged_translations: Translations | None = None
|
||
|
|
|
||
|
|
log.debug(f"Looking for translations for locale '{locale}'")
|
||
|
|
if locale.territory:
|
||
|
|
locale_str = f"{locale.language}_{locale.territory}"
|
||
|
|
else:
|
||
|
|
locale_str = locale.language
|
||
|
|
for theme_dir in reversed(theme_dirs):
|
||
|
|
dirname = os.path.join(theme_dir, locales_dir)
|
||
|
|
translations = Translations.load(dirname, [locale_str])
|
||
|
|
|
||
|
|
if type(translations) is NullTranslations:
|
||
|
|
log.debug(f"No translations found here: '{dirname}'")
|
||
|
|
continue
|
||
|
|
if TYPE_CHECKING:
|
||
|
|
assert isinstance(translations, Translations)
|
||
|
|
|
||
|
|
log.debug(f"Translations found here: '{dirname}'")
|
||
|
|
if merged_translations is None:
|
||
|
|
merged_translations = translations
|
||
|
|
else:
|
||
|
|
merged_translations.merge(translations)
|
||
|
|
|
||
|
|
return merged_translations
|