Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API Versioning + Migration #2430

Merged
merged 5 commits into from
Nov 17, 2023
Merged

Conversation

ada-x64
Copy link
Contributor

@ada-x64 ada-x64 commented Nov 13, 2023

Based on #2429

This PR adds versioning to the perspective viewer's save/restore API.
It also adds a new format for migrations and adds migrations for the new expression and X/Y scatter symbol serialization formats.

@ada-x64 ada-x64 force-pushed the features/api-versioning branch from 29edbb9 to 870b2f1 Compare November 17, 2023 15:07
Copy link
Member

@texodus texodus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR! Looks good!

It should be noted that versioning in this change is runtime-transparent, the version field is not read or validated in any way by <perspective-viewer> at runtime, only in wrt the migration script. IMO we either need to warn on all deprecated versions, or at least specifically warn of the version when a restore() call fails in addition to the actual error.

The dev notes are not correct, but I will update these.

```

`perspective-python` supports Python 3.8 and upwards.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yarn _requires_python is the correct way to do this. While this is not documented, a good place to look is always the CI actions yaml

yarn build
yarn setup # choose javascript > jupyterlab
yarn build
yarn jlab_link # run this whenever you need to update a local perspective package
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't actually work due to a bug. yarn jlab_link currently installs perspective-python in your virtual env, including the python and C++ extension, so further rebuilds in your source repo won't get picked up.

@texodus texodus added the enhancement Feature requests or improvements label Nov 17, 2023
@texodus texodus merged commit 743d6c7 into finos:master Nov 17, 2023
13 checks passed
@texodus texodus mentioned this pull request Dec 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Feature requests or improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants