[KED-2906] Add new plotly.JSONDataSet #981
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 tasks
antonymilne
commented
Oct 22, 2021
antonymilne
commented
Oct 22, 2021
Comment on lines
+149
to
+164
| def _load(self) -> Union[go.Figure, go.FigureWidget]: | ||
| load_path = get_filepath_str(self._get_load_path(), self._protocol) | ||
|
|
||
| with self._fs.open(load_path, **self._fs_open_args_load) as fs_file: | ||
| # read_json doesn't work correctly with file handler, so we have to read | ||
| # the file, decode it manually and pass to the low-level from_json instead. | ||
| return pio.from_json(str(fs_file.read(), "utf-8"), **self._load_args) | ||
|
|
||
| def _save(self, data: go.Figure) -> None: | ||
| save_path = get_filepath_str(self._get_save_path(), self._protocol) | ||
|
|
||
| with self._fs.open(save_path, **self._fs_open_args_save) as fs_file: | ||
| data.write_json(fs_file, **self._save_args) | ||
|
|
||
| self._invalidate_cache() | ||
|
|
There was a problem hiding this comment.
This is essentially the same as what plotly.PlotlyDataSet did but without conversion from a pandas dataframe first.
antonymilne
commented
Oct 22, 2021
| from kedro.io.core import Version, get_filepath_str | ||
| from kedro.io.core import Version | ||
|
|
||
| from .json_dataset import JSONDataSet | ||
|
|
||
|
|
||
| class PlotlyDataSet(JSONDataSet): |
There was a problem hiding this comment.
Note this now inherits from the new plotly.JSONDataSet class, not pandas.JSONDataSet like it used to.
antonymilne
changed the title
limdauto
approved these changes
Oct 22, 2021
| version=self._version, | ||
| ) | ||
|
|
||
| def _load(self) -> Union[go.Figure, go.FigureWidget]: |
There was a problem hiding this comment.
Is this Union intentional?
There was a problem hiding this comment.
Yes. You can specify the output_type (through load_args): https://plotly.com/python-api-reference/generated/plotly.io.from_json.html
setup.py
Outdated
| @@ -106,7 +106,10 @@ def _collect_requirements(requires): | |||
| "pandas.SQLQueryDataSet": [PANDAS, "SQLAlchemy~=1.2"], | |||
| } | |||
| pillow_require = {"pillow.ImageDataSet": ["Pillow~=8.0"]} | |||
| plotly_require = {"plotly.PlotlyDataSet": [PANDAS, "plotly~=4.14"]} | |||
| plotly_require = { | |||
| "plotly.PlotlyDataSet": [PANDAS, "plotly~=4.14"], | |||
There was a problem hiding this comment.
I feel like we can relax this even further to ~=4.0 to be honest.
| ) | ||
| def plotly_args(request): | ||
| return request.param | ||
| @pytest.fixture |
There was a problem hiding this comment.
I hereby nominate myself for a values award.
antonymilne
commented
Oct 22, 2021
6 tasks
lvijnck
pushed a commit
to lvijnck/kedro
that referenced
this pull request
Apr 7, 2022
Signed-off-by: Laurens Vijnck <laurens_vijnck@mckinsey.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Following #839 and #955, we now have a new dataset
plotly.JSONDataSet.The old
plotly.PlotlyDataSetstill works exactly as it did before:The inheritance structure has been rewritten and the code tided up.
plotly.JSONDataSetshould be considered the "base" class that does the heavy lifting of converting between plotly figure and json;plotly.PlotlyDataSetsubclasses this and is a convenience wrapper that enables you to make plots directly from a pandas DataFrame.Tested manually with both local and remote (s3) storage.
Checklist
RELEASE.mdfileNotice
I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":
I submit this contribution under the Apache 2.0 license and represent that I am entitled to do so on behalf of myself, my employer, or relevant third parties, as applicable.
I certify that (a) this contribution is my original creation and / or (b) to the extent it is not my original creation, I am authorised to submit this contribution on behalf of the original creator(s) or their licensees.
I certify that the use of this contribution as authorised by the Apache 2.0 license does not violate the intellectual property rights of anyone else.