PR: Initial traceback setup to use selected syntax style (IPython Console) #22965

dalthviz · 2024-11-13T00:43:47Z

Description of Changes

Included a screenshot or animation (if affecting the UI, see Licecap)

Enable context mode tracebacks to follow currently selected syntax style. A preview:

Depends on PR: Add logic to handle traceback color configuration spyder-kernels#521

Issue(s) Resolved

Notes

Probably the logic here to set the syntax style via the import of the VerboseTB class and set the exception handler to verbose (xmode magic) should go over spyder-kernels and be added as a kernel comm handler method? What do you think @ccordoba12 ?
Requires changes over spyder-kernels: spyder-ide/spyder-kernels#521

Affirmation

By submitting this Pull Request or typing my (user)name below,
I affirm the Developer Certificate of Origin
with respect to all commits and content included in this PR,
and understand I am releasing the same under Spyder's MIT (Expat) license.

I certify the above statement is true and correct: dalthviz

pep8speaks · 2024-11-13T00:43:52Z

Hello @dalthviz! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2024-11-27 00:41:13 UTC

ccordoba12 · 2024-11-13T16:17:35Z

Probably the logic here to set the syntax style via the import of the VerboseTB class and set the exception handler to verbose (xmode magic) should go over spyder-kernels and be added as a kernel comm handler method?

Yep, I was thinking exactly the same. You should be able to use the ShellWidget.set_kernel_configuration method to do that and then add a new method in spyder-kernels to set the traceback style.

That approach has the great advantage of being backwards compatible because the corresponding handler in spyder-kernels (SpyderKernel.set_configuration) doesn't do anything if it's asked to update a config it can't handle.

Also, since this requires the verbose traceback mode, you need to change that in the kernel too, specifically here:

https://github.com/spyder-ide/spyder-kernels/blob/7b8dc11d487b7f94cf94a9546ea29b65c64e3c84/spyder_kernels/console/start.py#L73

And you also probably need to update the code that allows to click on a traceback filename to open it in the editor due to that.

…rmats file paths

dalthviz · 2024-11-15T00:04:26Z

Note: Could it be that this will also end up fixing #1052 ?

ccordoba12 · 2024-11-15T04:23:15Z

Note: Could it be that this will also end up fixing #1052 ?

Yep, it will! 🎉

…ight style

--branch=spyder_22965 --update --force external-deps/spyder-kernels subrepo: subdir: "external-deps/spyder-kernels" merged: "75ebcac30" upstream: origin: "https://github.com/dalthviz/spyder-kernels.git" branch: "spyder_22965" commit: "75ebcac30" git-subrepo: version: "0.4.3" origin: "???" commit: "???"

… style

--branch=spyder_22965 --update --force external-deps/spyder-kernels subrepo: subdir: "external-deps/spyder-kernels" merged: "589c471ae" upstream: origin: "https://github.com/dalthviz/spyder-kernels.git" branch: "spyder_22965" commit: "589c471ae" git-subrepo: version: "0.4.3" origin: "???" commit: "???"

…_style_changed'

ccordoba12 · 2024-11-19T02:16:33Z

Thanks @dalthviz for your work on this! A couple of quick comments:

It seems now we need to adjust the ANSI color we're using for the reloaded modules message in the light theme. The light yellow shown in your second screenshot doesn't have enough contrast with respect to the background.
The background color used to highlight the line where the error is present in the dark theme is too strong and doesn't allow to read very well the text it highlights:

But according to PR Quick hack to make tb highlighting configurable. ipython/ipython#13756, we should be able to adjust it to use a better color.

dalthviz · 2024-11-19T21:49:33Z

What colors should be used instead? Something like this works:

?

--branch=spyder_22965 --update --force external-deps/spyder-kernels subrepo: subdir: "external-deps/spyder-kernels" merged: "f3211825d" upstream: origin: "https://github.com/dalthviz/spyder-kernels.git" branch: "spyder_22965" commit: "f3211825d" git-subrepo: version: "0.4.3" origin: "???" commit: "???"

--branch=spyder_22965 --update --force external-deps/spyder-kernels subrepo: subdir: "external-deps/spyder-kernels" merged: "d9e7bad05" upstream: origin: "https://github.com/dalthviz/spyder-kernels.git" branch: "spyder_22965" commit: "d9e7bad05" git-subrepo: version: "0.4.3" origin: "???" commit: "???"

