💡 (Flask-JWT-Extended) Remove unnecessary comments and imports

jslvtr · jslvtr · commit 33cfc807cfc8 · 2022-06-08T14:40:11.000+01:00
diff --git a/docs/docs/08_flask_jwt_extended/03_flask_jwt_extended_setup/end/app.py b/docs/docs/08_flask_jwt_extended/03_flask_jwt_extended_setup/end/app.py
@@ -25,11 +25,6 @@ def create_app(db_url=None):
     db.init_app(app)
     api = Api(app)
 
-    """
-    JWT related configuration. The following functions includes:
-    1) add claims to each jwt
-    2) customize the token expired error message
-    """
     app.config["JWT_SECRET_KEY"] = "jose"
     jwt = JWTManager(app)
 
diff --git a/docs/docs/08_flask_jwt_extended/04_user_model_and_schema/end/app.py b/docs/docs/08_flask_jwt_extended/04_user_model_and_schema/end/app.py
@@ -25,11 +25,6 @@ def create_app(db_url=None):
     db.init_app(app)
     api = Api(app)
 
-    """
-    JWT related configuration. The following functions includes:
-    1) add claims to each jwt
-    2) customize the token expired error message
-    """
     app.config["JWT_SECRET_KEY"] = "jose"
     jwt = JWTManager(app)
 
diff --git a/docs/docs/08_flask_jwt_extended/04_user_model_and_schema/start/app.py b/docs/docs/08_flask_jwt_extended/04_user_model_and_schema/start/app.py
@@ -25,11 +25,6 @@ def create_app(db_url=None):
     db.init_app(app)
     api = Api(app)
 
-    """
-    JWT related configuration. The following functions includes:
-    1) add claims to each jwt
-    2) customize the token expired error message
-    """
     app.config["JWT_SECRET_KEY"] = "jose"
     jwt = JWTManager(app)
 
diff --git a/docs/docs/08_flask_jwt_extended/05_registering_users_rest_api/end/app.py b/docs/docs/08_flask_jwt_extended/05_registering_users_rest_api/end/app.py
@@ -26,11 +26,6 @@ def create_app(db_url=None):
     db.init_app(app)
     api = Api(app)
 
-    """
-    JWT related configuration. The following functions includes:
-    1) add claims to each jwt
-    2) customize the token expired error message
-    """
     app.config["JWT_SECRET_KEY"] = "jose"
     jwt = JWTManager(app)
 
diff --git a/docs/docs/08_flask_jwt_extended/05_registering_users_rest_api/start/app.py b/docs/docs/08_flask_jwt_extended/05_registering_users_rest_api/start/app.py
@@ -25,11 +25,6 @@ def create_app(db_url=None):
     db.init_app(app)
     api = Api(app)
 
-    """
-    JWT related configuration. The following functions includes:
-    1) add claims to each jwt
-    2) customize the token expired error message
-    """
     app.config["JWT_SECRET_KEY"] = "jose"
     jwt = JWTManager(app)
 
diff --git a/docs/docs/08_flask_jwt_extended/06_login_users_rest_api/end/app.py b/docs/docs/08_flask_jwt_extended/06_login_users_rest_api/end/app.py
@@ -1,4 +1,4 @@
-from flask import Flask, jsonify
+from flask import Flask
 from flask_smorest import Api
 from flask_jwt_extended import JWTManager
 
@@ -26,11 +26,6 @@ def create_app(db_url=None):
     db.init_app(app)
     api = Api(app)
 
-    """
-    JWT related configuration. The following functions includes:
-    1) add claims to each jwt
-    2) customize the token expired error message
-    """
     app.config["JWT_SECRET_KEY"] = "jose"
     jwt = JWTManager(app)
 
diff --git a/docs/docs/08_flask_jwt_extended/06_login_users_rest_api/start/app.py b/docs/docs/08_flask_jwt_extended/06_login_users_rest_api/start/app.py
@@ -26,11 +26,6 @@ def create_app(db_url=None):
     db.init_app(app)
     api = Api(app)
 
