Skip to content

Fix crash in ExplicitNamespacePackageFinder #1714

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

Merged
merged 6 commits into from
Aug 9, 2022
Merged

Fix crash in ExplicitNamespacePackageFinder #1714

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
986f9a4
Fix crash in `ExplicitNamespacePackageFinder`
jacobtylerwalls Jul 16, 2022
3df0084
Add skip if no `six`
jacobtylerwalls Jul 16, 2022
ee6f4ed
`urllib3` does appear to be required
jacobtylerwalls Jul 16, 2022
21fcabd
Merge branch 'main' into namespace-path-crash
Pierre-Sassoulas Jul 23, 2022
b9b1e56
Check `submodule_search_locations`
jacobtylerwalls Jul 31, 2022
ee7ecc1
Update ChangeLog
Pierre-Sassoulas Jul 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions ChangeLog
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ What's New in astroid 2.12.3?
=============================
Release date: TBA

* Fixed crash in ``ExplicitNamespacePackageFinder`` involving ``_SixMetaPathImporter``.

Closes #1708

* Fix unhandled `FutureWarning` from pandas import in cython modules

Closes #1717
Expand Down
9 changes: 5 additions & 4 deletions astroid/interpreter/_import/util.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,8 @@ def is_namespace(modname: str) -> bool:
if found_spec and found_spec.submodule_search_locations:
last_submodule_search_locations = found_spec.submodule_search_locations

if found_spec is None:
return False

return found_spec.origin is None
return (
found_spec is not None
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we use last_submodule_search_locations here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know, I suspect (without looking too closely) that could create false positives if a portion of the path was a valid namespace package but the rest of the path wasn't. That variable is really just a hack to get around the KeyError described in the comment, I wouldn't trust it to represent more than that.

and found_spec.submodule_search_locations is not None
and found_spec.origin is None
)
1 change: 1 addition & 0 deletions requirements_test_brain.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ PyQt6
types-python-dateutil
six
types-six
urllib3
17 changes: 17 additions & 0 deletions tests/unittest_modutils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
from xml import etree
from xml.etree import ElementTree

import pytest
from pytest import CaptureFixture, LogCaptureFixture

import astroid
Expand All @@ -25,6 +26,13 @@

from . import resources

try:
import urllib3 # pylint: disable=unused-import

HAS_URLLIB3 = True
except ImportError:
HAS_URLLIB3 = False


def _get_file_from_object(obj) -> str:
return modutils._path_from_filename(obj.__file__)
Expand Down Expand Up @@ -439,5 +447,14 @@ def test_is_module_name_part_of_extension_package_whitelist_success(self) -> Non
)


@pytest.mark.skipif(not HAS_URLLIB3, reason="This test requires urllib3.")
def test_file_info_from_modpath__SixMetaPathImporter() -> None:
pytest.raises(
ImportError,
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So we no longer have a finder that will find the module created by _SixMetaPathImporter, but that's better than crashing while trying to find it with ExplicitNamespacePackageFinder (or incorrectly finding it with it!)

modutils.file_info_from_modpath,
["urllib3.packages.six.moves.http_client"],
)


if __name__ == "__main__":
unittest.main()