Skip to content

Commit

Permalink
Allow user to skip validation of pyproject.toml via env var (#4611)
Browse files Browse the repository at this point in the history
  • Loading branch information
abravalheri authored Nov 11, 2024
2 parents 8d518af + b7f7768 commit e14cfec
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 0 deletions.
7 changes: 7 additions & 0 deletions newsfragments/4611.feature.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Added support for the environment variable
``SETUPTOOLS_DANGEROUSLY_SKIP_PYPROJECT_VALIDATION=true``, allowing users to bypass
the validation of ``pyproject.toml``.
This option should be used only as a last resort when resolving dependency
issues, as it may lead to improper functioning.
Users who enable this setting are responsible for ensuring that ``pyproject.toml``
complies with setuptools requirements.
13 changes: 13 additions & 0 deletions setuptools/config/pyprojecttoml.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,19 @@ def load_file(filepath: StrPath) -> dict:


def validate(config: dict, filepath: StrPath) -> bool:
skip = os.getenv("SETUPTOOLS_DANGEROUSLY_SKIP_PYPROJECT_VALIDATION", "false")
if skip.lower() == "true": # https://github.com/pypa/setuptools/issues/4459
SetuptoolsWarning.emit(
"Skipping the validation of `pyproject.toml`.",
"""
Please note that some setuptools functionalities rely on the validation of
`pyproject.toml` against misconfiguration to ensure proper operation.
By skipping the automatic checks, you taking responsibility for making sure
the file is valid. Otherwise unexpected behaviours may occur.
""",
)
return True

from . import _validate_pyproject as validator

trove_classifier = validator.FORMAT_FUNCTIONS.get("trove-classifier")
Expand Down
7 changes: 7 additions & 0 deletions setuptools/tests/config/test_pyprojecttoml.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
)
from setuptools.dist import Distribution
from setuptools.errors import OptionError
from setuptools.warnings import SetuptoolsWarning

import distutils.core

Expand Down Expand Up @@ -394,3 +395,9 @@ def test_warn_tools_typo(tmp_path):

with pytest.warns(_ToolsTypoInMetadata):
read_configuration(pyproject)


def test_warn_skipping_validation(monkeypatch):
monkeypatch.setenv("SETUPTOOLS_DANGEROUSLY_SKIP_PYPROJECT_VALIDATION", "true")
with pytest.warns(SetuptoolsWarning, match="Skipping the validation"):
assert validate({"completely-wrong": "data"}, "pyproject.toml") is True

0 comments on commit e14cfec

Please sign in to comment.