Skip to content
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

Replace description-file setuptools metadata key with description_file in setup.cfg #1017

Conversation

JeanChristopheMorinPerso
Copy link
Member

Summary

Latest setuptools prints a deprecation warning as follows:

    /tmp/pip-build-env-cje71c9_/overlay/lib/python3.9/site-packages/setuptools/dist.py:697: UserWarning: Usage of dash-separated 'description-file' will not be supported in future versions. Please use the underscore name 'description_file' instead

So this PR simply replaces description-file with description_file.

@codecov-commenter
Copy link

Codecov Report

Merging #1017 (a494ea4) into master (5957ddc) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1017   +/-   ##
=======================================
  Coverage   85.55%   85.55%           
=======================================
  Files         192      192           
  Lines       18317    18317           
  Branches     2056     2056           
=======================================
  Hits        15672    15672           
  Misses       2119     2119           
  Partials      526      526           
Flag Coverage Δ
unittests 85.55% <ø> (ø)

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


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5957ddc...a494ea4. Read the comment docs.

@meshula
Copy link
Collaborator

meshula commented Jul 19, 2021

I can't find documentation, other than this, which doesn't mention the deprecation reported in the warning. https://docs.openstack.org/pbr/latest/user/features.html - our tests have all passed, including making wheels for py27, so it seems fine!

@JeanChristopheMorinPerso
Copy link
Member Author

JeanChristopheMorinPerso commented Jul 19, 2021

See pypa/setuptools#2588 and pypa/setuptools#1608 for more information on this warning.

@meshula
Copy link
Collaborator

meshula commented Jul 19, 2021

Thanks for the links. Looks like setuptools' maintainers decided to deviate from PEP508 which states that dashes and underscores are supposed to be equivalent.

@ssteinbach
Copy link
Collaborator

Are the other hyphenated fields ok?

@ssteinbach
Copy link
Collaborator

(meaning: will we have to change the rest to underscores as well?)

@ssteinbach
Copy link
Collaborator

Looking through the file, it looks like a mix of hyphens and underscores. This seems fine, we can fix them as they come up. Thanks!

@ssteinbach ssteinbach merged commit 8683d44 into AcademySoftwareFoundation:master Jul 19, 2021
@JeanChristopheMorinPerso
Copy link
Member Author

Looks like setuptools' maintainers decided to deviate from PEP508 which states that dashes and underscores are supposed to be equivalent.

The PEP isn't clear on that, so they decided one something, which is this warning.

Looking through the file, it looks like a mix of hyphens and underscores. This seems fine, we can fix them as they come up.

This warning should only apply to sections owned by setuptools/distutils, see pypa/setuptools#2595 (comment). So the PR I linked was a little problematic, which was fixed in pypa/setuptools#2600.

So the other sections not owned by setuptools/distutils are fine.

@JeanChristopheMorinPerso JeanChristopheMorinPerso deleted the remove_setuptools_usagewarning branch July 19, 2021 20:32
@ssteinbach ssteinbach changed the title Replace description-file metadata key with description_file Replace description-file setuptools metadata key with description_file in setup.cfg Oct 26, 2021
@ssteinbach ssteinbach added this to the Public Beta 14 milestone Oct 26, 2021
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.

None yet

4 participants