Backtestspydanticrun-20260923-170312#13660

Issue #13660 Merged fix PR # Run 23 Sep 2026 · run-20260923-170312 pydantic/pydantic

None is not treated as Literal[None] when annotating the discriminator in discriminated unions.

Worse

The merged fix was judged better than our patch.

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

Both patches correctly identify the root cause: `_infer_discriminator_values_for_inner_schema` never handled the `{'type': 'none'}` core schema produced by a bare `None` annotation, and both add the `[None]` branch that resolves the reported validation error. The decisive difference is completeness of the fix. When the discriminator value is `None`, JSON-schema generation in `json_schema.py` runs the key through `str(k)`, yielding the mapping key `'None'` — which does not match the serialized JSON payload (`null`). Patch A leaves this wrong: it fixes validation but silently produces an invalid discriminator mapping for the exact feature it enables, and its test only exercises validation, never `model_json_schema()`, so it never catches this. Patch B adds the `elif k is None: k = 'null'` branch and includes a test asserting the mapping is `{'A': ..., 'null': ...}` plus round-trip validation of both branches — genuinely fail-before/pass-after coverage of both dimensions. Patch A is markedly tighter in scope (4 lines) and B carries real costs against it: a wholesale rewrite of the if/elif chain into a `match` statement (unrequested churn), widening `list[str | int]`→`list[Any]` and `Hashable`→`Any` in core_schema.py (largely gratuitous, since `None` is itself hashable), and weakening the existing `test_bool_discriminated_union` to assert only a subset — a coverage regression. These are meaningful marks against B on scope and craft. But correctness is the first criterion, and A ships a subtly incorrect JSON schema for the feature it introduces while B handles the feature end-to-end and proves it. That correctness edge outweighs B's scope churn. Narrow call.

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

10m 29s8 turns

Wall-clock time in the container

Full test suite

No new failures

6,567 passed · 367 skipped · 6,934 total

Contamination audit

Unknown

See the audit notes for this run

Patch size

18vs 162 merged

Changed lines, ours vs merged

Initial Checks

  • I confirm that I'm using Pydantic V2

Description

Literal[None] and None should be semantically equivalent type annotations, to the point that flake8-pyi and ruff have warnings for the former: https://docs.astral.sh/ruff/rules/redundant-none-literal/

Pydantic does however not treat them as semantically equivalent for the purposes of discriminated unions.

Example Code

from typing import Annotated, Literal

from pydantic import BaseModel, Field


class A(BaseModel):
    field: Literal["A"] = "A"


class B(BaseModel):
    field: None = None


class Foo(BaseModel):
    a_or_b: Annotated[A | B, Field(discriminator="field")]

# Results in the error below. 
# If `: None` is replaced with `: Literal[None]` then there is no error.
# ...
# pydantic.errors.PydanticUserError: Model 'B' needs field 'field' to be of type `Literal`
# 
# For further information visit https://errors.pydantic.dev/2.13/u/discriminator-needs-literal

Python, Pydantic & OS Version

     pydantic version: 2.13.4
pydantic-core version: 2.46.4
  pydantic-core build: profile=release pgo=false
       python version: 3.12.8 (main, Jan  5 2025, 05:33:15) [Clang 19.1.6 ]
             platform: Linux-5.19.0-35-generic-x86_64-with-glibc2.35
     related packages: typing_extensions-4.16.0 email-validator-2.3.0
               commit: unknown

The two patches

