feat(core): add ruff rules D to tests except D1 (#32000)

Docs are not required for tests but when there are docstrings, they
shall be correctly formatted.
See https://docs.astral.sh/ruff/rules/#pydocstyle-d

Author: cbornet

libs/core/pyproject.toml

@@ -124,5 +124,5 @@ asyncio_default_fixture_loop_scope = "function"
 [tool.ruff.lint.per-file-ignores]
 "langchain_core/utils/mustache.py" = [ "PLW0603",]
 "tests/unit_tests/test_tools.py" = [ "ARG",]
-"tests/**" = [ "D", "S", "SLF",]
+"tests/**" = [ "D1", "S", "SLF",]
 "scripts/**" = [ "INP", "S",]

libs/core/tests/unit_tests/embeddings/test_deterministic_embedding.py

@@ -2,7 +2,9 @@
 
 
 def test_deterministic_fake_embeddings() -> None:
-    """Test that the deterministic fake embeddings return the same
+    """Test that DeterministicFakeEmbedding is deterministic.
+
+    Test that the deterministic fake embeddings return the same
     embedding vector for the same text.
     """
     fake = DeterministicFakeEmbedding(size=10)

libs/core/tests/unit_tests/indexing/test_indexing.py

@@ -905,7 +905,7 @@ async def test_ascoped_full_fails_with_bad_source_ids(
 def test_index_empty_doc_scoped_full(
     record_manager: InMemoryRecordManager, vector_store: InMemoryVectorStore
 ) -> None:
-    """Test Indexing with scoped_full strategy"""
+    """Test Indexing with scoped_full strategy."""
     loader = ToyLoader(
         documents=[
             Document(
@@ -1927,7 +1927,6 @@ def test_incremental_cleanup_with_different_batchsize(
     record_manager: InMemoryRecordManager, vector_store: VectorStore
 ) -> None:
     """Check that we can clean up with different batch size."""
-
     docs = [
         Document(
             page_content="This is a test document.",

libs/core/tests/unit_tests/language_models/llms/test_base.py

@@ -99,7 +99,7 @@ async def test_async_batch_size() -> None:
 
 async def test_error_callback() -> None:
     class FailingLLMError(Exception):
-        """FailingLLMError"""
+        """FailingLLMError."""
 
     class FailingLLM(LLM):
         @property

libs/core/tests/unit_tests/output_parsers/test_list_parser.py

@@ -28,7 +28,9 @@ def test_single_item() -> None:
 
 
 def test_multiple_items_with_spaces() -> None:
-    """Test that a string with multiple comma-separated items
+    """Test multiple items with spaces.
+
+    Test that a string with multiple comma-separated items
     with spaces is parsed to a list.
     """
     parser = CommaSeparatedListOutputParser()
@@ -66,7 +68,9 @@ def test_multiple_items() -> None:
 
 
 def test_multiple_items_with_comma() -> None:
-    """Test that a string with multiple comma-separated items with 1 item containing a
+    """Test multiple items with a comma.
+
+    Test that a string with multiple comma-separated items with 1 item containing a
     comma is parsed to a list.
     """
     parser = CommaSeparatedListOutputParser()

libs/core/tests/unit_tests/prompts/test_prompt.py

@@ -361,8 +361,9 @@ def test_prompt_from_file() -> None:
 
 
 def test_prompt_from_file_with_partial_variables() -> None:
-    """Test prompt can be successfully constructed from a file
-    with partial variables.
+    """Test prompt from file with partial variables.
+
+    Test prompt can be successfully constructed from a file with partial variables.
     """
     # given
     template = "This is a {foo} test {bar}."

libs/core/tests/unit_tests/runnables/test_runnable.py

@@ -102,6 +102,7 @@
 
 class FakeTracer(BaseTracer):
     """Fake tracer that records LangChain execution.
+
     It replaces run ids with deterministic UUIDs for snapshotting.
     """
 
@@ -4867,7 +4868,9 @@ async def __call__(self, _: AsyncIterator[Any]) -> AsyncIterator[int]:
 
 
 def test_runnable_gen_context_config() -> None:
-    """Test that a generator can call other runnables with config
+    """Test generator runnable config propagation.
+
+    Test that a generator can call other runnables with config
     propagated from the context.
     """
     fake = RunnableLambda(len)
@@ -4942,9 +4945,11 @@ def gen(_: Iterator[Any]) -> Iterator[int]:
     "async tasks in a specific context",
 )
 async def test_runnable_gen_context_config_async() -> None:
-    """Test that a generator can call other runnables with config
-    propagated from the context."""
+    """Test generator runnable config propagation.
 
+    Test that a generator can call other runnables with config
+    propagated from the context.
+    """
     fake = RunnableLambda(len)
 
     async def agen(_: AsyncIterator[Any]) -> AsyncIterator[int]:
@@ -5010,7 +5015,9 @@ async def agen(_: AsyncIterator[Any]) -> AsyncIterator[int]:
 
 
 def test_runnable_iter_context_config() -> None:
-    """Test that a generator can call other runnables with config
+    """Test generator runnable config propagation.
+
+    Test that a generator can call other runnables with config
     propagated from the context.
     """
     fake = RunnableLambda(len)
@@ -5069,9 +5076,11 @@ def gen(value: str) -> Iterator[int]:
     "async tasks in a specific context",
 )
 async def test_runnable_iter_context_config_async() -> None:
-    """Test that a generator can call other runnables with config
-    propagated from the context."""
+    """Test generator runnable config propagation.
 
+    Test that a generator can call other runnables with config
+    propagated from the context.
+    """
     fake = RunnableLambda(len)
 
     @chain
@@ -5135,7 +5144,9 @@ async def agen(value: str) -> AsyncIterator[int]:
 
 
 def test_runnable_lambda_context_config() -> None:
-    """Test that a function can call other runnables with config
+    """Test function runnable config propagation.
+
+    Test that a function can call other runnables with config
     propagated from the context.
     """
     fake = RunnableLambda(len)
@@ -5192,9 +5203,11 @@ def fun(value: str) -> int:
     "async tasks in a specific context",
 )
 async def test_runnable_lambda_context_config_async() -> None:
-    """Test that a function can call other runnables with config
-    propagated from the context."""
+    """Test function runnable config propagation.
 
+    Test that a function can call other runnables with config
+    propagated from the context.
+    """
     fake = RunnableLambda(len)
 
     @chain
@@ -5295,7 +5308,9 @@ def test_with_config_callbacks() -> None:
 
 
 async def test_ainvoke_on_returned_runnable() -> None:
-    """Verify that a runnable returned by a sync runnable in the async path will
+    """Test ainvoke on a returned runnable.
+
+    Verify that a runnable returned by a sync runnable in the async path will
     be runthroughaasync path (issue #13407).
     """
 
@@ -5637,7 +5652,9 @@ class CustomChatModel(RunnableSerializable):
 
 
 def test_schema_for_prompt_and_chat_model() -> None:
-    """Testing that schema is generated properly when using variable names
+    """Test schema generation for prompt and chat model.
+
+    Testing that schema is generated properly when using variable names
     that collide with pydantic attributes.
     """
     prompt = ChatPromptTemplate([("system", "{model_json_schema}, {_private}, {json}")])

libs/core/tests/unit_tests/runnables/test_runnable_events_v2.py

@@ -2797,6 +2797,5 @@ async def foo(x: int) -> int:
 
 def test_default_is_v2() -> None:
     """Test that we default to version="v2"."""
-
     signature = inspect.signature(Runnable.astream_events)
     assert signature.parameters["version"].default == "v2"

libs/core/tests/unit_tests/test_messages.py

@@ -940,7 +940,7 @@ def test_tool_message_serdes() -> None:
 
 
 class BadObject:
-    """"""
+    pass
 
 
 def test_tool_message_ser_non_serializable() -> None:

libs/core/tests/unit_tests/test_pydantic_serde.py

@@ -1,4 +1,6 @@
-"""A set of tests that verifies that Union discrimination works correctly with
+"""Test pydantic SerDe.
+
+A set of tests that verifies that Union discrimination works correctly with
 the various pydantic base models.
 
 These tests can uncover issues that will also arise during regular instantiation