Convert print to logging

Author: khteh

src/common/Authentication.py

@@ -33,10 +33,10 @@ def generate_token(user_id):
                 }
                 return jwt.encode(payload, current_app.config["JWT_SECRET_KEY"], "HS512")
             except Exception as e:
-                print("generate_token() exception!")
-                print(type(e))    # the exception instance
-                print(e.args)     # arguments stored in .args
-                print(e)          # __str__ allows args to be printed directly,
+                logging.exception(f"generate_token() exception! {e}")
+                #print(type(e))    # the exception instance
+                #print(e.args)     # arguments stored in .args
+                #print(e)          # __str__ allows args to be printed directly,
                                   # but may be overridden in exception subclasses
                 return Response(mimetype="application/json", response=json.dumps({"error": "Token generation error!"}), status=400)
         else:
@@ -57,7 +57,7 @@ def decode_token(token):
                 return result
             except jwt.InvalidAudienceError as audError:
                 result["error"] = {"message": "Invalid Audience! Please login again!"}
-                print("InvalidAudienceError!")
+                logging.exception(f"InvalidAudienceError! {audError}")
             except jwt.InvalidTokenError as invalid:
                 result["error"] = {"message": "Invalid Token! Please login again!"}
                 return result

src/controllers/AuthenticationController.py

@@ -54,8 +54,7 @@ async def login():
         except ValidationError as err:
             errors = err.messages
             valid_data = err.valid_data
-            logging.error(f"[Auth] login() error! {errors}")
-            print(f"login() error! {errors}")		
+            logging.exception(f"[Auth] login() exception! {errors}")
             return await render_template("login.html", title="Welcome to Python Flask RESTful API", error=errors)
     return await render_template("login.html", title="Welcome to Python Flask RESTful API")
 
@@ -105,7 +104,6 @@ async def logout():
     """
     User Logout
     """
-    print(f"logout()")
     logging.info(f"[Auth] User logged out")
     session["url"] = None
     session["user"] = None

src/controllers/AuthorController.py

@@ -54,7 +54,7 @@ async def create():
 			   "email": form["email"],
 			   "phone": form["phone"],
 			}
-            print(f"author.create() request data: {req_data}")
+            logging.debug(f"author.create() request data: {req_data}")
             data = author_schema.load(req_data)
             if not data:
                 await flash(f"Invalid input!", "danger")
@@ -71,7 +71,7 @@ async def create():
         except ValidationError as err:
             errors = err.messages
             valid_data = err.valid_data	
-            logging.error(f"User {user.email} failed to creat author! Exception: {errors}")
+            logging.exception(f"User {user.email} failed to creat author! Exception: {errors}")
             await flash(f"Failed to create author! {err.messages}", "danger")
             return redirect(url_for("author.create"))
     return await render_template("author_create.html", title="Welcome to Python Flask RESTful API")
@@ -93,7 +93,7 @@ async def get_by_firstname(firstname):
     """
     Get Author by firstname
     """
-    print(f"get_author_by_author_firstname: {firstname}")
+    logging.debug(f"get_author_by_author_firstname: {firstname}")
     return custom_response(author_schema.dump(AuthorModel.get_author_by_firstname(firstname)), 200)
 
 @author_api.route("/lastname/<string:lastname>")
@@ -143,7 +143,7 @@ async def update(id):
     except ValidationError as err:
         errors = err.messages
         valid_data = err.valid_data
-        logging.error(f"User {user.email} failed to update author {id}! Exception: {errors}")
+        logging.exception(f"User {user.email} failed to update author {id}! Exception: {errors}")
         await flash(f"Failed to update author {id}! Exception: {errors}", "danger")
     return redirect(url_for("author.index"))
 
@@ -165,7 +165,6 @@ async def delete(id):
     except ValidationError as err:
         errors = err.messages
         valid_data = err.valid_data	
-        print(f"Failed to delete author {id} error! {errors}")		
-        logging.error(f"User {user.email} failed to delete author {id}! Exception: {errors}")
+        logging.exception(f"User {user.email} failed to delete author {id}! Exception: {errors}")
         await flash(f"Failed to delete author {id}! Exception: {errors}", "danger")
     return redirect(url_for("user.index"))

