Apply suggestions from code review

Primarily, rewrite `IValidator` to `Validator`

Co-authored-by: Julian Berman <[email protected]>

Author: sirosen

docs/creating.rst

@@ -27,7 +27,7 @@ where in the instance or schema respectively the error occurred.
 The Validator Protocol
 ----------------------
 
-``jsonschema`` defines a protocol, ``jsonschema.protocols.IValidator`` which
+``jsonschema`` defines a `protocol <typing.Protocol>`, `jsonschema.protocols.Validator` which
 can be used in type annotations to describe the type of a validator object.
 
 For full details, see `validator-protocol`.

docs/errors.rst

@@ -275,7 +275,7 @@ error objects.
 As you can see, `jsonschema.exceptions.ErrorTree` takes an
 iterable of `ValidationError`\s when constructing a tree so
 you can directly pass it the return value of a validator object's
-`jsonschema.protocols.IValidator.iter_errors` method.
+`jsonschema.protocols.Validator.iter_errors` method.
 
 `ErrorTree`\s support a number of useful operations. The first one we
 might want to perform is to check whether a given element in our instance

docs/faq.rst

@@ -90,7 +90,7 @@ but fail the second!
 
 Still, filling in defaults is a thing that is useful. `jsonschema`
 allows you to `define your own validator classes and callables
-<creating>`, so you can easily create an `jsonschema.protocols.IValidator`
+<creating>`, so you can easily create an `jsonschema.protocols.Validator`
 that does do default setting. Here's some code to get you started. (In
 this code, we add the default properties to each object *before* the
 properties are validated, so the default values themselves will need to

docs/validate.rst

@@ -21,17 +21,17 @@ The simplest way to validate an instance under a given schema is to use the
 
 .. _validator-protocol:
 
-The Validator Interface
+The Validator Protocol
 -----------------------
 
 `jsonschema` defines a protocol that all validator
 classes should adhere to.
 
-.. autoclass:: jsonschema.protocols.IValidator
+.. autoclass:: jsonschema.protocols.Validator
     :members:
 
 All of the `versioned validators <versioned-validators>` that are included with
-`jsonschema` adhere to the interface, and implementers of validator classes
+`jsonschema` adhere to the protocol, and implementers of validator classes
 that extend or complement the ones included should adhere to it as well. For
 more information see `creating-validators`.
 

jsonschema/protocols.py

@@ -12,7 +12,8 @@
 except ImportError:
     from typing_extensions import Protocol, runtime_checkable
 
-from ._format import FormatChecker
+from jsonschema._format import FormatChecker
+
 from ._types import TypeChecker
 from .exceptions import ValidationError
 from .validators import RefResolver
@@ -31,14 +32,14 @@
 
 
 @runtime_checkable
-class IValidator(Protocol):
+class Validator(Protocol):
     """
     The protocol to which all validator classes should adhere.
 
     :argument dict schema: the schema that the validator object
         will validate with. It is assumed to be valid, and providing
         an invalid schema can lead to undefined behavior. See
-        `IValidator.check_schema` to validate a schema first.
+        `Validator.check_schema` to validate a schema first.
     :argument resolver: an instance of `jsonschema.RefResolver` that will be
         used to resolve :validator:`$ref` properties (JSON references). If
         unprovided, one will be created.
@@ -138,7 +139,7 @@ def validate(self, instance: dict) -> None:
         ValidationError: [2, 3, 4] is too long
         """
 
-    def evolve(self, **kwargs) -> "IValidator":
+    def evolve(self, **kwargs) -> "Validator":
         """
         Create a new validator like this one, but with given changes.
 

jsonschema/validators.py

@@ -155,7 +155,7 @@ def create(
 
     Returns:
 
-        a new `jsonschema.protocols.IValidator` class
+        a new `jsonschema.protocols.Validator` class
     """
 
     @attr.s
@@ -284,7 +284,7 @@ def extend(validator, validators=(), version=None, type_checker=None):
 
     Arguments:
 
-        validator (jsonschema.protocols.IValidator):
+        validator (jsonschema.protocols.Validator):
 
             an existing validator class
 
@@ -314,11 +314,11 @@ def extend(validator, validators=(), version=None, type_checker=None):
             a type checker, used when applying the :validator:`type` validator.
 
             If unprovided, the type checker of the extended
-            `jsonschema.protocols.IValidator` will be carried along.
+            `jsonschema.protocols.Validator` will be carried along.
 
     Returns:
 
-        a new `jsonschema.protocols.IValidator` class extending the one
+        a new `jsonschema.protocols.Validator` class extending the one
         provided
 
     .. note:: Meta Schemas