Fixed syntax errors, removed trailing whitespace, cleaned up docstrings, and addressed major linting issues

Author: Kamal Sai Devarapalli

src/pyportal_common/app_handlers/app_manager.py

@@ -45,22 +45,16 @@ def create_app_instance(self) -> Union[Flask, None]:
         except ImportError as ex:
             self.cmn_logger.error(
                 f"ImportError occurred :: {ex}\tLine No:: {sys.exc_info()[2].tb_lineno}"
-            )
-                f"ImportError occurred :: {ex}\tLine No:: {sys.exc_info()[2].tb_lineno}"
             )
             return None
         except TypeError as ex:
             self.cmn_logger.error(
                 f"TypeError occurred :: {ex}\tLine No:: {sys.exc_info()[2].tb_lineno}"
-            )
-                f"TypeError occurred :: {ex}\tLine No:: {sys.exc_info()[2].tb_lineno}"
             )
             return None
         except Exception as ex:
             self.cmn_logger.exception(
                 f"Exception occurred :: {ex}\tLine No:: {sys.exc_info()[2].tb_lineno}"
-            )
-                f"Exception occurred :: {ex}\tLine No:: {sys.exc_info()[2].tb_lineno}"
             )
             return None
 
@@ -79,8 +73,6 @@ def bind_jwt_manger_to_app_instance(
             jwt_instance = JWTManager(app_instance)
             return jwt_instance
         except Exception as ex:
-                f"Error occurred :: {ex}\tLine No:: {sys.exc_info()[2].tb_lineno}"
-            )
             self.cmn_logger.exception(
                 f"Error occurred :: {ex}\tLine No:: {sys.exc_info()[2].tb_lineno}"
             )

src/tokenmanagement_service/__init__.py

@@ -1,7 +1,7 @@
 """added indexand uniquecons for the token, userid
 
 Revision ID: b2645dcc2eb1
-Revises: 
+Revises:
 Create Date: 2023-09-08 13:09:33.052383
 
 """

src/tokenmanagement_service/migrations/versions/b2645dcc2eb1_added_indexand_uniquecons_for_the_token_.py

@@ -1,7 +1,7 @@
 """Add index to username and email
 
 Revision ID: 40c28f8c1faa
-Revises: 
+Revises:
 Create Date: 2023-09-07 23:01:00.296144
 
 """

src/usermanagement_service/migrations/versions/40c28f8c1faa_add_index_to_username_and_email.py

@@ -66,6 +66,7 @@ def ValidateUserCredentials(self, request, context):
                     context.set_code(grpc.StatusCode.INTERNAL)
                     context.set_details("Internal DB error")
                     user_management_logger.error(f"Error occurred :: {ex}\tLine No:: {sys.exc_info()[2].tb_lineno}")
-                user_management_logger.info(f"Packing and sending response back to gRPC Client :: {token_res_message}")
-                return token_res_message
+            user_management_logger.info(f"Packing and sending response back to gRPC Client :: {token_res_message}")
+            return token_res_message
         except Exception as ex:
+            pass

src/usermanagement_service/user_management_grpc/user_grpc_server.py

@@ -22,15 +22,13 @@
     is_username_email_already_exists_in_db,
     convert_db_model_to_resp,
 )
