chore: refurish python code by applying Pylint linter rules (#8322)

api/app.py

@@ -164,7 +164,7 @@ def initialize_extensions(app):
 @login_manager.request_loader
 def load_user_from_request(request_from_flask_login):
  """Load user based on the request."""
- if request.blueprint not in ["console", "inner_api"]:
+ if request.blueprint not in {"console", "inner_api"}:
  return None
  # Check if the user_id contains a dot, indicating the old format
  auth_header = request.headers.get("Authorization", "")

api/commands.py

@@ -140,9 +140,9 @@ def reset_encrypt_key_pair():
 @click.command("vdb-migrate", help="migrate vector db.")
 @click.option("--scope", default="all", prompt=False, help="The scope of vector database to migrate, Default is All.")
 def vdb_migrate(scope: str):
- if scope in ["knowledge", "all"]:
+ if scope in {"knowledge", "all"}:
  migrate_knowledge_vector_database()
- if scope in ["annotation", "all"]:
+ if scope in {"annotation", "all"}:
  migrate_annotation_vector_database()
 
 

api/controllers/console/app/audio.py

@@ -94,7 +94,7 @@ def post(self, app_model):
  message_id = args.get("message_id", None)
  text = args.get("text", None)
  if (
- app_model.mode in [AppMode.ADVANCED_CHAT.value, AppMode.WORKFLOW.value]
+ app_model.mode in {AppMode.ADVANCED_CHAT.value, AppMode.WORKFLOW.value}
  and app_model.workflow
  and app_model.workflow.features_dict
  ):

api/controllers/console/auth/oauth.py

@@ -71,7 +71,7 @@ def get(self, provider: str):
 
  account = _generate_account(provider, user_info)
  # Check account status
- if account.status == AccountStatus.BANNED.value or account.status == AccountStatus.CLOSED.value:
+ if account.status in {AccountStatus.BANNED.value, AccountStatus.CLOSED.value}:
  return {"error": "Account is banned or closed."}, 403
 
  if account.status == AccountStatus.PENDING.value:

api/controllers/console/datasets/datasets_document.py

@@ -354,7 +354,7 @@ def get(self, dataset_id, document_id):
  document_id = str(document_id)
  document = self.get_document(dataset_id, document_id)
 
- if document.indexing_status in ["completed", "error"]:
+ if document.indexing_status in {"completed", "error"}:
  raise DocumentAlreadyFinishedError()
 
  data_process_rule = document.dataset_process_rule
@@ -421,7 +421,7 @@ def get(self, dataset_id, batch):
  info_list = []
  extract_settings = []
  for document in documents:
- if document.indexing_status in ["completed", "error"]:
+ if document.indexing_status in {"completed", "error"}:
  raise DocumentAlreadyFinishedError()
  data_source_info = document.data_source_info_dict
  # format document files info
@@ -665,7 +665,7 @@ def patch(self, dataset_id, document_id, action):
  db.session.commit()
 
  elif action == "resume":
- if document.indexing_status not in ["paused", "error"]:
+ if document.indexing_status not in {"paused", "error"}:
  raise InvalidActionError("Document not in paused or error state.")
 
  document.paused_by = None

api/controllers/console/explore/audio.py

@@ -81,7 +81,7 @@ def post(self, installed_app):
  message_id = args.get("message_id", None)
  text = args.get("text", None)
  if (
- app_model.mode in [AppMode.ADVANCED_CHAT.value, AppMode.WORKFLOW.value]
+ app_model.mode in {AppMode.ADVANCED_CHAT.value, AppMode.WORKFLOW.value}
  and app_model.workflow
  and app_model.workflow.features_dict
  ):

api/controllers/console/explore/completion.py

@@ -92,7 +92,7 @@ class ChatApi(InstalledAppResource):
  def post(self, installed_app):
  app_model = installed_app.app
  app_mode = AppMode.value_of(app_model.mode)
- if app_mode not in [AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT]:
+ if app_mode not in {AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT}:
  raise NotChatAppError()
 
  parser = reqparse.RequestParser()
@@ -140,7 +140,7 @@ class ChatStopApi(InstalledAppResource):
  def post(self, installed_app, task_id):
  app_model = installed_app.app
  app_mode = AppMode.value_of(app_model.mode)
- if app_mode not in [AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT]:
+ if app_mode not in {AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT}:
  raise NotChatAppError()
 
  AppQueueManager.set_stop_flag(task_id, InvokeFrom.EXPLORE, current_user.id)

api/controllers/console/explore/conversation.py

@@ -20,7 +20,7 @@ class ConversationListApi(InstalledAppResource):
  def get(self, installed_app):
  app_model = installed_app.app
  app_mode = AppMode.value_of(app_model.mode)
- if app_mode not in [AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT]:
+ if app_mode not in {AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT}:
  raise NotChatAppError()
 
  parser = reqparse.RequestParser()
@@ -50,7 +50,7 @@ class ConversationApi(InstalledAppResource):
  def delete(self, installed_app, c_id):
  app_model = installed_app.app
  app_mode = AppMode.value_of(app_model.mode)
- if app_mode not in [AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT]:
+ if app_mode not in {AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT}:
  raise NotChatAppError()
 
  conversation_id = str(c_id)
@@ -68,7 +68,7 @@ class ConversationRenameApi(InstalledAppResource):
  def post(self, installed_app, c_id):
  app_model = installed_app.app
  app_mode = AppMode.value_of(app_model.mode)
- if app_mode not in [AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT]:
+ if app_mode not in {AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT}:
  raise NotChatAppError()
 
  conversation_id = str(c_id)
@@ -90,7 +90,7 @@ class ConversationPinApi(InstalledAppResource):
  def patch(self, installed_app, c_id):
  app_model = installed_app.app
  app_mode = AppMode.value_of(app_model.mode)
- if app_mode not in [AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT]:
+ if app_mode not in {AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT}:
  raise NotChatAppError()
 
  conversation_id = str(c_id)
@@ -107,7 +107,7 @@ class ConversationUnPinApi(InstalledAppResource):
  def patch(self, installed_app, c_id):
  app_model = installed_app.app
  app_mode = AppMode.value_of(app_model.mode)
- if app_mode not in [AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT]:
+ if app_mode not in {AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT}:
  raise NotChatAppError()
 
  conversation_id = str(c_id)

api/controllers/console/explore/installed_app.py

@@ -31,7 +31,7 @@ def get(self):
  "app_owner_tenant_id": installed_app.app_owner_tenant_id,
  "is_pinned": installed_app.is_pinned,
  "last_used_at": installed_app.last_used_at,
- "editable": current_user.role in ["owner", "admin"],
+ "editable": current_user.role in {"owner", "admin"},
  "uninstallable": current_tenant_id == installed_app.app_owner_tenant_id,
  }
  for installed_app in installed_apps

