Add a `pythonpath` setting to allow paths to be added to `sys.path`. #9134

okken · 2021-09-29T20:15:37Z

Closes #9114
Closes #8964

I made a lot of assumptions here, so please comment if necessary.

implemented as a plugin in a new file.
test is in a new test file.
tests make sense to me, but if they are not clear, please let me know.
The changelog entry seems very terse, but I'm at a loss as to how to expand it, at the moment.

Question:

If this is accepted, I assume that docs will need modified. Is that usually part of the initial PR? or does that come later in the process?

Implementation is based on:

plugins pytest-pythonpath, pytest-srcpaths
comment from @bluetech in the issue thread regarding names, hook function to use, and reversing the order of path inclusion

testing/test_pythonpath.py

bluetech

Thanks @okken, looking good! I left some comments.

Also:

We need to document this feature somewhere.

I think the plugin can use a cleanup hook. While the vast majority of users use pytest thru the pytest command, where the the session only executes once and then the interpreter exits, it is also possible to use pytest.main(). Without cleanup, if someone calls pytest.main() then goes on to do other stuff, their sys.path will be polluted.

There are various approaches to doing the cleanup I can think of:

Take a sys.path snapshot before, just restore it after.
Remove the pythonpath values indiscriminately.
Remove the pythonpath values if they match their expected positions.

1 and 3 are safer, but have a problem that if say some library imported by pytest modifies sys.path at import time, it will get lost (1) or not cleanup (3).

2 however can mess with pre-existing sys.path.

Not sure what is best, basically what we want is to remove what we added, and only that, maybe there's some trick to achieve it properly.

src/_pytest/pythonpath.py

okken · 2021-09-30T15:43:54Z

Pushed changes based on review feedback.
What's the process regarding "resolve conversation"? Should I click that on various comments when I agree? or when I've changed something? or just leave that button alone?

testing/test_pythonpath.py

okken · 2021-09-30T15:57:13Z

I've "resolved" some conversations after making changes. Let me know if that's NOT the correct procedure. :)

bluetech

A couple more comments.

Feel free to resolve my comments as you fix them, the PR is small enough to keep everything in my head :)

src/_pytest/pythonpath.py

testing/test_pythonpath.py

Co-authored-by: Ran Benita <ran@unusedvar.com>

src/_pytest/pythonpath.py

bluetech

The code looks good to me; nice and clean!

To verify, I tested it now on my aforementioned project which currently uses pytest-pythonpath. I found one issue, see line comments. With that fixed, it's working as intended.

As for the docs, just need to add a confval to doc/en/reference/reference.rst (and make the changelog entry reference it) and that would be enough as far as I'm concerned.

src/_pytest/pythonpath.py

changelog/9114.feature.rst

Co-authored-by: Ran Benita <ran@unusedvar.com>

…14_pythonpath_setting

RonnyPfannschmidt · 2021-10-01T19:06:47Z

@bluetech @okken would this be simplified if we provided config.exitstack as a exitstack that tears down contexts people add to it

then the actual iplementation would be a contextmanager thats unittestable + a configrue hook thats just putting it into the exit stack

okken · 2021-10-01T21:30:14Z

@bluetech @RonnyPfannschmidt
Added a 1st draft of docs. Not sure how verbose to be. Should we mention application vs package testing, or leave that out?

okken · 2021-10-01T21:31:49Z

@bluetech @RonnyPfannschmidt
Regarding exitstack, this isn't a complicated extension, so I don't think pythonpath requires it.
However, pythonpath plus many other builtin and external plugins could definitely benefit from some context manager based solution.
Really anywhere we have hook pairs. There may be more, but configure/unconfigure, sessionstart/sessionfinish, might find such a solution handy.
But at the very least, being able to use configure/unconfigure as a context manager would be cool. Especially if it kinda acted like fixture yield.
However, in the case of pythonpath, there really isn't that much extra work to re-look up the pythonpath values with getini.

bluetech

Docs LGTM, with a few suggestions.

changelog/9114.feature.rst

doc/en/reference/reference.rst

Co-authored-by: Ran Benita <ran@unusedvar.com>

okken · 2021-10-02T22:50:52Z

Thanks @bluetech for the documentation assistance, as well as all the other help with this PR.

okken · 2021-10-02T23:17:49Z

@bluetech Please let me know if there's anything else that needs done for this PR.

bluetech

@bluetech Please let me know if there's anything else that needs done for this PR.

I took the liberty of adding a cleanup test and pushing it to your branch, PTAL and feel free to make any changes to it. With it, and the small suggestion below, it's good to go from my side.

Since it's a new feature, I'd like the other maintainers to approve as well. Particularly @nicoddemus -- this might have some interaction with the import modes which touch sys.path as well, though I think it should be OK.

src/_pytest/config/__init__.py

bluetech · 2021-10-03T14:49:34Z

