chore(dev-deps): add blackdoc for docstring code formatting

.pre-commit-config.yaml

@@ -24,6 +24,11 @@ repos:
     rev: 23.9.1
     hooks:
       - id: black
+  - repo: https://github.com/keewis/blackdoc
+    rev: v0.3.8
+    hooks:
+      - id: blackdoc
+        exclude: ibis/examples/__init__\.py
   - repo: https://github.com/codespell-project/codespell
     rev: v2.2.5
     hooks:

docs/_renderer.py

@@ -44,7 +44,9 @@ def render(self, el: qd.ast.ExampleCode) -> str:
 
                 # if we expect failures, don't fail the notebook execution and
                 # render the error message
-                if expect_failure in first:
+                if expect_failure in first or any(
+                    expect_failure in line for line in rest
+                ):
                     assert (
                         start and end
                     ), "expected failure should never occur alongside a skipped doctest example"

justfile

@@ -25,6 +25,7 @@ lock:
 # format code
 fmt:
     black .
+    blackdoc .
     ruff --fix .
 
 # run all non-backend tests; additional arguments are forwarded to pytest

pyproject.toml

@@ -98,6 +98,7 @@ trino = { version = ">=0.321,<1", optional = true, extras = ["sqlalchemy"] }
 
 [tool.poetry.group.dev.dependencies]
 black = ">=22.1.0,<24"
+blackdoc = ">=0.3.8,<1"
 codespell = { version = ">=2.2.4,<3", extras = [
   "hard-encoding-detection",
   "toml",
@@ -477,6 +478,9 @@ required-imports = ["from __future__ import annotations"]
 "docs/*.py" = ["INP001"]
 "ci/release/verify_release.py" = ["T201"] # CLI tool that prints stuff
 
+[tool.blackdoc]
+extend_exclude = 'ibis/examples/__init__\.py'
+
 [tool.black]
 line_length = 88
 extend_exclude = '\.direnv|result(-\d+)|_py310\.py|decompiled\.py'

requirements-dev.txt

@@ -13,6 +13,7 @@ beartype==0.15.0 ; python_version >= "3.10" and python_version < "4.0"
 bidict==0.22.1 ; python_version >= "3.9" and python_version < "4.0"
 bitarray==2.8.1 ; python_version >= "3.9" and python_version < "4.0"
 black==23.9.1 ; python_version >= "3.9" and python_version < "4.0"
+blackdoc==0.3.8 ; python_version >= "3.9" and python_version < "4.0"
 cachetools==5.3.1 ; python_version >= "3.9" and python_version < "4.0"
 certifi==2023.7.22 ; python_version >= "3.9" and python_version < "4.0"
 cffi==1.15.1 ; python_version >= "3.9" and python_version < "4.0"
@@ -95,6 +96,7 @@ matplotlib-inline==0.1.6 ; python_version >= "3.9" and python_version < "4.0"
 matplotlib==3.7.2 ; python_version >= "3.10" and python_version < "4.0"
 mdurl==0.1.2 ; python_version >= "3.9" and python_version < "4.0"
 mizani==0.9.2 ; python_version >= "3.10" and python_version < "4.0"
+more-itertools==10.1.0 ; python_version >= "3.9" and python_version < "4.0"
 multidict==6.0.4 ; python_version >= "3.9" and python_version < "4.0"
 multipledispatch==1.0.0 ; python_version >= "3.9" and python_version < "4.0"
 mypy-extensions==1.0.0 ; python_version >= "3.9" and python_version < "4.0"
@@ -200,7 +202,7 @@ tenacity==8.2.3 ; python_version >= "3.10" and python_version < "4.0"
 threadpoolctl==3.2.0 ; python_version >= "3.10" and python_version < "4.0"
 thrift-sasl==0.4.3 ; python_version >= "3.9" and python_version < "4.0"
 thrift==0.16.0 ; python_version >= "3.9" and python_version < "4.0"
-tomli==2.0.1 ; python_version >= "3.9" and python_full_version <= "3.11.0a6"
+tomli==2.0.1 ; python_version >= "3.9" and python_version < "4.0"
 tomlkit==0.12.1 ; python_version >= "3.9" and python_version < "4.0"
 toolz==0.12.0 ; python_version >= "3.9" and python_version < "4.0"
 tornado==6.3.3 ; python_version >= "3.10" and python_version < "4.0"