api/controllers/console/explore/message.py

@@ -40,7 +40,7 @@ def get(self, installed_app):
  app_model = installed_app.app
 
  app_mode = AppMode.value_of(app_model.mode)
- if app_mode not in [AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT]:
+ if app_mode not in {AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT}:
  raise NotChatAppError()
 
  parser = reqparse.RequestParser()
@@ -125,7 +125,7 @@ class MessageSuggestedQuestionApi(InstalledAppResource):
  def get(self, installed_app, message_id):
  app_model = installed_app.app
  app_mode = AppMode.value_of(app_model.mode)
- if app_mode not in [AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT]:
+ if app_mode not in {AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT}:
  raise NotChatAppError()
 
  message_id = str(message_id)

api/controllers/console/explore/parameter.py

@@ -43,7 +43,7 @@ def get(self, installed_app: InstalledApp):
  """Retrieve app parameters."""
  app_model = installed_app.app
 
- if app_model.mode in [AppMode.ADVANCED_CHAT.value, AppMode.WORKFLOW.value]:
+ if app_model.mode in {AppMode.ADVANCED_CHAT.value, AppMode.WORKFLOW.value}:
  workflow = app_model.workflow
  if workflow is None:
  raise AppUnavailableError()

api/controllers/console/workspace/workspace.py

@@ -194,7 +194,7 @@ def post(self):
  raise TooManyFilesError()
 
  extension = file.filename.split(".")[-1]
- if extension.lower() not in ["svg", "png"]:
+ if extension.lower() not in {"svg", "png"}:
  raise UnsupportedFileTypeError()
 
  try:

api/controllers/service_api/app/app.py

@@ -42,7 +42,7 @@ class AppParameterApi(Resource):
  @marshal_with(parameters_fields)
  def get(self, app_model: App):
  """Retrieve app parameters."""
- if app_model.mode in [AppMode.ADVANCED_CHAT.value, AppMode.WORKFLOW.value]:
+ if app_model.mode in {AppMode.ADVANCED_CHAT.value, AppMode.WORKFLOW.value}:
  workflow = app_model.workflow
  if workflow is None:
  raise AppUnavailableError()

api/controllers/service_api/app/audio.py

@@ -79,7 +79,7 @@ def post(self, app_model: App, end_user: EndUser):
  message_id = args.get("message_id", None)
  text = args.get("text", None)
  if (
- app_model.mode in [AppMode.ADVANCED_CHAT.value, AppMode.WORKFLOW.value]
+ app_model.mode in {AppMode.ADVANCED_CHAT.value, AppMode.WORKFLOW.value}
  and app_model.workflow
  and app_model.workflow.features_dict
  ):