Also cc the author of pytest-pythonpath, @ericpalakovichcarr: this PR adds the equivalent of pytest-pythonpath into pytest itself, as a core plugin. We'd love to hear if you have any thoughts or comments on this!

ericpalakovichcarr · 2021-10-03T14:58:48Z

Thanks for the heads up, @bluetech. Everything looks good to me. And hat tip to @okken getting this functionality into pytest 🎉

okken · 2021-10-04T04:11:12Z

testing/test_pythonpath.py

+    assert before is not None
+    assert after is not None
+    assert any("I_SHALL_BE_REMOVED" in entry for entry in before)
+    assert not any("I_SHALL_BE_REMOVED" in entry for entry in after)


Cool tests. Thanks @bluetech

bluetech

LGTM!

nicoddemus

Particularly @nicoddemus -- this might have some interaction with the import modes which touch sys.path as well, though I think it should be OK.

Thanks for the heads up. Indeed it is fine. 👍

Thanks @okken!

RonnyPfannschmidt

lovely, well done 👍

bluetech · 2021-10-05T06:37:05Z

Thanks @okken!

…ytest-dev#9134)

Obsoleted by pytest-dev/pytest#9134, which was released as part of pytest 7.0.0. It has pytest<7 pinned, and we only have the single pytest version, so it can be removed.

LuminairPrime · 2022-04-03T16:58:30Z

I was just going in circles for a while looking for this exact feature, lol! Everyone on the internet recommends pytest for Python testing, but nobody mentions how to actually get it working when your source and tests aren't next to each other. There are countless google hits for people suggesting "sys.path.append" code snippits. It's the wild west out there.

Maybe I should make a feature request for this. I think it would be good to add some mention in the basic documentation. For example, the files:
https://docs.pytest.org/en/7.1.x/getting-started.html
https://docs.pytest.org/en/7.1.x/explanation/goodpractices.html

When there's mention of 1) starting a new project, or 2) a project directory hierarchy, there should be mention of setting pythonpath in pyproject.toml to include your source path. It should be assumed that normies like me are reading this documentation and just want to get their first unit test on their first program to run.

nicoddemus · 2022-04-03T18:01:23Z

Good point @LuminairPrime, created #9833 for this. Perhaps that's something you would like to contribute? 😁

https://build.opensuse.org/request/show/972472 by user mcalabkova + dimstar_suse from upstream README: **NOTE:** This plugin is obsolete as of pytest 7.0.0. Thanks to [this PR](pytest-dev/pytest#9134) from [Brian Okken](https://github.com/okken), you can now modify the PYTHONPATH using the `pythonpath` configuration option. See documentation here: https://docs.pytest.org/en/7.0.x/reference/reference.html#confval-pythonpath ... and as we didn't fork pytest 6, there is no package to provide pytest <7

okken added 2 commits September 29, 2021 13:07

Add a pythonpath setting to allow paths to be added to sys.path.

aa18d5e

add comments to a couple tests

028d56b

RonnyPfannschmidt reviewed Sep 30, 2021

View reviewed changes

testing/test_pythonpath.py Outdated Show resolved Hide resolved

bluetech requested changes Sep 30, 2021

View reviewed changes

changes in response to code review

6ead021

okken commented Sep 30, 2021

View reviewed changes

testing/test_pythonpath.py Outdated Show resolved Hide resolved

bluetech requested changes Sep 30, 2021

View reviewed changes

src/_pytest/pythonpath.py Outdated Show resolved Hide resolved

src/_pytest/pythonpath.py Outdated Show resolved Hide resolved

testing/test_pythonpath.py Outdated Show resolved Hide resolved

okken and others added 2 commits September 30, 2021 21:37

clean up sys.path during unconfigure

33d89c2

Update testing/test_pythonpath.py

e1a0437

Co-authored-by: Ran Benita <ran@unusedvar.com>

okken commented Oct 1, 2021

View reviewed changes

src/_pytest/pythonpath.py Outdated Show resolved Hide resolved

RonnyPfannschmidt reviewed Oct 1, 2021

View reviewed changes

src/_pytest/pythonpath.py Outdated Show resolved Hide resolved

bluetech reviewed Oct 1, 2021

View reviewed changes

src/_pytest/pythonpath.py Outdated Show resolved Hide resolved

src/_pytest/pythonpath.py Outdated Show resolved Hide resolved

src/_pytest/pythonpath.py Outdated Show resolved Hide resolved

retrieve list in unconfigure with getini

02e8d93

bluetech requested changes Oct 1, 2021

View reviewed changes

src/_pytest/pythonpath.py Outdated Show resolved Hide resolved

changelog/9114.feature.rst Outdated Show resolved Hide resolved

okken and others added 3 commits October 1, 2021 08:59

Update changelog/9114.feature.rst

a6a24dc

Co-authored-by: Ran Benita <ran@unusedvar.com>

