Skip to content

Commit

Permalink
Rename setuptools.config.{setupcfg => legacy_setupcfg}
Browse files Browse the repository at this point in the history
In pypa#2685 the plan that the community seems to agree on is to always
automatically translate `setup.cfg` into a `pyproject.toml` equivalent
and then proceed reading/parsing the configuration.

The objective of this change is to open space so we can implement this
way of reading `setup.cfg` in a new `setuptools.config.setupcfg` module
while keeping the legacy way of handling `setup.cfg` around.

The rationale behind keeping the legacy way around is that, to avoid
breaking existing packages during a transition period, we can compare
the old and the new way of parsing the configuration (e.g. via
`setuptools.{metadata,options}.compare`) and in the case they are
conflicting, use the old way and emit a warning asking the user to
report the error.
  • Loading branch information
abravalheri committed Dec 11, 2021
1 parent bb32cf6 commit 1a9e999
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion setuptools/config/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# For backward compatibility, the following classes/functions are exposed
# from `config.setupcfg`
from setuptools.config.setupcfg import (
from setuptools.config.legacy_setupcfg import (
ConfigHandler,
parse_configuration,
read_configuration,
Expand Down
File renamed without changes.

0 comments on commit 1a9e999

Please sign in to comment.