pylint

Author: UtkarshMishra-Microsoft

ClientAdvisor/App/.pylintrc

@@ -4,20 +4,17 @@ ignore=tests  ; Ignore the tests folder globally.
 [MESSAGES CONTROL]
 disable=
     invalid-name,                  # C0103: Ignore naming style errors
-    line-too-long,                 # C0301: Ignore long lines
     missing-function-docstring,    # C0116: Ignore missing function docstrings
     missing-class-docstring,       # C0115: Ignore missing class docstrings
     missing-module-docstring,      # C0114: Ignore missing module docstrings
-    redefined-outer-name,          # W0621: Ignore redefined variables warnings
     broad-exception-raised,        # W0719: Ignore broad exception raised warnings
     broad-exception-caught,        # W0718: Ignore broad exception caught warnings
     too-many-arguments,            # R0913: Ignore too many arguments
     too-many-locals,               # R0914: Ignore too many local variables
     too-many-return-statements,    # R0911: Ignore too many return statements
+    too-many-statements,           # R0915: Ignore too many statements in a function
     too-many-branches,             # R0912: Ignore too many branches
-    unused-argument,               # W0613: Ignore unused arguments
     unspecified-encoding,          # W1514: Ignore unspecified encoding in open()
-    logging-fstring-interpolation, # W1203: Ignore lazy f-string interpolation
     missing-timeout,               # W3101: Ignore missing timeout in requests.get
     no-else-return,                # R1705: Ignore unnecessary 'else' after return
     redefined-builtin,             # W0622: Ignore redefining built-ins
@@ -26,16 +23,18 @@ disable=
     no-member,                     # E1101: Ignore module has no 'member'
     pointless-string-statement,    # W0105: Ignore pointless string statements
     unnecessary-comprehension,     # R1721: Ignore unnecessary comprehensions
-    fixme,                         # W0511: Ignore TODO comments
+    simplifiable-if-expression,    # R1719: Ignore simplifiable if expressions
+    dangerous-default-value,       # W0102: Ignore mutable default arguments
+    consider-using-with,           # R1732: Ignore using 'with' for resource management
     too-many-instance-attributes,  # R0902: Ignore too many attributes in class
     too-many-positional-arguments, # R0917: Ignore too many positional arguments
     raise-missing-from,            # W0707: Ignore re-raising without 'raise from'
     import-outside-toplevel,       # C0415: Ignore imports outside top-level
-    no-value-for-parameter         # E1120: Ignore missing arguments in function calls
+    no-value-for-parameter,        # E1120: Ignore missing arguments in function calls
 
 [TYPECHECK]
 generated-members=get_bearer_token_provider
 
 [FORMAT]
-max-module-lines=1700              # Allow large modules up to 1700 lines
+max-module-lines=1700              # Allow modules up to 1700 lines
 max-line-length=160                # Allow lines up to 160 characters

ClientAdvisor/App/app.py

@@ -8,22 +8,31 @@
 
 import httpx
 import requests
-from azure.identity.aio import (DefaultAzureCredential,
-                                get_bearer_token_provider)
+from azure.identity.aio import DefaultAzureCredential, get_bearer_token_provider
+from backend.auth.auth_utils import get_authenticated_user_details, get_tenantid
+from backend.history.cosmosdbservice import CosmosConversationClient
+from backend.utils import (
+    convert_to_pf_format,
+    format_as_ndjson,
+    format_pf_non_streaming_response,
+    format_stream_response,
+    generateFilterString,
+    parse_multi_columns,
+)
+from db import get_connection
 from dotenv import load_dotenv
+
 # from quart.sessions import SecureCookieSessionInterface
 from openai import AsyncAzureOpenAI
-from quart import (Blueprint, Quart, jsonify, make_response, render_template,
-                   request, send_from_directory)
-
-from backend.auth.auth_utils import (get_authenticated_user_details,
-                                     get_tenantid)
-from backend.history.cosmosdbservice import CosmosConversationClient
-from backend.utils import (convert_to_pf_format, format_as_ndjson,
-                           format_pf_non_streaming_response,
-                           format_stream_response, generateFilterString,
-                           parse_multi_columns)
-from db import get_connection
+from quart import (
+    Blueprint,
+    Quart,
+    jsonify,
+    make_response,
+    render_template,
+    request,
+    send_from_directory,
+)
 
 bp = Blueprint("routes", __name__, static_folder="static", template_folder="static")
 
