keywords for working with multiple open notebook tabs #47

bdattoma · 2021-12-22T09:02:50Z

Signed-off by Berto D'Attoma: [email protected]

Hi, the following PR wants to propose some keywords to work where there are more than one notebook file opened in JupyterLab. Without these, there were issues trying to get cell outputs with the already present keywords.

implemented keywords

The keywords are:

Wait Until a Given JupyterLab Code Cell Is Not Active In a Given Tab - it waits until the [*] symbol disappear (so the cell finished to run) - renamed to Wait Until JupyterLab Code Cell Is Idle. It works fine in Jupyter v3 and v2.
Get A JupyterLab Code Cell Output In a Given Tab - it returns the output of the cell.
Select Tab By Name - it selects an open tab (notebook file). Renamed to Select JupyterLab Dock Panel Tab By FilePath. It works fine in Jupyter v3, v2 and v1
Get Selected Tab ID - it returns the tab id of the selected one (e.g., tab-key-0). Renamed to Get Selected JupyterLab Dock Panel Tab. It works fine in Jupyter v3 and v2

compatibility with Jupyter v1

The main issue is that in v1 we don't have the id attribute on the "tab" element. I can investigate a way to achieve the same result of keyword 1 and 2 without using the tab id (e.g., by targeting the tab by filepath, like done in keyword 3)

bollwyvl · 2021-12-22T22:14:33Z

src/JupyterLibrary/clients/jupyterlab/Notebook.robot

+Get Selected Tab ID
+    [Documentation]    Return the tab ID of the selected notebook tab
+    ${active-nb-tab} =    Get WebElement    xpath:${JL_TABBAR_SELECTED_XPATH}
+    ${tab-id} =    Get Element Attribute    ${active-nb-tab}    id


This seems like a useful capability.

For consistency, it should be added in Shell.robot (well, now Shell.resource) and probably something more like the existing keywords, e.g. Get JupyterLab Dock Panel Tab so perhaps Get Selected JupyterLab Dock Panel Tab and likely return the actual web element.

This can be a one-shot, as Get Element Attribute will accept xpath:. Further, it should

I don't see where JL_TABBAR_SELECTED_XPATH is defined, but would expect to conform to the (increasingly ridiculous, sorry) naming convention.

Hi, yeah sorry the JL_TABBAR_SELECTED_XPATH is missing, my bad. I will fix it.

Thanks for the review. I will go through all the comments asap.

@bollwyvl I move Get Selected JupyterLab Dock Panel Tab in Shell.resource and instead of returning only the tab ID, I return both the web element and the id. In this way i think the keyword is more useful to the user.
Do you agree with this solution?

I also made the xpath compliant with the naming convention you adopted.

bollwyvl · 2021-12-22T22:15:43Z

src/JupyterLibrary/clients/jupyterlab/Notebook.robot

+    ${tab-id} =    Get Element Attribute    ${active-nb-tab}    id
+    [Return]  ${tab-id}
+
+Select Tab By Name


Similar, as above re: naming convention, and I don't see where JL_TABBAR_CONTENT_XPATH is defined.

As other tab-related things, what happens if there's more than one?

As other tab-related things, what happens if there's more than one?

I changed the keyword to select the tab by filepath instead of filename. So, if there are tabs with same name but different filepath, it still works. What do you think?

bollwyvl · 2021-12-22T22:20:15Z

src/JupyterLibrary/clients/jupyterlab/Output.robot

@@ -39,3 +39,16 @@ Screenshot Each Output of Active JupyterLab Document
        Screenshot Each Output of Active JupyterLab Cell    ${prefix}_cell_${i}
        Screenshot Markdown of Active JupyterLab Cell    ${prefix}_cell_${i}
    END
+
+Wait Until a Given JupyterLab Code Cell Is Not Active In a Given Tab
+  [Documentation]  Waits until the given cell in a specific JL tab no longer has an active prompt "[*]:".


This is... very verbose. Could this be broken down into multiple concepts? e.g.

get a handle to the ${cell}

it might have just been added, or be selected by other means

(maybe) go off and do other stuff

Wait Until JupyterLab Cell is Idle ${cell}

