Persist code cell collapsed #3981

saulshanabrook · 2018-02-23T16:50:27Z

This adds support for loading the collapsed state of a code cell output from the collapsed metadata property, as well as saving to that property when the persistOutputsCollapsed command is run.

We do this by just storing the persisted value of the collapsed state in the CodeCellModel. The view initializes itself from this value, but when it is updated (you collapse a cell) it doesn't update the model. Only when the command is explicitly run does it set the metadata value in the model, which is then saved to disk when it is serialized to JSON.

This addresses the collapsed output cells part of #3799 but doesn't work on persisting the input cells.

load collapsed state to model from file
load view state from model
Add command to copy from view to model
Add menu item as well

saulshanabrook · 2018-02-26T14:52:32Z

@ellisonbg Let me know if this is implemented how you envisioned.

I don't find it particularly intuitive to have to run persistOutputsCollapsed to save the collapsed states, but it does the job of keeping that state independent of the file on disk.

As far as I understand it, this supports the case where two people have the same file open at once in different JupterLab instances and want to have different things collapsed. However, if this isn't a case we want to support, than just having the collapsed state part of the model makes more sense.

ellisonbg · 2018-03-07T21:50:39Z

Things we talked about today in the meeting:

Keep the command to manually persist the state.
Add a new extension point and keyboard shortcut (command+shift+S) that extensions can do additional things with before saving (such as persist this state).

saulshanabrook · 2018-03-07T21:57:12Z

Add a new extension point and keyboard shortcut (command+shift+S) that extensions can do additional things with before saving (such as persist this state).

Is there anything else at the moment that should also be saved here?

Here are a couple of options I was thinking for the label:

Save with View
Save with Current View
Save with View State

Or, if we want to keep it collapsed state specific atm

Save Notebook with Collapsed State
Save Notebook with Collapsed/Revealed

/cc @afshin

ellisonbg · 2018-03-07T22:06:47Z

Yeah, this is going to be tough to name. Of the options you list, I am probably partial to: * Save Notebook with View State The "Save Notebook..." follows our current menu design and both "view" and "current view" don't quite capture it. Or we could go more generic: * Save Notebook * Save Notebook with Extras ...Naming...

…

On Wed, Mar 7, 2018 at 1:57 PM, Saul Shanabrook ***@***.***> wrote: Add a new extension point and keyboard shortcut (command+shift+S) that extensions can do additional things with before saving (such as persist this state). Is there anything else at the moment that should also be saved here? Does "Save with View" make sense as a label? Couple of options for label: - Save with View - Save with Current View - Save with View State Or, if we want to keep it collapsed state specific atm - Save Notebook with Collapsed State - Save Notebook with Collapsed/Revealed /cc @afshin <https://github.com/afshin> — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#3981 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AABr0NaGrLZIJg7jEQ1Ht8aoDAY68ir1ks5tcFe5gaJpZM4SRKZF> .

-- Brian E. Granger Associate Professor of Physics and Data Science Cal Poly State University, San Luis Obispo @ellisonbg on Twitter and GitHub bgranger@calpoly.edu and ellisonbg@gmail.com

saulshanabrook · 2018-03-08T16:15:36Z

I added an extension point to the file menu that is similar to the "close and clean" one. It let's any widget register a custom save command, that has some extra logic. If it isn't implemented, it will appear as "Save with Extras":

For the notebook, it says "Save Notebook with View State":

I bound this by default to CMD SHIFT S.

ian-r-rose · 2018-05-17T17:16:27Z

I am glad to see the menu extension system getting some use! Looks like it needs a rebase, but the overall implementation looks sound to me.

My main question is this: will this functionality be widely-used enough that initiallyCollapsed should exist at the top-level of the cell model? As far as I can tell, we could accomplish the same thing by directly editing the cell metadata for 'collapsed', rather than another layer of indirection in the ICellModel.initiallyCollapsed.

Put another way, I think there is value to having the cell model be reasonably close to that described in nbformat.

saulshanabrook · 2018-05-22T18:19:31Z

@ian-r-rose thanks for looking over this.

As far as I can tell, we could accomplish the same thing by directly editing the cell metadata for 'collapsed', rather than another layer of indirection in the ICellModel.initiallyCollapsed.

