pypa / pypa/setuptools

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

Open
#4,672 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
2.9k
Forks
1.4k
Avg merge
1d 1h
Merged PRs (30d)
1

Description

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?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the referenced sections of setuptools/dist.py at lines 499-509 and 521-534, then review the linked GitHub search results for current setup.cfg usage. The issue needs a maintainer decision on the post-deprecation behavior; it is done when that policy and its compatibility impact are resolved into a specific implementation scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.