api/controllers/service_api/app/completion.py

@@ -96,7 +96,7 @@ class ChatApi(Resource):
  @validate_app_token(fetch_user_arg=FetchUserArg(fetch_from=WhereisUserArg.JSON, required=True))
  def post(self, app_model: App, end_user: EndUser):
  app_mode = AppMode.value_of(app_model.mode)
- if app_mode not in [AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT]:
+ if app_mode not in {AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT}:
  raise NotChatAppError()
 
  parser = reqparse.RequestParser()
@@ -144,7 +144,7 @@ class ChatStopApi(Resource):
  @validate_app_token(fetch_user_arg=FetchUserArg(fetch_from=WhereisUserArg.JSON, required=True))
  def post(self, app_model: App, end_user: EndUser, task_id):
  app_mode = AppMode.value_of(app_model.mode)
- if app_mode not in [AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT]:
+ if app_mode not in {AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT}:
  raise NotChatAppError()
 
  AppQueueManager.set_stop_flag(task_id, InvokeFrom.SERVICE_API, end_user.id)

api/controllers/service_api/app/conversation.py

@@ -18,7 +18,7 @@ class ConversationApi(Resource):
  @marshal_with(conversation_infinite_scroll_pagination_fields)
  def get(self, app_model: App, end_user: EndUser):
  app_mode = AppMode.value_of(app_model.mode)
- if app_mode not in [AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT]:
+ if app_mode not in {AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT}:
  raise NotChatAppError()
 
  parser = reqparse.RequestParser()
@@ -52,7 +52,7 @@ class ConversationDetailApi(Resource):
  @marshal_with(simple_conversation_fields)
  def delete(self, app_model: App, end_user: EndUser, c_id):
  app_mode = AppMode.value_of(app_model.mode)
- if app_mode not in [AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT]:
+ if app_mode not in {AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT}:
  raise NotChatAppError()
 
  conversation_id = str(c_id)
@@ -69,7 +69,7 @@ class ConversationRenameApi(Resource):
  @marshal_with(simple_conversation_fields)
  def post(self, app_model: App, end_user: EndUser, c_id):
  app_mode = AppMode.value_of(app_model.mode)
- if app_mode not in [AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT]:
+ if app_mode not in {AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT}:
  raise NotChatAppError()
 
  conversation_id = str(c_id)

api/controllers/service_api/app/message.py

@@ -76,7 +76,7 @@ class MessageListApi(Resource):
  @marshal_with(message_infinite_scroll_pagination_fields)
  def get(self, app_model: App, end_user: EndUser):
  app_mode = AppMode.value_of(app_model.mode)
- if app_mode not in [AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT]:
+ if app_mode not in {AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT}:
  raise NotChatAppError()
 
  parser = reqparse.RequestParser()
@@ -117,7 +117,7 @@ class MessageSuggestedApi(Resource):
  def get(self, app_model: App, end_user: EndUser, message_id):
  message_id = str(message_id)
  app_mode = AppMode.value_of(app_model.mode)
- if app_mode not in [AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT]:
+ if app_mode not in {AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT}:
  raise NotChatAppError()
 
  try:

api/controllers/web/app.py

@@ -41,7 +41,7 @@ class AppParameterApi(WebApiResource):
  @marshal_with(parameters_fields)
  def get(self, app_model: App, end_user):
  """Retrieve app parameters."""
- if app_model.mode in [AppMode.ADVANCED_CHAT.value, AppMode.WORKFLOW.value]:
+ if app_model.mode in {AppMode.ADVANCED_CHAT.value, AppMode.WORKFLOW.value}:
  workflow = app_model.workflow
  if workflow is None:
  raise AppUnavailableError()

api/controllers/web/audio.py

@@ -78,7 +78,7 @@ def post(self, app_model: App, end_user):
  message_id = args.get("message_id", None)
  text = args.get("text", None)
  if (
- app_model.mode in [AppMode.ADVANCED_CHAT.value, AppMode.WORKFLOW.value]
+ app_model.mode in {AppMode.ADVANCED_CHAT.value, AppMode.WORKFLOW.value}
  and app_model.workflow
  and app_model.workflow.features_dict
  ):

api/controllers/web/completion.py

@@ -87,7 +87,7 @@ def post(self, app_model, end_user, task_id):
 class ChatApi(WebApiResource):
  def post(self, app_model, end_user):
  app_mode = AppMode.value_of(app_model.mode)
- if app_mode not in [AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT]:
+ if app_mode not in {AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT}:
  raise NotChatAppError()
 
  parser = reqparse.RequestParser()
@@ -136,7 +136,7 @@ def post(self, app_model, end_user):
 class ChatStopApi(WebApiResource):
  def post(self, app_model, end_user, task_id):
  app_mode = AppMode.value_of(app_model.mode)
