Merge remote-tracking branch 'origin/main' into docs/autodoc

* origin/main:
  Remove noise from the Sphinx config.
  Fix instantiating validators with cached refs-to-bool schemas.
  Try fixing more Sphinx refs which fail only on Ubuntu...

Author: Julian

CHANGELOG.rst

@@ -1,3 +1,9 @@
+v4.17.3
+=======
+
+* Fix instantiating validators with cached refs to boolean schemas
+  rather than objects (#1018).
+
 v4.17.2
 =======
 

docs/conf.py

@@ -5,29 +5,16 @@
 ROOT = Path(__file__).parent.parent
 PACKAGE_SRC = ROOT / "jsonschema"
 
-# -- Project information -----------------------------------------------------
-
 project = "jsonschema"
 author = "Julian Berman"
 copyright = "2013, " + author
 
-# version: The short X.Y version
-# release: The full version, including alpha/beta/rc tags.
 release = importlib.metadata.version("jsonschema")
 version = release.partition("-")[0]
 
-
-# -- General configuration ---------------------------------------------------
-
-# If your documentation needs a minimal Sphinx version, state it here.
-#
-# needs_sphinx = "1.0"
-
+language = "en"
 default_role = "any"
 
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named "sphinx.ext.*") or your custom
-# ones.
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.autosectionlabel",
@@ -42,104 +29,18 @@
     "sphinxext.opengraph",
 ]
 
-# Add typing annotations to signatures
-autodoc_typehints = "signature"
-
 cache_path = "_cache"
 
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ["_templates"]
-
-# The suffix(es) of source filenames.
-# You can specify multiple suffix as a list of string:
-#
-# source_suffix = [".rst", ".md"]
-source_suffix = ".rst"
-
-# The master toctree document.
-master_doc = "index"
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-# today = ""
-# Else, today_fmt is used as the format for a strftime call.
-# today_fmt = "%B %d, %Y"
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ["_build", "_cache", "_static", "_templates"]
-
-# The name of the Pygments (syntax highlighting) style to use.
 pygments_style = "lovelace"
 pygments_dark_style = "one-dark"
 
-doctest_global_setup = """
-from jsonschema import *
-"""
-
-intersphinx_mapping = {
-    "python": ("https://docs.python.org/3", None),
-    "ujs": ("https://json-schema.org/understanding-json-schema/", None),
-}
-
-
-# -- Options for HTML output -----------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
 html_theme = "furo"
 
-# Theme options are theme-specific and customize the look and feel of a theme
-# further.  For a list of options available for each theme, see the
-# documentation.
-#
-# html_theme_options = {}
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-# html_static_path = ["_static"]
-
-
-# -- Options for HTMLHelp output ---------------------------------------------
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = "jsonschemadoc"
-
+# = Builders =
 
-# -- Options for LaTeX output ------------------------------------------------
-
-latex_documents = [
-    ("index", "jsonschema.tex", "jsonschema Documentation", author, "manual"),
-]
-
-
-# -- Options for manual page output ------------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [("index", "jsonschema", "jsonschema Documentation", [author], 1)]
-
-
-# -- Options for Texinfo output ----------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-#  dir menu entry, description, category)
-texinfo_documents = [
-    (
-        "index",
-        "jsonschema",
-        "jsonschema Documentation",
-        author,
-        "jsonschema",
-        "One line description of project.",
-        "Miscellaneous",
-    ),
-]
-
-# -- Options for the linkcheck builder --------------------------------------
+doctest_global_setup = """
+from jsonschema import *
+"""
 
 
 def entire_domain(host):
@@ -152,10 +53,45 @@ def entire_domain(host):
     "https://github.com/python-jsonschema/jsonschema/workflows/CI/badge.svg",
 ]
 
