Add model version separate from package version #448

ianhi · 2022-03-31T21:47:05Z

Hopefully fixes #416

Adds a model version version that is not tied to the npm release version so that we can (hopefully) have compatibility across patch versions.
Bumps the version for release of the double click fixes

This was already too low - previously was 3.3.1. With update of doubleclick we now need to require 3.4

github-actions · 2022-03-31T21:47:17Z

👈 Launch a binder notebook on branch ianhi/ipympl/model-version

ianhi · 2022-03-31T21:50:01Z

An alternative approach that would make things simpler going forward would be to declare the current state as being model version 1.0.0 so we have the full range of semver to play with when making changes. The downside would be that we wouldn't get the back compatibility for this release. Not sure the best tradeoff there - curious for thoughts from @martinRenou and @wholtz

martinRenou

Thanks a lot for doing this!

martinRenou · 2022-04-01T07:27:59Z

ipympl/_version.py

+# These should not be changed unless we introduce changes to communication between
+# frontend and backend.
+__TOOLBAR_MODEL_VERSION__ = "^0.10.5"
+__CANVAS_MODEL_VERSION__ = "^0.10.5"


It might be easier to track if we have one same version for all models?

Yeah that's probably a good call. One isn't really functional without the other so no need to have them separate.

martinRenou · 2022-04-01T07:28:52Z

README.md

@@ -64,6 +64,7 @@ Versions lookup table:

 | `ipympl` | `jupyter-matplotlib` | `JupyterLab` | `Matplotlib` |
 |----------|----------------------|--------------|--------------|
+| 0.8.9    | 0.10.x               | 3 or 2       | 3.4.0>=      |


I would prefer if we do version bumps separately, if you don't mind

martinRenou · 2022-04-01T07:29:05Z

package.json