Also the terminology (idle, active, whatever) probably needs some investigation in either the DOM or message protocol.

not sure I got what you mean by splitting into multiple concepts. i think it is useful to have a such high level keyword to use while running code cell.

I've just changed the keyword name to: Wait Until JupyterLab Code Cell Is Idle.

bollwyvl · 2021-12-22T22:26:35Z

src/JupyterLibrary/clients/jupyterlab/Output.robot

+  [Documentation]  Waits until the given cell in a specific JL tab no longer has an active prompt "[*]:".
+  ...              The cell index starts from 1 and you must count empty and markdown cells too.
+  [Arguments]  ${tab_id_to_wait}  ${cell_n}  ${timeout}=120seconds
+  Wait Until Element Is Not Visible  xpath=//div[@aria-labelledby="${tab_id_to_wait}"]/${NB TAB XP CONTENT}/div[${cell_n}]/${CELL XP INPUT STATUS ICON}   ${timeout}


Many of these aria-label attributes were only added very recently, and won't work with the older versions of lab under test. This is maybe fine, but it's worth exploring some alternate approaches to finding them.

Also, the 2 minutes is ridiculously long as a default. I guess it's all relative anyway but otherwise the longest one is 30s, and I'd recommend adopting that one as a default.

Out of scope of this: we should see whether SeleniumLibrary already has some related ones, and if so, use them (perhaps with some ghetto math). Otherwise, we could name and categorize our own defaults, e.g. ${RFJL DEFAULT WAIT LONG}, ${RFJL DEFAULT WAIT SHORT} that could be easily overriden at the suite level (or updated from the CLI when retrying).

retro-compatibility

I tried this keyword with JL 3.2.5, 2.3.2 and 1.2.21. I see that it works for both v3 and v2. It's not working for v1. Will update the PR description to include the compatibilities.

timeout

agree with you. I've updated it to 30 seconds.

Out of scope of this: we should see whether SeleniumLibrary already has some related ones [...]

agree. We could investigate this

bollwyvl · 2021-12-22T22:29:09Z

src/JupyterLibrary/clients/jupyterlab/Output.robot

+Get A JupyterLab Code Cell Output In a Given Tab
+   [Documentation]  It returns the output of a given cell in a specific JL tab.
+   ...              The cell index starts from 1 and you must count empty and markdown cells too.
+   [Arguments]  ${tab_id_to_read}  ${cell_n}


This one's tough. Also there can be many outputs, which many be worth parameterizing. Anyhow, I'd probably:

get a handle on the cell

get a handle on the output

then use SL's Get Text on the element

I didn't consider other output type (e.g., images) other than text. So, to write a more generic keyword, I thought to return all the output child elements. I could include a parameter to fetch one specific cell by its progressive number. After that, I could write a keyword to extract the text or the image (i'm not sure if there are more than two output types for jupyter)

src/JupyterLibrary/clients/jupyterlab/Selectors.robot

bollwyvl · 2021-12-22T22:31:20Z

src/JupyterLibrary/clients/jupyterlab/Selectors.robot

+${CELL XP INPUT STATUS ICON}  ${CELL XP INPUT}/div[contains(@class,"jp-InputArea-prompt") and (.="[*]:")]
+${CELL XP OUTPUT}  div[contains(@class, jp-Cell-outputWrapper)]/div[contains(@class,"jp-Cell-outputArea")]
+${CELL XP OUTPUT TEXT}  ${CELL XP OUTPUT}//div[contains(@class,"jp-RenderedText")]
+${NB TAB XP CONTENT}  div[@aria-label="notebook content"]


This will almost certainly not work with other lab versions.

Signed-off-by: bdattoma <[email protected]>

bollwyvl · 2022-01-10T14:38:13Z

src/JupyterLibrary/clients/jupyterlab/Selectors.resource

 ${JLAB XP DOCK TAB LABEL}               ${JLAB XP DOCK TAB}/div[contains(@class, 'p-TabBar-tabLabel')]
+${JLAB XP DOCK TAB SELECTED}            ${JLAB XP DOCK TABBAR CONTENT}/li[contains(@class,"lm-mod-current p-mod-current")]


