From a5fd78555bcc83054098b410af6fb5b97626f5e1 Mon Sep 17 00:00:00 2001 From: Anderson Bravalheri Date: Fri, 17 Jun 2022 18:04:44 +0100 Subject: [PATCH 1/2] Clarify modules used for pyproject.toml parsing are private --- setuptools/config/_apply_pyprojecttoml.py | 2 ++ setuptools/config/expand.py | 2 ++ setuptools/config/pyprojecttoml.py | 6 +++++- setuptools/config/setupcfg.py | 6 +++++- 4 files changed, 14 insertions(+), 2 deletions(-) diff --git a/setuptools/config/_apply_pyprojecttoml.py b/setuptools/config/_apply_pyprojecttoml.py index c33c8cc741..8af556169c 100644 --- a/setuptools/config/_apply_pyprojecttoml.py +++ b/setuptools/config/_apply_pyprojecttoml.py @@ -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 diff --git a/setuptools/config/expand.py b/setuptools/config/expand.py index da55d4eeb6..be987df5b4 100644 --- a/setuptools/config/expand.py +++ b/setuptools/config/expand.py @@ -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 diff --git a/setuptools/config/pyprojecttoml.py b/setuptools/config/pyprojecttoml.py index e9532d41b9..7587607cdb 100644 --- a/setuptools/config/pyprojecttoml.py +++ b/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 diff --git a/setuptools/config/setupcfg.py b/setuptools/config/setupcfg.py index b2d5c34609..6b874d100f 100644 --- a/setuptools/config/setupcfg.py +++ b/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 From 3376f182ef2f068863d784a3bc4ac82e15f0df75 Mon Sep 17 00:00:00 2001 From: Anderson Bravalheri Date: Fri, 17 Jun 2022 18:11:24 +0100 Subject: [PATCH 2/2] Add news fragment --- changelog.d/3385.misc.rst | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 changelog.d/3385.misc.rst diff --git a/changelog.d/3385.misc.rst b/changelog.d/3385.misc.rst new file mode 100644 index 0000000000..eace74c1bc --- /dev/null +++ b/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.