-# -- Options for sphinxcontrib-autosectionlabel ---------------------------
+# = Extensions =
+
+# -- autoapi --
+
+suppress_warnings = [
+    "autoapi.python_import_resolution",
+    "autoapi.toc_reference",
+    "epub.duplicated_toc_entry",
+]
+autoapi_root = "api"
+autoapi_ignore = [
+    "*/_[a-z]*.py",
+    "*/__main__.py",
+    "*/benchmarks/*",
+    "*/cli.py",
+    "*/tests/*",
+]
+autoapi_options = [
+    "members",
+    "undoc-members",
+    "show-module-summary",
+    "imported-members",
+]
+
+autoapi_type = "python"
+autoapi_dirs = [PACKAGE_SRC]
+
+# -- autosectionlabel --
 
 autosectionlabel_prefix_document = True
 
-# -- Options for sphinxcontrib-spelling -----------------------------------
+# -- intersphinx --
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "ujs": ("https://json-schema.org/understanding-json-schema/", None),
+}
+
+# -- sphinxcontrib-spelling --
 
 spelling_word_list_filename = "spelling-wordlist.txt"
+spelling_show_suggestions = True

docs/validate.rst

@@ -16,7 +16,7 @@ The Basics
 ----------
 
 The simplest way to validate an instance under a given schema is to use the
-:func:`validate` function.
+`validate <jsonschema.validators.validate>` function.
 
 .. autofunction:: validate
     :noindex:

jsonschema/protocols.py

@@ -29,6 +29,7 @@
 # but use `jsonschema` for any types which will otherwise not be resolvable
 if TYPE_CHECKING:
     import jsonschema
+    import jsonschema.validators
 
 from jsonschema.exceptions import ValidationError
 
@@ -107,7 +108,7 @@ class Validator(Protocol):
     def __init__(
         self,
         schema: Mapping | bool,
-        resolver: jsonschema.RefResolver | None = None,
+        resolver: jsonschema.validators.RefResolver | None = None,
         format_checker: jsonschema.FormatChecker | None = None,
     ) -> None:
         ...

jsonschema/tests/test_validators.py

@@ -1848,6 +1848,21 @@ class TestDraft202012Validator(ValidatorTestMixin, TestCase):
     invalid = {"type": "integer"}, "foo"
 
 
+class TestLatestValidator(TestCase):
+    """
+    These really apply to multiple versions but are easiest to test on one.
+    """
+
+    def test_ref_resolvers_may_have_boolean_schemas_stored(self):
+        ref = "someCoolRef"
+        schema = {"$ref": ref}
+        resolver = validators.RefResolver("", {}, store={ref: False})
+        validator = validators._LATEST_VERSION(schema, resolver=resolver)
+
+        with self.assertRaises(exceptions.ValidationError):
+            validator.validate(None)
+
+
 class TestValidatorFor(TestCase):
     def test_draft_3(self):
         schema = {"$schema": "http://json-schema.org/draft-03/schema"}

jsonschema/validators.py

@@ -4,7 +4,7 @@
 from __future__ import annotations
 
 from collections import deque
-from collections.abc import Sequence
+from collections.abc import Mapping, Sequence
 from functools import lru_cache
 from operator import methodcaller
 from urllib.parse import unquote, urldefrag, urljoin, urlsplit
@@ -745,7 +745,8 @@ def __init__(
         self.store.update(store)
         self.store.update(
             (schema["$id"], schema)
-            for schema in store.values() if "$id" in schema
+            for schema in store.values()
+            if isinstance(schema, Mapping) and "$id" in schema
         )
         self.store[base_uri] = referrer
 
@@ -1060,9 +1061,9 @@ def validate(instance, schema, cls=None, *args, **kwargs):
             ...
         ValidationError: [2, 3, 4] is too long
 
-    :func:`validate` will first verify that the provided schema is
-    itself valid, since not doing so can lead to less obvious error
-    messages and fail in less obvious or consistent ways.
+    :func:`~jsonschema.validators.validate` will first verify that the
+    provided schema is itself valid, since not doing so can lead to less
+    obvious error messages and fail in less obvious or consistent ways.
 
     If you know you have a valid schema already, especially
     if you intend to validate multiple instances with