PR: Generalize error reporting via signal and simplify widget

[goanpeca]

Description of Changes

• This adds error handling using a signal so devs do not need to call the Console Plugin directly (that should not be needed in general)
• Added documentation to signals in the Plugin and Widgets API
• Move some methods from the main window into the error report dialog, since there was a lot of back and forth and checks if a parent was the main window. I simplified things, since there was an error hapenning.
• Move tests from the main window to the report dialog tests (based on the refactor)
• Adapted a Variable Explorer test so that it passes locally on python 3.6 and OSX

Issue(s) Resolved

Fixes #

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: @goanpeca

[pep8speaks]

Hello @goanpeca! 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 2020-07-28 13:28:26 UTC

[goanpeca]

@nerohmot, it seems I had not yet included the signal (or I did in another API PR?) anyway, this addresses what we spoke today and also fixed some found issues.

This is ready for review @ccordoba12. @dalthviz if you could also test this that would be great.

Thanks.

[ccordoba12]

Thanks @goanpeca for this! Although the tests I added last time we changed this should catch errors with this functionality, this is a big change that deserves a bit of manual testing.

@dalthviz, please test that we can still report errors generated by the PyLS and internal errors too. For the first ones, you can put any kind error here

spyder/external-deps/python-language-server/pyls/plugins/jedi_completion.py

Lines 54 to 57 in b350ea1

	def pyls_completions(config, document, position):
	"""Get formatted completions for current code position"""
	settings = config.plugin_settings('jedi_completion', document_path=document.path)
	code_position = _utils.position_to_jedi_linecolumn(document, position)

(e.g. import foo) and then try to get completions with python bootstrap.py.

For the second ones, I usually put an error here

spyder/spyder/app/mainwindow.py

Lines 2794 to 2799 in b350ea1

	def show_dependencies(self):
	"""Show Spyder's Dependencies dialog box"""
	from spyder.widgets.dependencies import DependenciesDialog
	dlg = DependenciesDialog(self)
	dlg.set_data(dependencies.DEPENDENCIES)
	dlg.exec_()

and then try to show the dependencies dialog from the Help menu.

[dalthviz]

@ccordoba12 @goanpeca checked and in both cases (pyls and internal error) the report dialog pops-up 👍 however when trying to send the issue to Github this is what I'm getting:

In the cmd used to run spyder I get the following:

WARNING:spyder.widgets.github.backend:Failed to send bug report on Github. response={'code': 404, 'json': {'message': 'Not Found', 'documentation_url': 'https://developer.github.com/v3/issues/#create-an-issue'}}

[goanpeca]

Thanks for checking @dalthviz. Will take a look.

[goanpeca]

@dalthviz fixed the issue. Could you test again?

Also, it would be great if you could also test the Report issue under the Help Menu.

Thanks!

[ccordoba12]

/binder

[github-actions]

👈 Launch a Binder instance on this branch

[ccordoba12]

This shouldn't be necessary now that we don't support Python 2.

[goanpeca]

The number of items varies from python version (3.5, 3.6 3.7 3.8). The removal of py2 specific tests is done in the variable explorer migration PR.

[ccordoba12]

I checked this on Binder for both internal errors and issue reports and things are working as expected.

Thanks @goanpeca!