Yeah it took my like ten looking over my code to figure out what it was doing, so it should be changed somehow. Also, I don't why I added that indirection. I will try rebasing and removing that and hopefully that will be clearer and still work properly.

saulshanabrook · 2018-05-22T18:47:43Z

@ellisonbg Coming back to this, I wonder if the notebook specific save should be 'Save Notebook with Collapsed State' instead of 'Save Notebook with View State'. Otherwise, the user will not really know what is part of the view state. If we extend the command in the future to do more, we could update the name to be more general.

@ian-r-rose I removed the extra abstraction, should be more readable now.

ian-r-rose

Just took this for a spin, and it works really nicely. Am I right in thinking that "collapsed" is a semi-official metadata field for this behavior? In the current UI both inputs and outputs are able to be collapsed, but this only applies to outputs, so I found the naming to be a touch confusing. I don't think it's a big problem, though.

ian-r-rose · 2018-05-22T18:57:45Z

packages/notebook-extension/src/index.ts

+    persistAndSave: (current: NotebookPanel) => {
+      NotebookActions.persistOutputsCollapsed(current.notebook);
+      app.commands.execute('docmanager:save');
+      return Promise.resolve();


Is there a reason you are returning a resolved promise here, rather than return app.comands.execute('docmanager:save');?

Nope. I have changed it.

ian-r-rose · 2018-05-22T18:58:39Z

packages/notebook/src/actions.tsx

+   */
+  export
+  function persistOutputsCollapsed(widget: Notebook): void {
+    if (!widget.model || !widget.activeCell) {


Do we need an active cell check here? As far as I know, we should always have one, but it doesn't seem strictly necessary for the functionality.

Nope I don't believe we do, I was just copy and pasting. Removed.

ian-r-rose · 2018-05-22T19:00:28Z

packages/shortcuts-extension/schema/plugin.json

+      "default": { },
+      "properties": {
+        "command": { "default": "filemenu:persist-and-save" },
+        "keys": { "default": ["Accel Shift S"] },


This now conflicts with the "Save As..." shortcut (sorry, I know your PR predates that!). There is a lot of precedence for "Save As..." having Accel Shift S as a shortcut. Can we choose something else?

I changed to Accel Ctrl S which works for me on mac/chrome.

ian-r-rose · 2018-05-22T19:01:30Z

tests/test-notebook/src/actions.spec.ts

+        NotebookActions.persistOutputsCollapsed(widget);
+        for (const cell of widget.widgets) {
+          if (cell instanceof CodeCell) {
+            expect(cell.model.initiallyCollapsed).to.be(cell.outputHidden);


This looks like it needs to be fixed.

Yep. Changed to use metadata.

ian-r-rose

Thanks! This looks good to me, pending CI. If we want to change the label to "Collapsed State", that's cool too.

saulshanabrook · 2018-05-22T19:28:02Z

Am I right in thinking that "collapsed" is a semi-official metadata field for this behavior?

Yeah it is. AFAIK in the notebook we just have a single collapsed metadata for the whole cell. I don't know how to specify that the input collapsed vs the output is collapsed:

ian-r-rose · 2018-05-22T19:33:09Z

Does the classic notebook collapse the whole cell, or just the outputs?

Edit: looks to me like just the outputs. In which case, I think you have the correct behavior (even if the naming is a bit confusing).

akhmerov · 2018-05-22T19:34:26Z

There's a separate outputs_hidden

EDIT: also a separate source_hidden a couple of lines above.

ian-r-rose · 2018-05-22T19:43:09Z

As far as I can tell, outputs_hidden and collapsed have very similar behavior.

saulshanabrook · 2018-05-22T19:46:30Z

Looks like collapsed maybe should enabling scrolling for output and outputs_hidden and inputs_hidden should control if they are actually hidden (src, nbformat discussion).

So I guess I should update the PR to use outputs_hidden and maybe also include support for inputs_hidden.

EDIT: Does that seem like the right approach?

ian-r-rose · 2018-05-22T19:54:28Z

Thanks for the link @akhmerov. I don't see a difference in how the classic notebook handles collapsed vs outputs_hidden, nor do I see any effect for inputs_hidden. Is it possible that the classic notebook doesn't implement this feature?

akhmerov · 2018-05-22T19:58:21Z

AFAIR the classic notebook indeed never made use of these fields.

akhmerov · 2018-05-22T20:00:44Z

I found the official reference: https://github.com/jupyter/nbformat/blob/master/docs/changelog.rst#44

ian-r-rose · 2018-05-22T20:14:47Z

In that case, I see a couple of options:

Use collapsed as an alias for jupyter.outputs_hidden. Also introduce jupyter.inputs_hidden in the same fashion as this PR.
Use jupyter.inputs_hidden and jupyter.outputs_hidden as intended. Use collapsed as an alias for jupyter.inputs_hidden && jupyter.outputs_hidden.

Thoughts?

akhmerov · 2018-05-22T20:17:43Z

Should collapsed be used in this context at all? I believe it's older and has a different use.

ian-r-rose · 2018-05-22T20:19:25Z

I agree that it's older, but I was hoping to avoid breaking existing notebooks, and it is in the schema. Can you elaborate on what the different use is? Again, I could not see what it did other than hide the outputs.

akhmerov · 2018-05-22T21:00:50Z

Can you elaborate on what the different use is?

I was perhaps too hasty. I base my evaluation on the issue discussion found by @saulshanabrook (the nbformat docs are also not very helpful BTW). The discussion suggests that collapsed is perhaps more like "visible but occupying very little space". The current jupyterlab UI does not have an alternative means of showing such state, instead only implementing something more similar to output hiding.

Based on the above I believe that:

Jupyterlab should render cells that are collapsed the same way as cells with jupyter.outputs_hidden. In other words, jupyterlab shouldn't render outputs if collapsed || jupyter.outputs_hidden.
Whether the input is not shown should not depend on whether the cell is collapsed due to compatibility with the classic notebook.
Finally, it is probably a matter of choice whether hiding output using the jupyterlab UI should set the collapsed metadata. Given that right now classic notebook is extremely popular, I believe both flags should be set whenever used hides an output from jupyterlab UI.

saulshanabrook · 2018-05-22T21:05:19Z

@akhmerov Thanks for the suggestions.

The discussion suggests that collapsed is perhaps more like "visible but occupying very little space". The current jupyterlab UI does not have an alternative means of showing such state, instead only implementing something more similar to output hiding.

Do you think enabling scrolling for outputs covers this use case? Since it limits how much vertical space the outputs take up?

akhmerov · 2018-05-22T21:13:46Z

Do you think enabling scrolling for outputs covers this use case? Since it limits how much vertical space the outputs take up?

To be honest, I'm not an ultimate nbformat authority, and the docs are not too specific. Let's try to see WWCND (what would classic notebook do).

Pristine cell
"scrolled": true
"collapsed": true

So it seems it is would be more in line with the classic notebook to unify collapsed with jupyter.outputs_hidden than with scrolled.

saulshanabrook · 2018-05-28T17:26:36Z

I rebased and updated the current.notebook locations.

ian-r-rose · 2018-05-28T17:27:11Z

Great, thanks for all the back and forth!

dclong · 2018-06-30T02:44:46Z

Does nbconvert respect folded cells? That is when we export the notebook to an HTML, will folded cells in the notebook be folded in the HTML?

akhmerov · 2018-07-01T10:31:58Z

@dclong quoting the changelog of nbformat:

Introduce source_hidden and outputs_hidden as official front-end metadata fields to indicate hiding source and outputs areas. NB: These fields should not be used to hide elements in exported formats.

If I remember correctly though, modifying nbconvert config to use these fields should be relatively straightforward.

meeseeksmachine · 2019-07-25T15:54:24Z

This pull request has been mentioned on Jupyter Community Forum. There might be relevant details there:

https://discourse.jupyter.org/t/hiding-code-cell-on-launch/1763/4

jasongrout added this to the Beta 3 milestone Mar 28, 2018

jasongrout mentioned this pull request Mar 29, 2018

UI/UX for collapsing input/output #713

Closed

ellisonbg assigned ian-r-rose May 14, 2018

LeonDpl mentioned this pull request May 22, 2018

Keep output cells collapsed after re-execution #4580

Open

saulshanabrook force-pushed the persist-collapsed branch 2 times, most recently from 8a91e83 to 2cec23b Compare May 22, 2018 18:22

ian-r-rose reviewed May 22, 2018

View reviewed changes

ian-r-rose approved these changes May 22, 2018

View reviewed changes

saulshanabrook added 12 commits May 28, 2018 13:23

remove holdover test setup

c5e1816

Fix notebook action test to not use initiallCollapsed

1fbd0b6

Changed shortcut to use ctrl instead of shit

c8ae352

remove some unnecessary code

8c9a1af

Add support for loading scrolling and input hiding

0a0d216

Fix bugs

21ce37b

Moved state initialization after child constructor

0be5a9c

Make metadata loading more strict

7773cd3

fix test & not scrolled on autoscroll

1025a39

test typo

e87d150

Change keyboard shorcut for non mac compat

6957c4f

update for context refactor

6ce4241

saulshanabrook force-pushed the persist-collapsed branch from bf028ec to 6ce4241 Compare May 28, 2018 17:26

ian-r-rose merged commit 3202ec5 into jupyterlab:master May 28, 2018

saulshanabrook mentioned this pull request May 28, 2018

Persistence for collapsed input/output cells #3799

Closed

saulshanabrook deleted the persist-collapsed branch May 28, 2018 18:54

saulshanabrook mentioned this pull request May 28, 2018

Changelog for 0.33 #4622

Closed

saulshanabrook mentioned this pull request Jun 27, 2018

Add execution time to notebook/console cells #3320

Closed

This was referenced Sep 10, 2018

How to handle source_hidden and outputs_hidden #2740

Closed

Suggestion for the save menu #5200

Closed

jasongrout mentioned this pull request Dec 30, 2018

Setting for enabling output scrolling by default #4028

Closed

saulshanabrook mentioned this pull request Mar 26, 2019

outputs_hidden vs collapsed metadata jupyter/nbformat#137

Open

jasongrout mentioned this pull request Mar 27, 2019

Managing notebook metadata #5968

Merged

3 tasks

lock bot added the status:resolved-locked Closed issues are locked after 30 days inactivity. Please open a new issue for related discussion. label Aug 24, 2019

lock bot locked as resolved and limited conversation to collaborators Aug 24, 2019

Persist code cell collapsed #3981

Persist code cell collapsed #3981

Conversation

saulshanabrook commented Feb 23, 2018 • edited Loading

saulshanabrook commented Feb 26, 2018 • edited Loading

ellisonbg commented Mar 7, 2018

saulshanabrook commented Mar 7, 2018 • edited Loading

ellisonbg commented Mar 7, 2018 via email

saulshanabrook commented Mar 8, 2018

ian-r-rose commented May 17, 2018

saulshanabrook commented May 22, 2018 • edited Loading

saulshanabrook commented May 22, 2018

ian-r-rose 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ian-r-rose left a comment

Choose a reason for hiding this comment

saulshanabrook commented May 22, 2018

ian-r-rose commented May 22, 2018 • edited Loading

akhmerov commented May 22, 2018 • edited Loading

ian-r-rose commented May 22, 2018

saulshanabrook commented May 22, 2018 • edited Loading

ian-r-rose commented May 22, 2018

akhmerov commented May 22, 2018

akhmerov commented May 22, 2018

ian-r-rose commented May 22, 2018

akhmerov commented May 22, 2018

ian-r-rose commented May 22, 2018

akhmerov commented May 22, 2018

saulshanabrook commented May 22, 2018

akhmerov commented May 22, 2018

saulshanabrook commented May 28, 2018

ian-r-rose commented May 28, 2018

dclong commented Jun 30, 2018

akhmerov commented Jul 1, 2018

meeseeksmachine commented Jul 25, 2019

saulshanabrook commented Feb 23, 2018 •

edited

Loading

saulshanabrook commented Feb 26, 2018 •

edited

Loading

saulshanabrook commented Mar 7, 2018 •

edited

Loading

saulshanabrook commented May 22, 2018 •

edited

Loading

ian-r-rose commented May 22, 2018 •

edited

Loading

akhmerov commented May 22, 2018 •

edited

Loading

saulshanabrook commented May 22, 2018 •

edited

Loading