Add Back Optional Validators and Refine Types

Author: kojiromike

stubs/jsonschema/@tests/stubtest_allowlist.txt

@@ -1,6 +1,8 @@
 jsonschema._format.is_css21_color
 jsonschema._format.is_css_color_code
 jsonschema._format.is_datetime
+jsonschema._format.is_duration
+jsonschema._format.is_host_name
 jsonschema._format.is_idn_host_name
 jsonschema._format.is_iri
 jsonschema._format.is_iri_reference

stubs/jsonschema/jsonschema/_format.pyi

@@ -1,12 +1,12 @@
-from typing import Any
+from typing import Any, Iterable
 
 class FormatChecker:
     checkers: Any
-    def __init__(self, formats: Any | None = ...) -> None: ...
+    def __init__(self, formats: Iterable | None = ...) -> None: ...
     def checks(self, format, raises=...): ...
     cls_checks: Any
     def check(self, instance, format) -> None: ...
-    def conforms(self, instance, format): ...
+    def conforms(self, instance, format) -> bool: ...
 
 draft3_format_checker: FormatChecker
 draft4_format_checker: FormatChecker
@@ -15,28 +15,28 @@ draft7_format_checker: FormatChecker
 draft201909_format_checker: FormatChecker
 draft202012_format_checker: FormatChecker
 
-def is_email(instance): ...
-def is_ipv4(instance): ...
-def is_ipv6(instance): ...
+def is_email(instance) -> bool: ...
+def is_ipv4(instance) -> bool: ...
+def is_ipv6(instance) -> bool: ...
 
 # is_host_name is only defined if fqdn is installed.
-# def is_host_name(instance): ...
-def is_idn_host_name(instance): ...
-def is_uri(instance): ...
-def is_uri_reference(instance): ...
-def is_iri(instance): ...
-def is_iri_reference(instance): ...
-def is_datetime(instance): ...
-def is_time(instance): ...
-def is_regex(instance): ...
-def is_date(instance): ...
-def is_draft3_time(instance): ...
-def is_css_color_code(instance): ...
-def is_css21_color(instance): ...
-def is_json_pointer(instance): ...
-def is_relative_json_pointer(instance): ...
-def is_uri_template(instance): ...
+def is_host_name(instance) -> bool: ...
+def is_idn_host_name(instance) -> bool: ...
+def is_uri(instance) -> bool: ...
+def is_uri_reference(instance) -> bool: ...
+def is_iri(instance) -> bool: ...
+def is_iri_reference(instance) -> bool: ...
+def is_datetime(instance) -> bool: ...
+def is_time(instance) -> bool: ...
+def is_regex(instance) -> bool: ...
+def is_date(instance) -> bool: ...
+def is_draft3_time(instance) -> bool: ...
+def is_css_color_code(instance) -> bool: ...
+def is_css21_color(instance) -> bool: ...
+def is_json_pointer(instance) -> bool: ...
+def is_relative_json_pointer(instance) -> bool: ...
+def is_uri_template(instance) -> bool: ...
 
 # is_duration is only defined if isoduration is installed.
-# def is_duration(instance): ...
-def is_uuid(instance): ...
+def is_duration(instance) -> bool: ...
+def is_uuid(instance) -> bool: ...

stubs/jsonschema/jsonschema/_legacy_validators.pyi

@@ -1,4 +1,6 @@
-def ignore_ref_siblings(schema): ...
+from typing import Any, ItemsView, Union
+
+def ignore_ref_siblings(schema) -> Union[list[tuple[str, Any]], ItemsView]: ...
 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: ...

stubs/jsonschema/jsonschema/_types.pyi

@@ -1,24 +1,24 @@
-from typing import Any, Callable, Mapping
+from typing import Callable, Iterable, Mapping
 
-def is_array(checker, instance): ...
-def is_bool(checker, instance): ...
-def is_integer(checker, instance): ...
-def is_null(checker, instance): ...
-def is_number(checker, instance): ...
-def is_object(checker, instance): ...
-def is_string(checker, instance): ...
-def is_any(checker, instance): ...
+def is_array(checker, instance) -> bool: ...
+def is_bool(checker, instance) -> bool: ...
+def is_integer(checker, instance) -> bool: ...
+def is_null(checker, instance) -> bool: ...
+def is_number(checker, instance) -> bool: ...
+def is_object(checker, instance) -> bool: ...
+def is_string(checker, instance) -> bool: ...
+def is_any(checker, instance) -> bool: ...
 
 class TypeChecker:
     def __init__(self, type_checkers: Mapping[str, Callable[[object], bool]] = ...) -> None: ...
-    def is_type(self, instance, type): ...
-    def redefine(self, type, fn): ...
-    def redefine_many(self, definitions=...): ...
-    def remove(self, *types): ...
+    def is_type(self, instance, type: str) -> bool: ...
+    def redefine(self, type: str, fn: Callable) -> TypeChecker: ...
+    def redefine_many(self, definitions=...) -> TypeChecker: ...
+    def remove(self, *types: Iterable[str]) -> TypeChecker: ...
 
-draft3_type_checker: Any
-draft4_type_checker: Any
-draft6_type_checker: Any
-draft7_type_checker: Any
-draft201909_type_checker: Any
-draft202012_type_checker: Any
+draft3_type_checker: TypeChecker
+draft4_type_checker: TypeChecker
+draft6_type_checker: TypeChecker
+draft7_type_checker: TypeChecker
+draft201909_type_checker: TypeChecker
+draft202012_type_checker: TypeChecker

stubs/jsonschema/jsonschema/_utils.pyi

@@ -1,8 +1,8 @@
-from typing import Any, MutableMapping
+from typing import Any, Generator, Iterable, Mapping, MutableMapping, Sized, Union
 
 class URIDict(MutableMapping[Any, Any]):
-    def normalize(self, uri): ...
-    store: Any
+    def normalize(self, uri: str) -> str: ...
+    store: dict
     def __init__(self, *args, **kwargs) -> None: ...
     def __getitem__(self, uri): ...
     def __setitem__(self, uri, value) -> None: ...
@@ -13,12 +13,12 @@ class URIDict(MutableMapping[Any, Any]):
 class Unset: ...
 
 def load_schema(name): ...
-def format_as_index(container, indices): ...
-def find_additional_properties(instance, schema) -> None: ...
-def extras_msg(extras): ...
-def ensure_list(thing): ...
-def equal(one, two): ...
+def format_as_index(container: str, indices) -> str: ...
+def find_additional_properties(instance: Iterable, schema: Mapping) -> Generator: ...
+def extras_msg(extras: Union[Iterable, Sized]) -> str: ...
+def ensure_list(thing) -> list: ...
+def equal(one, two) -> bool: ...
 def unbool(element, true=..., false=...): ...
-def uniq(container): ...
-def find_evaluated_item_indexes_by_schema(validator, instance, schema): ...
-def find_evaluated_property_keys_by_schema(validator, instance, schema): ...
+def uniq(container) -> bool: ...
+def find_evaluated_item_indexes_by_schema(validator, instance, schema) -> list: ...
+def find_evaluated_property_keys_by_schema(validator, instance, schema) -> list: ...

stubs/jsonschema/jsonschema/validators.pyi

@@ -1,6 +1,6 @@
-from typing import Any
+from typing import Any, Callable
 
-def validates(version): ...
+def validates(version: str) -> Callable: ...
 def create(meta_schema, validators=..., version: Any | None = ..., type_checker=..., id_of=..., applicable_validators=...): ...
 def extend(validator, validators=..., version: Any | None = ..., type_checker: Any | None = ...): ...