Migrated config to pyproject.toml. #4310
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
It's not immediately obvious to me why this change breaks the build. |
|
The tests are failing with the "Pre-build distributions for test" part of the CI environment with the following traceback while attempting to invoke the PEP 517 |
|
I'm unable to replicate the failure in a clean docker image: |
|
Aah. The failures are in the |
|
Unfortunately, I still can't replicate the issue with |
|
Even running the action using |
|
As a shot in the dark, I tried setting the SETUPTOOLS_USE_DISTUTILS explicitly in the script and that does replicate the failure when using the diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index ec2e567a1..cdc66d2bb 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -96,7 +96,7 @@ jobs:
run: |
rm -rf dist
# workaround for pypa/setuptools#4333
- pipx run --pip-args 'pyproject-hooks!=1.1' build
+ env SETUPTOOLS_USE_DISTUTILS=stdlib pipx run --pip-args 'pyproject-hooks!=1.1' build
echo "PRE_BUILT_SETUPTOOLS_SDIST=$(ls dist/*.tar.gz)" >> $GITHUB_ENV
echo "PRE_BUILT_SETUPTOOLS_WHEEL=$(ls dist/*.whl)" >> $GITHUB_ENV
rm -rf setuptools.egg-info # Avoid interfering with the other tests |
|
After working around a bug in act, I've been able to replicate the failure reliably with the act command above. Moreover, by rolling back to an older docker image using Ubuntu Jammy, I'm able to replicate the failure in a standalone docker image: |
|
I've bisected the config from the bottom up and only after re-adding the full metadata section does the problem go away. I'm not yet sure if it's related, but this code is only hit when the pyproject.toml config is present. |
|
Any chance the cause of the problem is a late/delayed execution of the monkey patching in Explaining a bit better: I was wondering if it is possible that the following is happening?
But if it is a "late change of the binding" in Possible workarounds we can think of (if the supposition above is true):
- import distutils.command.install as orig
+ from distutils.command.install import install as orig_installand then change all occurrences of (that would prevent the error, but I suppose it would make the debian patching ineffective because it happens too late). Footnotes
|
|
BTW, we had another instance reported in the past of a very similar exception in #4136: File "/usr/lib/python3.10/_distutils_system_mod.py", line 33, in initialize_options
super().initialize_options()
TypeError: super(type, obj): obj must be an instance or subtype of type |
abravalheri
reviewed
May 12, 2024
|
Investigating a bit more, I've put a breakpoint at the top of |
|
And the behavior on main seems like the right behavior - if SETUPTOOLS_USE_DISTUTILS=stdlib, then the _distutils_system_mod shouldn't be invoked. Using this dockerfile: FROM jaraco/multipy-tox:jammy
RUN apt install -y vim
RUN python3.10 -m pip install wheel build "pyproject-hooks!=1.1"
ENV SETUPTOOLS_USE_DISTUTILS=stdlib
RUN sed -i -e "s/import os/breakpoint()\nimport os/" /usr/lib/python3.10/_distutils_system_mod.py
workdir setuptools
CMD python3.10 -m build --no-isolationAnd running it with the branch checked out locally, I can see the stack trace when _distutils_system_mod is imported during the build wheel step (and others): It seems as if But why then is that not an issue when using setup.cfg? There are several places in the code where |
|
I put a breakpoint in |
This approach seems most sound. I'll try that. |
That does seem to fix the issue. I'll apply that in a separate PR against #4136. |
|
Looks like the tests now pass when targeting main after #4361. |
Closed
3 tasks
abravalheri
approved these changes
May 21, 2024
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.