Skip to content

BUG: shows correct package name when import_optional_dependency is ca… #36134

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 5 commits into from
Sep 7, 2020
Merged

BUG: shows correct package name when import_optional_dependency is ca… #36134

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
98767bf
BUG: shows correct package name when import_optional_dependency is ca…
hs2361 Sep 4, 2020
655febf
formatted according to black
hs2361 Sep 5, 2020
1830771
made changes as per review
hs2361 Sep 5, 2020
71f4bb6
updated whatsnew v1.1.2 according to review
hs2361 Sep 5, 2020
fc5facb
Merge branch 'master' into master
hs2361 Sep 6, 2020
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
1 change: 1 addition & 0 deletions doc/source/whatsnew/v1.1.2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Bug fixes
- Bug in :meth:`DateTimeIndex.format` and :meth:`PeriodIndex.format` with ``name=True`` setting the first item to ``"None"`` where it should be ``""`` (:issue:`35712`)
- Bug in :meth:`Float64Index.__contains__` incorrectly raising ``TypeError`` instead of returning ``False`` (:issue:`35788`)
- Bug in :class:`DataFrame` indexing returning an incorrect :class:`Series` in some cases when the series has been altered and a cache not invalidated (:issue:`33675`)
- Bug in :meth:`import_optional_dependency` returning incorrect package names in cases where package name is different from import name (:issue:`35948`)

.. ---------------------------------------------------------------------------

Expand Down
21 changes: 19 additions & 2 deletions pandas/compat/_optional.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,19 @@
"numba": "0.46.0",
}

# A mapping from import name to package name (on PyPI) for packages where
# these two names are different.

INSTALL_MAPPING = {
"bs4": "beautifulsoup4",
"bottleneck": "Bottleneck",
"lxml.etree": "lxml",
"odf": "odfpy",
"pandas_gbq": "pandas-gbq",
"sqlalchemy": "SQLAlchemy",
"jinja2": "Jinja2",
}


def _get_version(module: types.ModuleType) -> str:
version = getattr(module, "__version__", None)
Expand Down Expand Up @@ -82,9 +95,13 @@ def import_optional_dependency(
is False, or when the package's version is too old and `on_version`
is ``'warn'``.
"""

package_name = INSTALL_MAPPING.get(name)
install_name = package_name if package_name is not None else name

msg = (
f"Missing optional dependency '{name}'. {extra} "
f"Use pip or conda to install {name}."
f"Missing optional dependency '{install_name}'. {extra} "
f"Use pip or conda to install {install_name}."
)
try:
module = importlib.import_module(name)
Expand Down