Move __version__ to __init__.py#243
Closed
pepoluan wants to merge 4 commits into
Closed
Conversation
This should solve issue aio-libs#241, in which setuptools < 46.4.0 tries to naively import smtp.py (due to version being specified as "attr: aiosmtpd.smtp.__version__" and barfs when encountering "from public import public" Moving __version__ to __init__.py seems to be the wisest -- and most semantically accurate -- decision. Not only can setuptools < 46.4.0 simply do a naive import of __init__.py (which contains no deps), but this signifies the version number applies to the _whole_ aiosmtpd package instead of just the smtp.py module. This impacts the following files * setup.cfg -- scan inside aiosmtpd instead of aiosmtpd.smtp * smtp.py -- it now needs to import * conf.py -- no longer scan smtp.py; import from __init__ instead
In this case, ensure __version__ from __init__.py is exact same object as __version__ from smtp.py
pepoluan
commented
Feb 5, 2021
Collaborator
Author
pepoluan
left a comment
pepoluan
left a comment
There was a problem hiding this comment.
No comments. Changes are simple and does not affect functionality.
Collaborator
Author
|
Since this is something simple, I'll just marinate for 1x24 |
Collaborator
Author
|
After some thinking, I think I'll merge this with #242 instead. Because it was @manfred-kaiser who brought this to our attention. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 do these changes do?
Move the
__version__attribute fromsmtp.pyto__init__.pyBenefits:
setuptools<46.4.0(see this PR which resulted in this change for 46.4.0Are there changes in behavior for the user?
Only if user actively searches for
__version__in the source code ofsmtp.py(via regex, startswith, or AST) instead of importing that attribute fromsmtp.pyUser that do
from aiosmtpd.smtp import __version__will NOT be affected, though it will be better if the import is donefrom aiosmtpdinstead.Related issue number
Fixes #241 (partially? Not sure if encoding error in the output posted in that issue is related to this...)
Checklist
(ALL)(ALL)qa,py36-{nocov,cov}(ALL)+pypy3-{nocov,cov,diffcov}(ALL)+pypy3-{nocov,cov,diffcov}(ALL)+pypy3-{nocov,cov,diffcov}NEWS.rstfilePR Note is undergoing editing; will undraft when editing done.