Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions sentry_sdk/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,11 @@
# Python 3.10 and below
BaseExceptionGroup = None # type: ignore

try:
from importlib import metadata as importlib_metadata
except ImportError:
importlib_metadata = None # type: ignore[assignment]

from typing import TYPE_CHECKING

import sentry_sdk
Expand Down Expand Up @@ -1841,6 +1846,14 @@ def package_version(package: str) -> "Optional[Tuple[int, ...]]":
_replace_hyphens_dots_and_underscores_with_dashes(package)
)

if importlib_metadata is not None:
# Look up the single distribution instead of scanning (and parsing
# the metadata of) every installed package on each call.
try:
return parse_version(importlib_metadata.version(normalized_package))
except importlib_metadata.PackageNotFoundError:
return None

installed_packages = {
_replace_hyphens_dots_and_underscores_with_dashes(module): v
for module, v in _get_installed_modules().items()
Expand Down
18 changes: 18 additions & 0 deletions tests/test_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -1412,6 +1412,24 @@ def test_package_version_is_none():
assert package_version("non_existent_package") is None


@pytest.mark.skipif(sys.version_info < (3, 8), reason="requires importlib.metadata")
def test_package_version_installed_package():
from importlib import metadata

assert package_version("pytest") == parse_version(metadata.version("pytest"))


@pytest.mark.skipif(sys.version_info < (3, 8), reason="requires importlib.metadata")
def test_package_version_does_not_scan_all_installed_packages(monkeypatch):
def _fail():
raise AssertionError("package_version must not scan all installed packages")

monkeypatch.setattr("sentry_sdk.utils._get_installed_modules", _fail)

assert package_version("pytest") is not None
assert package_version("non_existent_package") is None


@pytest.mark.parametrize(
"kwargs, expected",
[
Expand Down