Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

PR: Add feature to append/prepend PPM to IPython Console sys.path #18308

Closed
wants to merge 17 commits into from
Closed

PR: Add feature to append/prepend PPM to IPython Console sys.path #18308

wants to merge 17 commits into from

Conversation

mrclary
Copy link
Contributor

@mrclary mrclary commented Jun 16, 2022 •
edited
Loading

Add a checkbox to the PYTHONPATH Manager that allows the user to specify whether to append or prepend these paths to the IPython Console sys.path.

Prerequisites

Fixes: #17066

@mrclary mrclary self-assigned this Jun 16, 2022
@pep8speaks
Copy link

pep8speaks commented Jun 16, 2022 •
edited
Loading

Hello @mrclary! 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 2022-08-01 18:13:18 UTC

@mrclary mrclary marked this pull request as draft June 16, 2022 01:05
@mrclary
Copy link
Contributor Author

mrclary commented Jun 16, 2022

@ccordoba12, you mentioned using the update_syspath kernel handler. I wouldn't mind a quick overview via zoom when you have a moment. I see the basic functionality, as it is already used by the PPM on path updates. However, I think that we could completely eliminate set_spyder_pythonpath in spyder_kernels/customize/spydercustomize.py (and SPY_PYTHONPATH) by executing update_syspath upon client creation, but I'd want to know exactly the best signals to send and use for accomplishing this.

@CAM-Gerlach
Copy link
Member

However, I think that we could completely eliminate set_spyder_pythonpath in spyder_kernels/customize/spydercustomize.py (and SPY_PYTHONPATH) by executing update_syspath upon client creation,

Just FYI, I think that's what @ccordoba12 was saying as well over on the other issue:

By the way, that would make useless the code you changed here in spydercustomize.py, so you could remove it.

@ccordoba12 ccordoba12 mentioned this pull request Jun 19, 2022
Merged
@mrclary mrclary mentioned this pull request Jun 22, 2022
Closed
@mrclary mrclary linked an issue Jun 22, 2022 that may be closed by this pull request
Suggestion: insert paths from PYTHONPATH manager before system's PYTHONPATH #17066
Open
@mrclary
Copy link
Contributor Author

mrclary commented Jul 20, 2022

@ccordoba12 @dalthviz, I think that @goanpeca began to use the modern configuration system for the PPM paths about two years ago, but there are still references to individual path and not_active_path files in the configuration directory. So I think some cleanup may be necessary here. However, I'm confused about the roles of spyder.ini vs. transient.ini. Could you explain their intended differentiated purpose and what configurations belong in which file?

@dalthviz
Copy link
Member

From my side I'm not sure to be honest 😅 However, I think the main difference between spyder.ini and transient.ini is that the config options at transient are usually loaded at startup or created at startup if not found and meant to keep the session state next time Spyder starts (so I think usually the options there are persisted just before Spyder closes). Probably @ccordoba12 knows better.

@mrclary mrclary mentioned this pull request Jul 22, 2022
Closed
@CAM-Gerlach
Copy link
Member

CAM-Gerlach commented Jul 27, 2022 •
edited
Loading

As I understand it, transient.ini is for ephemeral state that is not particularly critical and can be discarded without much loss, while the main spyder.ini is for persistent config options affirmatively set by the user, e.g. in the preferences dialog.

mrclary and others added 15 commits August 1, 2022 10:59
@mrclary
Cleanup main configuration file.
47ab1b3 
Alphabetize DEFAULTS and NAME_MAP.
PEP8
@mrclary
Add pythonpath_manager to configuration manager
314930a
@mrclary
Rename get_spyder_pythonpath to get_spyder_active_pythonpath
e2bb9e0
@mrclary
Rename get_spyder_pythonpath_dict to get_spyder_pythonpath
4917e26
@mrclary
Build spyder pythonpath dictionary in get_spyder_pythonpath.
bf9916d 
Use the configuration manager and the projects paths to build pythonpath dictionary.
Projects plugin to connect update_python_path on project change instead of pythonpath_changed.
@mrclary
Update pythonpath configuration in update_python_path.
1610c19 
Use configuration manager.
Do not use save_python_path.
@mrclary
Remove obsolete load_python_path, save_python_path, and pythonpath_ch…
6417f6c 
…anged
@mrclary
Send pythonpath dictionary to PathManager.
0a7a4bd
@mrclary
Add get_project_paths method
69bc94a
@mrclary
Provide persistent old_path attribute because get_spyder_pythonpath w…
3fa4a4a 
…ill always have latest project path.
@mrclary
Cleanup PathManager.
3fb41e9 
Use path dictionary values and remove not_active_path attribute.
Do not disable path in path dictionary if it is duplicate of project path.
@mrclary
Ensure that sig_pythonpath_changed is emitted after console restarts …
6c193a6 
…in project plugin
@mrclary
Update pathmanager unit tests.
67e51dc 
Update call signatures.
Aggregate common path lists.
Remove nt constraint on test_button_state
@mrclary
PEP8
52aa67c
@mrclary
Import existing obsolete path and not_active_path files to modern con…
028c240 
…figuration and remove the files.

Revert this commit for a future release.
mrclary added 2 commits August 1, 2022 11:08
@mrclary
Add prepend feature to PPM.
48f2f8e 
Add prepend state to sig_path_changed.
Add prepend checkbox to PPM widget.
Add prepend argument to update_path
@mrclary
Add prepend to MainWindow.
1c8013f 
Add spyder_pythonpath_prepend to config.main.
Add prepend_path file to configuration path.
get_spyder_pythonpath_dict now returns path_dict and prepend.
load_python_path loads prepend_path and sets attribute.
save_python_path saves prepend_path file and sets spyder_ppythonpath_prepend config property.
Add new_prepend argument to update_python_path.
@mrclary mrclary mentioned this pull request Aug 31, 2022
Closed
10 tasks
@mrclary mrclary closed this Feb 1, 2023
@mrclary mrclary deleted the sys-path branch July 13, 2023 06:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@mrclary mrclary

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Suggestion: insert paths from PYTHONPATH manager before system's PYTHONPATH
4 participants
@mrclary @pep8speaks @CAM-Gerlach @dalthviz