Backtestspydanticrun-20261005-183002#13802

Issue #13802 Merged fix PR #13821 Run 5 Oct 2026 · run-20261005-183002 pydantic/pydantic

Three error-reference examples no longer raise the error they document, and the docs test suite cannot detect it

Better

Our patch was judged better than the merged fix.

In this judgment, Patch A = our agent, Patch B = the merged fix.

Both patches make the same three documentation fixes. Each changes `Model(num=False)` to `Model(num='not a complex number')`, which still raises `complex_type`. Each deletes the `string_sub_type` section. Each replaces `ImportString` with a `Callable` annotation (`Callable[[], None]` in A, `Callable[..., object]` in B). Both annotations have no JSON schema, so `invalid-for-json-schema` is raised again. On the docs themselves, the two are equivalent.

The difference is the second half of the issue: the blind spot that let these examples silently stop raising.

Patch A addresses it directly. It adds an AST transformer that injects `raise AssertionError(...)` into the `else` clause of every `try` that has handlers, and a parametrized `test_error_examples_raise` that runs every example under `docs/errors`. Before the doc changes, this test would have failed on exactly the three broken examples, and it now guards against regressions like the `complex` constructor change. A also adds a small unit test showing the transformer catches both the non-raising and the raising case. To keep `test_validation_error_codes` consistent after removing the docs section, it excludes `string_sub_type` from the expected codes with a clear comment, which leaves the core error variant untouched. That is the conservative choice the issue explicitly left to maintainers.

Patch B adds no detection mechanism, so the root blind spot remains. It instead deletes the `StringSubType` variant from pydantic-core: the Rust enum, the message, the `ErrorType` Literal and the core test entry. That is a public API change, since users may reference the literal or construct `PydanticCustomError`/`PydanticKnownError` with it, and it is riskier than needed for a docs issue. B also edits `docs/concepts/experimental.md`, turning the partial-JSON input `'"12'` into `'"12"'`. That is unrelated to the issue and changes what the experimental partial-JSON example demonstrates, likely altering or breaking its documented output.

On correctness of the reported problem, testing and scope, A is clearly better.

The judge saw only the two patches, labelled A and B in random order, with issue links and version numbers removed. The reasoning above is shown verbatim.

Solve

9m 24s

Wall-clock time in the container

Full test suite

No new failures

12,879 passed · 546 skipped · 13,425 total

Contamination audit

Clean

No sign the agent saw the real fix

Patch size

113vs 39 merged

Changed lines, ours vs merged

Initial Checks

  • I confirm that I'm using Pydantic V2

Description

Three examples on the error-reference pages no longer raise the error they document, and the documentation test suite cannot detect it.

Every example on those pages has the same shape: do something that should fail, catch it, then print or assert the error code. The only assertion lives inside the except branch. When the operation stops failing, that branch never runs, so nothing is printed and no assert is evaluated. run_print_check compares printed output against the #> comments, and an example whose print never ran produces no output to disagree with, so the example exits 0 and CI stays green while the page documents behaviour that no longer exists.

I checked this exhaustively rather than by sampling. I injected a sentinel as the first statement of every except block on both error pages and ran each example. Of the 152 examples containing a try/except at v2.13.5, all 152 run, and exactly 3 never enter their except branch. On main the count is 3 of 157. None of the three is marked test="skip", so all three are executed by CI today.

1. complex_type, docs/errors/validation_errors.md

Model(num=False) now validates successfully to 0j, so the #> 'complex_type' line never prints. This changed in 2.13.0b1 with #12498, which made complex validation call the complex() constructor unconditionally in Python mode, and complex(False) is 0j.

2. string_sub_type, docs/errors/validation_errors.md

The section says a strict str field rejects an instance of a str subclass. It does not: the example returns a plain str with the value 'foo', and #> 'string_sub_type' never prints. pydantic_core 2.49.0 still declares the error ("Input should be a string, not an instance of a subclass of str"), but I could not find any str schema that raises it. Building core_schema.str_schema() directly with strict=True, without strict, and with strict=True plus a pattern all accept a str subclass and return a plain str.

