Switch from deprecated imp to importlib by asottile · Pull Request #5468 · pytest-dev/pytest

asottile · 2019-06-22T23:06:07Z

Resolves #1403
Resolves #2761
Resolves #5078
Resolves #5432
Resolves #5433

nicoddemus · 2019-06-22T23:10:05Z

Awesome, thanks! This is really great, that imp machinery was as old as it gets.

I will try to take a look ASAP, possibly tomorrow.

asottile · 2019-06-22T23:12:00Z

oops this isn't ready yet, I broke package imports somehow? need to look more into that 👍

nicoddemus · 2019-06-22T23:15:19Z

Ahh OK. 👍

codecov · 2019-06-22T23:28:08Z

Codecov Report

Merging #5468 into master will increase coverage by 0.03%.
The diff coverage is 98.16%.

@@            Coverage Diff             @@
##           master    #5468      +/-   ##
==========================================
+ Coverage   96.03%   96.07%   +0.03%     
==========================================
  Files         115      115              
  Lines       25512    25458      -54     
  Branches     2480     2468      -12     
==========================================
- Hits        24501    24458      -43     
+ Misses        706      697       -9     
+ Partials      305      303       -2

Impacted Files	Coverage Δ
testing/test_assertion.py	`97.53% <ø> (ø)`	⬆️
testing/acceptance_test.py	`98.01% <100%> (+0.02%)`	⬆️
src/_pytest/pytester.py	`90.96% <100%> (-0.06%)`	⬇️
testing/test_assertrewrite.py	`84.03% <100%> (+0.24%)`	⬆️
src/_pytest/main.py	`96.91% <100%> (-0.03%)`	⬇️
testing/test_pathlib.py	`100% <100%> (ø)`	⬆️
src/_pytest/pathlib.py	`89.08% <100%> (+0.12%)`	⬆️
src/_pytest/assertion/rewrite.py	`94.83% <95.65%> (+1.34%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3d01dd3...4cd08f9. Read the comment docs.

asottile · 2019-06-23T00:56:22Z

ok I think this works now

testing/test_pytester.py

asottile · 2019-06-23T00:58:08Z

src/_pytest/assertion/rewrite.py

-        return tp == imp.PKG_DIRECTORY
+        _, _, modname = name.rpartition(".")
+        spec = self._find_dotted_spec(name)
+        return spec and spec.loader.is_package(modname)


this is by far my least favorite part of this patch :S -- I couldn't find a better way to do this though

asottile · 2019-06-23T03:01:46Z

fairly certain the flakey failures are related to this patch 🤔 -- but I'm not sure where I need to put the importlib.invalidate_caches() call

asottile · 2019-06-23T04:50:23Z

with pytest-randomly installed, this fails pretty reliably (like ~75-80% of the time)

pytest testing/python/integration.py -k test_mock

still not sure what's up with it though :/

asottile · 2019-06-23T18:13:13Z

oh but that reproduction isn't even valid, randomly is causing the assertion ordering to be changed 🤔

this is a tough one :S

asottile · 2019-06-23T21:53:18Z

OK, I figured this out and added another test for another github issue (validated it failed on macos before my change)

nicoddemus

Awesome work @asottile! Please take a look at my comments and let me know what you think.

nicoddemus · 2019-06-24T00:32:02Z

src/_pytest/assertion/rewrite.py

-    PYTEST_TAG = "{}-{}{}-PYTEST".format(impl, ver[0], ver[1])
-    del ver, impl
-
+PYTEST_TAG = "{}-PYTEST".format(sys.implementation.cache_tag)


From https://docs.python.org/3/library/sys.html#sys.implementation:

If cache_tag is set to None, it indicates that module caching should be disabled.

So we need to account for that. Because of this we should also add some tests where we execute a few tests in a subprocess with bytecode caching disabled to ensure we don't regress.

seems not a regression here -- would be happy to schedule this as a followup though (I believe there's already a check below for sys.dont_write_bytecode or whatever the flag is, so I suspect this being None doesn't matter (the string formatting still succeeds))

Hmmm I recall we had a py27-xdist-nobyte run or something were bytecode was disabled. I don't think we have that anymore, so we might introduce regressions by mistake.

I don't believe we need an entire tox environment for that, but we might consider one test which executes a few tests in a subprocess to ensure we don't regress.

You are absolutely right 😉

pytest/testing/test_assertrewrite.py

Lines 745 to 755 in 3f5b078

def test_dont_write_bytecode(self, testdir, monkeypatch):

testdir.makepyfile(

"""

import os

def test_no_bytecode():

assert "__pycache__" in __cached__

assert not os.path.exists(__cached__)

assert not os.path.exists(os.path.dirname(__cached__))"""

)

monkeypatch.setenv("PYTHONDONTWRITEBYTECODE", "1")

assert testdir.runpytest_subprocess().ret == 0

testing/test_pytester.py

src/_pytest/assertion/rewrite.py

testing/test_assertrewrite.py

nicoddemus · 2019-06-24T01:02:37Z

Does this fix #2419 too?

asottile · 2019-06-24T01:07:34Z

Does this fix #2419 too?

I'm not sure, it wasn't clear to me how to reproduce that one

nicoddemus · 2019-06-24T01:10:54Z

I'm not sure, it wasn't clear to me how to reproduce that one

No problem, we should make a note or something to post a question to the OP if they can reproduce the issue with 5.0 (once released). 👍

src/_pytest/main.py

nicoddemus

Again, awesome work!

asottile · 2019-06-24T16:35:16Z

let me comb through the --pyargs issues, I think I fixed a few there as well

src/_pytest/assertion/rewrite.py

src/_pytest/pytester.py

asottile · 2019-06-24T18:21:55Z

note: this will not be backported as we can't support the same functionality in python2 / python3.4 due to missing importlib apis

falzm · 2019-07-01T10:08:19Z

Hi, unless I'm mistaken this change has been merged and released in version 5.0.0, however I'm still having the deprecation warning message using this version... Am I missing something? 🤔

=============================================================================================== test session starts ===============================================================================================
platform darwin -- Python 3.7.3, pytest-5.0.0, py-1.8.0, pluggy-0.12.0
rootdir: /Users/marc/Documents/Exoscale/git/python-exoscale
collected 1 item

tests/test_compute.py .                                                                                                                                                                                     [100%]

================================================================================================ warnings summary =================================================================================================
tests/test_compute.py::TestCompute::test_list_zones
  /Users/marc/Documents/Exoscale/git/python-exoscale/.venv/lib/python3.7/distutils/__init__.py:1: DeprecationWarning: the imp module is deprecated in favour of importlib; see the module's documentation for alternative uses
    import imp

tests/test_compute.py::TestCompute::test_list_zones
tests/test_compute.py::TestCompute::test_list_zones
  /Users/marc/Documents/Exoscale/git/python-exoscale/.venv/lib/python3.7/site-packages/botocore/vendored/requests/packages/urllib3/_collections.py:1: DeprecationWarning: Using or importing the ABCs from 'collections' instead of from 'collections.abc' is deprecated, and in 3.8 it will stop working
    from collections import Mapping, MutableMapping

-- Docs: https://docs.pytest.org/en/latest/warnings.html
====================================================================================== 1 passed, 3 warnings in 0.40 seconds =======================================================================================

nicoddemus · 2019-07-01T12:01:54Z

Hi @falzm,

import imp is coming from distutils, not from pytest:

 /Users/marc/Documents/Exoscale/git/python-exoscale/.venv/lib/python3.7/distutils/__init__.py:1: DeprecationWarning: the imp module is deprecated in favour of importlib; see the module's documentation for alternative uses

I suggest passing -Werror:imp module in the command line and seeing who's importing distutils based on the traceback.

falzm · 2019-07-01T12:11:03Z

Thank you @nicoddemus.

csjmac · 2019-10-12T05:57:34Z

Hoping this is the right place to post this...if not please help guide me to the right place?

I just stood up a brand new pyramid project using cookiecutter starter for 1.10 and this is still a thing: https://docs.pytest.org/en/latest/changelog.html#id68

My env (baz is the pyramid project folder):

platform darwin -- Python 3.7.4, pytest-5.2.1, py-1.8.0, pluggy-0.13.0 rootdir: /Users/me/code/foo/bar/baz, inifile: pytest.ini, testpaths: baz plugins: cov-2.8.1

MacOS Mojave 10.14.6
Python 3.7.4
Pyramid 1.10.4
pytest 5.2.1
py 1.8.0
pluggy 0.13.0
cov 2.8.1

I am executing pytest using a local setup.sh file, which includes running the tests:

python3 -m venv env
env/bin/pip install --upgrade pip setuptools
env/bin/pip install --upgrade -e ".[testing]"
(alembic stuff)
env/bin/initialize_baz_db development.ini
env/bin/pytest

The 2 default pyramid tests pass but I get a warnings summary with 3 warnings:

env/lib/python3.7/site-packages/venusian/__init__.py:1
  /Users/me/code/foo/bar/baz/env/lib/python3.7/site-packages/venusian/__init__.py:1: DeprecationWarning: the imp module is deprecated in favour of importlib; see the module's documentation for alternative uses
    import imp

According to all of the docs I found, this should not be possible because this was fixed in pytest 5.0.0 however, I can see there is a reference to a PR from Aug (~2months ago) that indicate that maybe there is still some imp in use.

Workarounds I tried (but did not fix the problem):

running pytest outside of my shell script
deleting .pytest_cache dir and trying again
confirming package deps
blowing away my venv and starting over
forcing the update/upgrade of any/all suspect packages

...but the results are always the same.

For the first warning, caused by venusian pip show gives me this:

⋙ env/bin/pip show venusian
Name: venusian
Version: 1.2.0
Summary: A library for deferring decorator actions
Home-page: https://pylonsproject.org
Author: Chris McDonough, Agendaless Consulting
Author-email: pylons-devel@googlegroups.com
License: BSD-derived (http://www.repoze.org/LICENSE.txt)
Location: /Users/me/code/foo/bar/baz/env/lib/python3.7/site-packages
Requires: 
Required-by: pyramid

It strikes me as funny that this warning is still a thing, but, I stopped laughing a little while ago now. Perhaps I'm being a perfectionist in spending time on making this warning go away but it would be really tight to have this sorted before I dive into full TDD so I can see clean output for what is essentially 2 hello word test cases.

Thank you to everyone who read this far - you're the best.

(edits made to clarify original post, and, formatting for readability)

asottile · 2019-10-12T06:21:50Z

you'll want to report that to the venusian project

nicoddemus · 2019-10-12T11:51:44Z

Just to complement @asottile's answer, pytest is warning about imp on venusian project, not on pytest itself (which has been fixed some time ago, as you have found).

Notice that the warning location points to venusian/__init__.py:

env/lib/python3.7/site-packages/venusian/__init__.py:1
  .../site-packages/venusian/__init__.py:1: DeprecationWarning: the imp module is deprecated in favour of importlib; see the module's documentation for alternative uses
    import imp

asottile commented Jun 23, 2019

View reviewed changes

testing/test_pytester.py Outdated Show resolved Hide resolved

asottile commented Jun 23, 2019

View reviewed changes

nicoddemus reviewed Jun 24, 2019

View reviewed changes

RonnyPfannschmidt reviewed Jun 24, 2019

View reviewed changes

src/_pytest/main.py Show resolved Hide resolved

nicoddemus approved these changes Jun 24, 2019

View reviewed changes

asottile mentioned this pull request Jun 24, 2019

foo.test_foo is imported twice, including once before running conftest, when using pytest --pyargs foo.test_foo #5078

Closed

4 tasks

Switch from deprecated imp to importlib

4cd08f9

blueyed reviewed Jun 24, 2019

View reviewed changes

src/_pytest/assertion/rewrite.py Show resolved Hide resolved

src/_pytest/assertion/rewrite.py Show resolved Hide resolved

src/_pytest/pytester.py Show resolved Hide resolved

asottile merged commit 61dcb84 into pytest-dev:master Jun 24, 2019

asottile deleted the switch_importlib_to_imp branch June 24, 2019 18:22

RemiCardona mentioned this pull request Jul 1, 2019

Testing Flask apps breaks with 5.0.0 #5532

Closed

gyermolenko mentioned this pull request Aug 4, 2019

Partially remove dependency on imp. pylint-dev/astroid#686

Closed

2 tasks

blueyed mentioned this pull request Feb 1, 2020

Assertion rewriting breaks jedi due to missing InspectLoader support #6643

Open

	def test_dont_write_bytecode(self, testdir, monkeypatch):
	testdir.makepyfile(
	"""
	import os
	def test_no_bytecode():
	assert "__pycache__" in __cached__
	assert not os.path.exists(__cached__)
	assert not os.path.exists(os.path.dirname(__cached__))"""
	)
	monkeypatch.setenv("PYTHONDONTWRITEBYTECODE", "1")
	assert testdir.runpytest_subprocess().ret == 0

Uh oh!

Conversation

asottile commented Jun 22, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nicoddemus commented Jun 22, 2019

Uh oh!

asottile commented Jun 22, 2019

Uh oh!

nicoddemus commented Jun 22, 2019

Uh oh!

codecov bot commented Jun 22, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

asottile commented Jun 23, 2019

Uh oh!

Uh oh!

asottile Jun 23, 2019

Choose a reason for hiding this comment

Uh oh!

asottile commented Jun 23, 2019

Uh oh!

asottile commented Jun 23, 2019

Uh oh!

asottile commented Jun 23, 2019

Uh oh!

asottile commented Jun 23, 2019

Uh oh!

nicoddemus left a comment

Choose a reason for hiding this comment

Uh oh!

nicoddemus Jun 24, 2019

Choose a reason for hiding this comment

Uh oh!

asottile Jun 24, 2019

Choose a reason for hiding this comment

Uh oh!

nicoddemus Jun 24, 2019

Choose a reason for hiding this comment

Uh oh!

nicoddemus Jun 24, 2019

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nicoddemus commented Jun 24, 2019

Uh oh!

asottile commented Jun 24, 2019

Uh oh!

nicoddemus commented Jun 24, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

nicoddemus left a comment

Choose a reason for hiding this comment

Uh oh!

asottile commented Jun 24, 2019

Uh oh!

Uh oh!

Uh oh!

Uh oh!

asottile commented Jun 24, 2019

Uh oh!

falzm commented Jul 1, 2019

Uh oh!

nicoddemus commented Jul 1, 2019

Uh oh!

falzm commented Jul 1, 2019

Uh oh!

csjmac commented Oct 12, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

asottile commented Oct 12, 2019

Uh oh!

nicoddemus commented Oct 12, 2019

Uh oh!

Reviewers

Assignees

asottile commented Jun 22, 2019 •

edited

Loading

codecov bot commented Jun 22, 2019 •

edited

Loading

nicoddemus commented Jun 24, 2019 •

edited

Loading

csjmac commented Oct 12, 2019 •

edited

Loading