src/controllers/BookController.py

@@ -75,7 +75,7 @@ async def create():
             if not author:
                 await flash(f"Invalid author!", "danger")
                 return redirect(url_for("book.create"))
-            print(f"book.create(): {json.dumps(data)}")
+            logging.debug(f"book.create(): {json.dumps(data)}")
             book = BookModel(data)
             book.save()
             await flash(f"Book {book.title} created successfully!", "success")
@@ -84,9 +84,8 @@ async def create():
         except ValidationError as err:
             errors = err.messages
             valid_data = err.valid_data	
-            print(f"create() error! {errors}")		
             await flash(f"Failed to create book! {err.messages}", "danger")
-            logging.error(f"User {user.email} failed to create book! Exception: {errors}")
+            logging.exception(f"User {user.email} failed to create book! Exception: {errors}")
             return redirect(url_for("book.create"))
     authors = author_schema.dump(AuthorModel.get_authors(), many=True)
     return await render_template("book_create.html", title="Welcome to Python Flask RESTful API", authors = authors)
@@ -191,7 +190,7 @@ async def update(id):
     except ValidationError as err:
         errors = err.messages
         valid_data = err.valid_data	
-        logging.error(f"User {user.email} failed to update book {id}! Exception: {errors}")
+        logging.exception(f"User {user.email} failed to update book {id}! Exception: {errors}")
         await flash(f"Failed to update book {id}! Exception: {errors}", "danger")
     return redirect(url_for("book.index"))
 
@@ -213,6 +212,6 @@ async def delete(id):
     except ValidationError as err:
         errors = err.messages
         valid_data = err.valid_data	
-        logging.error(f"User {user.email} failed to delete book {id}! Exception: {errors}")
+        logging.exception(f"User {user.email} failed to delete book {id}! Exception: {errors}")
         await flash(f"Failed to delete book {id}! Exception: {errors}", "danger")
     return redirect(url_for("book.index"))

src/controllers/FibonacciController.py

@@ -1,4 +1,4 @@
-import jsonpickle
+import jsonpickle, logging
 from quart import request, session, Blueprint, flash, render_template, session
 from quart.utils import run_sync
 from datetime import datetime, timezone
@@ -24,19 +24,17 @@ async def fibonacci():
             if data["error"]:
                 return await render_template("login.html", title="Welcome to Python Flask RESTful API", error=data["error"])
             user_id = data["data"]["user_id"]
-            print(f"User: {user_id}")
+            logging.debug(f"User: {user_id}")
             user = UserModel.get_user(user_id)
             if not user:
                 return await render_template("login.html", title="Welcome to Python Flask RESTful API", error="Invalid user!")
-    print("fibonacci()")      
     if request.method == "POST":
-        print("fibonacci() POST")
         data = await request.get_data()
         params = parse_qs(data.decode('utf-8'))
-        print(f"data: {data}, params: {params}")
+        logging.debug(f"data: {data}, params: {params}")
         if params['n'] and params["n"][0].strip() and params["n"][0].strip().isdigit():
             n = int(params["n"][0].strip())
-            print(f"fibonacci(): {n}")
+            logging.debug(f"fibonacci(): {n}")
             try:
                 fibonacci = f"Hello {('there' if not user else user.firstname)}, fibonacci({n}): {await run_sync(fib)(n)}"
             except (Exception) as error:
@@ -47,7 +45,7 @@ async def fibonacci():
             #error = custom_response({"error": "Please provide an 'N' for the fibonacci number!"}, 400)
             await flash("Please provide a numeric value 'N' for the fibonacci number!", "danger")
     else:
-        print(f"Invalid request method: {request.method}!")
+        logging.error(f"Invalid request method: {request.method}!")
     return await render_template("fibonacci.html", title="Welcome to Python Flask Fibonacci calculator", fibonacci=fibonacci)
 
 def fib(n):

src/controllers/HomeController.py