This looks intentional rather than accidental. #6261 reported exactly this behaviour as a bug in June 2023, was labelled bug V2, and was closed with the conversation moved to pydantic-core#786. So the check appears to have been removed on purpose and this documentation section was left behind describing it.

3. invalid-for-json-schema, docs/errors/usage_errors.md

ImportString has had a JSON schema since 2.8.0 via #9344, so Model.model_json_schema() succeeds and returns a plain string schema. The assert exc_info.code == 'invalid-for-json-schema' inside the except block has not executed since that release.

Output of the example code below

Identical on 2.13.5 and on main at 2.14.0b2:

1. no exception; num = 0j
2. no exception; accepted 'foo'
3. no exception; {'properties': {'a': {'title': 'A', 'type': 'string'}}, 'required': ['a'], 'title': 'ImportStringModel', 'type': 'object'}

Suggested fixes

  1. complex_type is a one-word fix. Model(num='not a complex number') still raises complex_type, and so do [], {} and a bare object(). Replacing False with any of those restores the example.
  2. string_sub_type needs a decision rather than a fix, which is the main reason I am opening an issue instead of sending a patch. Given the trail through #6261, the section probably wants deleting rather than repairing, and possibly the error variant too, but that is your call.
  3. invalid-for-json-schema needs a type that genuinely has no JSON schema, in place of ImportString.

Separately, the blind spot itself is fixable. If an example on these pages had to demonstrate that the error occurred, for instance by printing inside the except and also failing loudly when nothing was raised, then a future change like #12498 would turn the docs red instead of silently making a section untrue. I am happy to send a PR for any or all of this, including that check as a test, if you tell me which direction you prefer.

I used AI assistance to run this audit, in line with your AI policy. I have reproduced and understood each of the three cases myself and can explain any of them.

Example Code

from enum import Enum

from pydantic import (
    BaseModel,
    Field,
    ImportString,
    PydanticUserError,
    ValidationError,
)

# 1. validation_errors.md, `complex_type`: documented to print 'complex_type'
class ComplexModel(BaseModel):
    num: complex

try:
    ComplexModel(num=False)
    print('1. no exception; num =', ComplexModel(num=False).num)
except ValidationError as exc:
    print('1.', repr(exc.errors()[0]['type']))

# 2. validation_errors.md, `string_sub_type`: documented to print 'string_sub_type'
class MyEnum(str, Enum):
    foo = 'foo'

class StrictStrModel(BaseModel):
    x: str = Field(strict=True)

try:
    print('2. no exception; accepted', repr(StrictStrModel(x=MyEnum.foo).x))
except ValidationError as exc:
    print('2.', repr(exc.errors()[0]['type']))

# 3. usage_errors.md, `invalid-for-json-schema`: the assert is never reached
class ImportStringModel(BaseModel):
    a: ImportString

try:
    print('3. no exception;', ImportStringModel.model_json_schema())
except PydanticUserError as exc:
    print('3.', exc.code)

Python, Pydantic & OS Version

pydantic version: 2.13.5
        pydantic-core version: 2.46.5
        python version: 3.12.10 (CPython)
        platform: Windows 11

also reproduced against main at pydantic 2.14.0b2 / pydantic-core 2.49.0

The two patches