make sure str version is removed, plus only remove if present

3078407

Merge remote-tracking branch 'origin/9114_pythonpath_setting' into 91…

9f72f93

…14_pythonpath_setting

1st draft of doc mods + changelog mod

13382a3

bluetech reviewed Oct 2, 2021

View reviewed changes

changelog/9114.feature.rst Outdated Show resolved Hide resolved

doc/en/reference/reference.rst Outdated Show resolved Hide resolved

doc/en/reference/reference.rst Outdated Show resolved Hide resolved

Apply suggestions from code review

dd05547

Co-authored-by: Ran Benita <ran@unusedvar.com>

Test clean up, assert the exit code

f8f7091

bluetech reviewed Oct 3, 2021

View reviewed changes

src/_pytest/config/__init__.py Outdated Show resolved Hide resolved

okken commented Oct 4, 2021

View reviewed changes

Update src/_pytest/config/__init__.py

0808d93

bluetech approved these changes Oct 4, 2021

View reviewed changes

nicoddemus approved these changes Oct 4, 2021

View reviewed changes

RonnyPfannschmidt approved these changes Oct 5, 2021

View reviewed changes

bluetech merged commit c82bda2 into pytest-dev:main Oct 5, 2021

hoefling pushed a commit to hoefling/pytest that referenced this pull request Oct 22, 2021

Add a pythonpath setting to allow paths to be added to sys.path. (p…

fa4a414

…ytest-dev#9134)

ivirshup mentioned this pull request Nov 15, 2021

Create a anndata.testing module scverse/anndata#646

Open

browniebroke mentioned this pull request Jan 26, 2022

"ModuleNotFoundError: No module named 'tests'" when using "src" directory pytest-dev/pytest-django#738

Closed

kurthaegeman mentioned this pull request Feb 10, 2022

Not working with pytest 7.0.0 ericpalakovichcarr/pytest-pythonpath#17

Closed

nicoddemus mentioned this pull request Apr 3, 2022

Mention pythonpath in the getting started/goodpractices documentation #9833

Closed

oke-aditya mentioned this pull request May 16, 2022

Restructuring torchvision tests pytorch/vision#6020

Open

xmo-odoo mentioned this pull request Jun 22, 2022

Update os.environ['PYTHONPATH'] with the contents of pythonpath #10067

Closed

Ark-kun mentioned this pull request Feb 10, 2024

I'm sad and tire of the way PyTest handles sys.path #11960

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a `pythonpath` setting to allow paths to be added to `sys.path`. #9134

Add a `pythonpath` setting to allow paths to be added to `sys.path`. #9134

okken commented Sep 29, 2021 •

edited by nicoddemus

bluetech left a comment

okken commented Sep 30, 2021

okken commented Sep 30, 2021

bluetech left a comment

bluetech left a comment

RonnyPfannschmidt commented Oct 1, 2021

okken commented Oct 1, 2021

okken commented Oct 1, 2021

bluetech left a comment

okken commented Oct 2, 2021

okken commented Oct 2, 2021

bluetech left a comment

bluetech commented Oct 3, 2021

ericpalakovichcarr commented Oct 3, 2021

okken Oct 4, 2021

bluetech left a comment

nicoddemus left a comment

RonnyPfannschmidt left a comment

bluetech commented Oct 5, 2021

LuminairPrime commented Apr 3, 2022

nicoddemus commented Apr 3, 2022

Add a pythonpath setting to allow paths to be added to sys.path. #9134

Add a pythonpath setting to allow paths to be added to sys.path. #9134

Conversation

okken commented Sep 29, 2021 • edited by nicoddemus

bluetech left a comment

Choose a reason for hiding this comment

okken commented Sep 30, 2021

okken commented Sep 30, 2021

bluetech left a comment

Choose a reason for hiding this comment

bluetech left a comment

Choose a reason for hiding this comment

RonnyPfannschmidt commented Oct 1, 2021

okken commented Oct 1, 2021

okken commented Oct 1, 2021

bluetech left a comment

Choose a reason for hiding this comment

okken commented Oct 2, 2021

okken commented Oct 2, 2021

bluetech left a comment

Choose a reason for hiding this comment

bluetech commented Oct 3, 2021

ericpalakovichcarr commented Oct 3, 2021

okken Oct 4, 2021

Choose a reason for hiding this comment

bluetech left a comment

Choose a reason for hiding this comment

nicoddemus left a comment

Choose a reason for hiding this comment

RonnyPfannschmidt left a comment

Choose a reason for hiding this comment

bluetech commented Oct 5, 2021

LuminairPrime commented Apr 3, 2022

nicoddemus commented Apr 3, 2022

Add a `pythonpath` setting to allow paths to be added to `sys.path`. #9134

Add a `pythonpath` setting to allow paths to be added to `sys.path`. #9134

okken commented Sep 29, 2021 •

edited by nicoddemus