Generate module version file at build

[4383]

Gunicore rely on eventlet.__version__ [1], however this data have been removed during our modernization of the continuous deployment mechanisms [2].

People reported problem with gunicore after 0.34.1 [3][4], so, it could be worth to reintroduce similar version info, to avoid side effects.

This patch propose to use a hatch-vcs hook [5] to generate dynamically, at build, the missing data. Other solutions exists but each of them have their own problems [6].

Indeed, considering "footgun" described in [6] I choose the hatch-vcs approach, because, retrieving a wrong version number during development when the lib is installed in editable mode, is not, I think, something horrible. I prefer this side effect rather than relying on another additional underlying library just to print a version number when eventlet is installed in editable mode. A new additional requirement which would be installed anytime at runtime and production.

Moreover, sometimes you want to import a package from a development repository tarball you just downloaded (where
there's no metadata or Git tags present). So, Using setuptools_scm or importlib.metadata.version won't works in that context.

Fix benoitc/gunicorn#3120

[1] benoitc/gunicorn#3120
[2] #845
[3] #845 (comment)
[4] #842 (comment)
[5] https://github.com/ofek/hatch-vcs#build-hook
[6] https://github.com/maresb/hatch-vcs-footgun-example

[codecov]

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (b738b0a) 53% compared to head (44fee01) 53%.
Report is 3 commits behind head on master.

Files	Patch %	Lines
eventlet/__init__.py	50%	2 Missing ⚠️

Additional details and impacted files

@@          Coverage Diff          @@
##           master   #859   +/-   ##
=====================================
- Coverage      53%    53%   -1%     
=====================================
  Files          88     88           
  Lines        9887   9891    +4     
  Branches     1854   1854           
=====================================
+ Hits         5337   5338    +1     
- Misses       4160   4163    +3     
  Partials      390    390           

Flag	Coverage Δ
ipv6	22% <50%> (+<1%)	⬆️
py310epolls	52% <50%> (-1%)	⬇️
py310poll	52% <50%> (-1%)	⬇️
py310selects	52% <50%> (-1%)	⬇️
py311epolls	52% <50%> (-1%)	⬇️
py312epolls	50% <50%> (-1%)	⬇️
py37epolls	50% <50%> (-1%)	⬇️
py38epolls	52% <50%> (-1%)	⬇️
py38openssl	51% <50%> (-1%)	⬇️
py38poll	52% <50%> (-1%)	⬇️
py38selects	52% <50%> (-1%)	⬇️
py39dnspython1	50% <50%> (-1%)	⬇️
py39epolls	52% <50%> (-1%)	⬇️
py39poll	52% <50%> (-1%)	⬇️
py39selects	52% <50%> (-1%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[pajod]

@4383 Thanks.
And yes, these version checks should really be left for apt/setuptools to worry about, and where they stood there should be assertions about using the intended stdlib/patched modules.. but even the prerequisite patch series for modernize efforts like that still need work, so I appreciate the API stability until there is a clear upgrade path for incompatible versions.

[itamarst]

I tested python -m build and it doesn't actually include a _version.py file, probably because of the config issue noted in the review comments.

[4383]

I tested python -m build and it doesn't actually include a _version.py file, probably because of the config issue noted in the review comments.

Successfully tested locally. Thanks

[osfrickler]

this raises an error for me, you'll have to make the warning a single str arg

[4383]

Fixed.

>>> import eventlet
>>> eventlet.__version__
'0.34.2.dev1+gc2236b8.d20231222'

[4383]

Let me know if you still face the error.

[osfrickler]

I must admit that originally I didn't actually test with python3.6, but just ran the warn() statement in py3.10, because I wanted to see how the multiline message would look like. With your original code, the issue would only be triggered when running with py3.6 or older. Now actually testing with py3.6, the error is gone, but also the deprecation warning actually isn't actually shown by default, since https://peps.python.org/pep-0565/ was only implemented for py3.7. So one would have to set something like PYTHONWARNINGS=error for the warning to actually take effect. This may just be the expected behavior and maybe I'm worrying too much about historic python versions, but maybe the alternative option of changing the warning to be a real error immediately might be a better solution?

[4383]

Thanks for your verification, and for your advices, they are really relevant.

Let's remove, from this pull request, the changes related to this warning. We can handle it in a separated pull request to more isolate the topics. I prefer to keep this pull request more focused on the sole topic of python version. I should have treated them separately.

[4383]

And anyway, this warning will be removed by https://github.com/eventlet/eventlet/pull/853/files
So, I suggest we do not waste time on it anywhere else.

[osfrickler]

Suggestion to fix grammar and spelling:

# NOTE(hberaud): Versions are now managed by hatch and control version.
# hatch has a build hook which generates the version file, however,
# if the project is installed in editable mode then the _version.py file
# will not be updated unless the package is reinstalled (or locally rebuilt).
# For further details, please read:

[4383]

Changed to your proposal.

[itamarst]

Thank you!

[itamarst]

I added a .gitignore entry for _version.py. Looks good to merge.