-    """
-    JWT related configuration. The following functions includes:
-    1) add claims to each jwt
-    2) customize the token expired error message
-    """
     app.config["JWT_SECRET_KEY"] = "jose"
     jwt = JWTManager(app)
 
diff --git a/docs/docs/08_flask_jwt_extended/07_protect_resources_with_jwt_required/end/app.py b/docs/docs/08_flask_jwt_extended/07_protect_resources_with_jwt_required/end/app.py
@@ -26,20 +26,9 @@ def create_app(db_url=None):
     db.init_app(app)
     api = Api(app)
 
-    """
-    JWT related configuration. The following functions includes:
-    1) add claims to each jwt
-    2) customize the token expired error message
-    """
     app.config["JWT_SECRET_KEY"] = "jose"
     jwt = JWTManager(app)
 
-    """
-    `claims` are data we choose to attach to each jwt payload
-    and for each jwt protected endpoint, we can retrieve these claims via `get_jwt_claims()`
-    one possible use case for claims are access level control, which is shown below
-    """
-
     @jwt.expired_token_loader
     def expired_token_callback(jwt_header, jwt_payload):
         return (
diff --git a/docs/docs/08_flask_jwt_extended/07_protect_resources_with_jwt_required/start/app.py b/docs/docs/08_flask_jwt_extended/07_protect_resources_with_jwt_required/start/app.py
@@ -1,4 +1,4 @@
-from flask import Flask, jsonify
+from flask import Flask
 from flask_smorest import Api
 from flask_jwt_extended import JWTManager
 
@@ -26,11 +26,6 @@ def create_app(db_url=None):
     db.init_app(app)
     api = Api(app)
 
-    """
-    JWT related configuration. The following functions includes:
-    1) add claims to each jwt
-    2) customize the token expired error message
-    """
     app.config["JWT_SECRET_KEY"] = "jose"
     jwt = JWTManager(app)
 
diff --git a/docs/docs/08_flask_jwt_extended/08_jwt_claims_and_authorization/end/app.py b/docs/docs/08_flask_jwt_extended/08_jwt_claims_and_authorization/end/app.py
@@ -26,20 +26,9 @@ def create_app(db_url=None):
     db.init_app(app)
     api = Api(app)
 
-    """
-    JWT related configuration. The following functions includes:
-    1) add claims to each jwt
-    2) customize the token expired error message
-    """
     app.config["JWT_SECRET_KEY"] = "jose"
     jwt = JWTManager(app)
 
-    """
-    `claims` are data we choose to attach to each jwt payload
-    and for each jwt protected endpoint, we can retrieve these claims via `get_jwt_claims()`
-    one possible use case for claims are access level control, which is shown below
-    """
-
     # @jwt.additional_claims_loader
     # def add_claims_to_jwt(identity):
     #     # TODO: Read from a config file instead of hard-coding
diff --git a/docs/docs/08_flask_jwt_extended/08_jwt_claims_and_authorization/start/app.py b/docs/docs/08_flask_jwt_extended/08_jwt_claims_and_authorization/start/app.py
@@ -26,20 +26,9 @@ def create_app(db_url=None):
     db.init_app(app)
     api = Api(app)
 
-    """
-    JWT related configuration. The following functions includes:
-    1) add claims to each jwt
-    2) customize the token expired error message
-    """
     app.config["JWT_SECRET_KEY"] = "jose"
     jwt = JWTManager(app)
 
-    """
-    `claims` are data we choose to attach to each jwt payload
-    and for each jwt protected endpoint, we can retrieve these claims via `get_jwt_claims()`
-    one possible use case for claims are access level control, which is shown below
-    """
-
     @jwt.expired_token_loader
     def expired_token_callback(jwt_header, jwt_payload):
         return (
diff --git a/docs/docs/08_flask_jwt_extended/09_logout_users_rest_api/end/app.py b/docs/docs/08_flask_jwt_extended/09_logout_users_rest_api/end/app.py
@@ -27,20 +27,9 @@ def create_app(db_url=None):
     db.init_app(app)
     api = Api(app)
 
-    """
-    JWT related configuration. The following functions includes:
-    1) add claims to each jwt
-    2) customize the token expired error message
-    """
     app.config["JWT_SECRET_KEY"] = "jose"
     jwt = JWTManager(app)
 
-    """
-    `claims` are data we choose to attach to each jwt payload
-    and for each jwt protected endpoint, we can retrieve these claims via `get_jwt_claims()`
-    one possible use case for claims are access level control, which is shown below
-    """
-
     # @jwt.additional_claims_loader
     # def add_claims_to_jwt(identity):
     #     # TODO: Read from a config file instead of hard-coding
diff --git a/docs/docs/08_flask_jwt_extended/09_logout_users_rest_api/start/app.py b/docs/docs/08_flask_jwt_extended/09_logout_users_rest_api/start/app.py
@@ -26,20 +26,9 @@ def create_app(db_url=None):
     db.init_app(app)
     api = Api(app)
 
-    """
-    JWT related configuration. The following functions includes:
-    1) add claims to each jwt
-    2) customize the token expired error message
-    """
     app.config["JWT_SECRET_KEY"] = "jose"
     jwt = JWTManager(app)
 
-    """
-    `claims` are data we choose to attach to each jwt payload
-    and for each jwt protected endpoint, we can retrieve these claims via `get_jwt_claims()`
-    one possible use case for claims are access level control, which is shown below
-    """
-
     # @jwt.additional_claims_loader
     # def add_claims_to_jwt(identity):
     #     # TODO: Read from a config file instead of hard-coding
@@ -75,15 +64,6 @@ def missing_token_callback(error):
             401,
         )
 
-    @jwt.revoked_token_loader
-    def revoked_token_callback(jwt_header, jwt_payload):
-        return (
-            jsonify(
-                {"description": "The token has been revoked.", "error": "token_revoked"}
-            ),
-            401,
-        )
-
     # JWT configuration ends
 
     @app.before_first_request
diff --git a/docs/docs/08_flask_jwt_extended/10_token_refreshing_flask_jwt_extended/end/app.py b/docs/docs/08_flask_jwt_extended/10_token_refreshing_flask_jwt_extended/end/app.py
@@ -27,20 +27,9 @@ def create_app(db_url=None):
     db.init_app(app)
     api = Api(app)
 
-    """
-    JWT related configuration. The following functions includes:
-    1) add claims to each jwt
-    2) customize the token expired error message
-    """
     app.config["JWT_SECRET_KEY"] = "jose"
     jwt = JWTManager(app)
 
-    """
-    `claims` are data we choose to attach to each jwt payload
-    and for each jwt protected endpoint, we can retrieve these claims via `get_jwt_claims()`
-    one possible use case for claims are access level control, which is shown below
-    """
-
     # @jwt.additional_claims_loader
     # def add_claims_to_jwt(identity):
     #     # TODO: Read from a config file instead of hard-coding
diff --git a/docs/docs/08_flask_jwt_extended/10_token_refreshing_flask_jwt_extended/start/app.py b/docs/docs/08_flask_jwt_extended/10_token_refreshing_flask_jwt_extended/start/app.py
@@ -27,20 +27,9 @@ def create_app(db_url=None):
     db.init_app(app)
     api = Api(app)
 
-    """
-    JWT related configuration. The following functions includes:
-    1) add claims to each jwt
-    2) customize the token expired error message
-    """
     app.config["JWT_SECRET_KEY"] = "jose"
     jwt = JWTManager(app)
 
-    """
-    `claims` are data we choose to attach to each jwt payload
-    and for each jwt protected endpoint, we can retrieve these claims via `get_jwt_claims()`
-    one possible use case for claims are access level control, which is shown below
-    """
-
     # @jwt.additional_claims_loader
     # def add_claims_to_jwt(identity):
     #     # TODO: Read from a config file instead of hard-coding
diff --git a/project/using-flask-smorest-docker b/project/using-flask-smorest-docker
@@ -1 +1 @@
-Subproject commit 18e6405b3897f6fa0cbcda2fd290596609e9ebb2
+Subproject commit e4e23a9fc20937b41ad9172346079252cb48d08e
