-
-
Notifications
You must be signed in to change notification settings - Fork 2.7k
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.
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
Try not to assume a module's file extension is .py #2374
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome, thanks a ton @Kodiologist! Please take a look at my comments and tell me what do you think.
@@ -235,8 +236,7 @@ def getmodpath(self, stopatmodule=True, includemodule=False): | |||
continue | |||
name = node.name | |||
if isinstance(node, Module): | |||
assert name.endswith(".py") | |||
name = name[:-3] | |||
name = os.path.splitext(name)[0] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
About a test for this:
I was considering writing a unittest that basically creates a Module
instance and calls getmodpath
.
But after thinking some more about it I think we need an integration test that demonstrates it is possible to collect a file without a .py
extension as a Module
object and the entire machinery works, otherwise we might end up introducing a regression later in some other part of the code and breaking this use case without realizing it.
I suggest to create a test that has a conftest.py
file which implements the pytest_collect_file
hook like this (untested):
def test_collects_different_extensions_as_python(testdir):
"""Ensure we can collect files with different extensions as .py files (#2369)""".
testdir.makeconftest("""
def pytest_collect_file(path, parent):
ext = path.ext
if ext == ".hy":
return Module(path, parent)
""")
testdir.writefile("""
# ... 1 test here in Hy ...
""", ext=".hy")
result = testdir.runpytest()
result.stdout.fnmatch_lines('*1 passed*')
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All right, thanks, a test is in.
CHANGELOG.rst
Outdated
@@ -12,6 +12,10 @@ | |||
* Added documentation related to issue (`#1937`_) | |||
Thanks `@skylarjhdownes`_ for the PR. | |||
|
|||
* In ``python.PyobjMixin.getmodpath``, don't assume the module's file extension |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would write this to reflect the use case instead of the internal implementation detail that changed, perhaps:
Changed some internal details slightly so it is possible to collect files of any extension as Python modules.
import sys, os, imp | ||
from _pytest.python import Module | ||
|
||
class Loader: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Clever solution. 😁
I notice though that you are using sys.meta_path.append
, and because we run this test in the same process as the main process running pytest, we are leaving that finder there for the rest of pytest's test run.
The simplest solution I can find now is to just use testdir.runpytest_subprocess()
to run that test in a separated process to ensure isolation. What do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds good to me. Done.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
for a different protection scheme you can use pytest_configure and pytest_unconfigure to push/pop the extra finder
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point. Do you think this should be changed, or leaving that as it is is fine?
I'm OK either way TBH.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
both ways work, i just wanted to document here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fair enough! 👍
Would you like to merge this then?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot @Kodiologist! 👍
Fixes #2369.
Any hints on how to write a test for this?