Allow semver-compatible frontend versions (#521)

Co-authored-by: Trevor Manz <[email protected]>

Author: kylebarron

.changeset/cuddly-fishes-heal.md

@@ -0,0 +1,7 @@
+---
+"anywidget": patch
+---
+
+Relax version pinning for anywidget front end
+
+Adopted `~major.minor.*` notation for more flexible version compatibility in the front end, mirroring practices improve compatability in environments where bumping the front-end versions is not possible for end users (i.e., JupyterHub). This change is intended to enhance adaptability without causing disruptions. If issues arise, please report them on our issues page.

anywidget/_descriptor.py

@@ -44,7 +44,7 @@
     repr_mimebundle,
     try_file_contents,
 )
-from ._version import __version__
+from ._version import _ANYWIDGET_SEMVER_VERSION
 
 if TYPE_CHECKING:  # pragma: no cover
     import comm
@@ -72,13 +72,14 @@ def __call__(self, obj: Any, include: set[str] | None) -> dict: ...
 _ANYWIDGET_MODEL_NAME = "AnyModel"
 _ANYWIDGET_VIEW_NAME = "AnyView"
 _ANYWIDGET_JS_MODULE = "anywidget"
+
 _ANYWIDGET_STATE = {
     "_model_module": _ANYWIDGET_JS_MODULE,
     "_model_name": _ANYWIDGET_MODEL_NAME,
-    "_model_module_version": __version__,
+    "_model_module_version": _ANYWIDGET_SEMVER_VERSION,
     "_view_module": _ANYWIDGET_JS_MODULE,
     "_view_name": _ANYWIDGET_VIEW_NAME,
-    "_view_module_version": __version__,
+    "_view_module_version": _ANYWIDGET_SEMVER_VERSION,
     "_view_count": None,
 }
 

anywidget/_version.py

@@ -10,3 +10,15 @@
     __version__ = version("anywidget")
 except PackageNotFoundError:
     __version__ = "uninstalled"
+
+
+def get_semver_version(version: str) -> str:
+    split = version.split(".", maxsplit=2)
+    is_pre_release = "a" in split[2] or "b" in split[2]
+    if is_pre_release:
+        return ".".join(split)
+
+    return "~" + ".".join([split[0], split[1], "*"])
+
+
+_ANYWIDGET_SEMVER_VERSION = get_semver_version(__version__)

anywidget/widget.py

@@ -17,7 +17,7 @@
     repr_mimebundle,
     try_file_contents,
 )
-from ._version import __version__
+from ._version import _ANYWIDGET_SEMVER_VERSION
 from .experimental import _collect_anywidget_commands, _register_anywidget_commands
 
 
@@ -26,11 +26,11 @@ class AnyWidget(ipywidgets.DOMWidget):  # type: ignore [misc]
 
     _model_name = t.Unicode("AnyModel").tag(sync=True)
     _model_module = t.Unicode("anywidget").tag(sync=True)
-    _model_module_version = t.Unicode(__version__).tag(sync=True)
+    _model_module_version = t.Unicode(_ANYWIDGET_SEMVER_VERSION).tag(sync=True)
 
     _view_name = t.Unicode("AnyView").tag(sync=True)
     _view_module = t.Unicode("anywidget").tag(sync=True)
-    _view_module_version = t.Unicode(__version__).tag(sync=True)
+    _view_module_version = t.Unicode(_ANYWIDGET_SEMVER_VERSION).tag(sync=True)
 
     def __init__(self, *args: Any, **kwargs: Any) -> None:
         if in_colab():

tests/test_utils.py

@@ -10,6 +10,7 @@
     remove_buffers,
     try_file_contents,
 )
+from anywidget._version import get_semver_version
 
 
 def enable_hmr():
@@ -163,3 +164,22 @@ def test_try_file_contents_warns(
 
         assert isinstance(file_contents, FileContents)
         assert file_contents._background_thread is None
+
+
+@pytest.mark.parametrize(
+    "version, expected",
+    [
+        ("1.0.0", "~1.0.*"),
+        ("2.1.1", "~2.1.*"),
+        ("0.0.1", "~0.0.*"),
+        ("1.2.3a", "1.2.3a"),
+        ("4.5.6b", "4.5.6b"),
+        ("1.0.0-alpha", "1.0.0-alpha"),
+        ("2.1.1-beta", "2.1.1-beta"),
+        ("3.2.1-alpha.1", "3.2.1-alpha.1"),
+        ("0.0.1-beta.2", "0.0.1-beta.2"),
+        ("1.2.3-rc.4", "~1.2.*"),
+    ],
+)
+def test_get_semver_version(version, expected):
+    assert get_semver_version(version) == expected