--branch=spyder_22965 --update --force external-deps/spyder-kernels subrepo: subdir: "external-deps/spyder-kernels" merged: "6939c42df" upstream: origin: "https://github.com/dalthviz/spyder-kernels.git" branch: "spyder_22965" commit: "6939c42df" git-subrepo: version: "0.4.3" origin: "???" commit: "???"

--branch=spyder_22965 --update --force external-deps/spyder-kernels subrepo: subdir: "external-deps/spyder-kernels" merged: "753558ad1" upstream: origin: "https://github.com/dalthviz/spyder-kernels.git" branch: "spyder_22965" commit: "753558ad1" git-subrepo: version: "0.4.3" origin: "???" commit: "???"

--branch=spyder_22965 --update --force external-deps/spyder-kernels subrepo: subdir: "external-deps/spyder-kernels" merged: "07b9ca3e8" upstream: origin: "https://github.com/dalthviz/spyder-kernels.git" branch: "spyder_22965" commit: "07b9ca3e8" git-subrepo: version: "0.4.3" origin: "???" commit: "???"

ccordoba12 · 2024-11-20T16:55:54Z

What colors should be used instead? Something like this works:

For the reloaded modules message:
- Dark theme: The previous yellow (i.e. the one from your initial screenshot) looks good.
- Light theme: The red you selected in your last screenshot looks fine.
For highlighted lines in tracebacks on both themes: I tried a lot of colors, but I found that the red and yellow ones you selected at the beginning were the best ones. Sorry for the noise.

--branch=spyder_22965 --update --force external-deps/spyder-kernels subrepo: subdir: "external-deps/spyder-kernels" merged: "db71627b9" upstream: origin: "https://github.com/dalthviz/spyder-kernels.git" branch: "spyder_22965" commit: "db71627b9" git-subrepo: version: "0.4.3" origin: "???" commit: "???"

--branch=spyder_22965 --update --force external-deps/spyder-kernels subrepo: subdir: "external-deps/spyder-kernels" merged: "20f181681" upstream: origin: "https://github.com/dalthviz/spyder-kernels.git" branch: "spyder_22965" commit: "20f181681" git-subrepo: version: "0.4.3" origin: "???" commit: "???"

ccordoba12

One last tiny comment for you @dalthviz, the rest looks good to me.

spyder/plugins/ipythonconsole/widgets/shell.py

Co-authored-by: Carlos Cordoba <ccordoba12@gmail.com>

…r-kernels.git --branch=master --update --force external-deps/spyder-kernels subrepo: subdir: "external-deps/spyder-kernels" merged: "07f24b6fd" upstream: origin: "https://github.com/spyder-ide/spyder-kernels.git" branch: "master" commit: "07f24b6fd" git-subrepo: version: "0.4.3" origin: "???" commit: "???"

dalthviz · 2024-11-26T23:17:39Z

Note: Failing tests jobs (linux fast) seem like are being caused due to python/pythondotorg#2663 🤔

ccordoba12 · 2024-11-26T23:33:49Z

Ok, so we'll have to wait until that issue is solved. In the meantime, please remove your two last commits.

ccordoba12 · 2024-11-27T00:39:29Z

And things seem to be working again, so we should be fine now.

ccordoba12

Great work, thanks @dalthviz!

ccordoba12 · 2024-11-27T04:13:38Z

@dalthviz, please open a follow-up PR to remove the spyder/plugins/ipythonconsole/utils/style.py module and import it instead from Spyder-kernels.

As we discussed, that's necessary to not have repeated code in two places and it'll be included in 6.1 only.

…up to use selected syntax style (IPython Console))

Backport PR #22965 on branch 6.x (PR: Initial traceback setup to use selected syntax style (IPython Console))

IPython Console: Initial traceback setup to use selected syntax style

0efc145

dalthviz added the component:IPython Console label Nov 13, 2024

dalthviz added this to the v6.0.3 milestone Nov 13, 2024

dalthviz self-assigned this Nov 13, 2024

IPython Console: Enable going to file from xmode plain and context fo…

44a08d3

…rmats file paths

dalthviz added 5 commits November 15, 2024 23:19

IPython Console: Use kernel configuration handler for traceback highl…

79dcad4

…ight style

IPython Console: Prevent premature call to config traceback highlight…

0927a4b

… style

IPython Console: Enable traceback config from Spyder call to '_syntax…

6c12cb1

…_style_changed'

dalthviz changed the title ~~[WIP] PR: Initial traceback setup to use selected syntax style (IPython Console)~~ PR: Initial traceback setup to use selected syntax style (IPython Console) Nov 18, 2024

Merge branch 'master' into fixes_issue_22412

