setuptools icon indicating copy to clipboard operation
setuptools copied to clipboard

What to do with the deprecation warnings for dash-separated and uppercase keys in `setup.cfg` after due date?

Open abravalheri opened this issue 1 year ago • 1 comments

When working recently on setuptools changes I noticed that some deprecations have reached due date:

https://github.com/pypa/setuptools/blob/3106af0512fe67464a8b5e7524c07fddf7717660/setuptools/dist.py#L499-L509

https://github.com/pypa/setuptools/blob/3106af0512fe67464a8b5e7524c07fddf7717660/setuptools/dist.py#L521-L534

The problem is that I don't think that the community have moved towards fixing those usages, as indicated by this GitHub search: https://github.com/search?q=%2Fauthor-email%7Cmaintainer-email%7Clong-description%7Clicense-file%2F+path%3Asetup.cfg&type=code&p=5. Disclaimer: I don't know if these results use the setup.cfg format of a tool that is different than setuptools and accepts dashes (I don't know for example if pbr accepts dashes).

What should we do now that we are arriving the end of the deprecation period? Should we simply transform the warnings in errors? Would that be too disruptive in the community?

abravalheri avatar Oct 07 '24 15:10 abravalheri

What should we do now that we are arriving the end of the deprecation period? Should we simply transform the warnings in errors? Would that be too disruptive in the community?

I think you've answered your own question today pretty conclusively.

I would personally apply Postel's Law here: "Be liberal in what you accept, and conservative in what you send."

I.e. Auto-replace - to _ for all the keys, so that you can fix user errors as broadly as possible and Do The Right Thing Regardless.

herebebeasties avatar Mar 24 '25 21:03 herebebeasties