deprecate comparablex509 (#207)

* deprecate comparablex509

* theres only 1

* Update src/josepy/util.py

Co-authored-by: ohemorange <ebportnoy@gmail.com>

---------

Co-authored-by: ohemorange <ebportnoy@gmail.com>

Author: bmw

CHANGELOG.rst

@@ -3,6 +3,14 @@ Changelog
 
 1.15.0 (main)
 ---------------
+
+* Added a deprecation warning about future backwards incompatible changes. The
+  text of that warning is "The next major version of josepy will remove
+  josepy.util.ComparableX509 and all uses of it as part of removing our
+  dependency on PyOpenSSL. This includes modifying any functions with
+  ComparableX509 parameters or return values. This will be a breaking change.
+  To avoid breakage, we recommend pinning josepy < 2.0.0 until josepy 2.0.0 is
+  out and you've had time to update your code."
 * Added support for Python 3.13.
 * Dropped support for Python 3.7.
 * Support for Python 3.8 has been deprecated and will be removed in the next

pyproject.toml

@@ -100,6 +100,8 @@ filterwarnings = [
     "ignore:CSR support in pyOpenSSL is deprecated:DeprecationWarning",
     # We ignore our own warning about dropping Python 3.8 support.
     "ignore:Python 3.8 support will be dropped:DeprecationWarning",
+    # We ignore our own warning about ComparableX509
+    "ignore:.*josepy will remove josepy.util.ComparableX509",
 ]
 norecursedirs = "*.egg .eggs dist build docs .tox"
 

src/josepy/util.py

@@ -22,9 +22,19 @@ class ComparableX509:
     :ivar wrapped: Wrapped certificate or certificate request.
     :type wrapped: `OpenSSL.crypto.X509` or `OpenSSL.crypto.X509Req`.
 
+    .. deprecated:: 1.15.0
     """
 
     def __init__(self, wrapped: Union[crypto.X509, crypto.X509Req]) -> None:
+        warnings.warn(
+            "The next major version of josepy will remove josepy.util.ComparableX509 and all "
+            "uses of it as part of removing our dependency on PyOpenSSL. This includes "
+            "modifying any functions with ComparableX509 parameters or return values. This "
+            "will be a breaking change. To avoid breakage, we recommend pinning josepy < 2.0.0 "
+            "until josepy 2.0.0 is out and you've had time to update your code.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         assert isinstance(wrapped, crypto.X509) or isinstance(wrapped, crypto.X509Req)
         self.wrapped = wrapped