Make it explicit that functions to parse `pyproject.toml` are not part of the API
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.9k
- Forks
- 1.4k
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 1
Description
setuptools does not explicitly list which functions are part of the exposed API and therefore users tend to consider everything public.
As pointed out in #3231, some users might try to reach out for a function to parse the TOML file.
Since pyproject.toml uses a data format that maps directly to Python builtin types (dicts, arrays, etc), it can be directly parsed by a TOML library, such as tomli or future tomllib.
Therefore my opinion is that we can explicitly sign that the modules used to parse pyproject.toml are internal by prefixing them with _.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the setuptools modules that parse pyproject.toml and checking how they are imported. Review the related discussion in #3231 and identify all references that would need updating. Done means the parsing modules are explicitly internal with underscore-prefixed names, without breaking supported APIs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100