kivy-garden-i18n 0.1.0__tar.gz → 0.2.0__tar.gz

kivy_garden_i18n-0.2.0/PKG-INFO

@@ -0,0 +1,44 @@
+Metadata-Version: 2.1
+Name: kivy-garden-i18n
+Version: 0.2.0
+Summary: i18n for Kivy
+Home-page: https://github.com/gottadiveintopython/i18n
+License: MIT
+Keywords: kivy
+Author: Nattōsai Mitō
+Author-email: flow4re2c@gmail.com
+Requires-Python: >=3.10,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Software Development :: Libraries
+Project-URL: Repository, https://github.com/gottadiveintopython/i18n
+Description-Content-Type: text/markdown
+
+# kivy_garden.i18n
+
+A library that assists in creating a Kivy app with internationalization support.
+
+It's composed of the following two primary components:
+
+- The **Font Finder** helps you find fonts.
+  If your app doesn't need i18n support, and you just want to use pre-installed fonts to saving space, you probably only need this.
+- The **Localizer** helps you switch texts and fonts according to "current language".
+
+## Installation
+
+```
+pip install "kivy-garden-i18n>=0.2<0.3"
+poetry add kivy-garden-i18n@~0.2
+```
+
+# Tested on
+
+- CPython 3.10 + Kivy 2.2.1
+- CPython 3.11 + Kivy 2.2.1
+

kivy_garden_i18n-0.2.0/README.md

@@ -0,0 +1,21 @@
+# kivy_garden.i18n
+
+A library that assists in creating a Kivy app with internationalization support.
+
+It's composed of the following two primary components:
+
+- The **Font Finder** helps you find fonts.
+  If your app doesn't need i18n support, and you just want to use pre-installed fonts to saving space, you probably only need this.
+- The **Localizer** helps you switch texts and fonts according to "current language".
+
+## Installation
+
+```
+pip install "kivy-garden-i18n>=0.2<0.3"
+poetry add kivy-garden-i18n@~0.2
+```
+
+# Tested on
+
+- CPython 3.10 + Kivy 2.2.1
+- CPython 3.11 + Kivy 2.2.1

{kivy_garden_i18n-0.1.0 → kivy_garden_i18n-0.2.0}/pyproject.toml

@@ -1,10 +1,10 @@
 [tool.poetry]
-name = "kivy_garden.i18n"
-version = "0.1.0"
+name = "kivy-garden-i18n"
+version = "0.2.0"
 description = "i18n for Kivy"
 authors = ["Nattōsai Mitō <flow4re2c@gmail.com>"]
 license = "MIT"
-readme = 'README.md'
+readme = "README.md"
 repository = 'https://github.com/gottadiveintopython/i18n'
 homepage = 'https://github.com/gottadiveintopython/i18n'
 keywords = ['kivy']
@@ -13,28 +13,30 @@ classifiers=[
     'License :: OSI Approved :: MIT License',
     'Intended Audience :: Developers',
     'Programming Language :: Python',
-    'Programming Language :: Python :: 3.8',
-    'Programming Language :: Python :: 3.9',
     'Programming Language :: Python :: 3.10',
     'Programming Language :: Python :: 3.11',
-    'Programming Language :: Python :: 3.12',
     'Topic :: Software Development :: Libraries',
     'Operating System :: OS Independent',
 ]
-
 packages = [
-    { include = "kivy_garden" },
+    { include = "kivy_garden", from = "src" },
 ]
 
 [tool.poetry.dependencies]
-python = "^3.8"
-
-[tool.poetry.dev-dependencies]
-pytest = "^6.2.5"
+python = "^3.10"
 
 [tool.poetry.group.dev.dependencies]
-kivy = "^2.2.1"
+pytest = "^7.4.3"
+Kivy = "^2.2.1"
+
+
+[tool.poetry.group.doc.dependencies]
+sphinx = "^7.2.6"
+sphinx-autobuild = "^2021.3.14"
 
 [build-system]
-requires = ["poetry-core>=1.0.0"]
+requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.scripts]
+extract-msgids = 'kivy_garden.i18n.utils._extract_msgids_from_string_literals:cli_main'

kivy_garden_i18n-0.2.0/src/kivy_garden/i18n/_exceptions.py

@@ -0,0 +1,14 @@
+__all__ = (
+    'I18nError', 'UnsupportedLanguageError',
+)
+from functools import cached_property
+
+
+class I18nError(Exception):
+    '''Base class of all the module-specific exceptions'''
+
+
+class UnsupportedLanguageError(I18nError):
+    @cached_property
+    def lang(self):
+        return self.args[0]

kivy_garden_i18n-0.2.0/src/kivy_garden/i18n/fontfinder.py

