Update sessions.py, add error handling in extension.py

Author: Grimpy101

flask_phpbb3/extension.py

@@ -106,6 +106,11 @@ def _backend(self) -> flask_phpbb3.backends.base.BaseBackend:
             flask.g.get('phpbb3_backend', None)
 
         if backend is None or backend.is_closed:
+            if not hasattr(current_app, 'phpbb3_cache'):
+                raise ValueError(
+                    'App not properly configured, phpbb3_cache is missing!'
+                )
+
             cache = getattr(current_app, 'phpbb3_cache')
             backend = PhpBB3._create_backend(
                 current_app.config['PHPBB3']['DRIVER'],

flask_phpbb3/sessions.py

@@ -1,5 +1,7 @@
 import json
-import typing
+from typing import Any, Dict, Optional, Set
+
+import cachelib
 
 import flask
 import flask.sessions
@@ -8,66 +10,56 @@
 import flask_phpbb3
 import flask_phpbb3.backends.base
 
-import cachelib
 
-ANONYMOUS_CACHE_TTL = 3600 * 24
+ANONYMOUS_CACHE_TTL: int = 3600 * 24
 
 
-class PhpBB3Session(dict, flask.sessions.SessionMixin):
-    def __init__(self):
-        # type: () -> None
+class PhpBB3Session(Dict[str, Any], flask.sessions.SessionMixin):
+    def __init__(self) -> None:
         # Some session related variables
-        self.modified = False
-        self.new = False
-        self._read_only_properties = set([])  # type: set
+        self.modified: bool = False
+        self.new: bool = False
+        self._read_only_properties: Set[str] = set([])
 
         # Some ACL related things
-        self._acl = None\
-            # type: typing.Optional[flask_phpbb3.backends.base.UserAcl]
+        self._acl: Optional[flask_phpbb3.backends.base.UserAcl] = None
 
         # Per request cache
         # This should not be cached into session, but per
         # request should not be executed multiple times
-        self._request_cache = {}  # type: dict
+        self._request_cache: Dict[str, Any] = {}
 
-    def __setitem__(self, key, value):
-        # type: (str, typing.Union[str, int]) -> None
-        modified = self.get(key) != value
+    def __setitem__(self, key: str, value: str | int) -> None:
+        modified: bool = self.get(key) != value
         super(PhpBB3Session, self).__setitem__(key, value)
         if key not in self._read_only_properties:
             self.modified |= modified
 
-    def __delitem__(self, key):
-        # type: (str) -> None
+    def __delitem__(self, key: str) -> None:
         super(PhpBB3Session, self).__delitem__(key)
         self.modified = True
 
     @property
-    def _phpbb3(self):
-        # type: () -> flask_phpbb3.PhpBB3
-        output = flask.current_app.phpbb3  # type: flask_phpbb3.PhpBB3
+    def _phpbb3(self) -> flask_phpbb3.PhpBB3:
+        output: flask_phpbb3.PhpBB3 = getattr(flask.current_app, 'phpbb3')
         return output
 
-    def pop(self, *args, **kwargs):
-        # type: (*typing.Any, **typing.Any) -> typing.Any
+    def pop(self, *args: Any, **kwargs: Any) -> Any:
         """Wrapper to set modified."""
         self.modified = True
         return super(PhpBB3Session, self).pop(*args, **kwargs)
 
-    def clear(self):
-        # type: () -> None
+    def clear(self) -> None:
         self.modified = True
         return super(PhpBB3Session, self).clear()
 
     @property
-    def is_authenticated(self):
-        # type: () -> bool
+    def is_authenticated(self) -> bool:
         """Helper method to test if user is authenticated."""
         user_id = int(self.get('user_id', 1))
         return user_id > 1
 
-    def is_member(self, group):
-        # type: (typing.Union[int, str]) -> bool
+    def is_member(self, group: int | str) -> bool:
         """Tests if user is a member of specified group."""
         if isinstance(group, int):
             # Try with default group
@@ -90,24 +82,21 @@ def is_member(self, group):
             return False
         return output
 
-    def has_privilege(self, option, forum_id=0):
-        # type: (str, int) -> bool
+    def has_privilege(self, option: str, forum_id: int = 0) -> bool:
         """Test if user has global or local (if forum_id is set) privileges."""
         if not self._acl:
             self._acl = self._phpbb3.get_user_acl(self['user_permissions'])
 
         return self._acl.has_privilege(option, forum_id)
 
-    def has_privileges(self, *options, **kwargs):
-        # type: (*str, **int) -> bool
+    def has_privileges(self, *options: str, **kwargs: int) -> bool:
         forum_id = kwargs.get('forum_id', 0)
 
         if not self._acl:
             self._acl = self._phpbb3.get_user_acl(self['user_permissions'])
         return self._acl.has_privileges(*options, forum_id=forum_id)
 
-    def get_link_hash(self, link):
-        # type: (str) -> str
+    def get_link_hash(self, link: str) -> str:
         """Returns link hash."""
         if not self.is_authenticated:
             return ''
@@ -116,8 +105,7 @@ def get_link_hash(self, link):
         return hashlib.sha1(self['user_form_salt'] + link).hexdigest()[:8]
 
     @property
-    def num_unread_notifications(self):
-        # type: () -> int
+    def num_unread_notifications(self) -> int:
         """Returns number of unread notifications."""
         if 'num_unread_notifications' not in self._request_cache:
             result = self._phpbb3.get_unread_notifications_count(
@@ -140,31 +128,41 @@ class PhpBB3SessionInterface(flask.sessions.SessionInterface):
     session_class = PhpBB3Session
 
     @classmethod
-    def _cache(cls, app):
-        # type: (flask.Flask) -> werkzeug.contrib.cache.BaseCache
-        output = app.phpbb3_cache  # type: werkzeug.contrib.cache.BaseCache
+    def _cache(cls, app: flask.Flask) -> cachelib.BaseCache:
+        if not hasattr(app, 'phpbb3_cache'):
+            raise ValueError(
+                'App not properly configured, phpbb3_cache is missing!'
+            )
+        output: cachelib.BaseCache = getattr(app, 'phpbb3_cache')
         return output
 
-    def _is_bot(self, app, request):
+    def _is_bot(
+        self,
+        app: flask.Flask,
+        request: flask.wrappers.Request
+    ) -> bool:
         for user_agent in app.config['PHPBB3_BOTLIST']:
             if request.headers.get('User-Agent', '').startswith(user_agent):
                 return True
         return False
 
-    def open_session(self, app, request):
-        # type: (flask.Flask, flask.wrappers.Request) -> PhpBB3Session
-        cookie_name = app.config.get('PHPBB3_COOKIE_NAME', 'phpbb3_')
+    def open_session(
+        self,
+        app: flask.Flask,
+        request: flask.wrappers.Request
+    ) -> PhpBB3Session:
+        cookie_name: str = app.config.get('PHPBB3_COOKIE_NAME', 'phpbb3_')
 
         if not hasattr(app, 'phpbb3'):
             raise ValueError('App not properly configured, phpbb3 is missing!')
-        phpbb3 = app.phpbb3  # type: flask_phpbb3.PhpBB3
+        phpbb3: flask_phpbb3.PhpBB3 = getattr(app, 'phpbb3')
 
-        session_id = request.args.get('sid', type=str)\
+        session_id: Optional[str] = request.args.get('sid', type=str)\
             or request.cookies.get(cookie_name + 'sid', None)
         if not session_id:
             session_id = None
 
-        user = None
+        user: Optional[Dict] = None
         if self._is_bot(app, request):
             user = {'user_id': 1, 'username': 'Anonymous'}
         elif session_id:
@@ -181,7 +179,7 @@ def open_session(self, app, request):
             )
 
         # Create session
-        session = self.session_class()
+        session: PhpBB3Session = self.session_class()
 
         # Set session data
         if isinstance(user, dict) and user:
@@ -204,8 +202,15 @@ def open_session(self, app, request):
 
         return session
 
-    def save_session(self, app, session, response):
-        # type: (flask.Flask, PhpBB3Session, flask.wrappers.Response) -> None
+    def save_session(
+        self,
+        app: flask.Flask,
+        session: flask.sessions.SessionMixin,
+        response: flask.wrappers.Response
+    ) -> None:
+        if not isinstance(session, PhpBB3Session):
+            raise TypeError('The provided session is not PhpBB3Session!')
+
         """Currenlty does nothing."""
         if session.modified and session._read_only_properties:
             # Store all 'storable' properties