PR: Add option to prepend or append Pythonpath Manager paths to sys.path #21769

mrclary · 2024-02-06T16:35:56Z

Description of Changes

Wrote at least one-line docstrings (for any new functions)
Added unit test(s) covering the changes (if testable)
Included a screenshot or animation (if affecting the UI, see Licecap)

UI/UX Changes

Added import button to update System Paths from the system PYTHONPATH environment variable.
Added toggle button that sets whether active paths should be prepended to or appended to sys.path in IPython console and Jedi completion environments.

Primary Changes

These changes directly affect the plugin API.

Spyder's transient configuration now includes user_paths, system_paths, and prioritize. user_paths and system_paths are dictionaries with path as key and enabled state as value. prioritize is a boolean. The unofficial configuration keys path, user_path, and system_path are no longer used. The spyder_pythonpath configuration key remains unchanged.
SPY_PYTHONPATH environment variable is eliminated in favor of directly accessing the spyder_pythonpath configuration key in the pythonpath_manager configuration section on startup of IPython console kernels.
sig_pythonpath_changed now sends the new spyder_pythonpath value (list of strings) and prioritize (boolean). This signal no longer sends the "old" paths. The old paths were only required by spyder-kernels in order to remove those paths from sys.path before adding the new paths to sys.path. The update to spyder-kernels in the companion PR eliminates the need for sending the "old" paths.
Fixed an issue where changes made by the user in the UI were applied even when the user presses the cancel button, if the system paths had changed on disk.
Fixed an issue where removing all user paths and then adding a user path resulted in an UnboundLocalError.

Secondary Changes

In order to simplify the handling of PYTHONPATH, the following changes were made to the Pythonpath Manager plugin. These do not directly affect the UI, UX, or plugin API, but streamline and clarify the actions performed within the plugin.

The internal attributes of the PythonpathContainer container object and the PathManager widget object were changed from path, not_active_path, user_path, system_path, and original_path_dict, to the less ambiguous user_paths and system_paths. The latter are maintained as OrderedDict objects throughout.
The pythonpath_manager configurations are now only set in PythonpathContainer._save_paths, and only on condition of change, rather than in multiple locations throughout the container and PathManager widget.
The sig_pythonpath_changed signal is emitted only in PythonpathContainer._save_paths, and only on condition that spyder_pythonpath or prioritize has changed.

Companion PRs

Outstanding questions

Should python-lsp-server.pylsp.Document.sys_path be removed (API break)?
What icon should be used for the prioritze button?

Issue(s) Resolved

Fixes #17066

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

pep8speaks · 2024-02-06T16:36:13Z

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

In the file spyder/plugins/pythonpath/widgets/pathmanager.py:

Line 375:80: E501 line too long (83 > 79 characters)
Line 376:80: E501 line too long (84 > 79 characters)
Line 379:80: E501 line too long (87 > 79 characters)
Line 380:80: E501 line too long (93 > 79 characters)
Line 494:80: E501 line too long (83 > 79 characters)
Line 497:80: E501 line too long (82 > 79 characters)

In the file spyder/utils/icon_manager.py:

Line 291:80: E501 line too long (101 > 79 characters)
Line 292:80: E501 line too long (102 > 79 characters)

Comment last updated at 2024-12-05 04:47:39 UTC

test_ipythoncosonle.py had many failures on latest master; attempting CI=1 skipped many tests but hangs on test_pdb_ignore_lib[True]

…rings.

…_paths, system_paths) and dictionary type

…pdate_paths method and call setup in update-paths method. This will allow the container to instantiate the PathManager widget before providing paths. Paths will not be retrieved or determined within the widget, only passed to it by the container.

These will be dictionaries and the container will handle updating the pythonpath_manager configuration and assembling the final spyder_pythonpath. There is no need for _update_system_path method because the container will handle updates to the underlying system path. Again, the widget will only handle user-interactive changes.

This will be done in the container instead.

…oritize) -> (_user_paths, _system_paths, _project_paths, _prioritize, _spyder_pythonpath). Path lists are now OrderedDict * Simplifies _load_pythonpath -> _load_paths * Move migration method from setup to _load_paths

* Promptly exits if remnants of old configuration are not present * Removes remnants of old configuration if present * Constructs user paths from old configuration remnants

* Configuration keys and private attributes for user paths, system paths, prioritize, and spyder_pythonpath are set conditionally in this method and nowhere else. * sig_pythonpath_changed is conditionally emitted from this method and nowhere else. This signal now sends only the spyder_pythonpath and prioritize, not the old spyder_pythonpath. Subscribers should update accordingly.

…ardly constructed from project, user, and system paths attributes.

…d in _save_paths if spyder_pythonpath is changed.

…d in PathManager.updat_paths

… Note that spyder-kernels must be updated to accommodate.

Icon and tooltip are changed to reflect current state.

Co-authored-by: Jitse Niesen <[email protected]> Typographical errors. Improved docstring clarity

The desired affect is project paths | user paths | system paths, where the paths are in that order and are overwritten in that order. System paths cannot overwrite user paths, which cannot overwrite project paths, i.e we cannot just do project_paths.update(user_paths) etc.

