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

Clarify modules used for pyproject.toml parsing are private #3385

Merged
merged 2 commits into from Jun 17, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions changelog.d/3385.misc.rst
@@ -0,0 +1,2 @@
Modules used to parse and evaluate configuration from ``pyproject.toml`` files are
intended for internal use only and that not part of the public API.
2 changes: 2 additions & 0 deletions setuptools/config/_apply_pyprojecttoml.py
Expand Up @@ -4,6 +4,8 @@
The distribution and metadata objects are modeled after (an old version of)
core metadata, therefore configs in the format specified for ``pyproject.toml``
need to be processed before being applied.

**PRIVATE MODULE**: API reserved for setuptools internal usage only.
"""
import logging
import os
Expand Down
2 changes: 2 additions & 0 deletions setuptools/config/expand.py
Expand Up @@ -14,6 +14,8 @@

This module focus on the second step, and therefore allow sharing the expansion
functions among several configuration file formats.

**PRIVATE MODULE**: API reserved for setuptools internal usage only.
"""
import ast
import importlib
Expand Down
6 changes: 5 additions & 1 deletion setuptools/config/pyprojecttoml.py
@@ -1,4 +1,8 @@
"""Load setuptools configuration from ``pyproject.toml`` files"""
"""
Load setuptools configuration from ``pyproject.toml`` files.

**PRIVATE MODULE**: API reserved for setuptools internal usage only.
"""
import logging
import os
import warnings
Expand Down
6 changes: 5 additions & 1 deletion setuptools/config/setupcfg.py
@@ -1,4 +1,8 @@
"""Load setuptools configuration from ``setup.cfg`` files"""
"""
Load setuptools configuration from ``setup.cfg`` files.

**API will be made private in the future**
"""
import os

import warnings
Expand Down