Our patch+85 −28
docs/errors/usage_errors.mdindex 7e28e9f8..2f36e3a8 100644@@ -620,11 +620,13 @@ type C = B This error is raised when Pydantic fails to generate a JSON schema for some `CoreSchema`.  ```python-from pydantic import BaseModel, ImportString, PydanticUserError+from collections.abc import Callable++from pydantic import BaseModel, PydanticUserError   class Model(BaseModel):-    a: ImportString+    a: Callable[[], None]   try:docs/errors/validation_errors.mdindex 71d3a929..95e240e7 100644@@ -233,7 +233,7 @@ class Model(BaseModel):   try:-    Model(num=False)+    Model(num='not a complex number') except ValidationError as exc:     print(repr(exc.errors()[0]['type']))     #> 'complex_type'@@ -1845,31 +1845,6 @@ except ValidationError as exc:     #> 'string_pattern_mismatch' ``` -## `string_sub_type`--This error is raised when the value is an instance of a strict subtype of `str` when the field is strict:--```python-from enum import Enum--from pydantic import BaseModel, Field, ValidationError---class MyEnum(str, Enum):-    foo = 'foo'---class Model(BaseModel):-    x: str = Field(strict=True)---try:-    Model(x=MyEnum.foo)-except ValidationError as exc:-    print(repr(exc.errors()[0]['type']))-    #> 'string_sub_type'-```- ## `string_too_long`  This error is raised when the input value is a string whose length is greater than the field's `max_length` constraint:tests/test_docs.pyindex 7c185657..67227a04 100644@@ -1,10 +1,14 @@ from __future__ import annotations as _annotations +import ast+import contextlib+import io import os import platform import re import subprocess import sys+import types from datetime import datetime from pathlib import Path from tempfile import NamedTemporaryFile@@ -249,6 +253,81 @@ def test_docs_devtools_example(example: CodeExample, eval_example: EvalExample,         assert output_html == output_file.read_text()  +class _RequireExceptionTransformer(ast.NodeTransformer):+    """Make every `try` statement fail loudly when its body completes without raising.++    Examples on the error pages demonstrate an error by triggering it inside `try` and checking it in an `except`+    branch. If the operation stops raising, the `except` branch never runs and the example would silently pass, so+    an `AssertionError` is raised at the start of the `else` clause instead.+    """++    def __init__(self, line_offset: int) -> None:+        self.line_offset = line_offset++    def visit_Try(self, node: ast.Try) -> ast.Try:+        self.generic_visit(node)+        if node.handlers:+            line = node.lineno + self.line_offset+            raise_stmt = ast.parse(+                f'raise AssertionError({f"try block at line {line} completed without raising an exception"!r})'+            ).body[0]+            for child in ast.walk(raise_stmt):+                ast.copy_location(child, node)+            node.orelse = [raise_stmt, *node.orelse]+        return node++    visit_TryStar = visit_Try+++def run_requiring_exceptions(source: str, filename: str, module_name: str, line_offset: int = 0) -> None:+    """Execute `source` as a module, failing if any `try` statement with `except` handlers does not raise."""+    tree = _RequireExceptionTransformer(line_offset).visit(ast.parse(source, filename=filename))+    code = compile(ast.fix_missing_locations(tree), filename, 'exec', dont_inherit=True)+    module = types.ModuleType(module_name)+    module.__file__ = filename+    sys.modules[module_name] = module+    try:+        with contextlib.redirect_stdout(io.StringIO()):+            exec(code, module.__dict__)+    finally:+        del sys.modules[module_name]+++def test_require_exception_transformer_detects_non_raising_try():+    source = 'try:\n    x = 1\nexcept ValueError:\n    print("not reached")\n'+    with pytest.raises(AssertionError, match='try block at line 11 completed without raising an exception'):+        run_requiring_exceptions(source, '<test>', '_docs_require_exception_check', line_offset=10)++    raising_source = 'try:\n    int("x")\nexcept ValueError:\n    print("reached")\n'+    run_requiring_exceptions(raising_source, '<test>', '_docs_require_exception_check')+++@pytest.mark.thread_unsafe+@pytest.mark.skipif(bool(skip_reason), reason=skip_reason or 'not skipping')+@pytest.mark.parametrize(+    'example', list(find_examples(str(DOCS_ROOT / 'errors'), skip=sys.platform == 'win32')), ids=str+)+def test_error_examples_raise(example: CodeExample):+    """Every `try` in an error page example must actually raise, otherwise the documented error is not demonstrated."""+    prefix_settings = example.prefix_settings()+    if prefix_settings.get('test', '').startswith('skip'):+        pytest.skip('running code skipped')+    requires_settings = prefix_settings.get('requires')+    if requires_settings:+        major, minor = map(int, requires_settings.split('.'))+        if sys.version_info < (major, minor):+            pytest.skip(f'requires python {requires_settings}')+    if 'try:' not in example.source:+        pytest.skip('no try statement')++    run_requiring_exceptions(+        example.source,+        str(example.path),+        f'_docs_error_example_{example.start_line}',+        line_offset=example.start_line,+    )++ def test_error_codes():     error_text = (DOCS_ROOT / 'errors/usage_errors.md').read_text() @@ -265,6 +344,7 @@ def test_validation_error_codes():     expected_validation_error_codes = set(core_schema.ErrorType.__args__)     # Remove codes that are not currently accessible from pydantic:     expected_validation_error_codes.remove('timezone_offset')  # not currently exposed for configuration in pydantic+    expected_validation_error_codes.remove('string_sub_type')  # declared by pydantic-core but never raised      test_failures = []  
Merged fix · PR #13821+6 −33
docs/concepts/experimental.mdindex cc349f3a0..ab1665260 100644@@ -342,7 +342,7 @@ class MyModel(BaseModel): ta = TypeAdapter(MyModel) try:     v = ta.validate_json(-        '{"a": 1, "b": ["12345", "12', experimental_allow_partial=True+        '{"a": 1, "b": ["12345", "12"', experimental_allow_partial=True     ) except ValidationError as e:     print(e)docs/errors/usage_errors.mdindex 7e28e9f82..3e6a67412 100644@@ -620,11 +620,13 @@ type C = B This error is raised when Pydantic fails to generate a JSON schema for some `CoreSchema`.  ```python-from pydantic import BaseModel, ImportString, PydanticUserError+from collections.abc import Callable++from pydantic import BaseModel, PydanticUserError   class Model(BaseModel):-    a: ImportString+    a: Callable[..., object]   try:docs/errors/validation_errors.mdindex 71d3a9292..95e240e70 100644@@ -233,7 +233,7 @@ class Model(BaseModel):   try:-    Model(num=False)+    Model(num='not a complex number') except ValidationError as exc:     print(repr(exc.errors()[0]['type']))     #> 'complex_type'@@ -1845,31 +1845,6 @@ except ValidationError as exc:     #> 'string_pattern_mismatch' ``` -## `string_sub_type`--This error is raised when the value is an instance of a strict subtype of `str` when the field is strict:--```python-from enum import Enum--from pydantic import BaseModel, Field, ValidationError---class MyEnum(str, Enum):-    foo = 'foo'---class Model(BaseModel):-    x: str = Field(strict=True)---try:-    Model(x=MyEnum.foo)-except ValidationError as exc:-    print(repr(exc.errors()[0]['type']))-    #> 'string_sub_type'-```- ## `string_too_long`  This error is raised when the input value is a string whose length is greater than the field's `max_length` constraint:pydantic-core/python/pydantic_core/core_schema.pyindex b6fce060b..fda0e35ee 100644@@ -4776,7 +4776,6 @@ ErrorType: TypeAlias = Literal[     'iterable_type',     'iteration_error',     'string_type',-    'string_sub_type',     'string_unicode',     'string_too_short',     'string_too_long',pydantic-core/src/errors/types.rsindex 4bdb92135..f49f48509 100644@@ -247,7 +247,6 @@ error_types! {     // ---------------------     // string errors     StringType {},-    StringSubType {},     StringUnicode {},     StringTooShort {         min_length: {ctx_type: usize, ctx_fn: field_from_context},@@ -533,7 +532,6 @@ impl ErrorType {             Self::IterableType { .. } => "Input should be iterable",             Self::IterationError { .. } => "Error iterating over object, error: {error}",             Self::StringType { .. } => "Input should be a valid string",-            Self::StringSubType { .. } => "Input should be a string, not an instance of a subclass of str",             Self::StringUnicode { .. } => {                 "Input should be a valid string, unable to parse raw data as a unicode string"             }pydantic-core/tests/test_errors.pyindex 66f15d81a..b024e618b 100644@@ -303,7 +303,6 @@ all_errors = [         {'field_type': 'Foobar', 'max_length': 42, 'actual_length': 50},     ),     ('string_type', 'Input should be a valid string', None),-    ('string_sub_type', 'Input should be a string, not an instance of a subclass of str', None),     ('string_unicode', 'Input should be a valid string, unable to parse raw data as a unicode string', None),     ('string_pattern_mismatch', "String should match pattern 'foo'", {'pattern': 'foo'}),     ('string_not_ascii', 'String should contain only ASCII characters', None),