Skip to content

bpo-38914 Do not require email field in setup.py. #17388

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Dec 23, 2019
Merged

bpo-38914 Do not require email field in setup.py. #17388

merged 4 commits into from
Dec 23, 2019

Conversation

jugmac00
Copy link
Contributor

@jugmac00 jugmac00 commented Nov 26, 2019

When checking setup.py and when the author field was provided, but
the author_email field was missing, erroneously a warning message was
displayed that the author_email field is required.

The specs do not require the author_emailfield:
https://packaging.python.org/specifications/core-metadata/#author

The same is valid for maintainer and maintainer_email.

The warning message has been adjusted.

modified: Doc/distutils/examples.rst
modified: Lib/distutils/command/check.py

https://bugs.python.org/issue38914

Automerge-Triggered-By: @pganssle

When checking `setup.py` and when the `author` field was provided, but
the `author_email` field was missing, erroneously a warning message was
displayed that the `author_email` field is required.

The specs do not require the `author_email`field:
https://packaging.python.org/specifications/core-metadata/#author

The same is valid for `maintainer` and `maintainer_email`.

The warning message has been adjusted.

modified:   Doc/distutils/examples.rst
modified:   Lib/distutils/command/check.py
@jugmac00 jugmac00 changed the title BPO-38914 Do not require email field in setup.py. bpo-38914 Do not require email field in setup.py. Nov 26, 2019
@bedevere-bot
Copy link

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@jugmac00
Copy link
Contributor Author

I do not know whether this matters, but @pganssle proposed a change of wording over at
pypa/pyproject-hooks#73 (comment)

Presumably we can solve it by adjusting the wording, since I see no such requirement in the specification.

@jugmac00
Copy link
Contributor Author

Well technically I did not
"I have made the requested changes; please review again"
as I do not think the requested changes are valid.

@bedevere-bot
Copy link

Thanks for making the requested changes!

@merwok: please review the changes made to this pull request.

@pganssle
Copy link
Member

@jugmac00 I am fine with the wording changes, but I do think we should put in a news entry, since this is a user-facing behavior.

Thank you for investigating this and making a PR!

new file:   Misc/NEWS.d/next/Library/2019-11-26-23-21-56.bpo-38914.8l-g-T.rst
modified:   Lib/distutils/command/check.py
@jugmac00
Copy link
Contributor Author

Thank you very much for your suggestions and for leading me through this pull request.

As I do not know whether you squash pull requests anyway or you'd prefer me to do it locally and force push, I just did created some more commits for the requested changes.

I will happily squash my commits locally and force push them - just leave me a note.

@jugmac00 jugmac00 requested a review from pganssle November 26, 2019 22:37
@merwok
Copy link
Member

merwok commented Nov 26, 2019

Squashing does not play well with github reviews and links, so CPython uses messy branches + squash merge. All info in the devguide: https://devguide.python.org/gitbootcamp/#creating-a-pull-request

@pganssle
Copy link
Member

pganssle commented Dec 8, 2019

I pushed a change to the wording of the news entry to clarify that this is just an adjustment to the wording of the warning and that otherwise the behavior has not changed. @jugmac00 If you agree with my new wording, I am happy to merge this.

@jugmac00
Copy link
Contributor Author

jugmac00 commented Dec 8, 2019

@pganssle Thanks for taking your time! lgtm :-)

@miss-islington miss-islington merged commit 9f9dac0 into python:master Dec 23, 2019
@merwok
Copy link
Member

merwok commented Dec 23, 2019

Small detail for future changes: there is no need to list modified files in the PR description, we can see that in github tabs and git metadata 🙂

SteadBytes added a commit to python-restx/flask-restx that referenced this pull request Jan 11, 2020
Change project authorship to "python-restx Authors"
and update LICENCE/setup.py accordingly to reflect
ownership of the new fork. The author_email field
has been removed from setup.py as it is no longer
a required field python/cpython#17388
and setting up a python-restx team email is not a
task we're looking to take on at the moment.
SteadBytes added a commit to python-restx/flask-restx that referenced this pull request Jan 12, 2020
Change project authorship to "python-restx Authors"
and update LICENCE/setup.py accordingly to reflect
ownership of the new fork. The author_email field
has been removed from setup.py as it is no longer
a required field python/cpython#17388
and setting up a python-restx team email is not a
task we're looking to take on at the moment.
SteadBytes added a commit to python-restx/flask-restx that referenced this pull request Jan 12, 2020
Change project authorship to "python-restx Authors"
and update LICENCE/setup.py accordingly to reflect
ownership of the new fork. The author_email field
has been removed from setup.py as it is no longer
a required field python/cpython#17388
and setting up a python-restx team email is not a
task we're looking to take on at the moment.
shihai1991 pushed a commit to shihai1991/cpython that referenced this pull request Jan 31, 2020
When checking `setup.py` and when the `author` field was provided, but
the `author_email` field was missing, erroneously a warning message was
displayed that the `author_email` field is required.

The specs do not require the `author_email`field:
https://packaging.python.org/specifications/core-metadata/#author

The same is valid for `maintainer` and `maintainer_email`.

The warning message has been adjusted.

modified:   Doc/distutils/examples.rst
modified:   Lib/distutils/command/check.py


https://bugs.python.org/issue38914
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants