dify/api/tests/unit_tests/.ruff.toml

extend = "../../.ruff.toml"
src = ["../.."]

[lint]
extend-select = ["ANN401", "ARG"]

# Existing strict-mode debt. Remove a file entry when bringing it under strict checking.
[lint.per-file-ignores]
"clients/agent_backend/test_request_builder.py" = ["TID251"]
"commands/test_retention.py" = ["ARG005"]
"commands/test_data_migration.py" = ["ARG001", "ARG002", "ARG005"]
"repositories/test_app_definition_query_repository.py" = ["ARG005", "TID251"]
"controllers/console/agent/test_roster.py" = ["ARG001", "ARG002", "ARG003", "ARG005", "TID251"]
"controllers/console/app/test_agent_config_inspector.py" = ["ARG005"]
"controllers/console/app/test_agent_manage_guard.py" = ["ARG001"]
"controllers/console/app/test_annotation.py" = ["ARG002"]
"controllers/console/app/test_app.py" = ["ARG001", "ARG002", "ARG004", "ARG005"]
"controllers/console/app/test_app_import.py" = ["ARG001", "ARG002", "ARG005"]
"controllers/console/app/test_conversation.py" = ["ARG001"]
"controllers/console/app/test_generator.py" = ["ARG001"]
"controllers/console/app/test_mcp_server.py" = ["ARG002"]
"controllers/console/app/test_message.py" = ["ARG001", "ARG004"]
"controllers/console/app/test_statistic.py" = ["ANN401", "ARG001", "TID251"]
"controllers/console/app/test_workflow.py" = ["ARG001", "ARG004", "ARG005"]
"controllers/console/app/test_workflow_node_output_inspector.py" = ["ANN401", "ARG001", "TID251"]
"controllers/console/app/test_workflow_run.py" = ["ANN401", "TID251"]
"fields/test_workflow_draft_variable_fields.py" = ["TID251"]
"controllers/console/auth/test_activate.py" = ["ARG002"]
"controllers/console/auth/test_login.py" = ["ARG002"]
"controllers/console/auth/test_oauth.py" = ["ARG002"]
"controllers/console/auth/test_oauth_timezone.py" = ["ARG001"]
"controllers/console/billing/test_billing.py" = ["ARG002"]
"controllers/console/datasets/test_datasets.py" = ["ARG005"]
"controllers/console/datasets/test_datasets_document.py" = ["ARG002", "ARG005"]
"controllers/console/datasets/test_datasets_segments.py" = ["TID251"]
"controllers/console/datasets/test_external.py" = ["TID251"]
"controllers/console/explore/test_trial.py" = ["ANN401", "ARG001", "ARG005", "TID251"]
"controllers/console/explore/test_wraps.py" = ["ARG001"]
"controllers/console/snippets/test_snippet_workflow.py" = ["ARG001"]
"controllers/console/tag/test_tags.py" = ["ARG002"]
"controllers/console/test_files.py" = ["ARG001", "ARG002"]
"controllers/console/test_human_input_form.py" = ["ARG001", "ARG005"]
"controllers/console/test_wraps.py" = ["ARG001", "ARG002"]
"controllers/console/workspace/test_plugin.py" = ["ARG002", "TID251"]
"controllers/console/workspace/test_snippets.py" = ["ARG002"]
"controllers/console/workspace/test_tool_providers.py" = ["ARG001", "ARG004", "ARG005"]
"controllers/inner_api/plugin/test_plugin.py" = ["ARG002"]
"controllers/inner_api/plugin/test_wraps.py" = ["ARG001", "ARG002", "ARG003", "TID251"]
"controllers/inner_api/test_runtime_credentials.py" = ["ARG001"]
"controllers/mcp/test_mcp.py" = ["ARG002"]
"controllers/openapi/test_account.py" = ["ARG005"]
"controllers/openapi/test_app_run.py" = ["ARG001"]
"controllers/openapi/test__contract.py" = ["ARG001", "TID251"]
"controllers/openapi/test__errors.py" = ["ARG002"]
"controllers/openapi/test_human_input_form.py" = ["ARG002"]
"controllers/openapi/test_workflow_events.py" = ["ARG002", "ARG005"]
"controllers/openapi/test_workspaces.py" = ["ARG001"]
"controllers/service_api/app/test_app.py" = ["ARG002"]
"controllers/service_api/app/test_completion.py" = ["ARG001", "ARG002", "ARG004"]
"controllers/service_api/app/test_file.py" = ["ARG002"]
"controllers/service_api/app/test_workflow_events.py" = ["ARG002", "ARG005"]
"controllers/service_api/dataset/rag_pipeline/test_rag_pipeline_workflow.py" = ["ARG002"]
"controllers/service_api/dataset/test_segment.py" = ["ARG002"]
"controllers/service_api/dataset/test_document.py" = ["ARG001", "ARG002"]
"controllers/service_api/test_wraps.py" = ["ARG001", "ARG002"]
"controllers/trigger/test_trigger.py" = ["ARG002"]
"controllers/trigger/test_webhook.py" = ["ARG002"]
"controllers/web/test_app.py" = ["ARG002", "ARG005"]
"controllers/web/test_audio.py" = ["ARG002"]
"controllers/web/test_completion.py" = ["ARG002"]
"controllers/web/test_human_input_form.py" = ["ARG001", "ARG002", "ARG005"]
"controllers/web/test_message.py" = ["ARG002"]
"controllers/web/test_login.py" = ["ARG002"]
"controllers/web/test_workflow.py" = ["ARG002"]
"core/agent/test_base_agent_runner.py" = ["ARG002"]
"core/agent/test_cot_agent_runner.py" = ["ARG001"]
"core/agent/test_cot_chat_agent_runner.py" = ["ARG002"]
"core/agent/test_fc_agent_runner.py" = ["TID251"]
"core/app/app_config/easy_ui_based_app/model_config/test_converter.py" = ["ARG002"]
"core/app/app_config/easy_ui_based_app/variables/test_manager.py" = ["ARG002"]
"core/app/apps/advanced_chat/test_app_generator.py" = ["ANN401", "ARG001", "ARG002", "ARG005", "TID251"]
"core/app/apps/advanced_chat/test_app_runner.py" = ["ARG001", "ARG005"]
"core/app/apps/advanced_chat/test_generate_task_pipeline.py" = ["ARG001", "ARG002", "ARG005"]
"core/app/apps/agent_app/test_app_generator.py" = ["ANN401", "ARG001", "ARG002", "ARG005", "TID251"]
"core/app/apps/agent_app/test_app_runner.py" = ["ANN401", "ARG002", "ARG005", "TID251"]
"core/app/apps/agent_app/test_runtime_request_builder.py" = ["ARG002", "TID251"]
"core/app/apps/agent_chat/test_app_config_manager.py" = ["ARG005"]
"core/app/apps/agent_chat/test_app_generator.py" = ["ARG001"]
"core/app/apps/chat/test_app_config_manager.py" = ["ARG001"]
"core/app/apps/chat/test_app_generator.py" = ["ARG001", "ARG002", "ARG005"]
"core/app/apps/common/test_workflow_response_converter.py" = ["ARG005", "TID251"]
"core/app/apps/completion/test_app_runner.py" = ["ARG001", "ARG002", "ARG005"]
"core/app/apps/pipeline/test_pipeline_generator.py" = ["ARG001", "ARG002", "ARG005"]
"core/app/apps/pipeline/test_pipeline_runner.py" = ["ARG001", "ARG002"]
"core/app/apps/test_base_app_generator.py" = ["ARG005"]
"core/app/apps/test_base_app_runner.py" = ["ARG001", "ARG002", "ARG005"]
"core/app/apps/test_streaming_utils.py" = ["ARG001"]
"core/app/apps/workflow/test_app_generator.py" = ["ARG005"]
"core/app/apps/test_workflow_app_runner.py" = ["ANN401", "ARG001", "ARG002", "ARG004", "ARG005", "TID251"]
"core/app/apps/workflow/test_generate_task_pipeline.py" = ["ARG002", "ARG005"]
"core/app/features/rate_limiting/test_rate_limit.py" = ["ARG001"]
"core/app/task_pipeline/test_easy_ui_based_generate_task_pipeline.py" = ["ARG001", "ARG002", "ARG005"]
"core/app/task_pipeline/test_message_cycle_manager.py" = ["ARG002"]
"core/app/app_config/easy_ui_based_app/model_config/test_manager.py" = ["ARG005"]
"services/test_workflow_persistence.py" = ["ANN401", "ARG001", "ARG005", "TID251"]
"core/app/workflow/test_file_runtime.py" = ["ARG001", "ARG005"]
"core/app/workflow/layers/test_observability.py" = ["ARG002", "ARG005"]
"core/base/tts/test_app_generator_tts_publisher.py" = ["ARG002"]
"core/callback_handler/test_agent_tool_callback_handler.py" = ["ARG002"]
"core/callback_handler/test_workflow_tool_callback_handler.py" = ["ARG002"]
"core/entities/test_mcp_provider.py" = ["ARG001"]
"core/entities/test_provider_configuration.py" = ["ANN401", "ARG001", "ARG005", "TID251"]
"core/external_data_tool/api/test_api.py" = ["ARG001"]
"core/external_data_tool/test_base.py" = ["TID251"]
"core/external_data_tool/test_external_data_fetch.py" = ["ARG001"]
"core/helper/code_executor/test_code_executor.py" = ["TID251"]
"core/llm_generator/test_llm_generator.py" = ["ARG002"]
"core/mcp/auth/test_auth_flow.py" = ["ARG002"]
"core/mcp/session/test_client_session.py" = ["ARG001", "ARG005", "TID251"]
"core/mcp/client/test_sse_client.py" = ["ARG001", "TID251"]
"core/mcp/client/test_streamable_client.py" = ["ARG001", "ARG005", "S110", "TID251"]
"core/mcp/session/test_base_session.py" = ["S110"]
"core/mcp/test_mcp_client.py" = ["ARG002"]
"core/memory/test_token_buffer_memory.py" = ["ARG002"]
"core/ops/test_base_trace_instance.py" = ["ARG001", "ARG004"]
"core/ops/test_ops_trace_manager.py" = ["ARG001", "ARG002", "ARG004", "ARG005"]
"core/ops/entities/test_trace_entity.py" = ["ARG001", "ARG005"]
"core/plugin/impl/test_agent.py" = ["ARG001"]
"core/plugin/impl/test_datasource.py" = ["ARG001"]
"core/plugin/impl/test_oauth.py" = ["ARG001"]
"core/plugin/impl/test_tool.py" = ["ARG001"]
"core/plugin/impl/test_trigger.py" = ["ARG001"]
"core/plugin/impl/test_endpoint.py" = ["ARG002"]
"core/plugin/impl/test_model_runtime.py" = ["ARG002"]
"core/plugin/impl/test_plugin.py" = ["ARG001", "ARG002", "TID251"]
"core/prompt/test_advanced_prompt_transform.py" = ["ARG005"]
"core/rag/datasource/keyword/jieba/test_jieba.py" = ["ARG001", "TID251"]
"core/rag/datasource/keyword/jieba/test_jieba_keyword_table_handler.py" = ["ARG004"]
"core/rag/datasource/test_retrieval_service.py" = ["ARG001", "ARG002", "ARG005", "TID251"]
"core/rag/datasource/vdb/test_vector_factory.py" = ["ARG002"]
"core/rag/embedding/test_cached_embedding.py" = ["ARG001"]
"core/rag/extractor/test_csv_extractor.py" = ["ARG001", "ARG005"]
"core/rag/extractor/test_excel_extractor.py" = ["ARG002", "ARG005"]
"core/rag/extractor/test_extract_processor.py" = ["ARG001", "ARG005"]
"core/rag/extractor/test_helpers.py" = ["ARG002"]
"core/rag/extractor/test_markdown_extractor.py" = ["ARG001"]
"core/rag/extractor/test_word_extractor.py" = ["ARG001", "ARG002", "ARG005"]
"core/rag/extractor/unstructured/test_unstructured_doc_extractor.py" = ["ARG001", "ARG005"]
"core/rag/extractor/watercrawl/test_client.py" = ["ARG001", "ARG005", "TID251"]
"core/rag/index_processor/processor/test_paragraph_index_processor.py" = ["ARG002", "TID251"]
"core/rag/index_processor/processor/test_qa_index_processor.py" = ["ARG001", "TID251"]
"core/rag/index_processor/test_index_processor.py" = ["ARG005"]
"core/rag/retrieval/test_dataset_retrieval.py" = ["ARG001", "ARG002", "ARG005", "TID251"]
"core/rag/splitter/test_text_splitter.py" = ["ARG002", "ARG005"]
"core/repositories/test_celery_workflow_execution_repository.py" = ["ARG002"]
"core/repositories/test_celery_workflow_node_execution_repository.py" = ["ARG002"]
"core/repositories/test_human_input_repository.py" = ["ANN401", "ARG001", "ARG004", "ARG005", "TID251"]
"core/repositories/test_sqlalchemy_workflow_node_execution_repository.py" = ["ANN401", "ARG002", "ARG005", "TID251"]
"core/schemas/test_resolver.py" = ["ARG005", "T201"]
"core/telemetry/test___init__.py" = ["ARG002", "ARG004"]
"core/telemetry/test_gateway.py" = ["ARG002"]
"core/test_model_manager.py" = ["ARG001"]
"core/trigger/debug/test_event_selectors.py" = ["ARG002"]
"core/tools/__base/test_tool.py" = ["ANN401", "ARG002", "TID251"]
"core/tools/builtin_tool/test_tool.py" = ["ARG001", "ARG002", "TID251"]
"core/tools/builtin_tool/test_provider.py" = ["ARG001", "ARG005", "TID251"]
"core/tools/builtin_tool/providers/time/tools/test_localtime_to_timestamp.py" = ["ARG005"]
"core/tools/custom_tool/test_tool.py" = ["ARG001", "ARG005", "TID251"]
"core/tools/utils/test_dataset_retriever_tool.py" = ["ARG005"]
"core/tools/mcp_tool/test_tool.py" = ["S110", "TID251"]
"core/tools/test_tool_engine.py" = ["ANN401", "ARG002", "ARG005", "TID251"]
"core/tools/test_tool_file_manager.py" = ["ARG001"]
"core/tools/test_tool_label_manager.py" = ["TID251"]
"core/tools/test_tool_manager.py" = ["ANN401", "ARG001", "ARG005", "TID251"]
"core/tools/__base/test_tool_provider.py" = ["TID251"]
"core/tools/utils/test_configuration.py" = ["ARG001", "ARG002", "TID251"]
"core/tools/utils/test_message_transformer.py" = ["TID251"]
"core/tools/utils/dataset_retriever/test_dataset_multi_retriever_tool.py" = ["ARG002"]
"core/tools/utils/test_model_invocation_utils.py" = ["ARG005", "TID251"]
"core/tools/utils/test_parser.py" = ["TID251"]
"core/tools/utils/test_web_reader_tool.py" = ["ARG001", "ARG002", "ARG005"]
"core/tools/workflow_as_tool/test_provider.py" = ["TID251"]
"core/tools/workflow_as_tool/test_tool.py" = ["ANN401", "ARG001", "ARG005", "TID251"]
"context/test_execution_context.py" = ["ANN401", "ARG002", "S110", "TID251"]
"context/test_flask_app_context.py" = ["ARG002"]
"core/workflow/generator/test_runner.py" = ["ARG001", "ARG002", "ARG003", "TID251"]
"core/workflow/generator/test_tool_catalogue.py" = ["ARG002"]
"../helpers/workflow/mock_config.py" = ["TID251"]
"../helpers/workflow/mock_factory.py" = ["TID251"]
"../helpers/workflow/mock_nodes.py" = ["ANN401", "S110", "TID251"]
"../e2e_tests/contracts/core/workflow/graph_engine/test_parallel_human_input_join_resume.py" = ["ARG002", "TID251"]
"../helpers/workflow/table_runner.py" = ["ARG001", "TID251"]
"core/workflow/nodes/agent_v2/test_agent_node.py" = ["ARG001", "ARG002", "ARG005"]
"core/workflow/nodes/agent_v2/test_dify_tools_builder.py" = ["ANN401", "ARG001", "ARG002", "ARG005", "TID251"]
"core/workflow/nodes/agent_v2/test_output_adapter.py" = ["ARG005"]
"core/workflow/nodes/agent_v2/test_runtime_request_builder.py" = ["ARG002"]
"core/workflow/nodes/agent_v2/test_validators.py" = ["ARG001"]
"../e2e_tests/contracts/core/workflow/nodes/http_request/test_http_request_node.py" = ["ANN401", "ARG002", "TID251"]
"core/workflow/nodes/human_input/test_entities.py" = ["TID251"]
"core/workflow/nodes/knowledge_index/test_knowledge_index_node.py" = ["ARG002"]
"core/workflow/nodes/knowledge_retrieval/test_knowledge_retrieval_node.py" = ["ARG002"]
"../e2e_tests/contracts/core/workflow/nodes/llm/test_node.py" = ["ARG002"]
"../e2e_tests/contracts/core/workflow/nodes/parameter_extractor/test_parameter_extractor_node.py" = ["TID251"]
"../e2e_tests/contracts/core/workflow/nodes/test_document_extractor_node.py" = ["ARG001"]
"../e2e_tests/contracts/core/workflow/nodes/tool/test_tool_node.py" = ["ANN401", "ARG002", "TID251"]
"core/workflow/nodes/trigger_webhook/test_node.py" = ["TID251"]
"core/workflow/nodes/human_input/test_pause_reason.py" = ["ANN401", "TID251"]
"core/workflow/test_human_input_adapter.py" = ["ARG005"]
"core/workflow/test_node_factory.py" = ["ARG002"]
"core/workflow/test_workflow_entry.py" = ["ARG001"]
"enterprise/telemetry/test_enterprise_trace.py" = ["ARG002", "TID251"]
"events/event_handlers/test_delete_tool_parameters_cache_when_sync_draft_workflow.py" = ["ARG005"]
"extensions/logstore/test_sql_escape.py" = ["ARG001", "ARG002"]
"extensions/otel/decorators/handlers/test_generate_handler.py" = ["ARG001", "ARG002"]
"extensions/otel/decorators/handlers/test_workflow_app_runner_handler.py" = ["ARG001"]
"core/workflow/nodes/knowledge_retrieval/test_retrieval.py" = ["ARG001"]
"factories/file_factory/test_builders.py" = ["ARG001"]
"factories/file_factory/test_remote.py" = ["ARG001"]
"fields/test_file_fields.py" = ["ARG005"]
"../helpers/unit/libs/_human_input/support.py" = ["TID251"]
"libs/broadcast_channel/redis/test_pubsub_channel.py" = ["ARG002", "ARG005"]
"libs/broadcast_channel/redis/test_streams_channel.py" = ["ARG001", "ARG002", "TID251"]
"libs/test_schedule_utils.py" = ["S110"]
"libs/test_email_i18n.py" = ["ANN401", "TID251"]
"models/test_dataset.py" = ["ARG005"]
"services/agent/test_observability_service.py" = ["ARG002", "ARG005"]
"services/agent/test_roster_service.py" = ["ARG001", "ARG002", "ARG003", "ARG005"]
"services/agent/test_prompt_mentions.py" = ["ARG005"]
"../helpers/unit/services/controller_api.py" = ["ARG002"]
"services/data_migration/test_import_service.py" = ["ARG002", "ARG005"]
"../helpers/unit/services/dataset_service_test_helpers.py" = ["TID251"]
"services/enterprise/test_account_deletion_sync.py" = ["ARG001"]
"services/enterprise/test_base.py" = ["ARG002"]
"../helpers/unit/services/hit_service.py" = ["TID251"]
"services/plugin/test_plugin_parameter_service.py" = ["ARG002"]
"services/rag_pipeline/pipeline_template/built_in/test_built_in_retrieval.py" = ["ARG001"]
"services/rag_pipeline/test_rag_pipeline_dsl_service.py" = ["ARG001", "ARG005", "T201", "TID251"]
"services/rag_pipeline/test_rag_pipeline.py" = ["ARG001", "ARG004", "ARG005"]
"services/rag_pipeline/test_rag_pipeline_task_proxy.py" = ["ARG001", "ARG002", "ARG004", "ARG005"]
"services/rag_pipeline/test_rag_pipeline_transform_service.py" = ["ARG001"]
"services/retention/workflow_run/test_archive_download_preparation.py" = ["ARG002"]
"services/retention/workflow_run/test_archive_log_service.py" = ["ARG001", "ARG002"]
"services/retention/workflow_run/test_bundle_archive_maintenance.py" = ["TID251"]
"services/retention/workflow_run/test_restore_archived_workflow_run.py" = ["ARG002"]
"services/test_annotation_service.py" = ["ANN401", "ARG002", "TID251"]
"services/test_api_token_service.py" = ["ARG002"]
"services/test_app_generate_service.py" = ["ARG001", "ARG002", "ARG004", "TID251"]
"services/test_audio_service.py" = ["ARG002", "TID251"]
"services/test_billing_service.py" = ["ARG001", "ARG002"]
"services/retention/workflow_run/test_clear_free_plan_expired_workflow_run_logs.py" = ["ANN401", "ARG002", "ARG005", "TID251"]
"services/test_clear_free_plan_tenant_expired_logs.py" = ["ARG002", "ARG003"]
"services/knowledge/test_dataset_service.py" = ["ARG002"]
"services/data_source/test_provider_service.py" = ["ARG002"]
"services/knowledge/external/test_service.py" = ["ARG002", "TID251"]
"services/test_human_input_delivery_test_service.py" = ["ARG005"]
"services/test_message_service.py" = ["ARG002"]
"services/retention/conversation/test_messages_clean_service.py" = ["TID251"]
"services/model_provider/test_service.py" = ["ANN401", "TID251"]
"services/test_operation_service.py" = ["TID251"]
"services/trigger/test_schedule_service.py" = ["ANN401", "TID251"]
"services/test_snippet_service.py" = ["ARG001", "ARG002"]
"services/knowledge/summaries/test_adapters.py" = ["ARG001"]
"services/test_variable_truncator.py" = ["ARG002", "TID251"]
"services/trigger/test_webhook_service.py" = ["ANN401", "ARG002", "TID251"]
"services/data_source/test_website_service.py" = ["TID251"]
"services/test_workflow_run_service.py" = ["ANN401", "ARG002", "TID251"]
"services/test_workflow_service.py" = ["ANN401", "ARG002", "TID251"]
"services/tools/test_builtin_tools_manage_service.py" = ["ARG001", "ARG002"]
"services/tools/test_tools_manage_service.py" = ["ARG002"]
"services/workflow/test_node_output_inspector_service.py" = ["TID251"]
"services/workflow/test_workflow_converter.py" = ["ANN401", "ARG001", "ARG005", "TID251"]
"services/test_workflow_event_snapshot_service.py" = ["ANN401", "ARG002", "ARG005", "TID251"]
"services/workflow/test_workflow_event_snapshot_service_additional.py" = ["ANN401", "ARG002", "ARG005", "TID251"]
"tasks/test_clean_dataset_task.py" = ["ARG002"]
"tasks/test_clean_document_task.py" = ["ARG002"]
"tasks/test_document_indexing_task.py" = ["ARG001", "ARG002"]
"tasks/test_document_indexing_sync_task.py" = ["ARG002"]
"tasks/test_human_input_timeout_tasks.py" = ["ARG001", "ARG002", "ARG005", "TID251"]
"tasks/test_initialize_created_app_rbac_access_task.py" = ["ARG005"]
"tasks/test_ops_trace_task.py" = ["ARG004"]
"tasks/test_process_tenant_plugin_autoupgrade_check_task.py" = ["ARG001"]
"tasks/test_remove_app_and_related_data_task.py" = ["ARG002"]
"tasks/app_generate/test_workflow_execute_task.py" = ["ARG005"]
"../e2e_tests/contracts/test_pytest_dify.py" = ["ARG001"]

[lint.flake8-tidy-imports.banned-api."flask_restx.reqparse"]
msg = "Use Pydantic payload/query models instead of reqparse."

[lint.flake8-tidy-imports.banned-api."flask_restx.reqparse.RequestParser"]
msg = "Use Pydantic payload/query models instead of reqparse."

[lint.flake8-tidy-imports.banned-api."typing.Any"]
msg = "Use object, Protocol, TypedDict, TypeVar, ParamSpec, or a localized cast instead."