PR: Add option to prepend or append Pythonpath Manager paths to sys.path #21769
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hello @mrclary! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:
Comment last updated at 2024-12-02 20:51:59 UTC |
mrclary
force-pushed
the
ppm-syspath
branch
2 times, most recently
from
3999697
to
3c2c64d
Compare
mrclary
force-pushed
the
ppm-syspath
branch
2 times, most recently
from
b11ccad
to
a433e97
Compare
mrclary
force-pushed
the
ppm-syspath
branch
13 times, most recently
from
5f68078
to
ffd9395
Compare
mrclary
force-pushed
the
ppm-syspath
branch
3 times, most recently
from
0a04027
to
73e407e
Compare
test_ipythoncosonle.py had many failures on latest master; attempting CI=1 skipped many tests but hangs on test_pdb_ignore_lib[True]
…_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: "???"
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of Changes
UI/UX Changes
sys.pathin IPython console and Jedi completion environments.Primary Changes
These changes directly affect the plugin API.
user_paths,system_paths, andprioritize.user_pathsandsystem_pathsare dictionaries with path as key and enabled state as value.prioritizeis a boolean. The unofficial configuration keyspath,user_path, andsystem_pathare no longer used. Thespyder_pythonpathconfiguration key remains unchanged.SPY_PYTHONPATHenvironment variable is eliminated in favor of directly accessing thespyder_pythonpathconfiguration key in thepythonpath_managerconfiguration section on startup of IPython console kernels.sig_pythonpath_changednow sends the newspyder_pythonpathvalue (list of strings) andprioritize(boolean). This signal no longer sends the "old" paths. The old paths were only required byspyder-kernelsin order to remove those paths fromsys.pathbefore adding the new paths tosys.path. The update tospyder-kernelsin the companion PR eliminates the need for sending the "old" paths.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.
PythonpathContainercontainer object and thePathManagerwidget object were changed frompath,not_active_path,user_path,system_path, andoriginal_path_dict, to the less ambiguoususer_pathsandsystem_paths. The latter are maintained asOrderedDictobjects throughout.pythonpath_managerconfigurations are now only set inPythonpathContainer._save_paths, and only on condition of change, rather than in multiple locations throughout the container andPathManagerwidget.sig_pythonpath_changedsignal is emitted only inPythonpathContainer._save_paths, and only on condition thatspyder_pythonpathorprioritizehas changed.Companion PRs
extra_pathsto be placed in front ofsys.pathpython-lsp/python-lsp-server#527.Outstanding questions
python-lsp-server.pylsp.Document.sys_pathbe removed (API break)?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