Our patch+18 −0
pydantic/_internal/_discriminated_union.pyindex 64f23145..d80a586b 100644@@ -438,6 +438,10 @@ class _ApplyInferredDiscriminator:         if schema['type'] == 'literal':             return schema['expected'] +        elif schema['type'] == 'none':+            # A bare `None` annotation is semantically equivalent to `Literal[None]`+            return [None]+         elif schema['type'] == 'union':             # Generally when multiple values are allowed they should be placed in a single `Literal`, but             # we add this case to handle the situation where a field is annotated as a `Union` of `Literal`s.tests/types/unions/test_discriminated_union.pyindex 63767910..b2df0861 100644@@ -112,6 +112,20 @@ def test_discriminated_union_literal_discriminator():             number: int  +def test_discriminated_union_none_discriminator():+    class A(BaseModel):+        field: Literal['a'] = 'a'++    class B(BaseModel):+        field: None = None++    class Foo(BaseModel):+        a_or_b: Annotated[Union[A, B], Field(discriminator='field')]++    assert isinstance(Foo(a_or_b={'field': 'a'}).a_or_b, A)+    assert isinstance(Foo(a_or_b={'field': None}).a_or_b, B)++ def test_discriminated_union_root_same_discriminator():     class BlackCat(BaseModel):         pet_type: Literal['blackcat'] 
Merged fix · PR #+77 −85
pydantic-core/python/pydantic_core/core_schema.pyindex 85f6a8c04..cb87ad5ae 100644@@ -7,7 +7,7 @@ from __future__ import annotations as _annotations  import sys import warnings-from collections.abc import Callable, Generator, Hashable, Mapping+from collections.abc import Callable, Generator, Mapping from datetime import date, datetime, time, timedelta from decimal import Decimal from fractions import Fraction@@ -2761,8 +2761,8 @@ def union_schema(  class TaggedUnionSchema(TypedDict, total=False):     type: Required[Literal['tagged-union']]-    choices: Required[dict[Hashable, CoreSchema]]-    discriminator: Required[str | list[str | int] | list[list[str | int]] | Callable[[Any], Hashable]]+    choices: Required[dict[Any, CoreSchema]]+    discriminator: Required[str | list[str | int] | list[list[str | int]] | Callable[[Any], Any]]     custom_error_type: str     custom_error_message: str     custom_error_context: dict[str, str | int | float]pydantic/_internal/_discriminated_union.pyindex 64f231459..554a4974d 100644@@ -1,6 +1,5 @@ from __future__ import annotations as _annotations -from collections.abc import Hashable, Sequence from typing import TYPE_CHECKING, Any, cast  from pydantic_core import CoreSchema, core_schema@@ -132,7 +131,7 @@ class _ApplyInferredDiscriminator:          # `_tagged_union_choices` is built during the call to `apply`, and will hold the choices to be included         # in the output TaggedUnionSchema that will replace the union from the input schema-        self._tagged_union_choices: dict[Hashable, core_schema.CoreSchema] = {}+        self._tagged_union_choices: dict[Any, core_schema.CoreSchema] = {}          # `_used` is changed to True after applying the discriminator to prevent accidental reuse         self._used = False@@ -303,7 +302,7 @@ class _ApplyInferredDiscriminator:      def _infer_discriminator_values_for_choice(  # noqa C901         self, choice: core_schema.CoreSchema, source_name: str | None-    ) -> list[str | int]:+    ) -> list[Any]:         """This function recurses over `choice`, extracting all discriminator values that should map to this choice.          `model_name` is accepted for the purpose of producing useful error messages.@@ -323,7 +322,7 @@ class _ApplyInferredDiscriminator:             )          elif choice['type'] == 'tagged-union':-            values: list[str | int] = []+            values: list[Any] = []             # Ignore str/int "choices" since these are just references to other choices             subchoices = [x for x in choice['choices'].values() if not isinstance(x, (str, int))]             for subchoice in subchoices:@@ -374,7 +373,7 @@ class _ApplyInferredDiscriminator:      def _infer_discriminator_values_for_typed_dict_choice(         self, choice: core_schema.TypedDictSchema, source_name: str | None = None-    ) -> list[str | int]:+    ) -> list[Any]:         """This method just extracts the _infer_discriminator_values_for_choice logic specific to TypedDictSchema         for the sake of readability.         """@@ -388,7 +387,7 @@ class _ApplyInferredDiscriminator:      def _infer_discriminator_values_for_model_choice(         self, choice: core_schema.ModelFieldsSchema, source_name: str | None = None-    ) -> list[str | int]:+    ) -> list[Any]:         source = 'ModelFields' if source_name is None else f'Model {source_name!r}'         field = choice['fields'].get(self.discriminator)         if field is None:@@ -399,7 +398,7 @@ class _ApplyInferredDiscriminator:      def _infer_discriminator_values_for_dataclass_choice(         self, choice: core_schema.DataclassArgsSchema, source_name: str | None = None-    ) -> list[str | int]:+    ) -> list[Any]:         source = 'DataclassArgs' if source_name is None else f'Dataclass {source_name!r}'         for field in choice['fields']:             if field['name'] == self.discriminator:@@ -410,7 +409,7 @@ class _ApplyInferredDiscriminator:             )         return self._infer_discriminator_values_for_field(field, source) -    def _infer_discriminator_values_for_field(self, field: CoreSchemaField, source: str) -> list[str | int]:+    def _infer_discriminator_values_for_field(self, field: CoreSchemaField, source: str) -> list[Any]:         if field['type'] == 'computed-field':             # This should never occur as a discriminator, as it is only relevant to serialization             return []@@ -429,53 +428,48 @@ class _ApplyInferredDiscriminator:             )         return self._infer_discriminator_values_for_inner_schema(field['schema'], source) -    def _infer_discriminator_values_for_inner_schema(-        self, schema: core_schema.CoreSchema, source: str-    ) -> list[str | int]:+    def _infer_discriminator_values_for_inner_schema(self, schema: core_schema.CoreSchema, source: str) -> list[Any]:         """When inferring discriminator values for a field, we typically extract the expected values from a literal         schema. This function does that, but also handles nested unions and defaults.         """-        if schema['type'] == 'literal':-            return schema['expected']--        elif schema['type'] == 'union':-            # Generally when multiple values are allowed they should be placed in a single `Literal`, but-            # we add this case to handle the situation where a field is annotated as a `Union` of `Literal`s.-            # For example, this lets us handle `Union[Literal['key'], Union[Literal['Key'], Literal['KEY']]]`-            values: list[Any] = []-            for choice in schema['choices']:-                choice_schema = choice[0] if isinstance(choice, tuple) else choice-                choice_values = self._infer_discriminator_values_for_inner_schema(choice_schema, source)-                values.extend(choice_values)-            return values--        elif schema['type'] == 'default':-            # This will happen if the field has a default value; we ignore it while extracting the discriminator values-            return self._infer_discriminator_values_for_inner_schema(schema['schema'], source)--        elif schema['type'] == 'function-after':-            # After validators don't affect the discriminator values-            return self._infer_discriminator_values_for_inner_schema(schema['schema'], source)--        elif schema['type'] == 'model' and schema.get('root_model'):-            # Support RootModel[Literal[...]] as discriminator field type-            return self._infer_discriminator_values_for_inner_schema(schema['schema'], source)--        elif schema['type'] in {'function-before', 'function-wrap', 'function-plain'}:-            validator_type = repr(schema['type'].split('-')[1])-            raise PydanticUserError(-                f'Cannot use a mode={validator_type} validator in the'-                f' discriminator field {self.discriminator!r} of {source}',-                code='discriminator-validator',-            )--        else:-            raise PydanticUserError(-                f'{source} needs field {self.discriminator!r} to be of type `Literal`',-                code='discriminator-needs-literal',-            )+        match schema:+            case {'type': 'literal', 'expected': expected}:+                return expected+            case {'type': 'none'}:+                return [None]+            case {'type': 'union', 'choices': choices}:+                # Generally when multiple values are allowed they should be placed in a single `Literal`, but+                # we add this case to handle the situation where a field is annotated as a `Union` of `Literal`s.+                # For example, this lets us handle `Union[Literal['key'], Union[Literal['Key'], Literal['KEY']]]`+                values: list[Any] = []+                for choice in choices:+                    choice_schema = choice[0] if isinstance(choice, tuple) else choice+                    choice_values = self._infer_discriminator_values_for_inner_schema(choice_schema, source)+                    values.extend(choice_values)+                return values+            case {'type': 'default', 'schema': inner_schema}:+                # This will happen if the field has a default value; we ignore it while extracting the discriminator values+                return self._infer_discriminator_values_for_inner_schema(inner_schema, source)+            case {'type': 'function-after', 'schema': inner_schema}:+                # After validators don't affect the discriminator values+                return self._infer_discriminator_values_for_inner_schema(inner_schema, source)+            case {'type': 'model', 'root_model': True, 'schema': inner_schema}:+                # Support RootModel[Literal[...]] as discriminator field type+                return self._infer_discriminator_values_for_inner_schema(inner_schema, source)+            case {'type': 'function-before' | 'function-wrap' | 'function-plain' as schema_type}:+                validator_type = repr(schema_type.split('-')[1])+                raise PydanticUserError(+                    f'Cannot use a mode={validator_type} validator in the'+                    f' discriminator field {self.discriminator!r} of {source}',+                    code='discriminator-validator',+                )+            case _:+                raise PydanticUserError(+                    f'{source} needs field {self.discriminator!r} to be of type `Literal`',+                    code='discriminator-needs-literal',+                ) -    def _set_unique_choice_for_values(self, choice: core_schema.CoreSchema, values: Sequence[str | int]) -> None:+    def _set_unique_choice_for_values(self, choice: core_schema.CoreSchema, values: list[Any]) -> None:         """This method updates `self.tagged_union_choices` so that all provided (discriminator) `values` map to the         provided `choice`, validating that none of these values already map to another (different) choice.         """pydantic/json_schema.pyindex c61378a5f..c2183e193 100644@@ -1384,6 +1384,8 @@ class GenerateJsonSchema:                 # Use the JSON representation so that the discriminator mapping                 # can be matched against the serialized payload value                 k = 'true' if k else 'false'+            elif k is None:+                k = 'null'             try:                 # Use str(k) since keys must be strings for json; while not technically correct,                 # it's the closest that can be represented in valid JSONtests/test_json_schema.pyindex 2d67f01ae..9cca32928 100644@@ -3986,40 +3986,36 @@ def test_bool_discriminated_union() -> None:     class Model(BaseModel):         setting: Enabled | Disabled = Field(discriminator='enabled') -    assert Model.model_json_schema() == {-        '$defs': {-            'Disabled': {-                'properties': {'enabled': {'const': False, 'title': 'Enabled', 'type': 'boolean'}},-                'required': ['enabled'],-                'title': 'Disabled',-                'type': 'object',-            },-            'Enabled': {-                'properties': {-                    'config': {'title': 'Config', 'type': 'string'},-                    'enabled': {'const': True, 'title': 'Enabled', 'type': 'boolean'},-                },-                'required': ['enabled', 'config'],-                'title': 'Enabled',-                'type': 'object',-            },-        },-        'properties': {-            'setting': {-                'discriminator': {-                    'mapping': {'false': '#/$defs/Disabled', 'true': '#/$defs/Enabled'},-                    'propertyName': 'enabled',-                },-                'oneOf': [{'$ref': '#/$defs/Enabled'}, {'$ref': '#/$defs/Disabled'}],-                'title': 'Setting',-            }-        },-        'required': ['setting'],-        'title': 'Model',-        'type': 'object',+    assert Model.model_json_schema()['properties']['setting']['discriminator'] == {+        'mapping': {'false': '#/$defs/Disabled', 'true': '#/$defs/Enabled'},+        'propertyName': 'enabled',     }  +def test_none_discriminated_union() -> None:+    """https://github.com/pydantic/pydantic/issues/13660"""++    class A(BaseModel):+        field: Literal['A'] = 'A'++    class B(BaseModel):+        field: None = None++    class Model(BaseModel):+        a_or_b: Annotated[A | B, Field(discriminator='field')]++    assert Model.model_json_schema()['properties']['a_or_b']['discriminator'] == {+        'mapping': {'A': '#/$defs/A', 'null': '#/$defs/B'},+        'propertyName': 'field',+    }++    m = Model.model_validate({'a_or_b': {'field': None}})+    assert isinstance(m.a_or_b, B)++    m2 = Model.model_validate({'a_or_b': {'field': 'A'}})+    assert isinstance(m2.a_or_b, A)++ def test_nested_discriminated_union():     class BlackCatWithHeight(BaseModel):         color: Literal['black'] 

What the agent reported

The fix is complete and verified. Here's my final report.

What was wrong

In discriminated unions, a member whose discriminator field was annotated with bare None (e.g. field: None) failed to build, raising a spurious PydanticUserError: ... needs field ... to be of type Literal (code discriminator-needs-literal). Meanwhile Literal[None] worked fine. The two annotations should be semantically equivalent.

Root cause: In pydantic/_internal/_discriminated_union.py, _infer_discriminator_values_for_inner_schema inspects the discriminator field's core schema type. Literal[None] produces a 'literal' schema (handled), but a bare None produces a 'none' core schema, which wasn't recognized and fell through to the else branch that raises the error.

What I changed

  • pydantic/_internal/_discriminated_union.py — added an elif schema['type'] == 'none': return [None] branch, treating a bare None discriminator annotation as equivalent to Literal[None]. This path is distinct from the existing outer-union 'none' handling (which sets _should_be_nullable), so nullable-union behavior is untouched.
  • tests/types/unions/test_discriminated_union.py — added test_discriminated_union_none_discriminator, reproducing the reported scenario (A with Literal['a'], B with bare None) and asserting {'field': 'a'} selects A and {'field': None} selects B.

Test evidence

  • The new test failed before the fix with the exact reported error (Model 'B' needs field 'field' to be of type Literal).
  • After the fix: ./bt-test tests/types/unions/test_discriminated_union.py → 80 passed, 4 xfailed (the new test passes; no previously passing test regressed).
  • Reviewer confirmed the change is minimal, correctly targeted, no scratch files, no weakened tests, and no blast-radius concern (the 'none' discriminator-field path does not collide with the existing nullable outer-union path; None is a valid Hashable tag key).

Requirements disposition

  • Treat bare None as Literal[None] for discriminated-union discriminators — ✅ Implemented and covered by the passing regression test exercising the report's exact example.

One minor, pre-existing note (not addressed, non-blocking): the function's return annotation list[str | int] doesn't include None, but this is cosmetic loose typing already present in the surrounding code and has no runtime effect. Changes are left uncommitted in the working tree.