Backtestspydanticrun-20261007-130130#13802
Three error-reference examples no longer raise the error they document, and the docs test suite cannot detect it
Our patch was judged better than the merged fix.
In this judgment, Patch A = our agent, Patch B = the merged fix.
Both patches fix the three broken examples the same way. They swap `complex_type` to a string input, delete the `string_sub_type` section, and replace `ImportString` with `Callable` (A uses bare `Callable`, B uses `Callable[..., object]`; both lack a JSON schema). Both also fix the broken partial-JSON example in experimental.md.
The difference is the issue's second ask: closing the blind spot. Patch A adds `test_examples_try_blocks_raise` to `tests/test_docs.py`. It rewrites each top-level try/except in the doc examples via the AST so that an `else` branch raises `AssertionError`. It then runs every example containing `except`, skipping ones marked skip, xfail, grouped or Python-version-gated. This test would fail on the original docs and pass after the fix, so it is a real regression guard. It also surfaced a further silently-wrong example in types.md, where `@dataclass` on `Owner` made the documented `model_type` errors never occur and the shown output was stale. A fixes that and corrects the printed output. A keeps the `string_sub_type` error variant and simply excludes it from `test_validation_error_codes`, with a comment pointing at the rationale. That is a low-risk choice.
Patch B adds no detection mechanism, so a future change like #12498 would again pass CI silently. Its only test change deletes a line. B also removes the `StringSubType` variant from pydantic-core's Rust enum and from the public `ErrorType` Literal. That is a public-API breaking change: code constructing `PydanticKnownError('string_sub_type')` or matching on it would break. The issue explicitly left this as the maintainers' call, so B adds risk without the corresponding test benefit.
A is better on tests and lower-risk on scope.
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
19m 8s
Wall-clock time in the container
Full test suite
No new failures
12,993 passed · 533 skipped · 13,526 total
Contamination audit
Clean
No sign the agent saw the real fix
Patch size
116vs 39 merged
Changed lines, ours vs merged
The issue
View on GitHubInitial 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
complex_typeis a one-word fix.Model(num='not a complex number')still raisescomplex_type, and so do[],{}and a bareobject(). ReplacingFalsewith any of those restores the example.string_sub_typeneeds 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.invalid-for-json-schemaneeds a type that genuinely has no JSON schema, in place ofImportString.
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.0The two patches
docs/concepts/experimental.mdindex cc349f3a..ab166526 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/concepts/types.mdindex a544c317..522fb130 100644@@ -743,7 +743,6 @@ schema for that generic parameter, not one that is influenced by the current con This is less important for custom types, but crucial for annotated metadata that modifies schema building. ```python-from dataclasses import dataclass from typing import Any, Generic, TypeVar, get_args, get_origin from pydantic_core import CoreSchema, core_schema@@ -759,10 +758,13 @@ ItemType = TypeVar('ItemType') # This is not a pydantic model, it's an arbitrary generic class-@dataclass class Owner(Generic[ItemType]):- name: str- item: ItemType+ def __init__(self, name: str, item: ItemType) -> None:+ self.name = name+ self.item = item++ def __repr__(self) -> str:+ return f'Owner(name={self.name!r}, item={self.item!r})' @classmethod def __get_pydantic_core_schema__(@@ -854,10 +856,10 @@ except ValidationError as e: print(e) """ 2 validation errors for Model- wine- Input should be a valid number, unable to parse string as a number [type=float_parsing, input_value='Kinda good', input_type=str]- cheese- Input should be a valid boolean, unable to interpret input [type=bool_parsing, input_value='yeah', input_type=str]+ car_owner+ Input should be a valid dictionary or instance of Car [type=model_type, input_value=House(rooms=3), input_type=House]+ home_owner+ Input should be a valid dictionary or instance of House [type=model_type, input_value=Car(color='black'), input_type=Car] """ # Similarly with JSONdocs/errors/usage_errors.mdindex 7e28e9f8..48403726 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 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..26f29391 100644@@ -1,5 +1,6 @@ from __future__ import annotations as _annotations +import ast import os import platform import re@@ -8,6 +9,7 @@ import sys from datetime import datetime from pathlib import Path from tempfile import NamedTemporaryFile+from types import ModuleType from typing import Any import pytest@@ -207,6 +209,65 @@ def test_docs_examples(example: CodeExample, eval_example: EvalExample, tmp_path run_example(example, eval_example, mocker) +def require_try_blocks_to_raise(source: str, filename: str) -> Any:+ """Compile `source`, adding an `else` branch that fails to every top-level `try`/`except` statement.++ Examples demonstrating an error only check it inside their `except` branch, so if the+ `try` body stops raising, nothing is printed or asserted and the example silently passes.+ """+ tree = ast.parse(source, filename)+ try_types = (ast.Try, ast.TryStar) if sys.version_info >= (3, 11) else (ast.Try,)+ for node in tree.body:+ if isinstance(node, try_types) and node.handlers and not node.orelse:+ message = f'line {node.lineno}: the `try` block did not raise, so its `except` branch never ran'+ raise_stmt = ast.parse(f'raise AssertionError({message!r})').body[0]+ ast.increment_lineno(raise_stmt, node.body[-1].end_lineno - 1)+ node.orelse = [raise_stmt]+ # `dont_inherit` avoids leaking this module's `from __future__ import annotations` into the example:+ return compile(tree, filename, 'exec', dont_inherit=True)+++def try_except_examples(path: Path) -> list[CodeExample]:+ return [+ example+ for example in find_examples(str(path), skip=sys.platform == 'win32')+ if 'except' in example.source and not str(example.path).startswith(str(SOURCES_ROOT / 'v1'))+ ]+++@pytest.mark.thread_unsafe+@pytest.mark.filterwarnings('ignore:(parse_obj_as|schema_json_of|schema_of) is deprecated.*:DeprecationWarning')+@pytest.mark.skipif(bool(skip_reason), reason=skip_reason or 'not skipping')+@pytest.mark.parametrize('example', try_except_examples(DOCS_ROOT) + try_except_examples(SOURCES_ROOT), ids=str)+def test_examples_try_blocks_raise(example: CodeExample, mocker):+ prefix_settings = example.prefix_settings()+ test_settings = prefix_settings.get('test', '')+ if test_settings.startswith(('skip', 'xfail')):+ pytest.skip('running code skipped or expected to fail')+ if prefix_settings.get('group'):+ pytest.skip('grouped examples depend on the globals of earlier examples')+ 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}')++ code = require_try_blocks_to_raise(example.source, str(example.path))++ # Run the example as a real module, so that Pydantic can resolve forward references against its namespace:+ # (only this key is removed afterwards: restoring the whole of `sys.modules` would drop modules lazily+ # imported by the example, and re-importing them later creates duplicate classes)+ module = ModuleType(example.module_name)+ module.__file__ = str(example.path)+ mocker.patch('random.randint', return_value=3)+ sys.modules[example.module_name] = module+ try:+ with time_machine.travel(datetime(2032, 1, 2, 3, 4, 5, 6).astimezone(), tick=False):+ exec(code, module.__dict__)+ finally:+ del sys.modules[example.module_name]++ @pytest.mark.thread_unsafe @pytest.mark.skipif(bool(skip_reason), reason=skip_reason or 'not skipping') @pytest.mark.skipif(sys.version_info >= (3, 13), reason='python-devtools does not yet support python 3.13')@@ -265,6 +326,8 @@ 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+ # never raised: `str` validation accepts instances of `str` subclasses, even in strict mode (see #6261)+ expected_validation_error_codes.remove('string_sub_type') test_failures = []
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),