langchain: Add ruff rules FBT (#31885)

cbornet · mdrxy · web-flow · commit ed35372580a8 · 2025-07-07T12:35:55.000-04:00
* Fixed for private functions and in tests * Added noqa escapes for public functions See https://docs.astral.sh/ruff/rules/#flake8-boolean-trap-fbt Co-authored-by: Mason Daugherty <mason@langchain.dev>
diff --git a/libs/langchain/langchain/agents/agent_toolkits/conversational_retrieval/openai_functions.py b/libs/langchain/langchain/agents/agent_toolkits/conversational_retrieval/openai_functions.py
@@ -27,10 +27,10 @@ def _get_default_system_message() -> SystemMessage:
 def create_conversational_retrieval_agent(
     llm: BaseLanguageModel,
     tools: list[BaseTool],
-    remember_intermediate_steps: bool = True,
+    remember_intermediate_steps: bool = True,  # noqa: FBT001,FBT002
     memory_key: str = "chat_history",
     system_message: Optional[SystemMessage] = None,
-    verbose: bool = False,
+    verbose: bool = False,  # noqa: FBT001,FBT002
     max_token_limit: int = 2000,
     **kwargs: Any,
 ) -> AgentExecutor:
diff --git a/libs/langchain/langchain/agents/agent_toolkits/vectorstore/base.py b/libs/langchain/langchain/agents/agent_toolkits/vectorstore/base.py
@@ -35,7 +35,7 @@ def create_vectorstore_agent(
     toolkit: VectorStoreToolkit,
     callback_manager: Optional[BaseCallbackManager] = None,
     prefix: str = PREFIX,
-    verbose: bool = False,
+    verbose: bool = False,  # noqa: FBT001,FBT002
     agent_executor_kwargs: Optional[dict[str, Any]] = None,
     **kwargs: Any,
 ) -> AgentExecutor:
@@ -128,7 +128,7 @@ def create_vectorstore_router_agent(
     toolkit: VectorStoreRouterToolkit,
     callback_manager: Optional[BaseCallbackManager] = None,
     prefix: str = ROUTER_PREFIX,
-    verbose: bool = False,
+    verbose: bool = False,  # noqa: FBT001,FBT002
     agent_executor_kwargs: Optional[dict[str, Any]] = None,
     **kwargs: Any,
 ) -> AgentExecutor:
diff --git a/libs/langchain/langchain/agents/json_chat/base.py b/libs/langchain/langchain/agents/json_chat/base.py
@@ -16,7 +16,7 @@ def create_json_chat_agent(
     llm: BaseLanguageModel,
     tools: Sequence[BaseTool],
     prompt: ChatPromptTemplate,
-    stop_sequence: Union[bool, list[str]] = True,
+    stop_sequence: Union[bool, list[str]] = True,  # noqa: FBT001,FBT002
     tools_renderer: ToolsRenderer = render_text_description,
     template_tool_response: str = TEMPLATE_TOOL_RESPONSE,
 ) -> Runnable:
diff --git a/libs/langchain/langchain/agents/openai_functions_agent/base.py b/libs/langchain/langchain/agents/openai_functions_agent/base.py
@@ -97,7 +97,7 @@ def plan(
         self,
         intermediate_steps: list[tuple[AgentAction, str]],
         callbacks: Callbacks = None,
-        with_functions: bool = True,
+        with_functions: bool = True,  # noqa: FBT001,FBT002
         **kwargs: Any,
     ) -> Union[AgentAction, AgentFinish]:
         """Given input, decided what to do.
diff --git a/libs/langchain/langchain/agents/openai_tools/base.py b/libs/langchain/langchain/agents/openai_tools/base.py
@@ -17,7 +17,7 @@ def create_openai_tools_agent(
     llm: BaseLanguageModel,
     tools: Sequence[BaseTool],
     prompt: ChatPromptTemplate,
-    strict: Optional[bool] = None,
+    strict: Optional[bool] = None,  # noqa: FBT001
 ) -> Runnable:
     """Create an agent that uses OpenAI tools.
 
diff --git a/libs/langchain/langchain/chains/base.py b/libs/langchain/langchain/chains/base.py
@@ -254,7 +254,10 @@ def raise_callback_manager_deprecation(cls, values: dict) -> Any:
 
     @field_validator("verbose", mode="before")
     @classmethod
-    def set_verbose(cls, verbose: Optional[bool]) -> bool:
+    def set_verbose(
+        cls,
+        verbose: Optional[bool],  # noqa: FBT001
+    ) -> bool:
         """Set the chain verbosity.
 
         Defaults to the global setting if not specified by the user.
@@ -353,7 +356,7 @@ async def _acall(
     def __call__(
         self,
         inputs: Union[dict[str, Any], Any],
-        return_only_outputs: bool = False,
+        return_only_outputs: bool = False,  # noqa: FBT001,FBT002
         callbacks: Callbacks = None,
         *,
         tags: Optional[list[str]] = None,
@@ -404,7 +407,7 @@ def __call__(
     async def acall(
         self,
         inputs: Union[dict[str, Any], Any],
-        return_only_outputs: bool = False,
+        return_only_outputs: bool = False,  # noqa: FBT001,FBT002
         callbacks: Callbacks = None,
         *,
         tags: Optional[list[str]] = None,
@@ -454,7 +457,7 @@ def prep_outputs(
         self,
         inputs: dict[str, str],
         outputs: dict[str, str],
-        return_only_outputs: bool = False,
+        return_only_outputs: bool = False,  # noqa: FBT001,FBT002
     ) -> dict[str, str]:
         """Validate and prepare chain outputs, and save info about this run to memory.
 
@@ -479,7 +482,7 @@ async def aprep_outputs(
         self,
         inputs: dict[str, str],
         outputs: dict[str, str],
-        return_only_outputs: bool = False,
+        return_only_outputs: bool = False,  # noqa: FBT001,FBT002
     ) -> dict[str, str]:
         """Validate and prepare chain outputs, and save info about this run to memory.
 
diff --git a/libs/langchain/langchain/chains/conversational_retrieval/base.py b/libs/langchain/langchain/chains/conversational_retrieval/base.py
@@ -420,7 +420,7 @@ def from_llm(
         retriever: BaseRetriever,
         condense_question_prompt: BasePromptTemplate = CONDENSE_QUESTION_PROMPT,
         chain_type: str = "stuff",
-        verbose: bool = False,
+        verbose: bool = False,  # noqa: FBT001,FBT002
         condense_question_llm: Optional[BaseLanguageModel] = None,
         combine_docs_chain_kwargs: Optional[dict] = None,
         callbacks: Callbacks = None,
diff --git a/libs/langchain/langchain/chains/llm_summarization_checker/base.py b/libs/langchain/langchain/chains/llm_summarization_checker/base.py
@@ -30,6 +30,7 @@ def _load_sequential_chain(
     check_assertions_prompt: PromptTemplate,
     revised_summary_prompt: PromptTemplate,
     are_all_true_prompt: PromptTemplate,
+    *,
     verbose: bool = False,
 ) -> SequentialChain:
     return SequentialChain(
@@ -188,7 +189,7 @@ def from_llm(
         check_assertions_prompt: PromptTemplate = CHECK_ASSERTIONS_PROMPT,
         revised_summary_prompt: PromptTemplate = REVISED_SUMMARY_PROMPT,
         are_all_true_prompt: PromptTemplate = ARE_ALL_TRUE_PROMPT,
-        verbose: bool = False,
+        verbose: bool = False,  # noqa: FBT001,FBT002
         **kwargs: Any,
     ) -> LLMSummarizationCheckerChain:
         chain = _load_sequential_chain(
diff --git a/libs/langchain/langchain/chains/openai_functions/extraction.py b/libs/langchain/langchain/chains/openai_functions/extraction.py
@@ -84,7 +84,7 @@ def create_extraction_chain(
     llm: BaseLanguageModel,
     prompt: Optional[BasePromptTemplate] = None,
     tags: Optional[list[str]] = None,
-    verbose: bool = False,
+    verbose: bool = False,  # noqa: FBT001,FBT002
 ) -> Chain:
     """Creates a chain that extracts information from a passage.
 
@@ -152,7 +152,7 @@ def create_extraction_chain_pydantic(
     pydantic_schema: Any,
     llm: BaseLanguageModel,
     prompt: Optional[BasePromptTemplate] = None,
-    verbose: bool = False,
+    verbose: bool = False,  # noqa: FBT001,FBT002
 ) -> Chain:
     """Creates a chain that extracts information from a passage using pydantic schema.
 
diff --git a/libs/langchain/langchain/chains/openai_functions/openapi.py b/libs/langchain/langchain/chains/openai_functions/openapi.py
@@ -23,14 +23,6 @@
     from openapi_pydantic import Parameter
 
 
-def _get_description(o: Any, prefer_short: bool) -> Optional[str]:
-    summary = getattr(o, "summary", None)
-    description = getattr(o, "description", None)
-    if prefer_short:
-        return summary or description
-    return description or summary
-
-
 def _format_url(url: str, path_params: dict) -> str:
     expected_path_param = re.findall(r"{(.*?)}", url)
     new_params = {}
@@ -260,7 +252,7 @@ def get_openapi_chain(
     prompt: Optional[BasePromptTemplate] = None,
     request_chain: Optional[Chain] = None,
     llm_chain_kwargs: Optional[dict] = None,
-    verbose: bool = False,
+    verbose: bool = False,  # noqa: FBT001,FBT002
     headers: Optional[dict] = None,
     params: Optional[dict] = None,
     **kwargs: Any,
diff --git a/libs/langchain/langchain/chains/openai_functions/qa_with_structure.py b/libs/langchain/langchain/chains/openai_functions/qa_with_structure.py
@@ -40,7 +40,7 @@ def create_qa_with_structure_chain(
     schema: Union[dict, type[BaseModel]],
     output_parser: str = "base",
     prompt: Optional[Union[PromptTemplate, ChatPromptTemplate]] = None,
-    verbose: bool = False,
+    verbose: bool = False,  # noqa: FBT001,FBT002
 ) -> LLMChain:
     """Create a question answering chain that returns an answer with sources
      based on schema.
@@ -119,7 +119,9 @@ def create_qa_with_structure_chain(
     ),
 )
 def create_qa_with_sources_chain(
-    llm: BaseLanguageModel, verbose: bool = False, **kwargs: Any
+    llm: BaseLanguageModel,
+    verbose: bool = False,  # noqa: FBT001,FBT002
+    **kwargs: Any,
 ) -> LLMChain:
     """Create a question answering chain that returns an answer with sources.
 
diff --git a/libs/langchain/langchain/chains/qa_with_sources/loading.py b/libs/langchain/langchain/chains/qa_with_sources/loading.py
@@ -37,6 +37,7 @@ def __call__(
 
 def _load_map_rerank_chain(
     llm: BaseLanguageModel,
+    *,
     prompt: BasePromptTemplate = MAP_RERANK_PROMPT,
     verbose: bool = False,
     document_variable_name: str = "context",
@@ -56,6 +57,7 @@ def _load_map_rerank_chain(
 
 def _load_stuff_chain(
     llm: BaseLanguageModel,
+    *,
     prompt: BasePromptTemplate = stuff_prompt.PROMPT,
     document_prompt: BasePromptTemplate = stuff_prompt.EXAMPLE_PROMPT,
     document_variable_name: str = "summaries",
@@ -74,6 +76,7 @@ def _load_stuff_chain(
 
 def _load_map_reduce_chain(
     llm: BaseLanguageModel,
+    *,
     question_prompt: BasePromptTemplate = map_reduce_prompt.QUESTION_PROMPT,
     combine_prompt: BasePromptTemplate = map_reduce_prompt.COMBINE_PROMPT,
     document_prompt: BasePromptTemplate = map_reduce_prompt.EXAMPLE_PROMPT,
@@ -131,6 +134,7 @@ def _load_map_reduce_chain(
 
 def _load_refine_chain(
     llm: BaseLanguageModel,
+    *,
     question_prompt: BasePromptTemplate = refine_prompts.DEFAULT_TEXT_QA_PROMPT,
     refine_prompt: BasePromptTemplate = refine_prompts.DEFAULT_REFINE_PROMPT,
     document_prompt: BasePromptTemplate = refine_prompts.EXAMPLE_PROMPT,
@@ -172,7 +176,7 @@ def _load_refine_chain(
 def load_qa_with_sources_chain(
     llm: BaseLanguageModel,
     chain_type: str = "stuff",
-    verbose: Optional[bool] = None,
+    verbose: Optional[bool] = None,  # noqa: FBT001
     **kwargs: Any,
 ) -> BaseCombineDocumentsChain:
     """Load a question answering with sources chain.
