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/app/tests/test_mainwindow.py:

Line 6560:80: E501 line too long (80 > 79 characters)
Line 6571:80: E501 line too long (81 > 79 characters)

In the file spyder/plugins/pythonpath/container.py:

Line 261:9: E303 too many blank lines (2)

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

Line 509:80: E501 line too long (83 > 79 characters)
Line 512:80: E501 line too long (82 > 79 characters)

In the file spyder/utils/icon_manager.py:

Line 293:80: E501 line too long (101 > 79 characters)
Line 294:80: E501 line too long (102 > 79 characters)

Comment last updated at 2025-01-24 02:08:36 UTC

… 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

Co-authored-by: Carlos Cordoba <[email protected]>

…igrated. _migrate_to_config_options only converts from old path configuration files to the new configuration system. Load paths from configuration (after possibly migrating the configuration) in setup; no need for _load_paths. Only get up-to-date system paths upon request from user in the pythonpath manager widget.

… in __init__

… widget rather than container (just a further check).

Co-authored-by: Carlos Cordoba <[email protected]>

…spyder-ide/spyder-kernels.git external-deps/spyder-kernels subrepo: subdir: "external-deps/spyder-kernels" merged: "633c29712" upstream: origin: "https://github.com/spyder-ide/spyder-kernels.git" branch: "master" commit: "633c29712" git-subrepo: version: "0.4.9" origin: "???" commit: "???"

…to the top of the user list actually placed it in the project path section. Fix issue where adding duplicate path that is also the same as project path and selecting "yes" to move it to the top of the user list actually moved the project path item to the user list section. Ensure that user path item is selectable even if same as project path item.

mrclary · 2025-02-24T19:55:28Z

@dalthviz, all the issues that you found should now be fixed.

dalthviz · 2025-02-24T21:11:56Z

Gave another check to the latest changes and seems like indeed things are working as expected now 👍

ccordoba12

Thanks @mrclary for this really powerful improvement!

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 and others added 23 commits February 24, 2025 11:49

Propagate changes to sig_pythonpath_changed to ipythonconsole plugin.…

7ea1f61

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

Propagate changes to sig_pythonpath_changed to completions plugin.

378beb0

Update main window test

2ec2ee0

Update export_pythonpath

251908b

Update widget icon.

5549407

Icon and tooltip are changed to reflect current state.

Apply suggestions from code review

db59c41

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

Apply suggestions from python-lsp-server code review

e6066b6

Do not emit sig_path_changed on closeEvent or reject.

23b439a

Add import path functionality.

fadf37a

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

Update unit tests

c7b4246

* 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

Apply suggestions from code review

71c4480

Co-authored-by: Carlos Cordoba <[email protected]>

Apply suggestion from code review per @ccordoba12

4994680

Rename _project_paths -> _project_path and consider only a single path.

09501b3

Rename attribute project_paths -> project_path and declare attributes…

849f2b1

… in __init__

Add test for PYTHONPATH priority. Initially add path via path manager…

912b4a5

… widget rather than container (just a further check).

Apply suggestions from code review

d51f9b2

Co-authored-by: Carlos Cordoba <[email protected]>

Increase minimal support for python-lsp-server

77468c7

Apply suggestions from code review

4fba46f

mrclary force-pushed the ppm-syspath branch from 93353fe to fa5ad5e Compare February 24, 2025 19:50

ccordoba12 approved these changes Feb 24, 2025

View reviewed changes

ccordoba12 changed the title ~~PR: Add option to prepend or append Pythonpath Manager paths to sys.path~~ PR: Add option to prepend or append Pythonpath Manager paths to sys.path Feb 24, 2025

ccordoba12 merged commit 1b3fe16 into spyder-ide:master Feb 24, 2025
30 checks passed

mrclary deleted the ppm-syspath branch February 25, 2025 17:27

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 by ccordoba12

Loading

pep8speaks commented Feb 6, 2024 •

edited

Loading

mrclary commented Feb 24, 2025

dalthviz commented Feb 24, 2025

ccordoba12 left a comment

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

Conversation

mrclary commented Feb 6, 2024 • edited by ccordoba12 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 2025-01-24 02:08:36 UTC

mrclary commented Feb 24, 2025

dalthviz commented Feb 24, 2025

ccordoba12 left a comment

Choose a reason for hiding this comment

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 by ccordoba12

Loading

pep8speaks commented Feb 6, 2024 •

edited

Loading