06fc003

dalthviz marked this pull request as ready for review November 18, 2024 23:47

dalthviz added 7 commits November 19, 2024 16:59

IPython Console: Pass syntax style dict to kernel config call

23928f7

Testing

5baef98

Merge branch 'master' into fixes_issue_22412

a6cb0c2

ccordoba12 added type:Bug type:Enhancement labels Nov 20, 2024

ccordoba12 added the User Interface (UI) label Nov 20, 2024

dalthviz added 3 commits November 20, 2024 18:10

Code style

55d747c

ccordoba12 reviewed Nov 26, 2024

View reviewed changes

spyder/plugins/ipythonconsole/widgets/shell.py Outdated Show resolved Hide resolved

dalthviz and others added 3 commits November 26, 2024 17:15

Apply suggestions from code review

41c288a

Co-authored-by: Carlos Cordoba <ccordoba12@gmail.com>

Merge branch 'master' into fixes_issue_22412

6378f5c

dalthviz force-pushed the fixes_issue_22412 branch from 8eb22b8 to 6378f5c Compare November 27, 2024 00:41

ccordoba12 approved these changes Nov 27, 2024

View reviewed changes

ccordoba12 merged commit 9eb4863 into spyder-ide:master Nov 27, 2024
22 of 34 checks passed

ccordoba12 added a commit to ccordoba12/spyder that referenced this pull request Nov 27, 2024

Backport PR spyder-ide#22965 on branch 6.x (PR: Initial traceback set…

fb06863

…up to use selected syntax style (IPython Console))

ccordoba12 added a commit that referenced this pull request Nov 27, 2024

Merge pull request #23090 from ccordoba12/backport-pr-22965

dff8e2d

Backport PR #22965 on branch 6.x (PR: Initial traceback setup to use selected syntax style (IPython Console))

dalthviz mentioned this pull request Nov 27, 2024

PR: Use style functions from spyder-kernels (IPython Console) #23100

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PR: Initial traceback setup to use selected syntax style (IPython Console) #22965

PR: Initial traceback setup to use selected syntax style (IPython Console) #22965

dalthviz commented Nov 13, 2024 •

edited

Loading

pep8speaks commented Nov 13, 2024 •

edited

Loading

ccordoba12 commented Nov 13, 2024 •

edited

Loading

dalthviz commented Nov 15, 2024

ccordoba12 commented Nov 15, 2024

ccordoba12 commented Nov 19, 2024 •

edited

Loading

dalthviz commented Nov 19, 2024

ccordoba12 commented Nov 20, 2024 •

edited

Loading

ccordoba12 left a comment •

edited

Loading

dalthviz commented Nov 26, 2024 •

edited

Loading

ccordoba12 commented Nov 26, 2024

ccordoba12 commented Nov 27, 2024

ccordoba12 left a comment

ccordoba12 commented Nov 27, 2024 •

edited

Loading

PR: Initial traceback setup to use selected syntax style (IPython Console) #22965

PR: Initial traceback setup to use selected syntax style (IPython Console) #22965

Conversation

dalthviz commented Nov 13, 2024 • edited Loading

Description of Changes

Issue(s) Resolved

Notes

Affirmation

pep8speaks commented Nov 13, 2024 • edited Loading

Comment last updated at 2024-11-27 00:41:13 UTC

ccordoba12 commented Nov 13, 2024 • edited Loading

dalthviz commented Nov 15, 2024

ccordoba12 commented Nov 15, 2024

ccordoba12 commented Nov 19, 2024 • edited Loading

dalthviz commented Nov 19, 2024

ccordoba12 commented Nov 20, 2024 • edited Loading

ccordoba12 left a comment • edited Loading

Choose a reason for hiding this comment

dalthviz commented Nov 26, 2024 • edited Loading

ccordoba12 commented Nov 26, 2024

ccordoba12 commented Nov 27, 2024

ccordoba12 left a comment

Choose a reason for hiding this comment

ccordoba12 commented Nov 27, 2024 • edited Loading

dalthviz commented Nov 13, 2024 •

edited

Loading

pep8speaks commented Nov 13, 2024 •

edited

Loading

ccordoba12 commented Nov 13, 2024 •

edited

Loading

ccordoba12 commented Nov 19, 2024 •

edited

Loading

ccordoba12 commented Nov 20, 2024 •

edited

Loading

ccordoba12 left a comment •

edited

Loading

dalthviz commented Nov 26, 2024 •

edited

Loading

ccordoba12 commented Nov 27, 2024 •

edited

Loading