-from src.usermanagement_service.users.response_handlers.create_user_success_response import (
-    generate_success_response,
-)
+from src.usermanagement_service.users.response_handlers.create_user_success_response import generate_success_response
 
 
 def register_user():
     try:
         user_management_logger.info(
-            f"REQUEST ==> Received Endpoint for the request:: {request.endpoint}"
+            f"REQUEST ==> Received Endpoint: {request.endpoint}"
         )
         user_management_logger.info(
             f"REQUEST ==> Received url for the request :: {request.url}"
@@ -40,21 +38,28 @@ def register_user():
             user_management_logger.info(
                 f"Received Headers from the request :: {rec_req_headers}"
             )
-            """ 
+            """
                 1. Find the missing headers, any schema related issue related to headers in the request
-                2. If any missing headers or schema related issue , send the error response back to client.
+                2. If any missing headers or schema related issue, send the error response back to client.
                 3. Custom error response contains the information about headers related to missing/schema issue, with status code as 400,BAD_REQUEST
             """
-            reg_header_result = usermanager.generate_req_missing_params(rec_req_headers, req_headers_schema)
+            reg_header_result = usermanager.generate_req_missing_params(
+                rec_req_headers, req_headers_schema
+            )
             if len(reg_header_result) > 0:
-                return send_invalid_request_error_to_client(app_logger_name=user_management_logger,message_data="Request Headers Missing",err_details=reg_header_result,)
+                return send_invalid_request_error_to_client(
+                    app_logger_name=user_management_logger,
+                    message_data="Request Headers Missing",
+                    err_details=reg_header_result,
+                )
 
             rec_req_data = request.get_json()
-            """ 
+            """
                 1. Find the missing params, any schema related issue related to params in the request body
-                2. If any missing params or schema related issue , send the error response back to client.
+                2. If any missing params or schema related issue, send the error response back to client.
                 3. Custom error response contains the information about params related to missing/schema issue, with status code as 400,BAD_REQUEST
             """
+            """
             body_result = usermanager.generate_req_missing_params(
                 rec_req_data, reg_user_req_schema
             )
@@ -72,21 +77,32 @@ def register_user():
             emailaddress = rec_req_data["email"]
             password = rec_req_data["password"]
             dateofbirth = rec_req_data["dateOfBirth"]
-            user_management_logger.info("Processing the request data... :: [STARTED]")
-            session_to_validate_existing_user = app_manager_db_obj.get_session_from_session_maker()
+            user_management_logger.info("Processing request data... [STARTED]")
+            session_to_validate_existing_user = (
+                app_manager_db_obj.get_session_from_session_maker()
+            )
             if session_to_validate_existing_user is None:
-                """
-                No need to close the connection/session if the timeout occurs during the session/connection creation.
-                If the queue is full, it will try to wait initiate/fetch connection from the overflows connections.
-                """
-                return send_internal_server_error_to_client(app_logger_name=user_management_logger, message_data="Create Session Failed",)
+                return send_internal_server_error_to_client(
+                    app_logger_name=user_management_logger,
+                    message_data="Create Session Failed",
+                )
             # Doing the pre-validation checks before procession the request.
-            if is_username_email_already_exists_in_db(session_instance=session_to_validate_existing_user, uname=username, email=emailaddress,) is None:
+            if is_username_email_already_exists_in_db(
+                session_instance=session_to_validate_existing_user,
+                uname=username,
+                email=emailaddress,
+            ) is None:
                 app_manager_db_obj.close_session(session_instance=session_to_validate_existing_user)
-                return send_internal_server_error_to_client(app_logger_name=user_management_logger, message_data="Db error")
+                return send_internal_server_error_to_client(
+                    app_logger_name=user_management_logger,
+                    message_data="Db error"
+                )
             if not is_username_email_already_exists_in_db:
                 app_manager_db_obj.close_session(session_instance=session_to_validate_existing_user)
-                return send_invalid_request_error_to_client(app_logger_name=user_management_logger, message_data="Existing User",)
+                return send_invalid_request_error_to_client(
+                    app_logger_name=user_management_logger,
+                    message_data="Existing User",
+                )
             # Register user-logic begins here
             try:
                 user_obj = User(
@@ -110,9 +126,6 @@ def register_user():
                         app_logger_name=user_management_logger,
                         message_data="User Instance creation Failed",
                     )
-                """
-                    Using the session begin the transaction, and add the user into the database using ORM.
-                """
                 session_to_create_new_user = app_manager_db_obj.get_session_from_session_maker()
                 if session_to_create_new_user is None:
                     return send_internal_server_error_to_client(app_logger_name=user_management_logger, message_data="Create Session Failed",)
@@ -121,10 +134,6 @@ def register_user():
                     if user_db_record_to_insert is None:
                         app_manager_db_obj.close_session(session_instance=session_to_create_new_user)
                         return send_internal_server_error_to_client(app_logger_name=user_management_logger, message_data="User DB - Instance mapping Failed",)
-                    """ 
-                        Add the user model to the database and commit the changes
-                        Any exception occur, logs the exception and sends back the error response to the client as internal_server_error
-                    """
                     try:
                         user_management_logger.info(
                             f"Data adding into  DataBase session {user_db_record_to_insert}:: [STARTED]"
@@ -147,11 +156,6 @@ def register_user():
                         )
                         return send_internal_server_error_to_client(app_logger_name=user_management_logger, message_data="Database Error",)
                     else:
-                        """
-                        1. Converting the database model of user to defined user and serialize to json
-                        2. Using the serialize , Generating the success custom response , headers
-                        3. Sending the response back to client
-                        """
                         user_instance = convert_db_model_to_resp(model_instance=user_db_record_to_insert)
                         if not user_instance:
                             app_manager_db_obj.close_session(session_instance=session_to_create_new_user)

src/usermanagement_service/views/create_user.py

@@ -28,7 +28,7 @@ def get_user_info(userid):
             user_management_app_logger.info(
                 f"Received Headers from the request :: {rec_req_headers}"
             )
-            """ 
+            """
                 1. Find the missing headers, any schema related issue related to headers in the request
                 2. If any missing headers or schema related issue , send the error response back to client.
                 3. Custom error response contains the information about headers related to missing/schema issue, with status code as 400,BAD_REQUEST

src/usermanagement_service/views/fetch_user.py

@@ -29,7 +29,7 @@ def deregister_user(userid):
             user_management_app_logger.info(
                 f"Received Headers from the request :: {rec_req_headers}"
             )
-            """ 
+            """
                 1. Find the missing headers, any schema related issue related to headers in the request
                 2. If any missing headers or schema related issue , send the error response back to client.
                 3. Custom error response contains the information about headers related to missing/schema issue, with status code as 400,BAD_REQUEST