Deprecate jsonschema.__version__.

importlib.metadata is in the standard library now, so there's
not much purpose in pre-calculating this attribute.

Author: Julian

docs/conf.py

@@ -1,9 +1,8 @@
+from importlib import metadata
 import os
 import re
 import sys
 
-import jsonschema
-
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -55,7 +54,7 @@
 #
 # version: The short X.Y version
 # release: The full version, including alpha/beta/rc tags.
-release = jsonschema.__version__
+release = metadata.version("jsonschema")
 version = release.partition("-")[0]
 
 # There are two options for replacing |today|: either, you set today to some

docs/jsonschema_role.py

@@ -1,4 +1,5 @@
 from datetime import datetime
+from importlib import metadata
 from urllib.parse import urljoin
 import errno
 import os
@@ -8,8 +9,6 @@
 from lxml import html
 import certifi
 
-import jsonschema
-
 __version__ = "1.2.0"
 
 BASE_URL = "https://json-schema.org/draft-07/"
@@ -57,7 +56,8 @@ def fetch_or_load(spec_path):
 
     headers = {
         "User-Agent": "python-jsonschema v{} - documentation build v{}".format(
-            jsonschema.__version__, __version__,
+            metadata.version("jsonschema"),
+            __version__,
         ),
     }
 

jsonschema/__init__.py

@@ -7,6 +7,7 @@
 Most commonly, `validate` is the quickest way to simply validate a given
 instance under a schema, and will create a validator for you.
 """
+import warnings
 
 from jsonschema._format import (
     FormatChecker,
@@ -36,8 +37,20 @@
     validate,
 )
 
-try:
-    from importlib import metadata
-except ImportError:
-    import importlib_metadata as metadata
-__version__ = metadata.version("jsonschema")
+
+def __getattr__(name):
+    if name == "__version__":
+        warnings.warn(
+            "Accessing jsonschema.__version__ is deprecated and will be "
+            "removed in a future release. Use importlib.metadata directly "
+            "to query for jsonschema's version.",
+            DeprecationWarning,
+        )
+
+        try:
+            from importlib import metadata
+        except ImportError:
+            import importlib_metadata as metadata
+
+        return metadata.version("jsonschema")
+    raise AttributeError(f"module {__name__} has no attribute {name}")

jsonschema/cli.py

@@ -10,9 +10,13 @@
 import sys
 import traceback
 
+try:
+    from importlib import metadata
+except ImportError:
+    import importlib_metadata as metadata
+
 import attr
 
-from jsonschema import __version__
 from jsonschema._reflect import namedAny
 from jsonschema.exceptions import SchemaError
 from jsonschema.validators import RefResolver, validator_for
@@ -189,7 +193,7 @@ def _namedAnyWithDefault(name):
 parser.add_argument(
     "--version",
     action="version",
-    version=__version__,
+    version=metadata.version("jsonschema"),
 )
 parser.add_argument(
     "schema",

jsonschema/tests/test_cli.py

@@ -10,9 +10,14 @@
 import sys
 import tempfile
 
+try:
+    from importlib import metadata
+except ImportError:
+    import importlib_metadata as metadata
+
 from pyrsistent import m
 
-from jsonschema import Draft4Validator, Draft202012Validator, __version__, cli
+from jsonschema import Draft4Validator, Draft202012Validator, cli
 from jsonschema.exceptions import (
     RefResolutionError,
     SchemaError,
@@ -896,7 +901,7 @@ def test_version(self):
             stderr=subprocess.STDOUT,
         )
         version = version.decode("utf-8").strip()
-        self.assertEqual(version, __version__)
+        self.assertEqual(version, metadata.version("jsonschema"))
 
     def test_no_arguments_shows_usage_notes(self):
         output = subprocess.check_output(

jsonschema/tests/test_deprecations.py

@@ -0,0 +1,19 @@
+from unittest import TestCase
+
+import jsonschema
+
+
+class TestDeprecations(TestCase):
+    def test_jsonschema_version(self):
+        """
+        As of v4.0.0, __version__ is deprecated in favor of importlib.metadata.
+        """
+
+        with self.assertWarns(DeprecationWarning) as w:
+            jsonschema.__version__
+
+        self.assertTrue(
+            str(w.warning).startswith(
+                "Accessing jsonschema.__version__ is deprecated",
+            ),
+        )