#92 initial pylint fixes

Author: suprajamannava17

server/README.md

@@ -1,31 +1,36 @@
 # Flask server
+
 This server has API endpoints supporting the application. Here's how you run this component individually.
 
 1. cd to server and follow the below steps based on your OS:
 
    ### On Mac
+
    The first time you want to run this code, you will need to:
+
    1. Create a virtual environment: <code>python3 -m venv venv</code>
-   2. Activate virtual environment: 
-      * On Mac or Linux: <code>source venv/bin/activate</code>
+   2. Activate virtual environment:
+      - On Mac or Linux: <code>source venv/bin/activate</code>
    3. Install dependencies into the virtual environment: <code>pip3 install -r requirements.txt</code>
 
    On all subsequent runs, you will need to:
-   1. Activate virtual environment: 
-      * On Mac or Linux: <code>source venv/bin/activate</code>
+
+   1. Activate virtual environment:
+      - On Mac or Linux: <code>source venv/bin/activate</code>
    2. Run the development server:
-      * On Mac or Linux: <code>bash run_dev_server.sh</code>
+      - On Mac or Linux: <code>bash run_dev_server.sh</code>
 
    ### On Windows
-   The first time you want to run this code, you will need to:
-   3. Install Git Bash (if not already installed) and in VS code open the terminal of type Git Bash
-   4. Create a virtual environment: <code>py -m venv venv</code>
-   5. Activate virtual environment: 
-      * On Windows: <code>source venv/Scripts/activate</code>
+
+   The first time you want to run this code, you will need to: 3. Install Git Bash (if not already installed) and in VS code open the terminal of type Git Bash 4. Create a virtual environment: <code>py -m venv venv</code> 5. Activate virtual environment:
+
+   - On Windows: <code>source venv/Scripts/activate</code>
+
    6. Install dependencies into the virtual environment: <code>pip install -r requirements.txt</code>
 
-   On all subsequent runs, you will need to:
-   7. Activate virtual environment: 
-      * On Windows: <code>source venv/Scripts/activate</code>
+   On all subsequent runs, you will need to: 7. Activate virtual environment:
+
+   - On Windows: <code>source venv/Scripts/activate</code>
+
    8. Run the development server:
-      * On Windows: <code>bash run_dev_server.sh</code>
+      - On Windows: <code>bash run_dev_server.sh</code>

server/application/config.py

@@ -1,3 +1,5 @@
+# pylint: disable=too-few-public-methods
+
 '''
 Configuration settings for the application are handled in this module
 '''

server/application/rest/search_orca_data.py

@@ -1,30 +1,20 @@
 """
 This module contains the RESTful route handlers
-for searching,previewing and downloading files.
+for searching, previewing, and downloading files.
 """
 import json
 from flask import Blueprint, Response, request, make_response
-from responses import ResponseTypes, ResponseSuccess, ResponseFailure
+from responses import ResponseSuccess
 from usecases.search_orca_data import find_sections_use_case, preview_document_use_case
-
+from utils.http_status_mapping import HTTP_STATUS_CODES_MAPPING
 
 blueprint = Blueprint("search_orca_data", __name__)
 
-HTTP_STATUS_CODES_MAPPING = {
-    ResponseTypes.NOT_FOUND: 404,
-    ResponseTypes.SYSTEM_ERROR: 500,
-    ResponseTypes.AUTHORIZATION_ERROR: 403,
-    ResponseTypes.PARAMETER_ERROR: 400,
-    ResponseTypes.SUCCESS: 200,
-    ResponseTypes.CONFLICT: 409
-}
-
 @blueprint.route('/preview', methods=['POST'])
 def preview_document():
