imacat/flask-digestauth
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 16 Wiki Activity

Revised the FlaskLoginTestCase test case and README.rst for illustrations on how to retrieve the currently logged-in user.

Browse Source
This commit is contained in:
依瑪貓 2022-11-26 18:59:17 +11:00
parent 6f49a180e3
commit cb3e313e21
2 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.rst
View File

@ -60,6 +60,8 @@ Flask-Digest-Auth Alone
Flask-Digest-Auth can authenticate the users alone. Flask-Digest-Auth can authenticate the users alone.
The currently logged-in user can be retrieved at ``g.user``, if any.
Example for Simple Applications with Flask-Digest-Auth Alone Example for Simple Applications with Flask-Digest-Auth Alone
------------------------------------------------------------ ------------------------------------------------------------
@ -88,7 +90,7 @@ In your ``my_app.py``:
@app.get("/admin") @app.get("/admin")
@auth.login_required @auth.login_required
def admin(): def admin():
... (Process the view) ... return f"Hello, {g.user.username}!"
@app.post("/logout") @app.post("/logout")
@auth.login_required @auth.login_required
@ -138,7 +140,7 @@ In your ``my_app/views.py``:
@bp.get("/admin") @bp.get("/admin")
@auth.login_required @auth.login_required
def admin(): def admin():
... (Process the view) ... return f"Hello, {g.user.username}!"
@app.post("/logout") @app.post("/logout")
@auth.login_required @auth.login_required
@ -161,6 +163,9 @@ authentication mechanism as it sees fit.
``login_manager.init_app(app)`` must be called before ``login_manager.init_app(app)`` must be called before
``auth.init_app(app)``. ``auth.init_app(app)``.
The currently logged-in user can be retrieved at
``flask_login.current_user``, if any.
Example for Simple Applications with Flask-Login Integration Example for Simple Applications with Flask-Login Integration
------------------------------------------------------------ ------------------------------------------------------------
@ -169,14 +174,14 @@ In your ``my_app.py``:
:: ::
import flask_login
from flask import Flask, request, redirect from flask import Flask, request, redirect
from flask_digest_auth import DigestAuth from flask_digest_auth import DigestAuth
from flask_login import LoginManager
app: flask = Flask(__name__) app: flask = Flask(__name__)
... (Configure the Flask application) ... ... (Configure the Flask application) ...
login_manager: LoginManager = LoginManager() login_manager: flask_login.LoginManager = flask_login.LoginManager()
login_manager.init_app(app) login_manager.init_app(app)
@login_manager.user_loader @login_manager.user_loader
@ -191,9 +196,9 @@ In your ``my_app.py``:
... (Load the password hash) ... ... (Load the password hash) ...
@app.get("/admin") @app.get("/admin")
@login_manager.login_required @flask_login.login_required
def admin(): def admin():
... (Process the view) ... return f"Hello, {flask_login.current_user.get_id()}!"
@app.post("/logout") @app.post("/logout")
@flask_login.login_required @flask_login.login_required
@ -249,7 +254,7 @@ In your ``my_app/views.py``:
@bp.get("/admin") @bp.get("/admin")
@flask_login.login_required @flask_login.login_required
def admin(): def admin():
... (Process the view) ... return f"Hello, {flask_login.current_user.get_id()}!"
@app.post("/logout") @app.post("/logout")
@flask_login.login_required @flask_login.login_required

4
tests/test_flask_login.py
View File

@ -110,7 +110,7 @@ class FlaskLoginTestCase(TestCase):
:return: The response. :return: The response.
""" """
return f"Hello, {flask_login.current_user.username}! #1" return f"Hello, {flask_login.current_user.get_id()}! #1"
@app.get("/admin-2/auth", endpoint="admin-2") @app.get("/admin-2/auth", endpoint="admin-2")
@flask_login.login_required @flask_login.login_required
@ -119,7 +119,7 @@ class FlaskLoginTestCase(TestCase):
:return: The response. :return: The response.
""" """
return f"Hello, {flask_login.current_user.username}! #2" return f"Hello, {flask_login.current_user.get_id()}! #2"
@app.post("/logout", endpoint="logout") @app.post("/logout", endpoint="logout")
@flask_login.login_required @flask_login.login_required