@@ -472,9 +481,7 @@ def get_configured_data_source():
                         else []
                     ),
                 },
-                "in_scope": (
-                    AZURE_SEARCH_ENABLE_IN_DOMAIN.lower() == "true"
-                ),
+                "in_scope": (AZURE_SEARCH_ENABLE_IN_DOMAIN.lower() == "true"),
                 "top_n_documents": (
                     int(AZURE_SEARCH_TOP_K) if AZURE_SEARCH_TOP_K else int(SEARCH_TOP_K)
                 ),
@@ -588,9 +595,7 @@ def get_configured_data_source():
                         else []
                     ),
                 },
-                "in_scope": (
-                    ELASTICSEARCH_ENABLE_IN_DOMAIN.lower() == "true"
-                ),
+                "in_scope": (ELASTICSEARCH_ENABLE_IN_DOMAIN.lower() == "true"),
                 "top_n_documents": (
                     int(ELASTICSEARCH_TOP_K)
                     if ELASTICSEARCH_TOP_K
@@ -640,9 +645,7 @@ def get_configured_data_source():
                         else []
                     ),
                 },
-                "in_scope": (
-                    AZURE_MLINDEX_ENABLE_IN_DOMAIN.lower() == "true"
-                ),
+                "in_scope": (AZURE_MLINDEX_ENABLE_IN_DOMAIN.lower() == "true"),
                 "top_n_documents": (
                     int(AZURE_MLINDEX_TOP_K)
                     if AZURE_MLINDEX_TOP_K
@@ -685,9 +688,7 @@ def get_configured_data_source():
                         else []
                     ),
                 },
-                "in_scope": (
-                    PINECONE_ENABLE_IN_DOMAIN.lower() == "true"
-                ),
+                "in_scope": (PINECONE_ENABLE_IN_DOMAIN.lower() == "true"),
                 "top_n_documents": (
                     int(PINECONE_TOP_K) if PINECONE_TOP_K else int(SEARCH_TOP_K)
                 ),

ClientAdvisor/App/tests/backend/auth/test_auth.py

@@ -2,8 +2,7 @@
 import json
 from unittest.mock import patch
 
-from backend.auth.auth_utils import (get_authenticated_user_details,
-                                     get_tenantid)
+from backend.auth.auth_utils import get_authenticated_user_details, get_tenantid
 
 
 def test_get_authenticated_user_details_no_principal_id():

ClientAdvisor/App/tests/backend/history/test_cosmosdb_service.py

@@ -2,7 +2,6 @@
 
 import pytest
 from azure.cosmos import exceptions
-
 from backend.history.cosmosdbservice import CosmosConversationClient
 
 

ClientAdvisor/App/tests/backend/test_utils.py

@@ -3,12 +3,17 @@
 from unittest.mock import MagicMock, patch
 
 import pytest
-
-from backend.utils import (JSONEncoder, convert_to_pf_format, fetchUserGroups,
-                           format_as_ndjson, format_non_streaming_response,
-                           format_pf_non_streaming_response,
-                           format_stream_response, generateFilterString,
-                           parse_multi_columns)
+from backend.utils import (
+    JSONEncoder,
+    convert_to_pf_format,
+    fetchUserGroups,
+    format_as_ndjson,
+    format_non_streaming_response,
+    format_pf_non_streaming_response,
+    format_stream_response,
+    generateFilterString,
+    parse_multi_columns,
+)
 
 
 @dataclasses.dataclass

ClientAdvisor/App/tests/test_app.py

@@ -2,9 +2,14 @@
 from unittest.mock import AsyncMock, MagicMock, patch
 
 import pytest
-
-from app import (create_app, delete_all_conversations, generate_title,
-                 init_cosmosdb_client, init_openai_client, stream_chat_request)
+from app import (
+    create_app,
+    delete_all_conversations,
+    generate_title,
+    init_cosmosdb_client,
+    init_openai_client,
+    stream_chat_request,
+)
 
 # Constants for testing
 INVALID_API_VERSION = "2022-01-01"

ClientAdvisor/App/tools/data_collection.py

@@ -3,9 +3,8 @@
 import os
 import sys
 
-from dotenv import load_dotenv
-
 import app
+from dotenv import load_dotenv
 
 # import the app.py module to gain access to the methods to construct payloads and
 # call the API through the sdk