From 1336eaf3e2500f729632382477a33c361d8057b7 Mon Sep 17 00:00:00 2001 From: dhairya05 Date: Fri, 6 Nov 2026 22:53:46 +0530 Subject: [PATCH] [jsonschema] Annotate keyword validators as returning iterators MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The keyword validation functions in `_keywords` and `_legacy_keywords` are generators that yield `ValidationError`, but 49 of them were declared `-> None`, so iterating their result was a type error: for error in additionalProperties(validator, False, instance, schema): ... # error: "None" has no attribute "__iter__" (not iterable) # error: "additionalProperties" does not return a value `_legacy_keywords.pyi` already annotates two of its own functions, `unevaluatedItems_draft2019` and `unevaluatedProperties_draft2019`, as `Iterator[ValidationError]`, and `protocols.pyi` uses the same type for `iter_errors`, so this makes the rest consistent with both. Every function was checked against jsonschema 4.26.0: all 49 changed here contain a `yield` or `yield from` outside any nested function. The three non-generators in `_legacy_keywords` — `ignore_ref_siblings`, `find_evaluated_item_indexes_by_schema` and `find_evaluated_property_keys_by_schema` — already return list types and are untouched. stubtest reports the same 12 pre-existing `_format` errors before and after (optional format dependencies, unrelated). mypy --strict and pyright are clean on the stubs. --- stubs/jsonschema/jsonschema/_keywords.pyi | 76 ++++++++++--------- .../jsonschema/_legacy_keywords.pyi | 26 +++---- 2 files changed, 53 insertions(+), 49 deletions(-) diff --git a/stubs/jsonschema/jsonschema/_keywords.pyi b/stubs/jsonschema/jsonschema/_keywords.pyi index 3d050a93933a..942e4de5f5b6 100644 --- a/stubs/jsonschema/jsonschema/_keywords.pyi +++ b/stubs/jsonschema/jsonschema/_keywords.pyi @@ -1,36 +1,40 @@ -def patternProperties(validator, patternProperties, instance, schema) -> None: ... -def propertyNames(validator, propertyNames, instance, schema) -> None: ... -def additionalProperties(validator, aP, instance, schema) -> None: ... -def items(validator, items, instance, schema) -> None: ... -def const(validator, const, instance, schema) -> None: ... -def contains(validator, contains, instance, schema) -> None: ... -def exclusiveMinimum(validator, minimum, instance, schema) -> None: ... -def exclusiveMaximum(validator, maximum, instance, schema) -> None: ... -def minimum(validator, minimum, instance, schema) -> None: ... -def maximum(validator, maximum, instance, schema) -> None: ... -def multipleOf(validator, dB, instance, schema) -> None: ... -def minItems(validator, mI, instance, schema) -> None: ... -def maxItems(validator, mI, instance, schema) -> None: ... -def uniqueItems(validator, uI, instance, schema) -> None: ... -def pattern(validator, patrn, instance, schema) -> None: ... -def format(validator, format, instance, schema) -> None: ... -def minLength(validator, mL, instance, schema) -> None: ... -def maxLength(validator, mL, instance, schema) -> None: ... -def dependentRequired(validator, dependentRequired, instance, schema) -> None: ... -def dependentSchemas(validator, dependentSchemas, instance, schema) -> None: ... -def enum(validator, enums, instance, schema) -> None: ... -def ref(validator, ref, instance, schema) -> None: ... -def dynamicRef(validator, dynamicRef, instance, schema) -> None: ... -def type(validator, types, instance, schema) -> None: ... -def properties(validator, properties, instance, schema) -> None: ... -def required(validator, required, instance, schema) -> None: ... -def minProperties(validator, mP, instance, schema) -> None: ... -def maxProperties(validator, mP, instance, schema) -> None: ... -def allOf(validator, allOf, instance, schema) -> None: ... -def anyOf(validator, anyOf, instance, schema) -> None: ... -def oneOf(validator, oneOf, instance, schema) -> None: ... -def not_(validator, not_schema, instance, schema) -> None: ... -def if_(validator, if_schema, instance, schema) -> None: ... -def unevaluatedItems(validator, unevaluatedItems, instance, schema) -> None: ... -def unevaluatedProperties(validator, unevaluatedProperties, instance, schema) -> None: ... -def prefixItems(validator, prefixItems, instance, schema) -> None: ... +from collections.abc import Iterator + +from .exceptions import ValidationError + +def patternProperties(validator, patternProperties, instance, schema) -> Iterator[ValidationError]: ... +def propertyNames(validator, propertyNames, instance, schema) -> Iterator[ValidationError]: ... +def additionalProperties(validator, aP, instance, schema) -> Iterator[ValidationError]: ... +def items(validator, items, instance, schema) -> Iterator[ValidationError]: ... +def const(validator, const, instance, schema) -> Iterator[ValidationError]: ... +def contains(validator, contains, instance, schema) -> Iterator[ValidationError]: ... +def exclusiveMinimum(validator, minimum, instance, schema) -> Iterator[ValidationError]: ... +def exclusiveMaximum(validator, maximum, instance, schema) -> Iterator[ValidationError]: ... +def minimum(validator, minimum, instance, schema) -> Iterator[ValidationError]: ... +def maximum(validator, maximum, instance, schema) -> Iterator[ValidationError]: ... +def multipleOf(validator, dB, instance, schema) -> Iterator[ValidationError]: ... +def minItems(validator, mI, instance, schema) -> Iterator[ValidationError]: ... +def maxItems(validator, mI, instance, schema) -> Iterator[ValidationError]: ... +def uniqueItems(validator, uI, instance, schema) -> Iterator[ValidationError]: ... +def pattern(validator, patrn, instance, schema) -> Iterator[ValidationError]: ... +def format(validator, format, instance, schema) -> Iterator[ValidationError]: ... +def minLength(validator, mL, instance, schema) -> Iterator[ValidationError]: ... +def maxLength(validator, mL, instance, schema) -> Iterator[ValidationError]: ... +def dependentRequired(validator, dependentRequired, instance, schema) -> Iterator[ValidationError]: ... +def dependentSchemas(validator, dependentSchemas, instance, schema) -> Iterator[ValidationError]: ... +def enum(validator, enums, instance, schema) -> Iterator[ValidationError]: ... +def ref(validator, ref, instance, schema) -> Iterator[ValidationError]: ... +def dynamicRef(validator, dynamicRef, instance, schema) -> Iterator[ValidationError]: ... +def type(validator, types, instance, schema) -> Iterator[ValidationError]: ... +def properties(validator, properties, instance, schema) -> Iterator[ValidationError]: ... +def required(validator, required, instance, schema) -> Iterator[ValidationError]: ... +def minProperties(validator, mP, instance, schema) -> Iterator[ValidationError]: ... +def maxProperties(validator, mP, instance, schema) -> Iterator[ValidationError]: ... +def allOf(validator, allOf, instance, schema) -> Iterator[ValidationError]: ... +def anyOf(validator, anyOf, instance, schema) -> Iterator[ValidationError]: ... +def oneOf(validator, oneOf, instance, schema) -> Iterator[ValidationError]: ... +def not_(validator, not_schema, instance, schema) -> Iterator[ValidationError]: ... +def if_(validator, if_schema, instance, schema) -> Iterator[ValidationError]: ... +def unevaluatedItems(validator, unevaluatedItems, instance, schema) -> Iterator[ValidationError]: ... +def unevaluatedProperties(validator, unevaluatedProperties, instance, schema) -> Iterator[ValidationError]: ... +def prefixItems(validator, prefixItems, instance, schema) -> Iterator[ValidationError]: ... diff --git a/stubs/jsonschema/jsonschema/_legacy_keywords.pyi b/stubs/jsonschema/jsonschema/_legacy_keywords.pyi index e2898f8ed015..3f05cda5ae5a 100644 --- a/stubs/jsonschema/jsonschema/_legacy_keywords.pyi +++ b/stubs/jsonschema/jsonschema/_legacy_keywords.pyi @@ -4,19 +4,19 @@ from collections.abc import ItemsView, Iterator from .exceptions import ValidationError def ignore_ref_siblings(schema) -> list[tuple[str, Incomplete]] | ItemsView[str, Incomplete]: ... -def dependencies_draft3(validator, dependencies, instance, schema) -> None: ... -def dependencies_draft4_draft6_draft7(validator, dependencies, instance, schema) -> None: ... -def disallow_draft3(validator, disallow, instance, schema) -> None: ... -def extends_draft3(validator, extends, instance, schema) -> None: ... -def items_draft3_draft4(validator, items, instance, schema) -> None: ... -def additionalItems(validator, aI, instance, schema) -> None: ... -def items_draft6_draft7_draft201909(validator, items, instance, schema) -> None: ... -def minimum_draft3_draft4(validator, minimum, instance, schema) -> None: ... -def maximum_draft3_draft4(validator, maximum, instance, schema) -> None: ... -def properties_draft3(validator, properties, instance, schema) -> None: ... -def type_draft3(validator, types, instance, schema) -> None: ... -def contains_draft6_draft7(validator, contains, instance, schema) -> None: ... -def recursiveRef(validator, recursiveRef, instance, schema) -> None: ... +def dependencies_draft3(validator, dependencies, instance, schema) -> Iterator[ValidationError]: ... +def dependencies_draft4_draft6_draft7(validator, dependencies, instance, schema) -> Iterator[ValidationError]: ... +def disallow_draft3(validator, disallow, instance, schema) -> Iterator[ValidationError]: ... +def extends_draft3(validator, extends, instance, schema) -> Iterator[ValidationError]: ... +def items_draft3_draft4(validator, items, instance, schema) -> Iterator[ValidationError]: ... +def additionalItems(validator, aI, instance, schema) -> Iterator[ValidationError]: ... +def items_draft6_draft7_draft201909(validator, items, instance, schema) -> Iterator[ValidationError]: ... +def minimum_draft3_draft4(validator, minimum, instance, schema) -> Iterator[ValidationError]: ... +def maximum_draft3_draft4(validator, maximum, instance, schema) -> Iterator[ValidationError]: ... +def properties_draft3(validator, properties, instance, schema) -> Iterator[ValidationError]: ... +def type_draft3(validator, types, instance, schema) -> Iterator[ValidationError]: ... +def contains_draft6_draft7(validator, contains, instance, schema) -> Iterator[ValidationError]: ... +def recursiveRef(validator, recursiveRef, instance, schema) -> Iterator[ValidationError]: ... def find_evaluated_item_indexes_by_schema(validator, instance, schema) -> list[int]: ... def unevaluatedItems_draft2019(validator, unevaluatedItems, instance, schema) -> Iterator[ValidationError]: ... def find_evaluated_property_keys_by_schema(validator, instance, schema) -> list[Incomplete]: ...