@@ -0,0 +1,154 @@
+__all__ =(
+    'enum_pre_installed_fonts', 'can_render_text', 'can_render_lang', 'default_filter', 'enum_langs', 'register_lang',
+)
+
+from typing import Union
+from collections.abc import Callable, Iterator
+from pathlib import Path, PurePath
+from kivy.core.text import LabelBase, Label as CoreLabel
+
+from ._exceptions import UnsupportedLanguageError
+
+
+def default_filter(font: PurePath, suffixes=('.ttf', '.otf', '.ttc', )) -> bool:
+    '''
+    The default *filter* of :func:`enum_pre_installed_fonts`.
+    If the suffix of the ``font`` is one of ``.ttf``, ``.otf`` and ``.ttc`` as well as its filename doesn't contain
+    ``'fallback'``, this function returns True.
+    '''
+    return font.suffix in suffixes and 'fallback' not in font.name.lower()
+
+
+def enum_pre_installed_fonts(*, filter: Callable[[Path], bool]=default_filter) -> Iterator[Path]:
+    for dir in LabelBase.get_system_fonts_dir():
+        for child in Path(dir).iterdir():
+            if filter(child):
+                yield child
+
+
+def can_render_text(font: Union[str, Path], text: str) -> bool:
+    '''
+    Whether a specified ``font`` is capable of rendering a specified ``text``.
+
+    :param text: must consist of more than two characters without repetition.
+
+    .. code-block::
+
+        from kivy_garden.i18n.fontfinder import can_render_text as f
+
+        # Roboto, the default font, lacks CJK characters.
+        assert f("Roboto", "ABC")
+        assert not f("Roboto", "漢字한글ひら")
+        assert not f("Roboto", "漢字한글ひらABC")
+
+        assert f("NotoSerifCJK-Regular.ttc", "ABC")
+        assert f("NotoSerifCJK-Regular.ttc", "漢字한글ひら")
+        assert f("NotoSerifCJK-Regular.ttc", "漢字한글ひらABC")
+
+        # Fallback-fonts may lack ASCII characters.
+        assert not f("DroidSansFallbackFull.ttf", "ABC")
+        assert f("DroidSansFallbackFull.ttf", "漢字한글ひら")
+        assert not f("DroidSansFallbackFull.ttf", "漢字한글ひらABC")
+
+    .. note::
+
+        The longer the ``text`` is, the more accurate the result will be, but the more time it would take.
+    '''
+    if not _validate_discriminant(text):
+        raise ValueError(f"'text' must consist of more than two characters without repetition (was {text!r})")
+    label = CoreLabel()
+    label._size = (16, 16, )
+    label.options['font_name'] = str(font)
+    label.resolve_font_name()
+    rendered_text = set()
+    for i, c in enumerate(text, start=1):
+        label.text = c
+        label._render_begin()
+        label._render_text(c, 0, 0)
+        data = label._render_end().data
+        if data in rendered_text:
+            return False
+        rendered_text.add(data)
+    return True
+
+
+DISCRIMINANTS = {
+    'ar': 'الجزيرةAB',
+    'hi': 'भारतAB',
+    'ja': (v := '経伝説あAB'),
+    'ja-JP': v,
+    'ja_JP': v,
+    'ko': (v := '안녕조AB'),
+    'ko-KR': v,
+    'ko_KR': v,
+    'zh-Hans': (v := '哪经传说AB'),
+    'zh_Hans': v,
+    'zh-CN': v,
+    'zh_CN': v,
+    'zh-SG': v,
+    'zh_SG': v,
+    'zh-Hant': (v := '哪經傳說AB'),
+    'zh_Hant': v,
+    'zh-TW': v,
+    'zh_TW': v,
+    'zh-HK': v,
+    'zh_HK': v,
+    'zh-MO': v,
+    'zh_MO': v,
+    'zh': '哪經傳說经传说AB',
+}
+
+
+def can_render_lang(font: Union[str, Path], lang: str) -> bool:
+    '''
+    Whether a specified ``font`` is capable of rendering a specified ``lang``.
+
+    .. code-block::
+
+        from kivy_garden.i18n.fontfinder import can_render_lang as f
+
+        assert not f("Roboto", "zh")
+        assert not f("Roboto", "ko")
+        assert not f("Roboto", "ja")
+
+        assert f("NotoSerifCJK-Regular.ttc", "zh")
+        assert f("NotoSerifCJK-Regular.ttc", "ko")
+        assert f("NotoSerifCJK-Regular.ttc", "ja")
+
+        # Font that lacks ASCII characters is considered unable to render any language.
+        assert not f("DroidSansFallbackFull.ttf", "zh")
+        assert not f("DroidSansFallbackFull.ttf", "ko")
+        assert not f("DroidSansFallbackFull.ttf", "ja")
+
+    :raise UnsupportedLanguageError: if the given ``lang`` is not supported.
+    '''
+    try:
+        text = DISCRIMINANTS[lang]
+    except KeyError:
+        raise UnsupportedLanguageError(lang)
+    return can_render_text(font, text)
+
+
+def enum_langs() -> Iterator[str]:
+    '''
+    Available languages for :func:`can_render_lang`.
+    '''
+    return DISCRIMINANTS.keys()
+
+
+def register_lang(lang: str, discriminant: str):
+    '''
+    Enable a language in the :func:`can_render_lang`.
+
+    .. code-block::
+
+        register_lang('th', "ราชอAB")  # Thai language
+    '''
+    if not _validate_discriminant(discriminant):
+        raise ValueError(f"'discriminant' must consist of more than two characters without repetition (was {discriminant!r})")
+    DISCRIMINANTS[lang] = discriminant
+
+
+def _validate_discriminant(discriminant: str, len=len, set=set) -> bool:
+    l = len(discriminant)
+    return l >= 3 and len(set(discriminant)) == l

kivy_garden_i18n-0.2.0/src/kivy_garden/i18n/localizer.py