…path manager widget is invoked. If the system paths have changed since last widget invocation, then the user may not be aware and there is no indication in the widget that there has been a change. Furthermore, canceling the widget may still result in a change to the pythonpath, which would be inconsistent with the cancel action.

Rather than automatically updating the system paths, provide mechanism for user to do so.

* Test system PYTHONPATH import in test_pathmanager instead of test_mainwindow * Move restore_user_env fixture from app/tests/conftest.py to utils/tests/conftest.py * Ensure that the user environment script runs on posix while testing

…lary/spyder-kernels.git external-deps/spyder-kernels subrepo: subdir: "external-deps/spyder-kernels" merged: "66766d44b" upstream: origin: "https://github.com/mrclary/spyder-kernels.git" branch: "ppm-syspath" commit: "66766d44b" git-subrepo: version: "0.4.9" origin: "???" commit: "???"

mrclary added type:Feature component:Pythonpath manager labels Feb 6, 2024

mrclary self-assigned this Feb 6, 2024

mrclary force-pushed the ppm-syspath branch 2 times, most recently from 3999697 to 3c2c64d Compare February 12, 2024 23:25

mrclary force-pushed the ppm-syspath branch 2 times, most recently from b11ccad to a433e97 Compare February 22, 2024 21:31

mrclary force-pushed the ppm-syspath branch 13 times, most recently from 5f68078 to ffd9395 Compare March 4, 2024 21:27

mrclary marked this pull request as ready for review March 4, 2024 22:11

mrclary marked this pull request as draft March 4, 2024 22:11

mrclary marked this pull request as ready for review March 4, 2024 22:14

mrclary requested review from ccordoba12, dalthviz and CAM-Gerlach March 4, 2024 22:14

mrclary force-pushed the ppm-syspath branch 3 times, most recently from 0a04027 to 73e407e Compare March 13, 2024 00:54

mrclary added 29 commits December 4, 2024 20:47

Update ipythonconsole plugin tests

1d5165c

test_ipythoncosonle.py had many failures on latest master; attempting CI=1 skipped many tests but hangs on test_pdb_ignore_lib[True]

Change sig_pythonpath_changed arguments from dictionary to list of st…

558d3a2

…rings.

Add system_paths and user_paths to pythonpath_manager configuration

6277f82

Convert (path, project_path, not_active_path) to (user_paths, project…

874d8c4

…_paths, system_paths) and dictionary type

Remove superfluous user_path attribute

dadf93e

Remove algorithm to save system PYTHONPATH.

4498fb7

This will be done in the container instead.

Simplify get_user_paths and get_system_paths

08b54b2

Revise configuration migration method.

6d4ca5a

* Promptly exits if remnants of old configuration are not present * Removes remnants of old configuration if present * Constructs user paths from old configuration remnants

Simplify get_spyder_pythonpath. spyder_pythonpath is now straightforw…

e018853

…ardly constructed from project, user, and system paths attributes.

Simplify update_active_project_path. sig_pythonpath_changed is emitte…

d587e6f

…d in _save_paths if spyder_pythonpath is changed.

Update show_path_manager method. Note that PathManager.setup is calle…

2a493ae

…d in PathManager.updat_paths

Propagate changes to sig_pythonpath_changed to pythonpath plugin

0cd46db

Propagate changes to sig_pythonpath_changed to ipythonconsole plugin.…

f0a042a

… Note that spyder-kernels must be updated to accommodate.

Propagate changes to sig_pythonpath_changed to completions plugin.

75a7f4e

Update main window test

becbf04

Update export_pythonpath

460985b

Update widget icon.

13fc624

Icon and tooltip are changed to reflect current state.

Apply suggestions from code review

e65f5b2

Co-authored-by: Jitse Niesen <[email protected]> Typographical errors. Improved docstring clarity

Apply suggestions from python-lsp-server code review

adf267e

Do not emit sig_path_changed on closeEvent or reject.

2540c17

Add import path functionality.

4739147

Rather than automatically updating the system paths, provide mechanism for user to do so.

Update unit tests

91e9cee

* Test system PYTHONPATH import in test_pathmanager instead of test_mainwindow * Move restore_user_env fixture from app/tests/conftest.py to utils/tests/conftest.py * Ensure that the user environment script runs on posix while testing

mrclary force-pushed the ppm-syspath branch from d36db51 to 956e704 Compare December 5, 2024 04:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PR: Add option to prepend or append Pythonpath Manager paths to sys.path #21769

PR: Add option to prepend or append Pythonpath Manager paths to sys.path #21769

mrclary commented Feb 6, 2024 •

edited

Loading

pep8speaks commented Feb 6, 2024 •

edited

Loading

PR: Add option to prepend or append Pythonpath Manager paths to sys.path #21769

Are you sure you want to change the base?

PR: Add option to prepend or append Pythonpath Manager paths to sys.path #21769

Conversation

mrclary commented Feb 6, 2024 • edited Loading

Description of Changes

UI/UX Changes

Primary Changes

Secondary Changes

Companion PRs

Outstanding questions

Issue(s) Resolved

Affirmation

pep8speaks commented Feb 6, 2024 • edited Loading

Comment last updated at 2024-12-05 04:47:39 UTC

mrclary commented Feb 6, 2024 •

edited

Loading

pep8speaks commented Feb 6, 2024 •

edited

Loading