diff --git a/libs/langchain/langchain/chains/query_constructor/base.py b/libs/langchain/langchain/chains/query_constructor/base.py
@@ -72,7 +72,7 @@ def from_components(
         allowed_comparators: Optional[Sequence[Comparator]] = None,
         allowed_operators: Optional[Sequence[Operator]] = None,
         allowed_attributes: Optional[Sequence[str]] = None,
-        fix_invalid: bool = False,
+        fix_invalid: bool = False,  # noqa: FBT001,FBT002
     ) -> StructuredQueryOutputParser:
         """
         Create a structured query output parser from components.
@@ -269,7 +269,7 @@ def load_query_constructor_chain(
     examples: Optional[list] = None,
     allowed_comparators: Sequence[Comparator] = tuple(Comparator),
     allowed_operators: Sequence[Operator] = tuple(Operator),
-    enable_limit: bool = False,
+    enable_limit: bool = False,  # noqa: FBT001,FBT002
     schema_prompt: Optional[BasePromptTemplate] = None,
     **kwargs: Any,
 ) -> LLMChain:
diff --git a/libs/langchain/langchain/chains/question_answering/chain.py b/libs/langchain/langchain/chains/question_answering/chain.py
@@ -36,6 +36,7 @@ def __call__(
 
 def _load_map_rerank_chain(
     llm: BaseLanguageModel,
+    *,
     prompt: BasePromptTemplate = MAP_RERANK_PROMPT,
     verbose: bool = False,
     document_variable_name: str = "context",
@@ -65,6 +66,7 @@ def _load_map_rerank_chain(
 
 def _load_stuff_chain(
     llm: BaseLanguageModel,
+    *,
     prompt: Optional[BasePromptTemplate] = None,
     document_variable_name: str = "context",
     verbose: Optional[bool] = None,
@@ -93,6 +95,7 @@ def _load_stuff_chain(
 
 def _load_map_reduce_chain(
     llm: BaseLanguageModel,
+    *,
     question_prompt: Optional[BasePromptTemplate] = None,
     combine_prompt: Optional[BasePromptTemplate] = None,
     combine_document_variable_name: str = "summaries",
@@ -176,6 +179,7 @@ def _load_map_reduce_chain(
 
 def _load_refine_chain(
     llm: BaseLanguageModel,
+    *,
     question_prompt: Optional[BasePromptTemplate] = None,
     refine_prompt: Optional[BasePromptTemplate] = None,
     document_variable_name: str = "context_str",
@@ -236,7 +240,7 @@ def _load_refine_chain(
 def load_qa_chain(
     llm: BaseLanguageModel,
     chain_type: str = "stuff",
-    verbose: Optional[bool] = None,
+    verbose: Optional[bool] = None,  # noqa: FBT001
     callback_manager: Optional[BaseCallbackManager] = None,
     **kwargs: Any,
 ) -> BaseCombineDocumentsChain:
diff --git a/libs/langchain/langchain/chains/summarize/chain.py b/libs/langchain/langchain/chains/summarize/chain.py
@@ -27,6 +27,7 @@ def __call__(
 
 def _load_stuff_chain(
     llm: BaseLanguageModel,
+    *,
     prompt: BasePromptTemplate = stuff_prompt.PROMPT,
     document_variable_name: str = "text",
     verbose: Optional[bool] = None,
@@ -44,6 +45,7 @@ def _load_stuff_chain(
 
 def _load_map_reduce_chain(
     llm: BaseLanguageModel,
+    *,
     map_prompt: BasePromptTemplate = map_reduce_prompt.PROMPT,
     combine_prompt: BasePromptTemplate = map_reduce_prompt.PROMPT,
     combine_document_variable_name: str = "text",
@@ -54,7 +56,6 @@ def _load_map_reduce_chain(
     verbose: Optional[bool] = None,
     token_max: int = 3000,
     callbacks: Callbacks = None,
-    *,
     collapse_max_retries: Optional[int] = None,
     **kwargs: Any,
 ) -> MapReduceDocumentsChain:
@@ -117,6 +118,7 @@ def _load_map_reduce_chain(
 
 def _load_refine_chain(
     llm: BaseLanguageModel,
+    *,
     question_prompt: BasePromptTemplate = refine_prompts.PROMPT,
     refine_prompt: BasePromptTemplate = refine_prompts.REFINE_PROMPT,
     document_variable_name: str = "text",
@@ -141,7 +143,7 @@ def _load_refine_chain(
 def load_summarize_chain(
     llm: BaseLanguageModel,
     chain_type: str = "stuff",
-    verbose: Optional[bool] = None,
+    verbose: Optional[bool] = None,  # noqa: FBT001
     **kwargs: Any,
 ) -> BaseCombineDocumentsChain:
     """Load summarizing chain.