@@ -0,0 +1,204 @@
+from __future__ import annotations
+
+__all__ = (
+    # type hints
+    'Translator', 'TranslatorFactory', 'FontPicker',
+
+    # exceptions
+    'I18nError', 'FontNotFoundError',
+
+    # concrete TranslatorFactory
+    'GettextBasedTranslatorFactory', 'MappingBasedTranslatorFactory',
+
+    # concrete FontPicker
+    'DefaultFontPicker',
+
+    #
+    'Localizer',
+)
+
+from collections.abc import Callable, Mapping
+from typing import TypeAlias, Union
+import itertools
+from functools import cached_property
+
+from kivy.properties import StringProperty, ObjectProperty
+from kivy.event import EventDispatcher
+from kivy.logger import Logger
+from kivy.uix.label import Label
+
+Msgid: TypeAlias = str
+Msgstr: TypeAlias = str
+Lang: TypeAlias = str
+Translator: TypeAlias = Callable[[Msgid], Msgstr]
+TranslatorFactory : TypeAlias = Callable[[Lang], Translator]
+Font: TypeAlias = str
+FontPicker: TypeAlias = Callable[[Lang], Font]
+
+
+class I18nError(Exception):
+    '''Base class of all the module-specific exceptions'''
+
+
+class FontNotFoundError(I18nError):
+    '''Failed to find a font.'''
+
+    @cached_property
+    def lang(self) -> Lang:
+        '''The language for which a localizer couldn't find a suitable font.'''
+        return self.args[0]
+
+
+class Localizer(EventDispatcher):
+    lang: Lang = StringProperty()
+    '''
+    The "current language" of this localizer.
+    '''
+
+    _: Translator = ObjectProperty(lambda msgid: msgid)
+    '''
+    (read-only)
+    A callable object that takes a ``msgid``, and returns the corresponging ``msgstr`` according to the "current language".
+
+    .. code-block::
+
+        loc = Localizer(...)
+        loc.lang = "en"
+        print(loc._("app title"))  # => "My First Kivy Program"
+        loc.lang = "ja"
+        print(loc._("app title"))  # => "初めてのKivyプログラム"
+
+    :meta public:
+    '''
+
+    font_name: Font = StringProperty(Label.font_name.defaultvalue)
+    '''
+    (read-only)
+    A font that is capable of rendering the "current language".
+
+    .. code-block::
+
+        loc = Localizer(...)
+        loc.lang = "en"
+        print(loc.font_name)  # => "Roboto"
+        loc.lang = "ko"
+        print(loc.font_name)  # => "/../NotoSerifCJK-Regular.ttc"
+    '''
+
+    def __init__(self, *, lang: Lang='en', translator_factory: TranslatorFactory=None, font_picker: FontPicker=None):
+        if translator_factory is None:
+            Logger.warning(
+                f"kivy_garden.i18n: No translator_factory was provided. ``msgid``s themselves will be displaed.")
+            translator_factory = lambda lang: lambda msgid: msgid
+        if font_picker is None:
+            font_picker = DefaultFontPicker()
+        self.translator_factory = translator_factory
+        self.font_picker = font_picker
+        super().__init__(lang=lang)
+
+    def install(self, *, name):
+        '''
+        Makes the localizer accessble from kv without any import-statements.
+
+        .. code-block::
+
+            loc = Localizer(...)
+            loc.install(name='l')
+
+        .. code-block:: yaml
+
+            Label:
+                font_name: l.font_name
+                text: l._("msgid")
+
+        :raises I18nError: if the ``name`` has already been used.
+        '''
+        from kivy.lang import global_idmap
+        if name in global_idmap:
+            raise I18nError(f"The name {name!r} has already been used.")
+        global_idmap[name] = self
+
+    def uninstall(self, *, name):
+        from kivy.lang import global_idmap
+        if name not in global_idmap:
+            raise I18nError(f"The name {name!r} not found.")
+        if global_idmap[name] is not self:
+            raise I18nError(f"The object referenced by {name!r} is not me.")
+        del global_idmap[name]
+
+    @staticmethod
+    def on_lang(self, lang):
+        ''':meta private:'''
+        self._ = self.translator_factory(lang)
+        self.font_name = self.font_picker(lang)
+
+
+class DefaultFontPicker:
+    PRESET = {
+        'en': (v := 'Roboto'),
+        'fr': v,
+        'it': v,
+        'pt': v,
+        'ru': v,
+    }
+    ''':meta private:'''
+
+    del v
+
+    def __init__(self, *, fallback: Union[Lang, None]='Roboto'):
+        self._lang2font = self.PRESET.copy()
+        self._fallback = fallback
+
+    def __call__(self, lang: Lang) -> Font:
+        try:
+            return self._lang2font[lang]
+        except KeyError:
+            pass
+
+        from .fontfinder import enum_pre_installed_fonts, can_render_lang
+        name = None
+        for font in enum_pre_installed_fonts():
+            if can_render_lang(font, lang):
+                name = font.name
+                break
+        if name is None:
+            fallback = self._fallback
+            if fallback is None:
+                raise FontNotFoundError(lang)
+            Logger.warning(f"kivy_garden.i18n: Couldn't find a font for lang '{lang}'. Use {fallback} as a fallback.")
+            name = fallback
+        self._lang2font[lang] = name
+        return name
+
+
+class GettextBasedTranslatorFactory:
+    def __init__(self, domain, localedir):
+        self.domain = domain
+        self.localedir = localedir
+
+    def __call__(self, lang: Lang) -> Translator:
+        from gettext import translation
+        return translation(domain=self.domain, localedir=self.localedir, languages=(lang, )).gettext
+
+
+class MappingBasedTranslatorFactory:
+    def __init__(self, table: Mapping[Msgid, Mapping[Lang, Msgstr]], /):
+        self._table = _reverse_mapping(table, nullable=False)
+
+    def __call__(self, lang: Lang) -> Translator:
+        return self._table[lang].__getitem__
+
+
+def _reverse_mapping(d: Mapping[Msgid, Mapping[Lang, Msgstr]], *, nullable=True) -> dict[Lang, dict[Msgid, Msgstr]]:
+    msgids = tuple(d.keys())
+    langs = set(itertools.chain.from_iterable(d.values()))
+    if nullable:
+        return {
+            lang: {msgid: d[msgid].get(lang, None) for msgid in msgids}
+            for lang in langs
+        }
+    else:
+        return {
+            lang: {msgid: d[msgid].get(lang, msgid) for msgid in msgids}
+            for lang in langs
+        }

