cherrypy-foundation 1.0.0a19__py3-none-any.whl → 1.0.0a21__py3-none-any.whl

cherrypy_foundation/flash.py

@@ -16,7 +16,7 @@
 
 from collections import namedtuple
 
-import cherrypy
+from cherrypy_foundation.sessions import session_lock
 
 FlashMessage = namedtuple('FlashMessage', ['message', 'level'])
 
@@ -27,22 +27,24 @@ def flash(message, level='info'):
     """
     assert message
     assert level in ['info', 'error', 'warning', 'success']
-    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)
+    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)
 
 
 def get_flashed_messages():
     """
     Return all flash message.
     """
-    if 'flash' in cherrypy.session:
-        messages = cherrypy.session['flash']
-        del cherrypy.session['flash']
-        return messages
+    with session_lock() as session:
+        if 'flash' in session:
+            messages = session['flash']
+            del session['flash']
+            return messages
     return []

cherrypy_foundation/sessions.py

@@ -1,20 +1,4 @@
-# Session timeout tool for cherrypy
-# Copyright (C) 2012-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/>.
-
-# BFH Science Self-Service Portal
+# Cherrypy-foundation
 # Copyright (C) 2025-2026 IKUS Software
 #
 # This program is free software: you can redistribute it and/or modify
@@ -29,6 +13,10 @@
 #
 # 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 logging
+import os
 import time
 from contextlib import contextmanager
 
@@ -38,7 +26,6 @@ from cherrypy.lib import locking
 from cherrypy.lib.sessions import FileSession as CPFileSession
 
 
-# Issue in cherrypy: https://github.com/cherrypy/cherrypy/issues/2065
 class FileSession(CPFileSession):
     """
     Override implementation of cherrpy file session to improve file locking.
@@ -46,6 +33,8 @@ class FileSession(CPFileSession):
 
     def acquire_lock(self, path=None):
         """Acquire an exclusive lock on the currently-loaded session data."""
+        # See Issue https://github.com/cherrypy/cherrypy/issues/2065
+
         if path is None:
             path = self._get_file_path()
         path += self.LOCK_SUFFIX
@@ -62,6 +51,28 @@ class FileSession(CPFileSession):
         if self.debug:
             cherrypy.log('Lock acquired.', 'TOOLS.SESSIONS')
 
+    def clean_up(self):
+        """Also clean-up left over lock files."""
+        # See Issue https://github.com/cherrypy/cherrypy/issues/1855
+
+        # Clean-up session files.
+        CPFileSession.clean_up(self)
+
+        # Then clean-up any orphane lock files.
+        suffix_len = len(self.LOCK_SUFFIX)
+        files = os.listdir(self.storage_path)
+        lock_files = [
+            fname for fname in files if fname.startswith(self.SESSION_PREFIX) and fname.endswith(self.LOCK_SUFFIX)
+        ]
+        for fname in lock_files:
+            session_file = fname[:-suffix_len]
+            if session_file not in files:
+                filepath = os.path.join(self.storage_path, fname)
+                try:
+                    os.unlink(filepath)
+                except Exception as e:
+                    cherrypy.log(f'Error deleting {filepath}: {e}', 'TOOLS.SESSIONS', severity=logging.WARNING)
+
 
 @contextmanager
 def session_lock():

cherrypy_foundation/tests/test_form.py

@@ -69,7 +69,7 @@ class LoginForm(CherryForm):
     )
 
 
-@cherrypy.tools.sessions(locking='explicit')
+@cherrypy.tools.sessions()
 @cherrypy.tools.jinja2(env=env)
 class Root:
 

cherrypy_foundation/tests/test_sessions.py