please just use p-mod-current (the lm-mod-current ones won't work with lab 1)

bollwyvl · 2022-01-10T14:43:06Z

src/JupyterLibrary/clients/jupyterlab/Output.resource

+  [Documentation]  Waits until the given cell in a specific JL tab no longer has an active prompt "[*]:".
+  ...              The cell index starts from 1 and you must count empty and markdown cells too.
+  [Arguments]  ${tab_id_to_wait}  ${cell_n}  ${timeout}=30
+  Wait Until Element Is Not Visible  xpath=//div[@aria-labelledby="${tab_id_to_wait}"]/${JLAB XP NOTEBOOK CONTENT}/div[${cell_n}]/${JLAB XP CELL INPUT STATUS ICON}   ${timeout}


for consistency, first argument should problaby start with xpath: rather than xpath=

bollwyvl · 2022-01-10T14:43:29Z

src/JupyterLibrary/clients/jupyterlab/Output.resource

+Wait Until JupyterLab Code Cell Is Idle
+  [Documentation]  Waits until the given cell in a specific JL tab no longer has an active prompt "[*]:".
+  ...              The cell index starts from 1 and you must count empty and markdown cells too.
+  [Arguments]  ${tab_id_to_wait}  ${cell_n}  ${timeout}=30


please include the unit, e.g 30s

some default of cell_n (e.g. the last) might be helpful.

bollwyvl · 2022-01-10T14:46:16Z

The force pushing makes it hard to track comments over time.

Generally, these are looking okay, but need representative acceptance tests added.

bollwyvl reviewed Dec 22, 2021

View reviewed changes

src/JupyterLibrary/clients/jupyterlab/Selectors.robot Outdated Show resolved Hide resolved

bollwyvl reviewed Dec 22, 2021

View reviewed changes

bdattoma added 3 commits January 3, 2022 12:06

rebase

aac1cd4

some doc added

367331c

Signed-off-by: bdattoma <[email protected]>

new jl selector refactoring

5178667

Signed-off-by: bdattoma <[email protected]>

bdattoma force-pushed the keyword_for_tabs branch from 7818640 to 5178667 Compare January 3, 2022 13:51

bdattoma added 2 commits January 3, 2022 16:11

refactor tab selection keywords

c7da89d

renaming and small changes in output keywords

1c518bf

bdattoma requested a review from bollwyvl January 10, 2022 10:42

bollwyvl reviewed Jan 10, 2022

View reviewed changes

bollwyvl mentioned this pull request Mar 8, 2022

"Add and Run JupyterLab Code Cell" keyword throws error intermittently #58

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

keywords for working with multiple open notebook tabs #47

keywords for working with multiple open notebook tabs #47

bdattoma commented Dec 22, 2021 •

edited

Loading

bollwyvl Dec 22, 2021

bdattoma Dec 23, 2021

bdattoma Jan 3, 2022 •

edited

Loading

bollwyvl Dec 22, 2021

bdattoma Jan 3, 2022

bollwyvl Dec 22, 2021

bdattoma Jan 3, 2022

bollwyvl Dec 22, 2021

bdattoma Jan 3, 2022

bollwyvl Dec 22, 2021

bdattoma Jan 3, 2022

bollwyvl Dec 22, 2021

bollwyvl Jan 10, 2022

bollwyvl Jan 10, 2022

bollwyvl Jan 10, 2022

bollwyvl Jan 10, 2022

bollwyvl commented Jan 10, 2022

		${JLAB XP DOCK TAB LABEL} ${JLAB XP DOCK TAB}/div[contains(@class, 'p-TabBar-tabLabel')]
		${JLAB XP DOCK TAB SELECTED} ${JLAB XP DOCK TABBAR CONTENT}/li[contains(@class,"lm-mod-current p-mod-current")]

keywords for working with multiple open notebook tabs #47

Are you sure you want to change the base?

keywords for working with multiple open notebook tabs #47

Conversation

bdattoma commented Dec 22, 2021 • edited Loading

implemented keywords

compatibility with Jupyter v1

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bdattoma Jan 3, 2022 • edited Loading

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

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

bollwyvl commented Jan 10, 2022

bdattoma commented Dec 22, 2021 •

edited

Loading

bdattoma Jan 3, 2022 •

edited

Loading