- if app_mode not in [AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT]:
+ if app_mode not in {AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT}:
  raise NotChatAppError()
 
  AppQueueManager.set_stop_flag(task_id, InvokeFrom.WEB_APP, end_user.id)

api/controllers/web/conversation.py

@@ -18,7 +18,7 @@ class ConversationListApi(WebApiResource):
  @marshal_with(conversation_infinite_scroll_pagination_fields)
  def get(self, app_model, end_user):
  app_mode = AppMode.value_of(app_model.mode)
- if app_mode not in [AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT]:
+ if app_mode not in {AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT}:
  raise NotChatAppError()
 
  parser = reqparse.RequestParser()
@@ -56,7 +56,7 @@ def get(self, app_model, end_user):
 class ConversationApi(WebApiResource):
  def delete(self, app_model, end_user, c_id):
  app_mode = AppMode.value_of(app_model.mode)
- if app_mode not in [AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT]:
+ if app_mode not in {AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT}:
  raise NotChatAppError()
 
  conversation_id = str(c_id)
@@ -73,7 +73,7 @@ class ConversationRenameApi(WebApiResource):
  @marshal_with(simple_conversation_fields)
  def post(self, app_model, end_user, c_id):
  app_mode = AppMode.value_of(app_model.mode)
- if app_mode not in [AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT]:
+ if app_mode not in {AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT}:
  raise NotChatAppError()
 
  conversation_id = str(c_id)
@@ -92,7 +92,7 @@ def post(self, app_model, end_user, c_id):
 class ConversationPinApi(WebApiResource):
  def patch(self, app_model, end_user, c_id):
  app_mode = AppMode.value_of(app_model.mode)
- if app_mode not in [AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT]:
+ if app_mode not in {AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT}:
  raise NotChatAppError()
 
  conversation_id = str(c_id)
@@ -108,7 +108,7 @@ def patch(self, app_model, end_user, c_id):
 class ConversationUnPinApi(WebApiResource):
  def patch(self, app_model, end_user, c_id):
  app_mode = AppMode.value_of(app_model.mode)
- if app_mode not in [AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT]:
+ if app_mode not in {AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT}:
  raise NotChatAppError()
 
  conversation_id = str(c_id)

api/controllers/web/message.py

@@ -78,7 +78,7 @@ class MessageListApi(WebApiResource):
  @marshal_with(message_infinite_scroll_pagination_fields)
  def get(self, app_model, end_user):
  app_mode = AppMode.value_of(app_model.mode)
- if app_mode not in [AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT]:
+ if app_mode not in {AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT}:
  raise NotChatAppError()
 
  parser = reqparse.RequestParser()
@@ -160,7 +160,7 @@ def get(self, app_model, end_user, message_id):
 class MessageSuggestedQuestionApi(WebApiResource):
  def get(self, app_model, end_user, message_id):
  app_mode = AppMode.value_of(app_model.mode)
- if app_mode not in [AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT]:
+ if app_mode not in {AppMode.CHAT, AppMode.AGENT_CHAT, AppMode.ADVANCED_CHAT}:
  raise NotCompletionAppError()
 
  message_id = str(message_id)

api/core/agent/output_parser/cot_output_parser.py

@@ -90,7 +90,7 @@ def extra_json_from_code_block(code_block) -> Generator[Union[dict, str], None,
 
  if not in_code_block and not in_json:
  if delta.lower() == action_str[action_idx] and action_idx == 0:
- if last_character not in ["\n", " ", ""]:
+ if last_character not in {"\n", " ", ""}:
  index += steps
  yield delta
  continue
@@ -117,7 +117,7 @@ def extra_json_from_code_block(code_block) -> Generator[Union[dict, str], None,
  action_idx = 0
 
  if delta.lower() == thought_str[thought_idx] and thought_idx == 0:
- if last_character not in ["\n", " ", ""]:
+ if last_character not in {"\n", " ", ""}:
  index += steps
  yield delta
  continue

api/core/app/app_config/base_app_config_manager.py

@@ -29,7 +29,7 @@ def convert_features(cls, config_dict: Mapping[str, Any], app_mode: AppMode) ->
  additional_features.show_retrieve_source = RetrievalResourceConfigManager.convert(config=config_dict)
 
  additional_features.file_upload = FileUploadConfigManager.convert(
- config=config_dict, is_vision=app_mode in [AppMode.CHAT, AppMode.COMPLETION, AppMode.AGENT_CHAT]
+ config=config_dict, is_vision=app_mode in {AppMode.CHAT, AppMode.COMPLETION, AppMode.AGENT_CHAT}
  )
 
  additional_features.opening_statement, additional_features.suggested_questions = (