kivy_garden_i18n-0.2.0/src/kivy_garden/i18n/utils/__init__.py

@@ -0,0 +1 @@
+from ._extract_msgids_from_string_literals import extract_msgids_from_string_literals

kivy_garden_i18n-0.1.0/kivy_garden/i18n/extract_msgids_from_string_literals.py → kivy_garden_i18n-0.2.0/src/kivy_garden/i18n/utils/_extract_msgids_from_string_literals.py

@@ -1,7 +1,5 @@
 __all__ = ('extract_msgids_from_string_literals', )
 
-'''xgettextは文字列literalからは抽出してくれないのでこのscriptを使って抽出する'''
-
 import re
 from typing import Iterator
 
@@ -16,9 +14,9 @@ def extract_string_literals(python_code: str) -> Iterator[str]:
 
 
 PATTERN = re.compile(r"""
-    (^|\W)(_\(".*?"\))  # _("")で括られた文字列
+    (^|\W)_\("(.*?)"\)  # _("")で括られた文字列
     |                   # もしくは
-    (^|\W)(_\('.*?'\))  # _('')で括られた文字列
+    (^|\W)_\('(.*?)'\)  # _('')で括られた文字列
 """, re.VERBOSE | re.MULTILINE)
 
 
@@ -28,6 +26,16 @@ def extract_msgid(s:str) -> Iterator[str]:
 
 
 def extract_msgids_from_string_literals(python_code: str) -> Iterator[str]:
+    '''
+    .. code-block::
+
+        msgids = extract_msgids_from_string_literals("""
+            Label:
+                font_name: _("AAA")
+                text: _("BBB")
+            """)
+        assert list(msgids) == ["AAA", "BBB"]
+    '''
     return (
         ls
         for s in extract_string_literals(python_code)
@@ -35,18 +43,22 @@ def extract_msgids_from_string_literals(python_code: str) -> Iterator[str]:
     )
 
 
-def main():
+def cli_main():
+    from textwrap import dedent
     import sys
     from pathlib import Path
     from io import StringIO
+
+    if len(sys.argv) == 1:
+        print(dedent("""
+            Usage:
+                extract-msgids filename1.py filename2.py ...
+            """),
+            file=sys.stderr)
+        return
     output = StringIO()
-    write = output.write
     for file in sys.argv[1:]:
         for ls in extract_msgids_from_string_literals(Path(file).read_text(encoding='utf-8')):
             print(ls, file=output)
     print(output.getvalue())
     output.close()
-
-
-if __name__ == "__main__":
-    main()

kivy_garden_i18n-0.1.0/PKG-INFO

