Deprecate the CLI (via import or running normally).

Julian · Julian · commit f40199de80d3 · 2022-11-01T15:41:50.000-04:00
It is less featureful (and less maintained) than the new 'official' option, check-jsonschema. See https://github.com/python-jsonschema/check-jsonschema for details. Closes: #600
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,3 +1,11 @@
+v4.17.0
+=======
+
+* The ``jsonschema`` CLI (along with ``jsonschema.cli`` the module) are now
+  deprecated. Use ``check-jsonschema`` instead, which can be installed via
+  ``pip install check-jsonschema`` and found
+  `here <https://github.com/python-jsonschema/check-jsonschema>`_.
+
 v4.16.1
 =======
 
diff --git a/jsonschema/cli.py b/jsonschema/cli.py
@@ -8,6 +8,7 @@
 import json
 import sys
 import traceback
+import warnings
 
 try:
     from importlib import metadata
@@ -24,6 +25,16 @@
 from jsonschema.exceptions import SchemaError
 from jsonschema.validators import RefResolver, validator_for
 
+warnings.warn(
+    (
+        "The jsonschema CLI is deprecated and will be removed in a future "
+        "version. Please use check-jsonschema instead, which can be installed "
+        "from https://pypi.org/project/check-jsonschema/"
+    ),
+    DeprecationWarning,
+    stacklevel=2,
+)
+
 
 class _CannotLoadFile(Exception):
     pass
diff --git a/jsonschema/tests/test_cli.py b/jsonschema/tests/test_cli.py
@@ -9,6 +9,7 @@
 import subprocess
 import sys
 import tempfile
+import warnings
 
 try:  # pragma: no cover
     from importlib import metadata
@@ -17,14 +18,18 @@
 
 from pyrsistent import m
 
-from jsonschema import Draft4Validator, Draft202012Validator, cli
+from jsonschema import Draft4Validator, Draft202012Validator
 from jsonschema.exceptions import (
     RefResolutionError,
     SchemaError,
     ValidationError,
 )
 from jsonschema.validators import _LATEST_VERSION, validate
 
+with warnings.catch_warnings():
+    warnings.simplefilter("ignore")
+    from jsonschema import cli
+
 
 def fake_validator(*errors):
     errors = list(reversed(errors))
@@ -895,7 +900,7 @@ def test_license(self):
 
     def test_version(self):
         version = subprocess.check_output(
-            [sys.executable, "-m", "jsonschema", "--version"],
+            [sys.executable, "-W", "ignore", "-m", "jsonschema", "--version"],
             stderr=subprocess.STDOUT,
         )
         version = version.decode("utf-8").strip()
diff --git a/jsonschema/tests/test_deprecations.py b/jsonschema/tests/test_deprecations.py
@@ -1,4 +1,6 @@
 from unittest import TestCase
+import subprocess
+import sys
 
 from jsonschema import FormatChecker, validators
 
@@ -261,3 +263,14 @@ def test_draftN_format_checker(self):
 
         with self.assertRaises(ImportError):
             from jsonschema import draft1234_format_checker  # noqa
+
+    def test_cli(self):
+        """
+        As of v4.17.0, the jsonschema CLI is deprecated.
+        """
+
+        process = subprocess.run(
+            [sys.executable, "-m", "jsonschema"],
+            capture_output=True,
+        )
+        self.assertIn(b"The jsonschema CLI is deprecated ", process.stderr)
