cherrypy-foundation 1.0.0a13__tar.gz → 1.0.0a14__tar.gz

{cherrypy_foundation-1.0.0a13/src/cherrypy_foundation.egg-info → cherrypy_foundation-1.0.0a14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cherrypy-foundation
-Version: 1.0.0a13
+Version: 1.0.0a14
 Summary: CherryPy Foundation
 Author-email: Patrik Dufresne <patrik@ikus-soft.com>
 License: GPLv3

{cherrypy_foundation-1.0.0a13 → cherrypy_foundation-1.0.0a14}/src/cherrypy_foundation/components/ColorModes.jinja

@@ -1,3 +1,4 @@
+{# def header="Toggle theme", light_label="Light", dark_label="Dark", auto_label="Auto" #}
 {#css vendor/bootstrap5/css/bootstrap.min.css #}
 {#js vendor/popper/popper.min.js, vendor/bootstrap5/js/bootstrap.min.js, vendor/bootstrap5/js/color-modes.js #}
 <svg class="d-none" xmlns="http://www.w3.org/2000/svg">
@@ -21,7 +22,7 @@
 </svg>
 <li>
   <span id="bd-theme" class="dropdown-item disabled">
-    <span id="bd-theme-text">{% trans %}Toggle theme{% endtrans %}</span>
+    <span id="bd-theme-text">{{ header }}</span>
     <svg aria-hidden="true"
          class="theme-icon-active visually-hidden"
          width="16"
@@ -40,7 +41,7 @@
       <use href="#sun-fill">
       </use>
     </svg>
-    {% trans %}Light{% endtrans %}
+    {{ light_label }}
   </button>
 </li>
 <li>
@@ -52,7 +53,7 @@
       <use href="#moon-stars-fill">
       </use>
     </svg>
-    {% trans %}Dark{% endtrans %}
+    {{ dark_label }}
   </button>
 </li>
 <li>
@@ -64,6 +65,6 @@
       <use href="#circle-half">
       </use>
     </svg>
-    {% trans %}Auto{% endtrans %}
+    {{ auto_label }}
   </button>
 </li>

cherrypy_foundation-1.0.0a14/src/cherrypy_foundation/components/LocaleSelection.jinja

@@ -0,0 +1,13 @@
+{# def header="Language selection" #}
+<li>
+  <h6 class="dropdown-header">{{ header }}</h6>
+</li>
+{% set cur_locale = get_translation().locale %}
+{% for locale in list_available_locales() %}
+  <li>
+    <button aria-pressed="{{ 'true' if cur_locale == locale else 'false' }}"
+            class="dropdown-item btn-locale{{ ' active' if cur_locale == locale else '' }}"
+            data-locale="{{ locale.language }}"
+            type="button">{{ locale.display_name.capitalize() }}</button>
+  </li>
+{% endfor %}

cherrypy_foundation-1.0.0a14/src/cherrypy_foundation/components/LocaleSelection.js

@@ -0,0 +1,26 @@
+/*
+ * Handle locale selection.
+ */
+document.addEventListener('DOMContentLoaded', function () {
+  const LOCALE_COOKIE_NAME = 'locale';
+  const ONE_YEAR = 60 * 60 * 24 * 365;
+
+  function setLocaleCookie(locale) {
+    document.cookie = `${LOCALE_COOKIE_NAME}=${locale}; path=/; max-age=${ONE_YEAR}; SameSite=Lax`;
+  }
+
+  function onLanguageClick(event) {
+    const locale = event.target.dataset.locale;
+    if (!locale) return;
+
+    setLocaleCookie(locale);
+
+    // Reload page so backend can use the new language
+    window.location.reload();
+  }
+
+  document.querySelectorAll('.btn-locale').forEach(btn => {
+    btn.addEventListener('click', onLanguageClick);
+  });
+  
+});

cherrypy_foundation-1.0.0a14/src/cherrypy_foundation/tests/__init__.py

@@ -0,0 +1,72 @@
+# CherryPy foundation
+# Copyright (C) 2026 IKUS Software
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+import os
+import tempfile
+import unittest
+from contextlib import contextmanager
+
+from selenium import webdriver
+
+
+class SeleniumUnitTest:
+
+    @property
+    def _session_id(self):
+        if hasattr(self, 'cookies') and self.cookies:
+            for unused, value in self.cookies:
+                for part in value.split(';'):
+                    key, unused, value = part.partition('=')
+                    if key == 'session_id':
+                        return value
+
+    @contextmanager
+    def selenium(self, headless=True, implicitly_wait=3):
+        """
+        Decorator to load selenium for a test.
+        """
+        # Skip selenium test is display is not available.
+        if not os.environ.get('DISPLAY', False):
+            raise unittest.SkipTest("selenium require a display")
+        # Start selenium driver
+        options = webdriver.ChromeOptions()
+        if headless:
+            options.add_argument('--headless')
+        options.add_argument('--disable-gpu')
+        options.add_argument('--window-size=1280,800')
+        options.add_argument('--no-sandbox')
+        options.add_argument('--disable-dev-shm-usage')
+        options.add_argument('--lang=en-US')
+        driver = webdriver.Chrome(options=options)
+        try:
+            # If logged in, reuse the same session id.
+            if self._session_id:
+                driver.get(f'{self.baseurl}/login/')
+                driver.add_cookie({"name": "session_id", "value": self.session_id})
+            # Configure download folder
+            download = os.path.join(os.path.expanduser('~'), 'Downloads')
+            os.makedirs(download, exist_ok=True)
+            self._selenium_download_dir = tempfile.mkdtemp(dir=download, prefix='selenium-download-')
+            driver.execute_cdp_cmd(
+                'Page.setDownloadBehavior', {'behavior': 'allow', 'downloadPath': self._selenium_download_dir}
+            )
+            # Set default wait.
+            driver.implicitly_wait(implicitly_wait)
+            yield driver
+        finally:
+            # Code to release resource, e.g.:
+            driver.close()
+            driver = None

{cherrypy_foundation-1.0.0a13 → cherrypy_foundation-1.0.0a14}/src/cherrypy_foundation/tests/templates/test_flash.html

@@ -1,4 +1,5 @@
-<html>
+<!DOCTYPE html>
+<html lang="en">
     <head>
         <title>test-flash</title>
     </head>

{cherrypy_foundation-1.0.0a13 → cherrypy_foundation-1.0.0a14}/src/cherrypy_foundation/tests/templates/test_form.html

@@ -1,4 +1,5 @@
-<html>
+<!DOCTYPE html>
+<html >
     <head>
         <title>test-form</title>
     </head>

{cherrypy_foundation-1.0.0a13 → cherrypy_foundation-1.0.0a14}/src/cherrypy_foundation/tests/templates/test_url.html

@@ -1,4 +1,4 @@
-<html>
+<html lang="en">
     <head>
         <title>test-url</title>
     </head>

{cherrypy_foundation-1.0.0a13 → cherrypy_foundation-1.0.0a14}/src/cherrypy_foundation/tools/i18n.py

@@ -296,6 +296,11 @@ def list_available_locales():
     """
     Return a list of available translations.
     """
+    return_value = []
+    # Always return the source code locale.
+    sourcecode_lang = _get_config('tools.i18n.sourcecode_lang', 'en')
+    return_value.append(Locale.parse(sourcecode_lang))
+    # Then scan language directory for more translation.
     mo_dir = _get_config('tools.i18n.mo_dir')
     domain = _get_config('tools.i18n.domain', 'messages')
     if not mo_dir:
@@ -303,9 +308,10 @@ def list_available_locales():
     for lang in os.listdir(mo_dir):
         if os.path.exists(os.path.join(mo_dir, lang, 'LC_MESSAGES', f'{domain}.mo')):
             try:
-                yield Locale.parse(lang)
+                return_value.append(Locale.parse(lang))
             except Exception:
                 continue
+    return return_value
 
 
 def list_available_timezones():
@@ -405,8 +411,6 @@ def _load_default(mo_dir, domain, default, **kwargs):
     # Clear current translation
     _preferred_lang.set(tuple())
     _preferred_timezone.set(tuple())
-    cherrypy.request._i18n_lang_func = kwargs.get('lang', kwargs.get('func', False))
-    cherrypy.request._i18n_tzinfo_func = kwargs.get('tzinfo', False)
     # Clear current translation
     _translation.set(None)
     # Clear current timezone
@@ -425,11 +429,40 @@ def _load_accept_language(**kwargs):
         _translation.set(None)
 
 
+def _load_cookie_language(**kwargs):
+    """
+    Load preferred language from a request cookie.
+
+    Expected cookie value formats:
+    - en
+    - en_US
+    - en-US
+    """
+    # Skip this step if cookie name is not defined.
+    cookie_name = _get_config('tools.i18n.cookie_name')
+    if not cookie_name:
+        return
+
+    # Check if value defined in cookie.
+    cookie = cherrypy.request.cookie
+    if cookie_name not in cookie:
+        return
+
+    try:
+        value = cookie[cookie_name].value.replace('-', '_')
+    except Exception:
+        return
+
+    # Set preferred language and clear cached translation
+    _preferred_lang.set((value,))
+    _translation.set(None)
+
+
 def _load_func_language(**kwargs):
     """
     When running a request where a current user is found, load preferred language from user preferences.
     """
-    func = getattr(cherrypy.request, '_i18n_lang_func', False)
+    func = _get_config('tools.i18n.lang', default=_get_config('tools.i18n.func'))
     if not func:
         return
     try:
@@ -448,7 +481,7 @@ def _load_func_tzinfo(**kwargs):
     """
     When running a request, load the preferred timezone information from user preferences.
     """
-    func = getattr(cherrypy.request, '_i18n_tzinfo_func', False)
+    func = _get_config('tools.i18n.tzinfo')
     if not func:
         return
     try:
@@ -487,6 +520,7 @@ class I18nTool(cherrypy.Tool):
         cherrypy.Tool._setup(self)
         # Attach additional hooks as different priority to update preferred lang with more accurate preferences.
         cherrypy.request.hooks.attach('before_handler', _load_accept_language, priority=60)
+        cherrypy.request.hooks.attach('before_handler', _load_cookie_language, priority=70)
         cherrypy.request.hooks.attach('before_handler', _load_func_language, priority=75)
         cherrypy.request.hooks.attach('before_handler', _load_func_tzinfo, priority=75)
         cherrypy.request.hooks.attach('before_finalize', _set_content_language)

{cherrypy_foundation-1.0.0a13 → cherrypy_foundation-1.0.0a14}/src/cherrypy_foundation/tools/jinja2.py

@@ -80,7 +80,17 @@ class Jinja2Tool(cherrypy.Tool):
 
         # Enable translation if available
         if hasattr(cherrypy.tools, 'i18n'):
-            from .i18n import format_date, format_datetime, get_language_name, get_translation, ugettext, ungettext
+            from .i18n import (
+                format_date,
+                format_datetime,
+                get_language_name,
+                get_timezone_name,
+                get_translation,
+                list_available_locales,
+                list_available_timezones,
+                ugettext,
+                ungettext,
+            )
 
             env.add_extension('jinja2.ext.i18n')
             env.install_gettext_callables(ugettext, ungettext, newstyle=True)
@@ -88,6 +98,9 @@ class Jinja2Tool(cherrypy.Tool):
             env.filters['format_datetime'] = format_datetime
             env.globals['get_language_name'] = get_language_name
             env.globals['get_translation'] = get_translation
+            env.globals['list_available_locales'] = list_available_locales
+            env.globals['list_available_timezones'] = list_available_timezones
+            env.globals['get_timezone_name'] = get_timezone_name
 
         # Update globals, filters and tests
         env.globals.update(globals)

{cherrypy_foundation-1.0.0a13 → cherrypy_foundation-1.0.0a14}/src/cherrypy_foundation/tools/tests/templates/test_jinja2.html

@@ -1,4 +1,5 @@
-<html>
+<!DOCTYPE html>
+<html lang="en">
     <head>
         <title>test-jinja2</title>
     </head>

{cherrypy_foundation-1.0.0a13 → cherrypy_foundation-1.0.0a14}/src/cherrypy_foundation/tools/tests/templates/test_jinjax.html

@@ -1,6 +1,7 @@
-<html>
+<!DOCTYPE html>
+<html lang="en">
     <head>
-        <title>test-jinja2</title>
+        <title>test-jinjax</title>
     </head>
     <body>
         <Button link="http://example.com" label="foo" />

cherrypy_foundation-1.0.0a14/src/cherrypy_foundation/tools/tests/templates/test_jinjax_i18n.html

@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+<html lang="{{ get_translation().locale }}">
+    <head>
+        <title>test-jinja2</title>
+        {{ catalog.render_assets() }}
+    </head>
+    <body>
+        <!-- Selector -->
+        <div class="dropdown">
+            <button class="btn btn-secondary dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false">
+                Dropdown button
+            </button>
+            <ul class="dropdown-menu">
+                <LocaleSelection />
+            </ul>
+        </div>
+        {{ get_language_name(get_translation().locale) }}<br/>
+        {% trans %}Some text to translate{% endtrans %}<br/>
+        {{ my_datetime | format_datetime(format='full') }}<br/>
+        {{ my_date | format_date(format='full') }}
+    </body>
+</html>

{cherrypy_foundation-1.0.0a13 → cherrypy_foundation-1.0.0a14}/src/cherrypy_foundation/tools/tests/test_i18n.py

@@ -76,6 +76,7 @@ class AbstractI18nTest(helper.CPWebCase):
                 'tools.i18n.default': cls.default_lang,
                 'tools.i18n.mo_dir': importlib.resources.files(__package__) / 'locales',
                 'tools.i18n.domain': 'messages',
+                'tools.i18n.cookie_name': 'locale',
             }
         )
         cherrypy.tree.mount(Root(), '/')
@@ -124,6 +125,13 @@ class TestI18nWebCase(AbstractI18nTest):
         # Tehn page return en-US
         self.assertHeaderItemValue("Content-Language", "en-US")
 
+    def test_cookie_fr(self):
+        # When calling with locale variant
+        self.getPage("/", headers=[("Accept-Language", "en-US"), ("Cookie", "locale=fr")])
+        self.assertStatus('200 OK')
+        # Tehn page return en-US
+        self.assertHeaderItemValue("Content-Language", "fr")
+
     def test_with_preferred_lang(self):
         # Given a default lang 'en'
         date = datetime.fromtimestamp(1680111611, timezone.utc)
@@ -175,6 +183,23 @@ class TestI18nWebCase(AbstractI18nTest):
             with i18n.preferred_lang('de_CH'):
                 self.assertEqual('29. März 2023, 19:40:11 MESZ', i18n.format_datetime(date, format='long'))
 
+    def test_list_available_locales(self):
+        self.assertEqual(['de', 'en', 'fr'], sorted([str(l) for l in i18n.list_available_locales()]))
+
+    def test_list_available_timezones(self):
+        timezones = i18n.list_available_timezones()
+        self.assertIn('America/Toronto', timezones)
+
+    def test_get_timezone_name(self):
+        with i18n.preferred_lang('en'):
+            self.assertEqual('Eastern Time', i18n.get_timezone_name('America/Toronto'))
+            self.assertEqual('ET', i18n.get_timezone_name('America/Toronto', width='short'))
+            self.assertEqual('Eastern Time', i18n.get_timezone_name('America/Toronto', width='long'))
+        with i18n.preferred_lang('fr'):
+            self.assertEqual('heure de l’Est nord-américain', i18n.get_timezone_name('America/Toronto'))
+            self.assertEqual('HE', i18n.get_timezone_name('America/Toronto', width='short'))
+            self.assertEqual('heure de l’Est nord-américain', i18n.get_timezone_name('America/Toronto', width='long'))
+
 
 class TestI18nDefaultLangWebCase(AbstractI18nTest):
     default_lang = 'FR'

{cherrypy_foundation-1.0.0a13 → cherrypy_foundation-1.0.0a14}/src/cherrypy_foundation/tools/tests/test_jinja2.py

@@ -21,6 +21,10 @@ import cherrypy
 from cherrypy.test import helper
 from parameterized import parameterized
 
+from cherrypy_foundation.components import StaticMiddleware
+from cherrypy_foundation.tests import SeleniumUnitTest
+from cherrypy_foundation.url import url_for
+
 from .. import i18n  # noqa
 from .. import jinja2  # noqa
 
@@ -38,9 +42,18 @@ def extra_processor():
     return {'var2': 'bar'}
 
 
-@cherrypy.tools.jinja2(env=env, extra_processor=extra_processor)
+@cherrypy.tools.i18n(on=False)
+@cherrypy.tools.sessions(on=False)
+class Static:
+
+    components = StaticMiddleware()
+
+
+@cherrypy.tools.jinja2(on=False, env=env, extra_processor=extra_processor)
 class Root:
 
+    static = Static()
+
     @cherrypy.expose
     @cherrypy.tools.jinja2(template='test_jinja2.html')
     def index(self):
@@ -52,12 +65,13 @@ class Root:
         return {'var1': 'test-jinjax'}
 
     @cherrypy.expose
-    @cherrypy.tools.jinja2(template='test_jinja2_i18n.html')
+    @cherrypy.tools.jinja2(template='test_jinjax_i18n.html')
     @cherrypy.tools.i18n(
         default='fr',
         default_timezone='America/Toronto',
         mo_dir=importlib.resources.files(__package__) / 'locales',
         domain='messages',
+        cookie_name='locale',  # For LocaleSelection
     )
     def localized(self):
         return {
@@ -66,7 +80,7 @@ class Root:
         }
 
 
-class Jinja2Test(helper.CPWebCase):
+class Jinja2Test(helper.CPWebCase, SeleniumUnitTest):
     default_lang = None
     interactive = False
 
@@ -95,6 +109,7 @@ class Jinja2Test(helper.CPWebCase):
         # Then the page is render dynamically using page context
         self.assertInBody('<a class="btn btn-primary" href="http://example.com">foo</a>')
 
+    @skipUnless(HAS_JINJAX, reason='Required jinjax')
     @parameterized.expand(
         [
             ('server_default', {}, 'fr'),
@@ -121,3 +136,18 @@ class Jinja2Test(helper.CPWebCase):
             self.assertInBody('Some text to translate')
             self.assertInBody('Wednesday, November 26, 2025, 6:16:00\u202fAM Eastern Standard Time')
             self.assertInBody('Monday, December 22, 2025')
+
+    @skipUnless(HAS_JINJAX, reason='Required jinjax')
+    def test_get_page_i18n_selenium(self):
+        # Given a localized page render with jinja2
+        with self.selenium() as driver:
+            # When querying the page
+            driver.get(url_for('localized'))
+            # Then page load without error in english (enforced chronium lang)
+            self.assertFalse(driver.get_log('browser'))
+            self.assertEqual('en_US', driver.find_element('css selector', 'html').get_attribute('lang'))
+            # When user select a language
+            btn = driver.find_element('css selector', 'button[data-locale=fr]')
+            btn.click()
+            # Then page is reloaded with in French.
+            self.assertEqual('fr', driver.find_element('css selector', 'html').get_attribute('lang'))

{cherrypy_foundation-1.0.0a13 → cherrypy_foundation-1.0.0a14}/src/cherrypy_foundation/url.py

@@ -60,8 +60,7 @@ def url_for(*args, _relative=None, _base=None, **kwargs):
     elif not path.startswith('.'):
         path = urljoin('/', path)
     # Outside a request, use cherrypy.tools.proxy config
-    if not cherrypy.request.app:
-        if _base is None:
-            _base = cherrypy.config.get('tools.proxy.base', None)
+    if not cherrypy.request.app and _base is None:
+        _base = cherrypy.config.get('tools.proxy.base', None)
     # Use cherrypy to build the URL
     return cherrypy.url(path=path, qs=qs, relative=_relative, base=_base)

{cherrypy_foundation-1.0.0a13 → cherrypy_foundation-1.0.0a14/src/cherrypy_foundation.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cherrypy-foundation
-Version: 1.0.0a13
+Version: 1.0.0a14
 Summary: CherryPy Foundation
 Author-email: Patrik Dufresne <patrik@ikus-soft.com>
 License: GPLv3

{cherrypy_foundation-1.0.0a13 → cherrypy_foundation-1.0.0a14}/src/cherrypy_foundation.egg-info/SOURCES.txt

@@ -38,6 +38,8 @@ src/cherrypy_foundation/components/Field.js
 src/cherrypy_foundation/components/Fields.jinja
 src/cherrypy_foundation/components/Flash.jinja
 src/cherrypy_foundation/components/Icon.jinja
+src/cherrypy_foundation/components/LocaleSelection.jinja
+src/cherrypy_foundation/components/LocaleSelection.js
 src/cherrypy_foundation/components/SideBySideMultiSelect.css
 src/cherrypy_foundation/components/SideBySideMultiSelect.jinja
 src/cherrypy_foundation/components/SideBySideMultiSelect.js
@@ -144,5 +146,5 @@ src/cherrypy_foundation/tools/tests/locales/de/LC_MESSAGES/messages.po
 src/cherrypy_foundation/tools/tests/locales/fr/LC_MESSAGES/messages.mo
 src/cherrypy_foundation/tools/tests/locales/fr/LC_MESSAGES/messages.po
 src/cherrypy_foundation/tools/tests/templates/test_jinja2.html
-src/cherrypy_foundation/tools/tests/templates/test_jinja2_i18n.html
-src/cherrypy_foundation/tools/tests/templates/test_jinjax.html
+src/cherrypy_foundation/tools/tests/templates/test_jinjax.html
+src/cherrypy_foundation/tools/tests/templates/test_jinjax_i18n.html

cherrypy_foundation-1.0.0a13/src/cherrypy_foundation/tools/tests/templates/test_jinja2_i18n.html

@@ -1,11 +0,0 @@
-<html lang="{{ get_translation().locale }}">
-    <head>
-        <title>test-jinja2</title>
-    </head>
-    <body>
-        {{ get_language_name(get_translation().locale) }}<br/>
-        {% trans %}Some text to translate{% endtrans %}<br/>
-        {{ my_datetime | format_datetime(format='full') }}<br/>
-        {{ my_date | format_date(format='full') }}
-    </body>
-</html>