PR: Fix syncing IPython console cwd with the Working directory toolbar

[ccordoba12]

Description of Changes

• This was working before but I don't know when it broke. Now it works in three ways:
  1. When switching between consoles.
  2. When opening new consoles.
  3. When opening/closing projects.
• Add tests to check that the Working directory toolbar and Files are updated in those cases.
• Set the right working directory when opening a console from Files (this was reported on issue IPython ignore "Open IPython console here" #19003).
• Restore functionality of IPython console's public API method set_working_directory, which I broke in PR PR: Add new API methods to the IPython console #18544.
• Add a new method to it called save_working_directory to save the cwd reported by the Working directory plugin. This is necessary to start new consoles.
• Rename some methods related to the cwd in the IPython console for clarity.

Issue(s) Resolved

Fixes #19003

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

[dalthviz]

Thanks @ccordoba12 ! Checking locally seems like there is an odd behavior when opening a project. Seems like the working directory is not being updated and then any new consoles start with the previous working directory that was set before opening the project:

Also, when closing the project the working directory still references the project path but then the new console cwd is not set to be the last path but the default user directory?:

[ccordoba12]

Thanks for checking those cases @dalthviz! I think I fixed them in my last commit, in which I also expanded the new tests I added to cover them.

[dalthviz]

Thanks for the changes @ccordoba12 ! Seems like the first part is fixed However, the last part (when closing a project the old working directory set is changed to be again the user default/home directory) is still failing. Locally, I can see that when closing a project the path in the working directory toolbar is the correct one for an split second but then after the console finishes loading it changes to use the user default/home directory:

[ccordoba12]

Locally, I can see that when closing a project the path in the working directory toolbar is the correct one for an split second but then after the console finishes loading it changes to use the user default/home directory

This is the default behavior @dalthviz, i.e. when closing a project the first console's cwd is set to the user's home directory. What would you expect it to be? The cwd before the project was open?

[dalthviz]

What would you expect it to be? The cwd before the project was open?

Yep exactly

[ccordoba12]

Ok, that sounds like a reasonable expectation when there's a single console open (as in the gif you posted above). However, if users have many of them, we would have to use as the "previous cwd" the one of the console which has focus before the project is open.

And in that case, I don't know if users would be surprised by us setting the cwd when the project is closed to what could appear to be a random directory, specially if they forgot what was the cwd of the last console with focus.

[dalthviz]

I see, also if the current behavior is the default behavior then I guess this is ok 👍 . Maybe creating a new issue to discuss that behavior in the ux-improvements repo could be worthy, but for sure not something to address here. So, besides the comment I left for the update_in_spyder new kwarg, this LGTM 👍

[ccordoba12]

Maybe creating a new issue to discuss that behavior in the ux-improvements repo could be worthy

Good idea. I opened spyder-ide/ux-improvements#74 to keep track of this discussion.

[dalthviz]

Thanks @ccordoba12 👍