[ruff] Add pydocstyle check (mostly autofix)

Author: Pierre-Sassoulas

pyproject.toml

@@ -68,8 +68,10 @@ write_to = "pytest_asyncio/_version.py"
 
 [tool.ruff]
 line-length = 88
+format.docstring-code-format = true
 lint.select = [
   "B",      # bugbear
+  "D",      # pydocstyle
   "E",      # pycodestyle
   "F",      # pyflakes
   "PGH004", # pygrep-hooks - Use specific rule codes when using noqa
@@ -80,9 +82,28 @@ lint.select = [
   "UP",     # pyupgrade
   "W",      # pycodestyle
 ]
+
 lint.ignore = [
   # bugbear ignore
   "B028", # No explicit `stacklevel` keyword argument found
+  # pydocstyle ignore
+  "D100", # Missing docstring in public module
+  "D101", # Missing docstring in public class
+  "D102", # Missing docstring in public method
+  "D103", # Missing docstring in public function
+  "D104", # Missing docstring in public package
+  "D105", # Missing docstring in magic method
+  "D106", # Missing docstring in public nested class
+  "D107", # Missing docstring in `__init__`
+  "D203", # `one-blank-line-before-class` (D203) and `no-blank-line-before-class` (D211) are incompatible
+  "D205", # 1 blank line required between summary line and description
+  "D209", # [*] Multi-line docstring closing quotes should be on a separate line
+  "D212", # `multi-line-summary-first-line` (D212) and `multi-line-summary-second-line` (D213) are incompatible.
+  "D400", # First line should end with a period
+  "D401", # First line of docstring should be in imperative mood
+  "D402", # First line should not be the function's signature
+  "D404", # First word of the docstring should not be "This"
+  "D415", # First line should end with a period, question mark, or exclamation point
 ]
 
 [tool.pytest.ini_options]

pytest_asyncio/plugin.py

@@ -266,9 +266,7 @@ def _preprocess_async_fixtures(
 
 
 def _synchronize_async_fixture(fixturedef: FixtureDef) -> None:
-    """
-    Wraps the fixture function of an async fixture in a synchronous function.
-    """
+    """Wraps the fixture function of an async fixture in a synchronous function."""
     if inspect.isasyncgenfunction(fixturedef.func):
         _wrap_asyncgen_fixture(fixturedef)
     elif inspect.iscoroutinefunction(fixturedef.func):
@@ -908,9 +906,10 @@ def pytest_pyfunc_call(pyfuncitem: Function) -> Optional[object]:
 def wrap_in_sync(
     func: Callable[..., Awaitable[Any]],
 ):
-    """Return a sync wrapper around an async function executing it in the
-    current event loop."""
-
+    """
+    Return a sync wrapper around an async function executing it in the
+    current event loop.
+    """
     # if the function is already wrapped, we rewrap using the original one
     # not using __wrapped__ because the original function may already be
     # a wrapped one

tests/hypothesis/test_base.py

@@ -1,4 +1,5 @@
-"""Tests for the Hypothesis integration, which wraps async functions in a
+"""
+Tests for the Hypothesis integration, which wraps async functions in a
 sync shim for Hypothesis.
 """
 

tests/test_simple.py

@@ -75,8 +75,10 @@ class TestMarkerInClassBasedTests:
 
     @pytest.mark.asyncio
     async def test_asyncio_marker_with_implicit_loop_fixture(self):
-        """Test the "asyncio" marker works on a method in
-        a class-based test with implicit loop fixture."""
+        """
+        Test the "asyncio" marker works on a method in
+        a class-based test with implicit loop fixture.
+        """
         ret = await async_coro()
         assert ret == "ok"