Fixing deprecated version attribute

[vagi8]

Creating a fix for #2316

[sentrivana]

Heya @vagi8, thanks for the contribution! This will work, but not in Python versions lower than 3.8 since importlib.metadata was only added in 3.8 -- and we still want to support those.

The good news is, there is already a place in the SDK where we gather all installed packages and their versions. Have a look at this:

sentry-python/sentry_sdk/integrations/modules.py

Lines 53 to 58 in 1f00437

	def _get_installed_modules():
	# type: () -> Dict[str, str]
	global _installed_modules
	if _installed_modules is None:
	_installed_modules = dict(_generate_installed_modules())
	return _installed_modules

[sentrivana]

See my previous comment. :)

[vagi8]

Hey @sentrivana
Thanks for bringing this to my attention.
Possible solution I can think of

1. use importlib.metadata and pkg_resources along with a try except block inside the flask.py to get the version. (pkg_resources.get_distribution("flask").version). Similar to the '_generate_installed_modules' function but specifically for flask.
2. Reuse the _get_installed_modules as is and extract flask version. also rename the function without the leading underscore
3. Re-design the '_get_installed_modules' to also fetch the version for a specific module if given an input.

[sentrivana]

Hey @vagi8. I'd go with option 2. The _get_installed_modules function is set up so that the actual module version collection only runs once the first time it's called and is then cached in a global variable. Any subsequent calls to it will just read the global variable. So calling it from the Flask integration wouldn't mean that it would be gathering info for all modules again, if that's your concern. It's fine to call it as is.

Let's please keep the leading underscore though, the intention there is to mark it as not part of the public API.

[sentrivana]

_get_installed_modules() returns a dict, so you'd want:

Suggested change

	FLASK_VERSION = installed_packages("flask")
	FLASK_VERSION = installed_packages["flask"]

I'm also thinking we could move these two lines into the setup_once method instead, so that all the version checking code is in one place.

[sentrivana]

Is this global variable needed? We only seem to be using FLASK_VERSION inside the setup_once function, so we just define and use it there?

[sentrivana]

Looking great @vagi8, thank you for the contribution! 🚀

One last thing: flake8 is complaining about the variable name now: sentry_sdk/integrations/flask.py:69:10: N806 variable 'FLASK_VERSION' in function should be lowercase, once we fix that we're good to merge 👍🏻