@@ -1,269 +0,0 @@
-Metadata-Version: 2.1
-Name: kivy-garden-i18n
-Version: 0.1.0
-Summary: i18n for Kivy
-Home-page: https://github.com/gottadiveintopython/i18n
-License: MIT
-Keywords: kivy
-Author: Nattōsai Mitō
-Author-email: flow4re2c@gmail.com
-Requires-Python: >=3.8,<4.0
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Topic :: Software Development :: Libraries
-Project-URL: Repository, https://github.com/gottadiveintopython/i18n
-Description-Content-Type: text/markdown
-
-# i18n
-
-Kivyアプリの多言語化は面倒くさいです。
-というのも只表示する文字列を切り替えればいいわけではないからです。
-**Kivyは文字列の描画に必要なフォントを自動で選んでくれはしないので、アプリ側がKivyに教えてあげなければいけません。**
-それを怠れば画面には文字に代わって豆腐が表示されてしまいます。
-
-また多くのKivyアプリはフォントをアプリに詰め込むという方法を採っていますが、これも多言語化の際には問題となります。
-フォントを幾つも詰め込んでアプリのサイズが数十MB膨れ上がればアプリの利用者は喜ばないでしょう。
-
-そこでこのmoduleの出番です。
-このmoduleは文字列を切り替える機能に加えて、**OSにinstall済のフォントの中から各言語用の物を自動で選んでくれます。**
-なのでアプリにフォントを詰め込む必要はもうありません。
-
-## 使い方
-
-### フォントの検索
-
-表示する文字列の切り替えとフォントの切り替えは別々の機能であり、どちらか片方だけ使うこともできます。
-また多言語化には興味無いもののOSにinstall済のフォントを利用して少しでもアプリの容量を減らしたいという人も居るでしょう。
-そういった人には以下のような使い方がおすすめです。
-
-
-```python
-# OSにinstall済の日本語フォントの内 最初に見つけた物を利用する例
-
-from kivy_garden.i18n.fontfinder import enum_fonts_from_lang
-
-font = next(enum_fonts_from_lang('ja'), None)
-if font is None:
-    print("日本語フォントが見つかりませんでした")
-else:
-    print("日本語フォントが見つかりました:", font.name)
-    label.font_name = font.name
-    textinput.font_name = font.name
-```
-
-### フォントの切り替え
-
-そして多言語化させたい場合は以下のようにします。
-
-```python
-from kivy_garden.i18n.localizer import KXLocalizer
-
-loc = KXLocalizer()
-loc.lang = 'ja'
-print(loc.font_name)  # => 何かの日本語フォント名が出力される
-loc.lang = 'zh'
-print(loc.font_name)  # => 何かの中文フォント名が出力される
-```
-
-重要なのが`KXLocalizer`が`EventDispatcher`な事で
-
-```python
-class KXLocalizer(EventDispatcher):
-    lang = StringProperty(...)
-    font_name = StringProperty(...)
-    _ = ObjectProperty(...)
-```
-
-bindingを利かせれば`lang`を切り替えた時に`Label`の`font_name`も自動で切り替えられます。
-
-```python
-from kivy.app import App
-from kivy.lang import Builder
-from kivy_garden.i18n.localizer import KXLocalizer
-
-
-KV_CODE = '''
-Label:
-    font_name: app.loc.font_name
-'''
-
-
-class SampleApp(App):
-    def build(self):
-        self.loc = KXLocalizer()
-        return Builder.load_string(KV_CODE)
-
-    def on_start(self):
-        self.loc.lang = 'ja'  # bindingによりLabelには自動で日本語フォントが適用される
-        self.loc.lang = 'ko'  # bindingによりLabelには自動で韓国語フォントが適用される
-```
-
-また`KXLocalizer.install()`を用いる事で`#:import`無しで`KXLocalizer`をKv言語内で直接参照できます。
-ただしglobal変数を書き換える行為なので使用は自己責任で。
-
-```python
-# 上のcodeど同等のcode
-from kivy.app import App
-from kivy.lang import Builder
-from kivy_garden.i18n.localizer import KXLocalizer
-
-
-KV_CODE = '''
-Label:
-    font_name: l.font_name  # import無しで参照 !!
-'''
-
-class SampleApp(App):
-    def build(self):
-        self.loc = KXLocalizer()
-        self.loc.install(name='l')  # install
-        return Builder.load_string(KV_CODE)
-
-    def on_start(self):
-        self.loc.lang = 'ja'
-```
-
-### 翻訳(文字列の切り替え)
-
-そして肝心の翻訳ですが、これは`KXLocalizer`に翻訳者(Translator)を与える事で実現できます。
-現在ある翻訳者は
-
-- `gettext`を利用する`GettextTranslator`と
-- 辞書を用いた単純な仕組みの`DictBasedTranslator`
-
-の二種で、ここでは`DictBasedTranslator`を用いた方法を解説します。
-`GettextTranslator`に関しては[gettext_example](https://github.com/gottadiveintopython/i18n/blob/main/examples/gettext_example.py)を参照して下さい。
-
-まず必要となるのは以下のような辞書型の翻訳表です。
-
-```python
-翻訳表 = {
-    'tiger': {
-        'zh': '老虎',
-        'ja': '虎',
-        'en': 'tiger',
-    },
-    'apple': {
-        'zh': '蘋果',
-        'ja': 'りんご',
-        'en': 'apple',
-    },
-}
-```
-
-pythonの辞書literalは書きづらいので実際にはYAML形式で翻訳表を作り、それをpythonの辞書に変換した方が良いかもしれません。
-
-```yaml
-tiger:
-  zh: 老虎
-  ja: 虎
-  en: tiger
-apple:
-  zh: 蘋果
-  ja: りんご
-  en: apple
-```
-
-```python
-# pip install pyyaml
-import yaml
-翻訳表 = yaml.safe_load(YAML文字列)
-```
-
-翻訳表ができたら後は以下のようにして`KXLocalizer`に与えるだけです。
-
-```python
-from kivy_garden.i18n.localizer import KXLocalizer, DictBasedTranslator
-loc = KXLocalizer(translator=DictBasedTranslator(翻訳表))
-```
-
-これで既に`loc.lang`(現在の言語)に基づいて適切な翻訳結果が得られるようになっています。
-
-```python
-loc.lang = 'ja'
-print(loc._("tiger"))  # => 虎
-print(loc._("apple"))  # => りんご
-print(loc.font_name)   # => 何かの日本語フォント名
-loc.lang = 'zh'
-print(loc._("tiger"))  # => 老虎
-print(loc._("apple"))  # => 蘋果
-print(loc.font_name)   # => 何かの中文フォント名
-```
-
-そして当然bindingを利かせてあげれば`loc.lang`(現在の言語)に連動して`Label`の`text`と`font_name`が自動で更新されます。
-
-```python
-from kivy.app import App
-from kivy.lang import Builder
-from kivy_garden.i18n.localizer import KXLocalizer, DictBasedTranslator
-
-
-KV_CODE = '''
-Label:
-    font_name: l.font_name
-    text: l._("apple")
-'''
-
-
-class SampleApp(App):
-    def build(self):
-        self.loc = KXLocalizer(translator=DictBasedTranslator(翻訳表))
-        self.loc.install(name='l')
-        return Builder.load_string(KV_CODE)
-
-    def on_start(self):
-        # Labelのfont_nameに日本語フォントが、textには りんご が入る
-        self.loc.lang = 'ja'
-
-        # Labelのfont_nameに英文フォントが、textには apple が入る
-        self.loc.lang = 'en'
-```
-
-このように`EventDispacther`のbindingの仕組みを利用すると**アプリの実行中に表示言語を自由に切り替えられるのがこのmoduleの強みとなります**。
-もちろん言語切替時にアプリの再起動を求めるつもりなのであれば無理にbindingを利かせる必要はありません。
-
-以上がこのmoduleの基本的な使い方となります。
-
-## 小道具
-
-`xgettext`は翻訳の必要性のある文字列をpythonソース中から抜き出してくれる素晴らしい道具ですが、
-文字列literalの中までは見てくれないという欠点があります。
-すなわち以下のcodeにおいて
-
-```python
-KV_CODE = '''
-BoxLayout:
-    Label:
-        text: _("ABC")
-    Label:
-        text: _("DEF")
-'''
-
-_("123")
-```
-
-`123`は抜き出してくれても`ABC`と`DEF`は抜き出してくれません。
-というわけでそういったことをしてくれる物を作りました。
-
-```
-python -m kivy_gardem.i18n.extract_msgids_from_string_literals 上記のpythonファイル > ./output.py
-```
-
-```python
-# output.pyの中身
-_("ABC")
-_("DEF")
-```
-
-このように文字列literal内の翻訳対象文字列をその外に抜き出してくれるので、
-それを`xgettext`に喰わせてあげれば取りこぼさずに済みます。
-

kivy_garden_i18n-0.1.0/README.md

@@ -1,243 +0,0 @@
-# i18n
-
-Kivyアプリの多言語化は面倒くさいです。
-というのも只表示する文字列を切り替えればいいわけではないからです。
-**Kivyは文字列の描画に必要なフォントを自動で選んでくれはしないので、アプリ側がKivyに教えてあげなければいけません。**
-それを怠れば画面には文字に代わって豆腐が表示されてしまいます。
-
-また多くのKivyアプリはフォントをアプリに詰め込むという方法を採っていますが、これも多言語化の際には問題となります。
-フォントを幾つも詰め込んでアプリのサイズが数十MB膨れ上がればアプリの利用者は喜ばないでしょう。
-
-そこでこのmoduleの出番です。
-このmoduleは文字列を切り替える機能に加えて、**OSにinstall済のフォントの中から各言語用の物を自動で選んでくれます。**
-なのでアプリにフォントを詰め込む必要はもうありません。
-
-## 使い方
-
-### フォントの検索
-
-表示する文字列の切り替えとフォントの切り替えは別々の機能であり、どちらか片方だけ使うこともできます。
-また多言語化には興味無いもののOSにinstall済のフォントを利用して少しでもアプリの容量を減らしたいという人も居るでしょう。
-そういった人には以下のような使い方がおすすめです。
-
-
-```python
-# OSにinstall済の日本語フォントの内 最初に見つけた物を利用する例
-
-from kivy_garden.i18n.fontfinder import enum_fonts_from_lang
-
-font = next(enum_fonts_from_lang('ja'), None)
-if font is None:
-    print("日本語フォントが見つかりませんでした")
-else:
-    print("日本語フォントが見つかりました:", font.name)
-    label.font_name = font.name
-    textinput.font_name = font.name
-```
-
-### フォントの切り替え
-
-そして多言語化させたい場合は以下のようにします。
-
-```python
-from kivy_garden.i18n.localizer import KXLocalizer
-
-loc = KXLocalizer()
-loc.lang = 'ja'
-print(loc.font_name)  # => 何かの日本語フォント名が出力される
-loc.lang = 'zh'
-print(loc.font_name)  # => 何かの中文フォント名が出力される
-```
-
-重要なのが`KXLocalizer`が`EventDispatcher`な事で
-
-```python
-class KXLocalizer(EventDispatcher):
-    lang = StringProperty(...)
-    font_name = StringProperty(...)
-    _ = ObjectProperty(...)
-```
-
-bindingを利かせれば`lang`を切り替えた時に`Label`の`font_name`も自動で切り替えられます。
-
-```python
-from kivy.app import App
-from kivy.lang import Builder
-from kivy_garden.i18n.localizer import KXLocalizer
-
-
-KV_CODE = '''
-Label:
-    font_name: app.loc.font_name
-'''
-
-
-class SampleApp(App):
-    def build(self):
-        self.loc = KXLocalizer()
-        return Builder.load_string(KV_CODE)
-
-    def on_start(self):
-        self.loc.lang = 'ja'  # bindingによりLabelには自動で日本語フォントが適用される
-        self.loc.lang = 'ko'  # bindingによりLabelには自動で韓国語フォントが適用される
-```
-
-また`KXLocalizer.install()`を用いる事で`#:import`無しで`KXLocalizer`をKv言語内で直接参照できます。
-ただしglobal変数を書き換える行為なので使用は自己責任で。
-
-```python
-# 上のcodeど同等のcode
-from kivy.app import App
-from kivy.lang import Builder
-from kivy_garden.i18n.localizer import KXLocalizer
-
-
-KV_CODE = '''
-Label:
-    font_name: l.font_name  # import無しで参照 !!
-'''
-
-class SampleApp(App):
-    def build(self):
-        self.loc = KXLocalizer()
-        self.loc.install(name='l')  # install
-        return Builder.load_string(KV_CODE)
-
-    def on_start(self):
-        self.loc.lang = 'ja'
-```
-
-### 翻訳(文字列の切り替え)
-
-そして肝心の翻訳ですが、これは`KXLocalizer`に翻訳者(Translator)を与える事で実現できます。
-現在ある翻訳者は
-
-- `gettext`を利用する`GettextTranslator`と
-- 辞書を用いた単純な仕組みの`DictBasedTranslator`
-
-の二種で、ここでは`DictBasedTranslator`を用いた方法を解説します。
-`GettextTranslator`に関しては[gettext_example](https://github.com/gottadiveintopython/i18n/blob/main/examples/gettext_example.py)を参照して下さい。
-
-まず必要となるのは以下のような辞書型の翻訳表です。
-
-```python
-翻訳表 = {
-    'tiger': {
-        'zh': '老虎',
-        'ja': '虎',
-        'en': 'tiger',
-    },
-    'apple': {
-        'zh': '蘋果',
-        'ja': 'りんご',
-        'en': 'apple',
-    },
-}
-```
-
-pythonの辞書literalは書きづらいので実際にはYAML形式で翻訳表を作り、それをpythonの辞書に変換した方が良いかもしれません。
-
-```yaml
-tiger:
-  zh: 老虎
-  ja: 虎
-  en: tiger
-apple:
-  zh: 蘋果
-  ja: りんご
-  en: apple
-```
-
-```python
-# pip install pyyaml
-import yaml
-翻訳表 = yaml.safe_load(YAML文字列)
-```
-
-翻訳表ができたら後は以下のようにして`KXLocalizer`に与えるだけです。
-
-```python
-from kivy_garden.i18n.localizer import KXLocalizer, DictBasedTranslator
-loc = KXLocalizer(translator=DictBasedTranslator(翻訳表))
-```
-
-これで既に`loc.lang`(現在の言語)に基づいて適切な翻訳結果が得られるようになっています。
-
-```python
-loc.lang = 'ja'
-print(loc._("tiger"))  # => 虎
-print(loc._("apple"))  # => りんご
-print(loc.font_name)   # => 何かの日本語フォント名
-loc.lang = 'zh'
-print(loc._("tiger"))  # => 老虎
-print(loc._("apple"))  # => 蘋果
-print(loc.font_name)   # => 何かの中文フォント名
-```
-
-そして当然bindingを利かせてあげれば`loc.lang`(現在の言語)に連動して`Label`の`text`と`font_name`が自動で更新されます。
-
-```python
-from kivy.app import App
-from kivy.lang import Builder
-from kivy_garden.i18n.localizer import KXLocalizer, DictBasedTranslator
-
-
-KV_CODE = '''
-Label:
-    font_name: l.font_name
-    text: l._("apple")
-'''
-
-
-class SampleApp(App):
-    def build(self):
-        self.loc = KXLocalizer(translator=DictBasedTranslator(翻訳表))
-        self.loc.install(name='l')
-        return Builder.load_string(KV_CODE)
-
-    def on_start(self):
-        # Labelのfont_nameに日本語フォントが、textには りんご が入る
-        self.loc.lang = 'ja'
-
-        # Labelのfont_nameに英文フォントが、textには apple が入る
-        self.loc.lang = 'en'
-```
-
-このように`EventDispacther`のbindingの仕組みを利用すると**アプリの実行中に表示言語を自由に切り替えられるのがこのmoduleの強みとなります**。
-もちろん言語切替時にアプリの再起動を求めるつもりなのであれば無理にbindingを利かせる必要はありません。
-
-以上がこのmoduleの基本的な使い方となります。
-
-## 小道具
-
-`xgettext`は翻訳の必要性のある文字列をpythonソース中から抜き出してくれる素晴らしい道具ですが、
-文字列literalの中までは見てくれないという欠点があります。
-すなわち以下のcodeにおいて
-
-```python
-KV_CODE = '''
-BoxLayout:
-    Label:
-        text: _("ABC")
-    Label:
-        text: _("DEF")
-'''
-
-_("123")
-```
-
-`123`は抜き出してくれても`ABC`と`DEF`は抜き出してくれません。
-というわけでそういったことをしてくれる物を作りました。
-
-```
-python -m kivy_gardem.i18n.extract_msgids_from_string_literals 上記のpythonファイル > ./output.py
-```
-
-```python
-# output.pyの中身
-_("ABC")
-_("DEF")
-```
-
-このように文字列literal内の翻訳対象文字列をその外に抜き出してくれるので、
-それを`xgettext`に喰わせてあげれば取りこぼさずに済みます。

kivy_garden_i18n-0.1.0/kivy_garden/i18n/fontfinder.py

@@ -1,98 +0,0 @@
-__all__ =(
-    'enum_all_fonts', 'get_all_fonts', 'enum_fonts_from_text', 'enum_fonts_from_lang',
-)
-
-from typing import Tuple, Iterator
-from functools import lru_cache
-from pathlib import Path
-
-SUFFIXES = {'.ttf', '.otf', '.ttc', }
-EXCLUDES = {
-    # SDL2 text provider cannot render this font. Don't know about other providers.
-    'NotoColorEmoji.ttf',
-
-    # This doesn't contain English letters.
-    'DroidSansFallbackFull.ttf',
-}
-DISCRIMINANT = {
-    'ar': 'الجزيرةAB',
-    'hi': 'भारतAB',
-    'ja': (v := '経伝説あAB'),
-    'ja-JP': v,
-    'ja_JP': v,
-    'ko': (v := '안녕조AB'),
-    'ko-KR': v,
-    'ko_KR': v,
-    'zh-Hans': (v := '哪经传说AB'),
-    'zh_Hans': v,
-    'zh-CN': v,
-    'zh_CN': v,
-    'zh-SG': v,
-    'zh_SG': v,
-    'zh-Hant': (v := '哪經傳說AB'),
-    'zh_Hant': v,
-    'zh-TW': v,
-    'zh_TW': v,
-    'zh-HK': v,
-    'zh_HK': v,
-    'zh-MO': v,
-    'zh_MO': v,
-    'zh': '哪經傳說经传说AB',
-}
-
-def enum_all_fonts() -> Iterator[Path]:
-    '''Enumerates pre-installed fonts'''
-    from kivy.core.text import LabelBase
-    suffixes = SUFFIXES
-    excludes = EXCLUDES
-    for dir in LabelBase.get_system_fonts_dir():
-        for child in Path(dir).iterdir():
-            if child.suffix in suffixes and child.name not in excludes:
-                yield child
-
-
-@lru_cache(maxsize=1)
-def get_all_fonts() -> Tuple[Path]:
-    '''Returns a tuple of pre-installed fonts. Caches the return-value.'''
-    return tuple(enum_all_fonts())
-
-
-def enum_fonts_from_text(text: str) -> Iterator[Path]:
-    '''Enumerates pre-installed fonts that are capable of rendering the given
-    ``text``. The ``text`` must contain more than two characters without
-    duplication.
-
-    .. note::
-
-        The longer the ``text`` is, the more accurate the result would be,
-        but the more time it'll take.
-    '''
-    from kivy.core.text import Label as CoreLabel
-    if len(text) < 3:
-        raise ValueError(f"'text' must contain more than two characters")
-    if len(set(text)) < len(text):
-        raise ValueError(f"'text' should not contain duplicated characters")
-    label = CoreLabel()
-    label._size = (16, 16)
-    for path in get_all_fonts():
-        label.options['font_name'] = str(path)
-        label.resolve_font_name()
-        pixels_set = set()
-        for i, c in enumerate(text, start=1):
-            label.text = c
-            label._render_begin()
-            label._render_text(c, 0, 0)
-            pixels_set.add(label._render_end().data)
-            if len(pixels_set) != i:
-                break
-        else:
-            yield path
-
-
-def enum_fonts_from_lang(lang: str) -> Iterator[Path]:
-    '''Enumerates pre-installed fonts supporting the given language. '''
-    try:
-        text = DISCRIMINANT[lang]
-    except KeyError:
-        return iter('')
-    return enum_fonts_from_text(text)

kivy_garden_i18n-0.1.0/kivy_garden/i18n/localizer.py

@@ -1,94 +0,0 @@
-__all__ = ('KXLocalizer', 'GettextTranslator', 'DictBasedTranslator', )
-from typing import Callable, Dict
-
-from kivy.properties import StringProperty, ObjectProperty
-from kivy.event import EventDispatcher
-from kivy.uix.label import Label
-
-# type hints
-Lang = str
-Msgid = str
-Fontname = str
-FuncTranslate = Callable[[Msgid], str]
-
-
-class KXLocalizer(EventDispatcher):
-    lang = StringProperty()
-
-    _ = ObjectProperty(lambda v: v)
-    '''(read-only) translator'''
-
-    font_name = StringProperty(Label.font_name.defaultvalue)
-    '''(read-only)'''
-
-    def __init__(
-        self, *,
-        lang: Lang='en',
-        translator: Callable[[Lang], FuncTranslate]=None,
-        fontfinder: Callable[[Lang], Fontname]=None,
-    ):
-        if translator is None:
-            translator = lambda lang: lambda msgid: msgid
-        if fontfinder is None:
-            fontfinder = DefaultFontFinder()
-        self._translator = translator
-        self._fontfinder = fontfinder
-        super().__init__(lang=lang)
-
-    def install(self, *, name):
-        from kivy.lang import global_idmap
-        global_idmap[name] = self
-
-    def on_lang(self, __, lang):
-        self.font_name = self._fontfinder(lang)
-        self._ = self._translator(lang)
-
-
-class DefaultFontFinder:
-    PRESET = {
-        'en': (v := 'Roboto'),
-        'fr': v,
-        'ru': v,
-    }
-    def __init__(self):
-        self._font_names = self.PRESET.copy()
-
-    def __call__(self, lang: Lang) -> Fontname:
-        try:
-            return self._font_names[lang]
-        except KeyError:
-            pass
-        from .fontfinder import enum_fonts_from_lang
-        try:
-            font_name = next(enum_fonts_from_lang(lang)).name
-        except StopIteration:
-            from kivy.logger import Logger
-            Logger.warning(
-                f"kivy_garden.i18n: Couldn't find a font for lang'{lang}'. "
-                "Use Roboto as a fallback.")
-            font_name = 'Roboto'
-        self._font_names[lang] = font_name
-        return font_name
-
-
-class GettextTranslator:
-    def __init__(self, domain, localedir):
-        self.domain = domain
-        self.localedir = localedir
-
-    def __call__(self, lang: Lang) -> FuncTranslate:
-        from gettext import translation
-        return translation(domain=self.domain, localedir=self.localedir, languages=(lang, )).gettext
-
-
-class DictBasedTranslator:
-    def __init__(self, table: Dict[Msgid, Dict[Lang, str]]):
-        self._table = table
-
-    def __call__(self, lang: Lang) -> FuncTranslate:
-        def func(msgid):
-            try:
-                return self._table[msgid][lang]
-            except KeyError:
-                return msgid
-        return func