@@ -1,6 +1,6 @@
 {
    "name": "jupyter-matplotlib",
-    "version": "0.10.5",
+    "version": "0.10.6",


Same comment here for the version bump

martinRenou · 2022-04-01T07:31:26Z

Concerning the version bump, what I did until now was to push release commits to master (see this for example), that keeps the release commit clean in the history and far from any merge commit.

ianhi · 2022-04-01T14:38:13Z

removed version bumping stuff
Used same number for toolbar and canvas
model version now 1.0.0

ianhi · 2022-04-01T15:08:23Z

any idea what's causing this new error?

src/plugin.ts:35:9 - error TS2322: Type '() => Promise<typeof import("/home/ian/Documents/oss/matplotlib/ipympl/src/index")>' is not assignable to type 'ExportData'.
  Type '() => Promise<typeof import("/home/ian/Documents/oss/matplotlib/ipympl/src/index")>' is not assignable to type '() => ExportMap'.
    Type 'Promise<typeof import("/home/ian/Documents/oss/matplotlib/ipympl/src/index")>' is not assignable to type 'ExportMap'.
      Index signature is missing in type 'Promise<typeof import("/home/ian/Documents/oss/matplotlib/ipympl/src/index")>'.

35         exports: () => import('./index'),
           ~~~~~~~

  node_modules/@jupyter-widgets/base/lib/registry.d.ts:35:5
    35     exports: ExportData;
           ~~~~~~~
    The expected type comes from property 'exports' which is declared here on type 'IWidgetRegistryData'

ianhi · 2022-04-01T15:17:04Z

src/plugin.ts

@@ -32,6 +32,6 @@ function activateWidgetExtension(
    registry.registerWidget({
        name: MODULE_NAME,
        version: MODULE_VERSION,
-        exports: () => import('./index'),
+        exports: (): any => import('./index'),


this gets rid of the typescript error, but is probably not the best way to do that.

ianhi · 2022-04-01T15:39:05Z

Thank goodness for those galata tests. they catch that this actually does break things :/

ianhi · 2022-04-01T16:02:18Z

ipympl/_version.py

+# how to speak. See counterpart in the src/version.ts file.
+# These should not be changed unless we introduce changes to communication between
+# frontend and backend.
+__MODEL_VERSION__ = "^1.0.0"


in ipywidgets there is no ^ maybe we should remove also?

wholtz · 2022-04-01T17:15:24Z

I don't have any strong opinion on declaring the current state as being model version 1.0.0. I suspect there isn't a way through this change without a bit of pain for users and I'd lean towards getting the painful parts over soon. Therefore I support the proposed way forward. Looking forward to this -- thanks @ianhi!

martinRenou · 2022-04-04T07:56:51Z

I suspect there isn't a way through this change without a bit of pain for users and I'd lean towards getting the painful parts over soon

I actually believe this could go smoothly for users. They will hopefully just see a version bump on ipympl and jupyter-matplotlib, as for any release. Then it will hopefully be easier for them to update one without the other from now on :)

to allow compatibility between patch releases.

ianhi · 2022-04-05T14:53:17Z

src/toolbar_widget.ts

@@ -12,8 +12,8 @@ export class ToolbarModel extends DOMWidgetModel {
            _view_name: 'ToolbarView',
            _model_module: 'jupyter-matplotlib',
            _view_module: 'jupyter-matplotlib',
-            _model_module_version: '^' + MODULE_VERSION,
-            _view_module_version: '^' + MODULE_VERSION,
+            _model_module_version: MODEL_VERSION,


I'm not sure having the ^ does anything - and ipywidgets doesn't do this, so I removed it to be more similar to ipywidgets.

ianhi · 2022-04-05T14:53:34Z

I think this is ready now (supposing tests pass)

ianhi added 2 commits March 31, 2022 17:35

update black version

46716af

avoids: psf/black#2964

bump min matplotlib version

e36bce8

This was already too low - previously was 3.3.1. With update of doubleclick we now need to require 3.4

ianhi requested a review from martinRenou March 31, 2022 21:47

martinRenou reviewed Apr 1, 2022

View reviewed changes

ianhi force-pushed the model-version branch from 36ab612 to f4160c9 Compare April 1, 2022 14:36

ianhi force-pushed the model-version branch from f4160c9 to 5b21a6a Compare April 1, 2022 15:08

ianhi commented Apr 1, 2022

View reviewed changes

ianhi force-pushed the model-version branch from 57bd652 to 7ea02d2 Compare April 1, 2022 15:56

ianhi commented Apr 1, 2022

View reviewed changes

Add model version separate from package version

a027447

to allow compatibility between patch releases.

ianhi force-pushed the model-version branch from 7ea02d2 to a027447 Compare April 5, 2022 14:52

ianhi commented Apr 5, 2022

View reviewed changes

ianhi changed the title ~~A model version + bump version~~ Add model version separate from package version Apr 12, 2022

ianhi merged commit 8911332 into matplotlib:main Apr 13, 2022

ianhi deleted the model-version branch April 13, 2022 17:36

ianhi mentioned this pull request Apr 13, 2022

Incompatibilities between patch versions when installed in both server and kernel environment #416

Closed

martinRenou mentioned this pull request Apr 21, 2022

v0.9.0 breaks Output rendering in voila #463

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add model version separate from package version #448

Add model version separate from package version #448

ianhi commented Mar 31, 2022

github-actions bot commented Mar 31, 2022

ianhi commented Mar 31, 2022

martinRenou left a comment

martinRenou Apr 1, 2022

ianhi Apr 1, 2022

martinRenou Apr 1, 2022

ianhi Apr 1, 2022

martinRenou Apr 1, 2022

martinRenou commented Apr 1, 2022

ianhi commented Apr 1, 2022

ianhi commented Apr 1, 2022

ianhi Apr 1, 2022

ianhi commented Apr 1, 2022

ianhi Apr 1, 2022

wholtz commented Apr 1, 2022

martinRenou commented Apr 4, 2022

ianhi Apr 5, 2022

ianhi commented Apr 5, 2022

Add model version separate from package version #448

Add model version separate from package version #448

Conversation

ianhi commented Mar 31, 2022

github-actions bot commented Mar 31, 2022

ianhi commented Mar 31, 2022

martinRenou left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

martinRenou commented Apr 1, 2022

ianhi commented Apr 1, 2022

ianhi commented Apr 1, 2022

Choose a reason for hiding this comment

ianhi commented Apr 1, 2022

Choose a reason for hiding this comment

wholtz commented Apr 1, 2022

martinRenou commented Apr 4, 2022

Choose a reason for hiding this comment

ianhi commented Apr 5, 2022