add disable_default_fail option to checkpoints

Author: CheeseCake87

CHANGES.md

@@ -4,6 +4,10 @@ Unreleased
 
 - x
 
+## Version 6.1.4
+
+- add disable_default_fail option to checkpoints
+
 ## Version 6.1.3
 
 - adjust fail_response to accept a callable to avoid out of context error

docs/Security/flask_imp_security-checkpoint.md

@@ -73,7 +73,8 @@ IS_LOGGED_IN = SessionCheckpoint(
     values_allowed=True,
 ).action(
     pass_endpoint='blueprint.admin_page',
-    message="Already logged in"
+    message="Already logged in",
+    disable_default_fail=True,
 )
 
 

docs/Security/flask_imp_security-checkpoint_callable.md

@@ -16,6 +16,7 @@ def checkpoint_callable(
     pass_url: t.Optional[t.Union[str, t.Callable[[], t.Any]]] = None,
     message: t.Optional[str] = None,
     message_category: str = "message",
+    disable_default_fail: bool = False,
 )
 ```
 

docs/SecurityCheckpoints/flask_imp_security-apikeycheckpoint.md

@@ -17,6 +17,7 @@ APIKeyCheckpoint(
     pass_url: t.Optional[t.Union[str, t.Callable[[], t.Any]]] = None,
     message: t.Optional[str] = None,
     message_category: str = "message",
+    disable_default_fail: bool = False
 )
 ```
 

docs/SecurityCheckpoints/flask_imp_security-bearercheckpoint.md

@@ -15,6 +15,7 @@ BearerCheckpoint(
     pass_url: t.Optional[t.Union[str, t.Callable[[], t.Any]]] = None,
     message: t.Optional[str] = None,
     message_category: str = "message",
+    disable_default_fail: bool = False
 )
 ```
 

docs/SecurityCheckpoints/flask_imp_security-createacheckpoint.md

@@ -29,5 +29,6 @@ MyCheckpoint(
     pass_url: t.Optional[t.Union[str, t.Callable[[], t.Any]]] = None,
     message: t.Optional[str] = None,
     message_category: str = "message",
+    disable_default_fail: bool = False
 )
 ```

docs/SecurityCheckpoints/flask_imp_security-sessioncheckpoint.md

@@ -16,6 +16,7 @@ SessionCheckpoint(
     pass_url: t.Optional[t.Union[str, t.Callable[[], t.Any]]] = None,
     message: t.Optional[str] = None,
     message_category: str = "message",
+    disable_default_fail: bool = False
 )
 ```
 
@@ -99,7 +100,8 @@ IS_LOGGED_IN = SessionCheckpoint(
     values_allowed=True,
 ).action(
     pass_endpoint='blueprint.admin_page',
-    message="Already logged in"
+    message="Already logged in",
+    disable_default_fail=True
 )
 
 

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "flask-imp"
-version = "6.1.3"
+version = "6.1.4"
 description = 'A Flask auto importer that allows your Flask apps to grow big.'
 authors = [{ name = "David Carmichael", email = "david@uilix.com" }]
 readme = "README.md"

src/flask_imp/security/_checkpoint.py

@@ -149,6 +149,9 @@ def inner(*args: t.Any, **kwargs: t.Any) -> t.Any:
             if request.is_json:
                 return {"error": "Unauthorized"}, checkpoint_.fail_status
 
+            if checkpoint_.disable_default_fail:
+                func(*args, **kwargs)
+
             # Otherwise, abort with the specified status code
             return abort(checkpoint_.fail_status)
 

src/flask_imp/security/_checkpoint_callable.py

@@ -22,6 +22,7 @@ def checkpoint_callable(
     pass_url: t.Optional[t.Union[str, t.Callable[[], t.Any]]] = None,
     message: t.Optional[str] = None,
     message_category: str = "message",
+    disable_default_fail: bool = False,
 ) -> t.Callable[..., t.Any]:
     """
     A decorator that evaluates if the passed in callable is truly.
@@ -98,6 +99,7 @@ def number():
     :param pass_url: the url to redirect to if the callable passes
     :param message: if a message is specified, a flash message is shown
     :param message_category: the category of the flash message
+    :param disable_default_fail: if True, the callable will be called without default failure handling
     :return: the decorated callable, or abort(abort_status) response
     """
 
@@ -161,6 +163,9 @@ def inner(*args: t.Any, **kwargs: t.Any) -> t.Any:
 
                 raise TypeError("Pass URL must either be a string or a partial")
 
+            if not disable_default_fail:
+                return func(*args, **kwargs)
+
             return abort(fail_status)
 
         return inner