@@ -1,8 +1,8 @@
+import re, jsonpickle, logging
 from quart import Blueprint, render_template, session
 from datetime import datetime, timezone
 from ..common.Authentication import Authentication
 from ..models.UserModel import UserModel
-import re, jsonpickle
 home_api = Blueprint("home", __name__)
 @home_api.context_processor
 def inject_now():
@@ -11,7 +11,6 @@ def inject_now():
 @home_api.route("/")
 @home_api.route("/index")
 async def index():
-    #print("homeController hello")
     greeting = None
     now = datetime.now()
     # https://www.programiz.com/python-programming/datetime/strftime
@@ -31,13 +30,12 @@ async def index():
     if data["error"]:
         return await render_template("login.html", title="Welcome to Python RESTful API", error=data["error"])
     user_id = data["data"]["user_id"]
-    print(f"User: {user_id}")
+    logging.debug(f"User: {user_id}")
     user = UserModel.get_user(user_id)
     if not user:
         return await render_template("login.html", title="Welcome to Python RESTful API", error="Invalid user!")           
     try:
-        print("Get user name...")
-        print(f"Firstname: {user.firstname}, Lastname: {user.lastname}")
+        logging.debug(f"Firstname: {user.firstname}, Lastname: {user.lastname}")
         name = user.firstname + ", " + user.lastname
         # Filter the name argument to letters only using regular expressions. URL arguments
         # can contain arbitrary text, so we restrict to safe characters only.

src/controllers/UserController.py

@@ -51,7 +51,7 @@ async def create():
 			   "email": form["email"],
                "password": form["password"]
 			}
-            print(f"create() request data: {req_data}")
+            logging.debug(f"create() request data: {req_data}")
             data = user_schema.load(req_data)
 		    # Check if user already exists in the database
             if not data:
@@ -67,14 +67,14 @@ async def create():
 		    #print(f"create() user id: {ser_data.get('id')}")
             token = Authentication.generate_token(ser_data.get("id"))
             session['user'] = jsonpickle.encode(user)
-            print(f"session['user']: {session['user']}")
+            logging.debug(f"session['user']: {session['user']}")
 		    #print(f"create() token: {token}")
             await flash(f"User created user id: {user.id}, email: {user.email} successfully!", "success")
             return redirect(url_for("user.index"))
         except ValidationError as err:
             errors = err.messages
             valid_data = err.valid_data	
-            print(f"create() error! {errors}")
+            logging.exception(f"create() exception! {errors}")
             await flash(f"Failed to create user! {err.messages}", "danger")
             return redirect(url_for("user.create"))
     return await render_template("user_create.html", title="Welcome to Python Flask RESTful API")
@@ -92,7 +92,7 @@ async def get_user(id):
     """
     user = UserModel.get_user(id)
     if not user:
-        print(f"User id: {id} not found!")
+        logging.warning(f"User id: {id} not found!")
         return custom_response({"error": f"User {id} not found!"}, 400)
     return custom_response(user_schema.dump(user), 200)
 
@@ -119,7 +119,7 @@ async def update(id):
     except ValidationError as err:
         errors = err.messages
         valid_data = err.valid_data
-        logging.error(f"Failed to update user {id}! Exception: {errors}")
+        logging.exception(f"Failed to update user {id}! Exception: {errors}")
         await flash(f"Failed to update user {id}! Exception: {errors}!", "danger")
     return redirect(url_for("user.index"))
 
@@ -141,7 +141,6 @@ async def delete(id):
     except ValidationError as err:
         errors = err.messages
         valid_data = err.valid_data	
-        print(f"create() error! {errors}")
-        logging.error(f"User {user.email} failed to delete user {id}! Exception: {errors}")
+        logging.exception(f"User {user.email} failed to delete user {id}! Exception: {errors}")
         await flash(f"Failed to delete user {id}! Exception: {errors}", "danger")
     return redirect(url_for("user.index"))

src/main.py

@@ -80,5 +80,5 @@ def readiness():
 
 app = create_app()
 
-print(f"Running app...")
+logging.info(f"Running app...")
 #asyncio.run(serve(app, config), debug=True)