cherrypy-foundation 1.0.0__py3-none-any.whl → 1.0.0a1__py3-none-any.whl

cherrypy_foundation/components/ColorModes.jinja

@@ -1,4 +1,3 @@
-{# 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">
@@ -22,7 +21,7 @@
 </svg>
 <li>
   <span id="bd-theme" class="dropdown-item disabled">
-    <span id="bd-theme-text">{{ header }}</span>
+    <span id="bd-theme-text">{% trans %}Toggle theme{% endtrans %}</span>
     <svg aria-hidden="true"
          class="theme-icon-active visually-hidden"
          width="16"
@@ -41,7 +40,7 @@
       <use href="#sun-fill">
       </use>
     </svg>
-    {{ light_label }}
+    {% trans %}Light{% endtrans %}
   </button>
 </li>
 <li>
@@ -53,7 +52,7 @@
       <use href="#moon-stars-fill">
       </use>
     </svg>
-    {{ dark_label }}
+    {% trans %}Dark{% endtrans %}
   </button>
 </li>
 <li>
@@ -65,6 +64,6 @@
       <use href="#circle-half">
       </use>
     </svg>
-    {{ auto_label }}
+    {% trans %}Auto{% endtrans %}
   </button>
 </li>

cherrypy_foundation/components/Datatable.jinja

@@ -15,14 +15,14 @@
 {% set buttons_cfg_default = {
   "dom": {
     "button": {
-      "className": "btn btn-sm ms-1 mb-2 mb-sm-0",
+      "className": "btn btn-sm ms-1 mb-1",
       "active": "active"
     },
     "collection": {
       "tag": "div",
       "button": {
         "tag": "a",
-        "className": "btn btn-sm btn-link mb-2 mb-sm-0 w-100 text-start",
+        "className": "btn btn-sm btn-link mb-1 w-100 text-start",
         "active": "active",
         "disabled": "disabled"
       }

cherrypy_foundation/components/Datatable.js

@@ -1,6 +1,6 @@
 /**
- * Cherrypy-foundation
- * Copyright (C) 2026 IKUS Software
+ * CherryPy Foundation
+ * Copyright (C) 2025 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

cherrypy_foundation/components/Field.jinja

@@ -1,6 +1,4 @@
 {# def field, floating=False #}
-{#css vendor/bootstrap5/css/bootstrap.min.css #}
-{#js vendor/jquery/jquery.min.js, vendor/popper/popper.min.js, vendor/bootstrap5/js/bootstrap.min.js #}
 {# djlint:off #}
 {% set bootstrap_class_table = {
   "CheckboxInput": ("form-check-input", "form-check-label", False, True),
@@ -31,24 +29,16 @@
   {% set input_class, label_class, floating_supported, label_always_last = bootstrap_class_table.get(field.widget.__class__.__name__) or ('', 'form-label', False, False) %}
   {% set label_last = (floating and floating_supported) or label_always_last %}
   {% do attrs.add_class(input_class) %}
+  {# Render label an widget #}
   {# Used for input-group #}
   {% set prepend = attrs.get('prepend', None) %}
   {% set append = attrs.get('append', None) %}
   {% set input_group = prepend or append %}
-  {# Build container & label specific attributes #}
-  {% set container_attrs = attrs.__class__({'class': 'mb-2 form-field'}) %}
-  {% set label_attrs = attrs.__class__({'class': label_class}) %}
-  {% for key, value in attrs.as_dict.items() %}
-    {% if key.startswith('container-') or key.startswith('container_') %}
-      {% do container_attrs.set(**{key[10:]: value|string}) %}
-    {% endif %}
-    {% if key.startswith('label-') or key.startswith('label_') %}
-      {% do label_attrs.set(**{key[6:]: value|string}) %}
-    {% endif %}
-  {% endfor %}
-  <div {{ container_attrs.as_dict | xmlattr }}>
+  {% set container_class = attrs.get('container_class', 'col-12') %}
+  {% do attrs.__delitem__('container_class') %}
+  <div class="mb-2 form-field {{ container_class }}">
     {% if floating and floating_supported %}<div class="form-floating">{% endif %}
-      {% if not label_last %}{{ field.label(**label_attrs.as_dict) }}{% endif %}
+      {% if not label_last %}{{ field.label(class=label_class) }}{% endif %}
       {% if input_group %}
         <div class="input-group">
           {% if prepend %}<span class="input-group-text">{{ prepend }}</span>{% endif %}
@@ -58,7 +48,7 @@
           {% if append %}<span class="input-group-text">{{ append }}</span>{% endif %}
         </div>
       {% endif %}
-      {% if label_last %}{{ field.label(**label_attrs.as_dict) }}{% endif %}
+      {% if label_last %}{{ field.label(class=label_class) }}{% endif %}
       {% for error in field.errors %}<div class="invalid-feedback">{{ error }}</div>{% endfor %}
       {% if field.description %}<div class="form-text small test-secondary">{{ field.description }}</div>{% endif %}
       {% if floating and floating_supported %}</div>{% endif %}

cherrypy_foundation/components/Fields.jinja

@@ -1,4 +1,6 @@
 {# def form, floating=False #}
+{#css vendor/bootstrap5/css/bootstrap.min.css #}
+{#js vendor/jquery/jquery.min.js, vendor/popper/popper.min.js, vendor/bootstrap5/js/bootstrap.min.js #}
 <div class="row">
   {% for id, field in form._fields.items() %}<Field field={{ field }} floating={{ floating }} />{% endfor %}
 </div>

cherrypy_foundation/components/Typeahead.css

@@ -10,11 +10,6 @@
     top: 0.5rem;
 }
 
-/* Fix lense position */
-.typeahead__button button {
-    height: 100%;
-}
-
 /* Fix color for DarkMode */
 .typeahead__container button,
 .typeahead__container button.disabled,
@@ -52,4 +47,4 @@
 .typeahead__list .typeahead__item:not([disabled])>a:hover {
     background-color: var(--bs-tertiary-bg);
     color: var(--bs-body-color);
-}
+}

cherrypy_foundation/components/Typeahead.jinja

@@ -1,5 +1,5 @@
 {#def 
-accent=False, 
+accent=True, 
 async_result=False, 
 autofocus=False, 
 backdrop=False, 
@@ -27,7 +27,7 @@ href=None,
 loading_animation=True, 
 matcher=None,
 max_item=8, 
-max_item_per_group=None, 
+max_item_per_group=10, 
 max_length=None, 
 min_length=2, 
 multiselect=None, 

cherrypy_foundation/components/__init__.py

@@ -1,5 +1,5 @@
-# Cherrypy-foundation
-# Copyright (C) 2026 IKUS Software
+# udb, A web interface to manage IT network
+# Copyright (C) 2025 IKUS Software inc.
 #
 # 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

cherrypy_foundation/components/tests/test_static.py

@@ -1,5 +1,5 @@
 # CherryPy
-# Copyright (C) 2026 IKUS Software
+# Copyright (C) 2025 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

cherrypy_foundation/error_page.py

@@ -1,5 +1,5 @@
-# Cherrypy-foundation
-# Copyright (C) 2020-2026 IKUS Software
+# CherryPy Foundation
+# Copyright (C) 2020-2025 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
@@ -19,6 +19,9 @@ import logging
 
 import cherrypy
 
+# Define the logger
+logger = logging.getLogger(__name__)
+
 HTML_ERROR_TEMPLATE = '''<!DOCTYPE html>
 <html>
 <head>
@@ -50,45 +53,39 @@ HTML_ERROR_TEMPLATE = '''<!DOCTYPE html>
 '''
 
 
-def error_page(status='', message='', traceback='', version=''):
+def error_page(**kwargs):
     """
     Error page handler to handle Plain Text (text/plain), Json (application/json) or HTML (text/html) output.
 
     If available, uses Jina2 environment to generate error page using `error_page.html`.
     """
     # Log server error exception
-    if status.startswith('500'):
-        cherrypy.log(
-            f'error page status={status} message={message}\n{traceback}', context='ERROR-PAGE', severity=logging.WARNING
+    if kwargs.get('status', '').startswith('500'):
+        logger.error(
+            'error page: %s %s\n%s' % (kwargs.get('status', ''), kwargs.get('message', ''), kwargs.get('traceback', ''))
         )
 
     # Replace message by generic one for 404. Default implementation leak path info.
-    if status == '404 Not Found' and cherrypy.serving.request.path_info in message:
-        message = 'Nothing matches the given URI'
+    if kwargs.get('status', '') == '404 Not Found':
+        kwargs['message'] = 'Nothing matches the given URI'
 
     # Check expected response type.
     mtype = cherrypy.serving.response.headers.get('Content-Type') or cherrypy.tools.accept.callable(
         ['text/html', 'text/plain', 'application/json']
     )
     if mtype == 'text/plain':
-        return message
+        return kwargs.get('message')
     elif mtype == 'application/json':
-        return json.dumps({'message': message, 'status': status})
+        return json.dumps({'message': kwargs.get('message', ''), 'status': kwargs.get('status', '')})
     elif mtype == 'text/html':
-        context = {'status': status, 'message': message, 'traceback': traceback, 'version': version}
         if hasattr(cherrypy.tools, 'jinja2'):
             # Try to build a nice error page with Jinja2 env
             try:
-                return cherrypy.tools.jinja2.render_request(template='error_page.html', context=context)
+                return cherrypy.tools.jinja2.render_request(template='error_page.html', vars=kwargs)
             except Exception:
-                cherrypy.log(
-                    'fail to render error page with jinja2',
-                    context='ERROR-PAGE',
-                    severity=logging.ERROR,
-                    traceback=True,
-                )
+                logger.exception('fail to render error page')
         # Fallback to built-int HTML error page
-        return HTML_ERROR_TEMPLATE % context
+        return HTML_ERROR_TEMPLATE % kwargs
 
     # Fallback to raw error message.
-    return message
+    return kwargs.get('message')

cherrypy_foundation/flash.py

@@ -1,5 +1,5 @@
-# Cherrypy-foundation
-# Copyright (C) 2020-2026 IKUS Software
+# CherryPy Foundation
+# Copyright (C) 2020-2025 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
@@ -16,7 +16,7 @@
 
 from collections import namedtuple
 
-from cherrypy_foundation.sessions import session_lock
+import cherrypy
 
 FlashMessage = namedtuple('FlashMessage', ['message', 'level'])
 
@@ -27,24 +27,22 @@ def flash(message, level='info'):
     """
     assert message
     assert level in ['info', 'error', 'warning', 'success']
-    with session_lock() as session:
-        if 'flash' not in session:
-            session['flash'] = []
-        # Support Markup and string
-        if hasattr(message, '__html__'):
-            flash_message = FlashMessage(message, level)
-        else:
-            flash_message = FlashMessage(str(message), level)
-        session['flash'].append(flash_message)
+    if 'flash' not in cherrypy.session:
+        cherrypy.session['flash'] = []
+    # Support Markup and string
+    if hasattr(message, '__html__'):
+        flash_message = FlashMessage(message, level)
+    else:
+        flash_message = FlashMessage(str(message), level)
+    cherrypy.session['flash'].append(flash_message)
 
 
 def get_flashed_messages():
     """
     Return all flash message.
     """
-    with session_lock() as session:
-        if 'flash' in session:
-            messages = session['flash']
-            del session['flash']
-            return messages
+    if 'flash' in cherrypy.session:
+        messages = cherrypy.session['flash']
+        del cherrypy.session['flash']
+        return messages
     return []

cherrypy_foundation/form.py

@@ -1,5 +1,5 @@
-# Cherrypy-foundation
-# Copyright (C) 2020-2026 IKUS Software
+# CherryPy Foundation
+# Copyright (C) 2020-2025 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

cherrypy_foundation/logging.py

@@ -1,5 +1,5 @@
-# Cherrypy-foundation
-# Copyright (C) 2026 IKUS Software
+# CherryPy Foundation
+# Copyright (C) 2025 IKUS Software inc.
 #
 # 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

cherrypy_foundation/passwd.py

@@ -1,5 +1,5 @@
-# Cherrypy-foundation
-# Copyright (C) 2026 IKUS Software
+# CherryPy Foundation
+# Copyright (C) 2025 IKUS Software inc.
 #
 # 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

cherrypy_foundation/plugins/db.py

@@ -1,5 +1,5 @@
 # SQLAlchemy plugins for cherrypy
-# Copyright (C) 2022-2026 IKUS Software
+# Copyright (C) 2022-2025 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
@@ -23,6 +23,8 @@ from sqlalchemy.engine import Engine
 from sqlalchemy.exc import IntegrityError, SQLAlchemyError
 from sqlalchemy.orm import declarative_base, scoped_session, sessionmaker
 
+logger = logging.getLogger(__name__)
+
 
 @event.listens_for(Engine, 'connect')
 def _set_sqlite_journal_mode_wal(connection, connection_record):
@@ -166,10 +168,6 @@ class SQLA(SimplePlugin):
     _session = None
     _engine = None
 
-    @property
-    def engine(self):
-        return self._engine
-
     def start(self):
         if self.uri is None:
             return
@@ -182,22 +180,14 @@ class SQLA(SimplePlugin):
         self.clear_sessions()
         # Associate our session to our engine
         self.get_session().configure(bind=self._engine)
-        self.bus.log("database session plugin started")
-
-    # This is slightly lower priority to get database started first.
-    start.priority = 45
+        self.bus.log("Database session plugin started.")
 
     def stop(self):
         if self._session:
             self.clear_sessions()
         if self._engine:
             self._engine.dispose()
-        self.bus.log("database session plugin stopped")
-
-    def graceful(self):
-        """Reload of subscribers."""
-        self.stop()
-        self.start()
+        self.bus.log("Database session plugin stopped.")
 
     def create_all(self):
         try:
@@ -252,27 +242,11 @@ class SQLA(SimplePlugin):
         try:
             # When terminating, raise an error if objects are not commit.
             if self._session.dirty or self._session.new or self._session.deleted:
-                cherrypy.log(
-                    'database session dirty; uncommitted objects detected — potential application bug',
-                    context='DB',
-                    severity=logging.ERROR,
+                changes = ', '.join([str(_get_model_changes(obj)) for obj in self._session.dirty])
+                logger.exception(
+                    'session is dirty, some database object(s) are not commited, this indicate a bug in the application '
+                    'dirty %s new %s deleted %s' % (changes, self._session.new, self._session.deleted)
                 )
-                if self._session.dirty:
-                    changes = ', '.join([str(_get_model_changes(obj)) for obj in self._session.dirty])
-                    cherrypy.log(
-                        f'database session dirty_objects={self._session.dirty}', context='DB', severity=logging.ERROR
-                    )
-                    cherrypy.log(f'database session pending_changes={changes}', context='DB', severity=logging.ERROR)
-                if self._session.new:
-                    cherrypy.log(
-                        f'database session new_objects={self._session.new}', context='DB', severity=logging.ERROR
-                    )
-                if self._session.deleted:
-                    cherrypy.log(
-                        f'database session deleted_objects={self._session.deleted}',
-                        context='DB',
-                        severity=logging.ERROR,
-                    )
                 raise SQLAlchemyError('session is dirty')
         finally:
             self._session.rollback()

cherrypy_foundation/plugins/ldap.py

@@ -1,5 +1,5 @@
 # LDAP Plugins for cherrypy
-# Copyright (C) 2026 IKUS Software
+# Copyright (C) 2025 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
@@ -21,12 +21,14 @@ import ldap3
 from cherrypy.process.plugins import SimplePlugin
 from ldap3.core.exceptions import LDAPException, LDAPInvalidCredentialsResult
 
+logger = logging.getLogger(__name__)
+
 _safe = ldap3.utils.conv.escape_filter_chars
 
 
 def all_attribute(attributes, keys, default=None):
     """
-    Extract all values from LDAP attributes.
+    Extract the all value from LDAP attributes.
     """
     # Skip loopkup if key is not defined.
     if not keys:
@@ -61,9 +63,7 @@ def first_attribute(attributes, keys, default=None):
     for attr in keys:
         try:
             value = attributes[attr]
-            if isinstance(value, list):
-                if len(value) == 0:
-                    continue
+            if isinstance(value, list) and len(value) > 0:
                 return value[0]
             else:
                 return value
@@ -77,8 +77,8 @@ class LdapPlugin(SimplePlugin):
     """
     Used this plugin to authenticate user against an LDAP server.
 
-    `authenticate(login, password)` return None if the credentials are not
-    valid. Otherwise it return a tuple or login and extra attributes.
+    `authenticate(username, password)` return None if the credentials are not
+    valid. Otherwise it return a tuple or username and extra attributes.
     The extra attribute may contains `_fullname` and `_email`.
     """
 
@@ -89,7 +89,7 @@ class LdapPlugin(SimplePlugin):
     scope = 'subtree'
     tls = False
     user_filter = '(objectClass=*)'
-    login_attribute = ['uid']
+    username_attribute = ['uid']
     required_group = None
     group_attribute = 'member'
     group_attribute_is_dn = False
@@ -101,7 +101,6 @@ class LdapPlugin(SimplePlugin):
     firstname_attribute = None
     lastname_attribute = None
     email_attribute = None
-    pool_size = 10
 
     def start(self):
         # Don't configure this plugin if the ldap URI is not provided.
@@ -119,7 +118,6 @@ class LdapPlugin(SimplePlugin):
             version=self.version,
             raise_exceptions=True,
             client_strategy=ldap3.REUSABLE,
-            pool_size=self.pool_size,
         )
 
     def stop(self):
@@ -128,19 +126,14 @@ class LdapPlugin(SimplePlugin):
         if hasattr(self, '_pool'):
             self._pool.unbind()
 
-    def graceful(self):
-        """Reload of subscribers."""
-        self.stop()
-        self.start()
-
-    def authenticate(self, login, password):
+    def authenticate(self, username, password):
         """
         Check if the given credential as valid according to LDAP.
         Return False if invalid.
         Return None if the plugin is unavailable to validate credentials or if the plugin is disabled.
-        Return tuple (<login>, <attributes>) if the credentials are valid.
+        Return tuple (<username>, <attributes>) if the credentials are valid.
         """
-        assert isinstance(login, str)
+        assert isinstance(username, str)
         assert isinstance(password, str)
 
         if not hasattr(self, '_pool'):
@@ -150,14 +143,14 @@ class LdapPlugin(SimplePlugin):
         with self._pool as conn:
             try:
                 # Search the LDAP server for user's DN.
-                safe_login = _safe(login)
-                attr_filter = ''.join([f'({_safe(attr)}={safe_login})' for attr in self.login_attribute])
+                safe_username = _safe(username)
+                attr_filter = ''.join([f'({_safe(attr)}={safe_username})' for attr in self.username_attribute])
                 search_filter = f"(&{self.user_filter}(|{attr_filter}))"
                 response = self._search(conn, search_filter)
                 if not response:
-                    cherrypy.log(f"lookup failed login={login} reason=not_found", context='LDAP')
+                    logger.info("user %s not found in LDAP", username)
                     return False
-                cherrypy.log(f"lookup successful login={login}", context='LDAP')
+                logger.info("user %s found in LDAP", username)
                 user_dn = response[0]['dn']
 
                 # Use a separate connection to validate credentials
@@ -170,21 +163,17 @@ class LdapPlugin(SimplePlugin):
                     client_strategy=ldap3.ASYNC,
                 )
                 if not login_conn.bind():
-                    cherrypy.log(
-                        f'ldap authentication failed login={login} reason=wrong_password',
-                        context='LDAP',
-                        severity=logging.WARNING,
-                    )
+                    logger.warning("LDAP authentication failed for user %s", username)
                     return False
 
-                # Get user's login
+                # Get username
                 attrs = response[0]['attributes']
-                new_login = first_attribute(attrs, self.login_attribute[0])
-                if not new_login:
-                    cherrypy.log(
-                        f"object missing login attribute user_dn={user_dn} attribute={self.login_attribute[0]}",
-                        context='LDAP',
-                        severity=logging.WARNING,
+                new_username = first_attribute(attrs, self.username_attribute)
+                if not new_username:
+                    logger.info(
+                        "user object %s was found but the username attribute %s doesn't exists",
+                        user_dn,
+                        self.username_attribute,
                     )
                     return False
 
@@ -192,7 +181,7 @@ class LdapPlugin(SimplePlugin):
                 if self.required_group:
                     if not isinstance(self.required_group, list):
                         self.required_group = [self.required_group]
-                    user_value = user_dn if self.group_attribute_is_dn else new_login
+                    user_value = user_dn if self.group_attribute_is_dn else new_username
                     group_filter = '(&(%s=%s)(|%s)%s)' % (
                         _safe(self.group_attribute),
                         _safe(user_value),
@@ -200,15 +189,17 @@ class LdapPlugin(SimplePlugin):
                         self.group_filter,
                     )
                     # Search LDAP Server for matching groups.
-                    cherrypy.log(
-                        f"group check start login={user_value} required_groups={' '.join(self.required_group)}",
-                        context='LDAP',
+                    logger.info(
+                        "check if user %s is member of any group %s",
+                        user_value,
+                        ' '.join(self.required_group),
                     )
                     response = self._search(conn, group_filter, attributes=['cn'])
                     if not response:
-                        cherrypy.log(
-                            f"group check failed login={user_value} required_groups={' '.join(self.required_group)}",
-                            context='LDAP',
+                        logger.info(
+                            "user %s was found but is not member of any group(s) %s",
+                            user_value,
+                            ' '.join(self.required_group),
                         )
                         return False
 
@@ -220,11 +211,11 @@ class LdapPlugin(SimplePlugin):
                     firstname = first_attribute(attrs, self.firstname_attribute, '')
                     lastname = first_attribute(attrs, self.lastname_attribute, '')
                     attrs['fullname'] = ' '.join([name for name in [firstname, lastname] if name])
-                return (new_login, attrs)
+                return (new_username, attrs)
             except LDAPInvalidCredentialsResult:
                 return False
             except LDAPException:
-                cherrypy.log(f"unexpected error login={login}", context='LDAP', severity=logging.ERROR, traceback=True)
+                logger.exception("can't validate user %s credentials", username)
             return None
 
     def search(self, filter, attributes=ldap3.ALL_ATTRIBUTES, search_base=None, paged_size=None):
@@ -237,10 +228,11 @@ class LdapPlugin(SimplePlugin):
         search_scope = {'base': ldap3.BASE, 'onelevel': ldap3.LEVEL, 'subtree': ldap3.SUBTREE}.get(
             self.scope, ldap3.SUBTREE
         )
-        search_base = search_base or self.base_dn
-        cherrypy.log(f"search {self.uri}/{search_base}?{search_scope}?{filter}", context='LDAP')
+        logger.debug(
+            "search ldap server: {}/{}?{}?{}".format(self.uri, search_base or self.base_dn, search_scope, filter)
+        )
         msg_id = conn.search(
-            search_base=search_base,
+            search_base=search_base or self.base_dn,
             search_filter=filter,
             search_scope=search_scope,
             time_limit=self.timeout,

cherrypy_foundation/plugins/restapi.py

@@ -1,5 +1,5 @@
 # RestAPI plugin for cherrypy
-# Copyright (C) 2024-2026 IKUS Software
+# Copyright (C) 2024-2025 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