diff --git a/libs/langchain/langchain/evaluation/string_distance/base.py b/libs/langchain/langchain/evaluation/string_distance/base.py
@@ -106,7 +106,7 @@ def _prepare_output(self, result: dict[str, Any]) -> dict[str, Any]:
         return result
 
     @staticmethod
-    def _get_metric(distance: str, normalize_score: bool = False) -> Callable:
+    def _get_metric(distance: str, *, normalize_score: bool = False) -> Callable:
         """
         Get the distance metric function based on the distance type.
 
diff --git a/libs/langchain/langchain/globals.py b/libs/langchain/langchain/globals.py
@@ -16,7 +16,9 @@
 _llm_cache: Optional["BaseCache"] = None
 
 
-def set_verbose(value: bool) -> None:
+def set_verbose(
+    value: bool,  # noqa: FBT001
+) -> None:
     """Set a new value for the `verbose` global setting."""
     import langchain
 
@@ -71,7 +73,9 @@ def get_verbose() -> bool:
     return _verbose or old_verbose
 
 
-def set_debug(value: bool) -> None:
+def set_debug(
+    value: bool,  # noqa: FBT001
+) -> None:
     """Set a new value for the `debug` global setting."""
     import langchain
 
diff --git a/libs/langchain/langchain/output_parsers/structured.py b/libs/langchain/langchain/output_parsers/structured.py
@@ -43,7 +43,10 @@ def from_response_schemas(
     ) -> StructuredOutputParser:
         return cls(response_schemas=response_schemas)
 
-    def get_format_instructions(self, only_json: bool = False) -> str:
+    def get_format_instructions(
+        self,
+        only_json: bool = False,  # noqa: FBT001,FBT002
+    ) -> str:
         """Get format instructions for the output parser.
 
         example:
diff --git a/libs/langchain/langchain/retrievers/multi_query.py b/libs/langchain/langchain/retrievers/multi_query.py
@@ -66,7 +66,7 @@ def from_llm(
         llm: BaseLanguageModel,
         prompt: BasePromptTemplate = DEFAULT_QUERY_PROMPT,
         parser_key: Optional[str] = None,
-        include_original: bool = False,
+        include_original: bool = False,  # noqa: FBT001,FBT002
     ) -> "MultiQueryRetriever":
         """Initialize from llm using default template.
 
diff --git a/libs/langchain/langchain/retrievers/parent_document_retriever.py b/libs/langchain/langchain/retrievers/parent_document_retriever.py
diff --git a/libs/langchain/langchain/retrievers/self_query/base.py b/libs/langchain/langchain/retrievers/self_query/base.py
diff --git a/libs/langchain/langchain/smith/evaluation/runner_utils.py b/libs/langchain/langchain/smith/evaluation/runner_utils.py
diff --git a/libs/langchain/pyproject.toml b/libs/langchain/pyproject.toml
diff --git a/libs/langchain/tests/mock_servers/robot/server.py b/libs/langchain/tests/mock_servers/robot/server.py
diff --git a/libs/langchain/tests/unit_tests/chains/test_sequential.py b/libs/langchain/tests/unit_tests/chains/test_sequential.py
diff --git a/libs/langchain/tests/unit_tests/evaluation/string_distance/test_base.py b/libs/langchain/tests/unit_tests/evaluation/string_distance/test_base.py
diff --git a/libs/langchain/tests/unit_tests/indexes/test_indexing.py b/libs/langchain/tests/unit_tests/indexes/test_indexing.py
diff --git a/libs/langchain/tests/unit_tests/test_globals.py b/libs/langchain/tests/unit_tests/test_globals.py
