Add version as an importable variable and remove dependency on pkg_resources
#566
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zippolyte
requested changes
Jun 8, 2020
datadog/util/config.py
Outdated
Comment on lines
135
to
160
| def get_pkg_version(): | ||
| """ | ||
| Resolve `datadog` package version. | ||
| """ | ||
| if not pkg: | ||
| return u"unknown" | ||
|
|
||
| dist = pkg.get_distribution("datadog") | ||
| # Normalize case for Windows systems | ||
| dist_loc = os.path.normcase(dist.location) | ||
| here = os.path.normcase(__file__) | ||
| if not here.startswith(dist_loc): | ||
| # not installed, but there is another version that *is* | ||
| raise pkg.DistributionNotFound | ||
|
|
||
| return dist.version | ||
|
|
||
|
|
||
| def get_version(): | ||
| """ | ||
| Resolve `datadog` package version. | ||
| """ | ||
| try: | ||
| return get_pkg_version() | ||
| except pkg.DistributionNotFound: | ||
| return u"Please install `datadog` with setup.py" |
There was a problem hiding this comment.
I would keep these two functions for compatibility, in case some people use it in their code.
Just make them return the __version__ variable, and maybe add a comment in the docstring we're keeping them for compatibility but user should import __version__ from version instead.
zippolyte
approved these changes
Jun 9, 2020
zippolyte
added
the
changelog/Changed
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
zippolyte
added
changelog/Added
zippolyte
changed the title
pkg_resources
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Remove the dependency on
pkg_resourcesby moving the version todatadog/version.pyDescription of the Change
importing of
pkg_resourcescan be slow as it does a lot of import-time processing (see pypa/setuptools#926, pypa/setuptools#510)This change moves the version from
setup.pyinto a file inside the datadog module so that it can be imported from other locations in the code (most notably it can be imported from the dogstatsd module without causing a circular import)Alternate Designs
This document outlines the possible approaches: https://packaging.python.org/guides/single-sourcing-package-version/
pkg_resourcesPossible Drawbacks
The main drawback is that it is a change to the release process, which may cause a small amount of friction when releasing a new version.
Verification Process
python setup.py --versionReview checklist (to be filled by reviewers)
changelog/label attached. If applicable it should have thebackward-incompatiblelabel attached.do-not-merge/label attached.kind/andseverity/labels attached at least.