-    '''
-    This method defines the API endpoint to preview
-    the document
-    '''
+    """
+    API endpoint to preview the document.
+    """
     data = request.get_json(force=True)
     response = preview_document_use_case(data)
     return Response(
@@ -35,23 +25,29 @@ def preview_document():
 
 @blueprint.route('/find-sections', methods=['POST'])
 def find_sections():
-    '''
-    This method defines the API endpoint to find the sections
-    based on the search input and to download the output as
-    word document
-    '''
+    """
+    API endpoint to find sections and download as Word document.
+    """
     data = request.get_json(force=True)
     response = find_sections_use_case(data)
+
     if isinstance(response, ResponseSuccess):
         docx_content = response.value
-        response = make_response(docx_content)
-        response.headers.set('Content-Type',
-        'application/vnd.openxmlformats-officedocument.wordprocessingml.document')
-        response.headers.set('Content-Disposition', 'attachment', filename='output.docx')
-        return response
-    elif isinstance(response, ResponseFailure):
-        return Response(
-            json.dumps(response.value),
-            mimetype="application/json",
-            status=HTTP_STATUS_CODES_MAPPING[response.response_type],
+        docx_response = make_response(docx_content)
+        docx_response.headers.set(
+            'Content-Type',
+            'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
         )
+        docx_response.headers.set(
+            'Content-Disposition',
+            'attachment',
+            filename='output.docx'
+        )
+        return docx_response
+
+    # Handle ResponseFailure
+    return Response(
+        json.dumps(response.value),
+        mimetype="application/json",
+        status=HTTP_STATUS_CODES_MAPPING[response.response_type],
+    )

server/application/rest/upload_files.py

@@ -7,18 +7,10 @@
 from flask_cors import cross_origin
 from responses import ResponseTypes
 from usecases.upload_files import file_upload_use_case, get_data_use_case
+from utils.http_status_mapping import HTTP_STATUS_CODES_MAPPING
 
 blueprint = Blueprint("upload_files", __name__)
 
-HTTP_STATUS_CODES_MAPPING = {
-    ResponseTypes.NOT_FOUND: 404,
-    ResponseTypes.SYSTEM_ERROR: 500,
-    ResponseTypes.AUTHORIZATION_ERROR: 403,
-    ResponseTypes.PARAMETER_ERROR: 400,
-    ResponseTypes.SUCCESS: 200,
-    ResponseTypes.CONFLICT: 409
-}
-
 @blueprint.route('/upload', methods=['POST'])
 @cross_origin()
 def file_upload():

server/responses.py

@@ -1,3 +1,5 @@
+# pylint: disable=too-few-public-methods
+
 '''
 This module defines the response classes and types for the server.
 
@@ -33,22 +35,40 @@ def _format_message(self, msg):
 
     @property
     def value(self):
+        '''
+        Returns the response as a dictionary containing the type and message.
+        '''
         return {"type": self.response_type, "message": self.message}
 
     def __bool__(self):
+        '''
+        Determines the truthiness of the response (always False).
+        '''
         return False
 
 
 class ResponseSuccess:
+    '''
+    Represents a successful response.
+    '''
     def __init__(self, value=None):
+        '''
+        Initializes a ResponseSuccess instance.
+        '''
         self.value = value
         self.response_type = ResponseTypes.SUCCESS
 
     def __bool__(self):
+        '''
+        Determines the truthiness of the response (always True).
+        '''
         return True
 
 
 def build_response_from_invalid_request(invalid_request):
+    '''
+    Builds a ResponseFailure from an invalid request, compiling its errors.
+    '''
     message = "\n".join(
         [f"{err['parameter']}: {err['message']}"
          for err in invalid_request.errors]

server/services/file_search_operations.py

@@ -1,7 +1,12 @@
+'''
+This module provides functions for extracting sections from an ORCA log file 
+based on specified search terms and saving the extracted data to a byte stream.
+'''
 from io import BytesIO
 import re
 
-def extract_sections(file_path, search_terms, sections, specify_lines, use_total_lines, total_lines):
+def extract_sections(file_path, search_terms, sections, specify_lines,
+                    use_total_lines, total_lines):
     '''
     Extracts the data from orca log file based on search terms and sections.
     '''
@@ -15,11 +20,7 @@ def extract_sections(file_path, search_terms, sections, specify_lines, use_total
 
     # Function to determine if a line is content
     def is_content_line(line, term, header_pattern=None):
-        if line.strip() == "":
-            return False
-        if line.startswith("-----"):
-            return False
-        if line.startswith(term):
+        if line.strip() == "" or line.startswith("-----") or line.startswith(term):
             return False
         if header_pattern and re.match(header_pattern, line):
             return False

server/services/file_upload_operations.py

@@ -1,3 +1,7 @@
+'''
+This module contains functions for handling file upload operations.
+'''
+
 import os
 from flask import current_app
 
@@ -11,7 +15,7 @@ def get_uploads_dir():
 
 def save_uploaded_file(file):
     '''
-    saves the uploaded file
+    saves the uploaded file to the uploads directory
     '''
     uploads_dir = get_uploads_dir()
     filename = os.path.join(uploads_dir, file.filename)

server/usecases/search_orca_data.py

@@ -1,3 +1,9 @@
+"""
+This module provides use cases for searching and processing 
+data in ORCA log files, including functions for previewing document 
+content and finding specific sections based on search terms.
+"""
+
 from responses import ResponseSuccess, ResponseFailure, ResponseTypes
 from docx import Document
 from services.file_search_operations import extract_sections, save_document_to_bytes
@@ -21,8 +27,8 @@ def preview_document_use_case(data):
     try:
         sections = list(map(int, sections))
         specify_lines = [temp_specify_lines] * len(sections)
-        document_content = extract_sections(file_path, search_terms, sections, 
-                                            specify_lines, use_total_lines, total_lines)
+        document_content = extract_sections(file_path, search_terms, sections,
+                                        specify_lines, use_total_lines, total_lines)
         return ResponseSuccess({'document_content': document_content})
     except FileNotFoundError as e:
         return ResponseFailure(ResponseTypes.PARAMETER_ERROR, f'File not found: {str(e)}')
@@ -47,24 +53,19 @@ def find_sections_use_case(data):
     if not all([file_path, search_terms, sections, temp_specify_lines]):
         return ResponseFailure(ResponseTypes.PARAMETER_ERROR, 'Missing required fields')
 
-    sections = list(map(int, sections))
-    specify_lines = [temp_specify_lines] * len(sections)
-
     try:
-        document_content = extract_sections(file_path, search_terms, sections, 
+        sections = list(map(int, sections))
+        specify_lines = [temp_specify_lines] * len(sections)
+        document_content = extract_sections(file_path, search_terms, sections,
                                             specify_lines, use_total_lines, total_lines)
         document = Document()
         for paragraph in document_content.split('\n'):
             document.add_paragraph(paragraph.strip())
         docx_bytes = save_document_to_bytes(document)
-        return ResponseSuccess(docx_bytes)
-    except FileNotFoundError as e:
-        return ResponseFailure(ResponseTypes.PARAMETER_ERROR, f'File not found: {str(e)}')
-    except PermissionError as e:
-        return ResponseFailure(ResponseTypes.PARAMETER_ERROR, f'Permission denied: {str(e)}')
-    except ValueError as e:
-        return ResponseFailure(ResponseTypes.PARAMETER_ERROR, f'Value error: {str(e)}')
-    except AttributeError as e:
-        return ResponseFailure(ResponseTypes.SYSTEM_ERROR, f'Document processing error: {str(e)}')
-    except TypeError as e:
-        return ResponseFailure(ResponseTypes.SYSTEM_ERROR, f'Document type error: {str(e)}')
+        result = ResponseSuccess(docx_bytes)
+    except (FileNotFoundError, PermissionError, ValueError) as e:
+        result = ResponseFailure(ResponseTypes.PARAMETER_ERROR, str(e))
+    except (AttributeError, TypeError) as e:
+        result = ResponseFailure(ResponseTypes.SYSTEM_ERROR, str(e))
+
+    return result

server/usecases/upload_files.py

@@ -1,3 +1,9 @@
+"""
+This module provides use cases for uploading and handling files, 
+including file upload validation and saving to a temporary folder.
+It also includes a sample data function to test server connection.
+"""
+
 from responses import ResponseSuccess, ResponseFailure, ResponseTypes
 from services.file_upload_operations import save_uploaded_file
 

server/utils/http_status_mapping.py

@@ -0,0 +1,14 @@
+"""
+Utility module for HTTP status code mappings.
+"""
+
+from responses import ResponseTypes
+
+HTTP_STATUS_CODES_MAPPING = {
+    ResponseTypes.NOT_FOUND: 404,
+    ResponseTypes.SYSTEM_ERROR: 500,
+    ResponseTypes.AUTHORIZATION_ERROR: 403,
+    ResponseTypes.PARAMETER_ERROR: 400,
+    ResponseTypes.SUCCESS: 200,
+    ResponseTypes.CONFLICT: 409
+}