Backtestspydanticrun-20261009-110034#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 make the same three doc repairs. Each replaces `Model(num=False)` with input that still raises `complex_type` (`[]` in A, a string in B). Each swaps `ImportString` for a `Callable`, which really has no JSON schema. Each deletes the stale `string_sub_type` section. The issue names two root causes: the stale examples and the docs test suite's blind spot. Patch A addresses the blind spot. It adds `test_error_docs_examples_raise`, which rewrites every `try`/`except` in the error docs to record entry into the `except` branch. The test fails if any `try` never enters a handler. It would have caught all three regressions before this change, and it guards against future ones like the `complex` behaviour change. Patch A also updates `test_validation_error_codes` so it no longer expects a `string_sub_type` doc section, with a comment explaining why. Patch B adds no test for the blind spot. Its only test change removes a line from pydantic-core's error tests. Instead it deletes the `StringSubType` variant from pydantic-core: the Rust enum, its message, and the public `ErrorType` Literal. That is a public API change in core, which the issue explicitly left to the maintainers to decide. It adds risk to users who reference that error type, and it is beyond what was asked. Patch B also edits `docs/concepts/experimental.md`, changing the partial-JSON input. That change is unrelated to the issue and may alter that example's documented output. On correctness of the root cause, on tests, and on scope and risk, Patch A is clearly stronger.
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 34s
Wall-clock time in the container
Full test suite
No new failures
12,878 passed · 545 skipped · 13,423 total
Contamination audit
Clean
No sign the agent saw the real fix
Patch size
95vs 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/errors/usage_errors.mdindex 7e28e9f8..c1b8d767 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[[int], int] try:docs/errors/validation_errors.mdindex 71d3a929..defd987d 100644@@ -233,7 +233,7 @@ class Model(BaseModel): try:- Model(num=False)+ Model(num=[]) 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..4d552d86 100644@@ -1,5 +1,7 @@ from __future__ import annotations as _annotations +import ast+import dataclasses import os import platform import re@@ -265,6 +267,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') # not raised by any pydantic-core validator test_failures = [] @@ -291,3 +294,62 @@ def test_validation_error_codes(): code_validation_error_codes = sorted(expected_validation_error_codes) assert code_validation_error_codes == documented_validation_error_codes, 'Error codes in code and docs do not match'+++ERROR_DOCS = (+ DOCS_ROOT / 'errors/errors.md',+ DOCS_ROOT / 'errors/usage_errors.md',+ DOCS_ROOT / 'errors/validation_errors.md',+)+_TRY_NODES = (ast.Try, ast.TryStar) if sys.version_info >= (3, 11) else (ast.Try,)+++class _RecordHandlerEntries(ast.NodeTransformer):+ """Insert a `__record_handler__(<try line>)` call as the first statement of every `except` handler."""++ def __init__(self) -> None:+ self.try_lines: list[int] = []++ def generic_visit(self, node: ast.AST) -> ast.AST:+ node = super().generic_visit(node)+ if isinstance(node, _TRY_NODES) and node.handlers:+ self.try_lines.append(node.lineno)+ for handler in node.handlers:+ record = ast.parse(f'__record_handler__({node.lineno})').body[0]+ handler.body.insert(0, record)+ return node+++@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', list(find_examples(*map(str, ERROR_DOCS), skip=sys.platform == 'win32')), ids=str)+def test_error_docs_examples_raise(example: CodeExample, eval_example: EvalExample):+ """Every `try`/`except` in the error reference examples must actually enter an `except` branch.++ The examples only print or assert the error code inside the `except` branch, so if the+ documented operation stops raising, `test_docs_examples` would still pass.+ """+ 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}')++ transformer = _RecordHandlerEntries()+ tree = ast.fix_missing_locations(transformer.visit(ast.parse(example.source)))+ if not transformer.try_lines:+ pytest.skip('no try/except in example')++ entered: set[int] = set()+ instrumented = dataclasses.replace(example, source=ast.unparse(tree))+ eval_example.run(instrumented, module_globals={'__record_handler__': entered.add})++ not_entered = sorted(set(transformer.try_lines) - entered)+ assert not not_entered, (+ f'`try` statement(s) at example line(s) {not_entered} never entered an `except` branch: '+ 'the documented error is no longer raised'+ )
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),