@@ -0,0 +1,89 @@
+# 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 cherrypy
+from cherrypy.test import helper
+
+from cherrypy_foundation.sessions import FileSession, session_lock
+
+
+@cherrypy.tools.sessions(on=True, locking='explicit', storage_class=FileSession)
+class Root:
+
+    @cherrypy.expose
+    def index(self, value='OK'):
+        if value:
+            with session_lock() as s:
+                s['value'] = value
+        return s['value']
+
+
+class FileSessionTest(helper.CPWebCase):
+    interactive = False
+
+    @classmethod
+    def setup_class(cls):
+        cls.tempdir = tempfile.TemporaryDirectory(prefix='cherrypy-foundation-', suffix='-file-session-test')
+        cls.storage_path = cls.tempdir.name
+        super().setup_class()
+
+    @classmethod
+    def teardown_class(cls):
+        cls.tempdir.cleanup()
+        super().teardown_class()
+
+    @classmethod
+    def setup_server(cls):
+        cherrypy.config.update(
+            {
+                'tools.sessions.storage_path': cls.storage_path,
+            }
+        )
+        cherrypy.tree.mount(Root(), '/')
+
+    @property
+    def _session_id(self):
+        """Return session id from cookie."""
+        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
+
+    def test_get_page(self):
+        # Given a page with session enabled
+        # When the page get queried
+        self.getPage("/")
+        # Then a session is created with a id
+        self.assertStatus(200)
+        self.assertTrue(self._session_id)
+        # Then this session is created on disk.
+        s = FileSession(id=self._session_id, storage_path=self.storage_path)
+        self.assertTrue(s._exists())
+        # When session timeout and get clean-up
+        s.acquire_lock()
+        s.load()
+        s.timeout = 0
+        s.save()
+        s.clean_up()
+        # Then session get deleted
+        self.assertFalse(s._exists())
+        # Lock file also get deleted.
+        self.assertFalse(os.path.exists(s._get_file_path() + FileSession.LOCK_SUFFIX))

{cherrypy_foundation-1.0.0a19.dist-info → cherrypy_foundation-1.0.0a21.dist-info}/METADATA

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

{cherrypy_foundation-1.0.0a19.dist-info → cherrypy_foundation-1.0.0a21.dist-info}/RECORD

@@ -1,10 +1,10 @@
 cherrypy_foundation/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cherrypy_foundation/error_page.py,sha256=GEg_KZGRE63ZsTTtmrEpE9GsYcm6shZvp5KLR53sIMA,3248
-cherrypy_foundation/flash.py,sha256=qCghKgVgtjbQVrm6xyIIfRKzf03njFHh6b4tnawzkUM,1542
+cherrypy_foundation/flash.py,sha256=vraKvmYmjdV1cGsPSxTLVsekwqOnoyiVPqKjv6UW5OU,1646
 cherrypy_foundation/form.py,sha256=8zp72fpYrmMGsIK5LxVY7sL_qqhoMDnIQoMND1s6CXk,3994
 cherrypy_foundation/logging.py,sha256=JyzcuAu3HWzvMTSFBuKpwgnJLz1lRlx-j6EkuTwlb6I,3463
 cherrypy_foundation/passwd.py,sha256=iyz3SgcvpgxsZgPUoTEXiqdKtwOANPrRKYhVPm2d_NQ,2139
-cherrypy_foundation/sessions.py,sha256=uboQcf4W2zsHFoplRtSziZu1KzvhsudIehHGbG1XYW8,2977
+cherrypy_foundation/sessions.py,sha256=6OmjrJtX2Hhjhx5Q8Cy1nwG6_Ur6PwPErfPPA7FfzYg,3180
 cherrypy_foundation/url.py,sha256=WtfD0XEOs5FNmLvxhnBvi9aW4hQpUz0ZZXPfEXd4To8,2849
 cherrypy_foundation/widgets.py,sha256=-wxNv3wIgf7eB8WyyycfsqSCXep3YhZgBK_5PJ1qYbY,1549
 cherrypy_foundation/components/ColorModes.jinja,sha256=Ai2fy1qHFwEgutvyvvGjKJmffcBdNb7wmY20DJqZ8R4,3528
