Prompt parameter customizable and default to None

Author: rayluo

docs/abc.rst

@@ -11,4 +11,7 @@ It is an abstract base class. You cannot use it directly.
 
 .. autoclass:: identity.pallet.PalletAuth
    :members:
+   :inherited-members:
+
+   .. automethod:: __init__
 

identity/django.py

@@ -38,6 +38,7 @@ def __init__(
         self,
         *args,
         post_logout_view: Optional[callable] = None,
+        prompt: Optional[str] = None,
         **kwargs,
     ):
         """Initialize the Auth class for a Django web application.
@@ -57,7 +58,13 @@ def __init__(
                 )
 
             where ``my_post_logout_view`` is a Django view function.
+
+        :param str prompt:
+            Optional. The prompt parameter to be used during login.
+            Valid values are defined in
+            `OpenID Connect Core spec <https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest>`_
         """
+        self._prompt = prompt
         super(Auth, self).__init__(*args, **kwargs)
         route, redirect_view = _parse_redirect_uri(self._redirect_uri)
         self.urlpattern = path(route, include([
@@ -90,7 +97,7 @@ def login(
         log_in_result = self._build_auth(request.session).log_in(
             scopes=scopes,  # Have user consent to scopes (if any) during log-in
             redirect_uri=self._redirect_uri,  # Optional. If present, this absolute URL must match your app's redirect_uri registered in Azure Portal
-            prompt="select_account",  # Optional. More values defined in  https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
+            prompt=self._prompt,  # Optional. More values defined in  https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
             next_link=next_link,
             )
         if "error" in log_in_result:
@@ -209,4 +216,3 @@ def wrapper(request, *args, **kwargs):
                 scopes=scopes,
                 )
         return wrapper
-

identity/flask.py

@@ -69,7 +69,7 @@ def build_app():
             If provided, it shall be the view (which is a function)
             that will be redirected to, after the user has logged out.
 
-        It also passes extra parameters to :class:`identity.web.WebFrameworkAuth`.
+        It also passes extra parameters to :class:`identity.pallet.PalletAuth`.
         """
         self._request = request  # Not available during class definition
         self._session = session  # Not available during class definition
@@ -100,7 +100,7 @@ def login(
         log_in_result: dict = self._auth.log_in(
             scopes=scopes,  # Have user consent to scopes (if any) during log-in
             redirect_uri=self._redirect_uri,
-            prompt="select_account",  # Optional. More values defined in  https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
+            prompt=self._prompt,  # self._prompt was defined in parent class
             next_link=next_link,
             )
         if "error" in log_in_result:
@@ -166,4 +166,3 @@ def call_an_api(*, context):
                     ...
         """
         return super(Auth, self).login_required(function, scopes=scopes)
-

identity/pallet.py

@@ -11,11 +11,28 @@
 logger = logging.getLogger(__name__)
 
 
-class PalletAuth(WebFrameworkAuth):  # A common base class for Flask and Quart
+class PalletAuth(WebFrameworkAuth):
+    """A common base class for Flask and Quart web authentication.
+
+    Provides shared functionality for login handling, session management, and routing
+    used by both Flask and Quart framework implementations.
+    """
     _endpoint_prefix = "identity"  # A convention to match the template's folder name
     _auth: Optional[Auth] = None  # None means not initialized yet
 
-    def __init__(self, app, *args, **kwargs):
+    def __init__(self, app, *args, prompt: Optional[str] = None, **kwargs):
+        """Initialize the Auth class for a Pallet-based web application.
+
+        :param app:
+            The Flask or Quart application instance, or ``None``.
+            If None, you must call init_app() later. This pattern can be useful
+            when your project does not use a global app object, such as when using
+            the application factory pattern.
+        :param str prompt:
+            Optional. The prompt parameter to be used during login.
+            Valid values are defined in
+            `OpenID Connect Core spec <https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest>`_
+        """
         if not (
             self._Blueprint and self._Session and self._redirect
             and getattr(self, "_session", None) is not None
@@ -24,6 +41,7 @@ def __init__(self, app, *args, **kwargs):
             raise RuntimeError(
                 "Subclass must provide "
                 "_Blueprint, _Session, _redirect, _session, and _request.")
+        self._prompt = prompt
         super(PalletAuth, self).__init__(*args, **kwargs)
         self._bp = bp = self._Blueprint(
             self._endpoint_prefix,
@@ -106,4 +124,3 @@ def wrapper(*args, **kwargs):
                 # Save an http 302 by calling self.login(request) instead of redirect(self.login)
                 return self.login(next_link=self._request.url, scopes=scopes)
         return wrapper
-

identity/quart.py

@@ -69,7 +69,7 @@ def build_app():
             If provided, it shall be the view (which is a function)
             that will be redirected to, after the user has logged out.
 
-        It also passes extra parameters to :class:`identity.web.WebFrameworkAuth`.
+        It also passes extra parameters to :class:`identity.pallet.PalletAuth`.
         """
         self._request = request  # Not available during class definition
         self._session = session  # Not available during class definition
@@ -98,7 +98,7 @@ async def login(
         log_in_result = self._auth.log_in(
             scopes=scopes,  # Have user consent to scopes (if any) during log-in
             redirect_uri=self._redirect_uri,
-            prompt="select_account",  # Optional. More values defined in  https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
+            prompt=self._prompt,  # self._prompt was defined in parent class
             next_link=next_link,
             )
         if "error" in log_in_result:
@@ -165,4 +165,3 @@ async def call_api(*, context):
 
         """
         return super(Auth, self).login_required(function, scopes=scopes)
-