@@ -97,9 +97,10 @@ cherrypy_foundation/plugins/tests/test_smtp.py,sha256=LYUXjDe8TtyruBSm18N73nSxHi
 cherrypy_foundation/tests/__init__.py,sha256=bbdyalzM2mwBbId-7JBPXYuRzk7oUBCncq33ypD9v3Y,2818
 cherrypy_foundation/tests/test_error_page.py,sha256=EmsCXYkFFMReNSORZYCo7qKvL2x98QgtKIlv1nFKIUU,2399
 cherrypy_foundation/tests/test_flash.py,sha256=NNbT3XI1dHk0hXqJsWndCmPPohK9ig87ZYJaRNPJxR8,1994
-cherrypy_foundation/tests/test_form.py,sha256=wfmKcWTEOPi6BOAUy9oDfkX7LJf9DfxtNRER8R3Ma2g,5560
+cherrypy_foundation/tests/test_form.py,sha256=-2h38e00hWlYNJeVWrUB2V11UZ3x0FmTcsCez5vWoas,5542
 cherrypy_foundation/tests/test_logging.py,sha256=Lg1yGwFHTSpGbPvNXBi9risypZziJlAOMi1DeennxRs,2623
 cherrypy_foundation/tests/test_passwd.py,sha256=nGqJZYwRPziifLvf5rm3YifxAvIOFdU_6LkHaUvRk8w,1951
+cherrypy_foundation/tests/test_sessions.py,sha256=_jcCn75hMGr7ETucWZnCqWcI3pw5PCdlzPQuxdE4yZE,2873
 cherrypy_foundation/tests/test_url.py,sha256=sSNwK7KZJcrLtnf_XROYQAPQoYNO5lAsa2BjhFjgmws,6434
 cherrypy_foundation/tests/templates/test_flash.html,sha256=b1S4I9v0n-Y1yoTUh2ZKNysR1NMrqv8ldvqONtmInzw,213
 cherrypy_foundation/tests/templates/test_form.html,sha256=liubTm2q74-3hqQb4weaGJU3sq4vdq868GdVahBafSQ,333
@@ -128,8 +129,8 @@ cherrypy_foundation/tools/tests/locales/fr/LC_MESSAGES/messages.po,sha256=6_Sk9I
 cherrypy_foundation/tools/tests/templates/test_jinja2.html,sha256=s1bHmy-lyf0YW0t-LOx3ugILV2kqFoBNYxziWgrZbo0,216
 cherrypy_foundation/tools/tests/templates/test_jinjax.html,sha256=NImzIW0mUHxilFd61PSoxFC-yu1nayEVwv-5zlgD9yo,179
 cherrypy_foundation/tools/tests/templates/test_jinjax_i18n.html,sha256=yre8j7HBjpTQZHpM0PuB3ASGD3O4vKkJ-y72Fm6STgY,771
-cherrypy_foundation-1.0.0a19.dist-info/licenses/LICENSE.md,sha256=trSLYs5qlaow_bBwsLTRKpmTXsXzFksM_YUCMqrgAJQ,35149
-cherrypy_foundation-1.0.0a19.dist-info/METADATA,sha256=etkiHbuCu6NKyrzniIbKIfhxMKdwIVfr6A3XGHy6yyo,3551
-cherrypy_foundation-1.0.0a19.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-cherrypy_foundation-1.0.0a19.dist-info/top_level.txt,sha256=B1vQPTLYhpKJ6W0JkRCWyAf8RPcnwJWdYxixv75-4ew,20
-cherrypy_foundation-1.0.0a19.dist-info/RECORD,,
+cherrypy_foundation-1.0.0a21.dist-info/licenses/LICENSE.md,sha256=trSLYs5qlaow_bBwsLTRKpmTXsXzFksM_YUCMqrgAJQ,35149
+cherrypy_foundation-1.0.0a21.dist-info/METADATA,sha256=iAkKOmpDqv05F3r7I44szCpJbFck3F6ik0f1qvvUqek,3551
+cherrypy_foundation-1.0.0a21.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+cherrypy_foundation-1.0.0a21.dist-info/top_level.txt,sha256=B1vQPTLYhpKJ6W0JkRCWyAf8RPcnwJWdYxixv75-4ew,20
+cherrypy_foundation-1.0.0a21.dist-info/RECORD,,