[build] modernize build-frontend: `python setup.py develop/install` -> `[uv ]pip install --no-build-isolation [-e ].` #156027

XuehaiPan · 2025-06-15T16:22:39Z

Modernize the development installation:

# python setup.py develop
python -m pip install --no-build-isolation -e .

# python setup.py install
python -m pip install --no-build-isolation .

Now, the python setup.py develop is a wrapper around python -m pip install -e . since setuptools>=80.0:

Rely on pip for setup.py develop pypa/setuptools#4955

python setup.py install is deprecated and will emit a warning during run. The warning will become an error on October 31, 2025.

https://github.com/pypa/setuptools/blob/9c4d383631d3951fcae0afd73b5d08ff5a262976/setuptools/command/install.py#L58-L67

SetuptoolsDeprecationWarning.emit(
    "setup.py install is deprecated.",
    """
    Please avoid running ``setup.py`` directly.
    Instead, use pypa/build, pypa/installer or other
    standards-based tools.
    """,
    see_url="https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html",
    due_date=(2025, 10, 31),
)

Overhaul for better visibility of warnings pypa/setuptools#3849

Additional Resource:

Why you shouldn't invoke setup.py directly

Stack from ghstack (oldest at bottom):

cc @seemethere @malfet @osalpekar @atalman

[ghstack-poisoned]

pytorch-bot · 2025-06-15T16:22:43Z

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/156027

📄 Preview Python docs built from this PR
📄 Preview C++ docs built from this PR
❓ Need help or want to give feedback on the CI? Visit the bot commands wiki or our office hours

Note: Links to docs will display an error until the docs builds have been completed.

❌ 2 New Failures

As of commit 872688b with merge base 476874b ():

NEW FAILURES - The following jobs have failed:

Build Official Docker Images / build (12.9, 12.9.1, 9, devel, linux/amd64) (gh)
Process completed with exit code 2.
Build Official Docker Images / build (12.9, 12.9.1, 9, runtime, linux/amd64) (gh)
Process completed with exit code 2.

This comment was automatically generated by Dr. CI and updates every 15 minutes.

[ghstack-poisoned]

…> `[uv ]pip install[ -e] .` Modernize the development installation: ```bash python -m pip install -e . python -m pip install . ``` ghstack-source-id: 6127c08 Pull-Request: pytorch#156027

[ghstack-poisoned]

XuehaiPan · 2025-07-09T03:23:17Z

@pytorchbot merge -i

pytorchmergebot · 2025-07-09T03:25:09Z

Merge started

Your change will be merged while ignoring the following 2 checks: Build Official Docker Images / build (12.9, 12.9.1, 9, runtime, linux/amd64), Build Official Docker Images / build (12.9, 12.9.1, 9, devel, linux/amd64)

Learn more about merging in the wiki.

Questions? Feedback? Please reach out to the PyTorch DevX Team

Advanced Debugging

Check the merge workflow status
here

pytorchmergebot · 2025-07-09T09:23:39Z

The merge job was canceled or timed out. This most often happen if two merge requests were issued for the same PR, or if merge job was waiting for more than 6 hours for tests to finish. In later case, please do not hesitate to reissue the merge command
For more information see pytorch-bot wiki.

XuehaiPan · 2025-07-09T09:24:29Z

@pytorchbot merge -i

pytorchmergebot · 2025-07-09T09:26:18Z

Merge started

Your change will be merged while ignoring the following 2 checks: Build Official Docker Images / build (12.9, 12.9.1, 9, runtime, linux/amd64), Build Official Docker Images / build (12.9, 12.9.1, 9, devel, linux/amd64)

Learn more about merging in the wiki.

Questions? Feedback? Please reach out to the PyTorch DevX Team

Advanced Debugging

Check the merge workflow status
here

…> `[uv ]pip install --no-build-isolation [-e ].` Modernize the development installation: ```bash python -m pip install --no-build-isolation -e . python -m pip install --no-build-isolation . ``` ghstack-source-id: c2d1f33 Pull-Request: pytorch#156027

albanD · 2025-07-22T14:41:58Z

@XuehaiPan @ezyang doesn't this new recommendation break ccache due to folder randomization?
Why do we recommend that??

rgommers · 2025-07-22T16:02:06Z

It shouldn't, pip just defaults to building in the build folder nowadays, that was changed several years ago. uv does the same.

albanD · 2025-07-22T16:05:57Z

But then I'm surprised of the very big warning that was added to vllm recently: https://docs.vllm.ai/en/latest/getting_started/installation/gpu.html#full-build-with-compilation ?

rgommers · 2025-07-22T16:19:32Z

Those vllm instructions omit --no-build-isolation in their default instructions, which is a really bad idea: it re-installs all build dependencies on each invocation into a temporary venv, and yes that does change to a random path which will break ccache.

Doing an editable build with build isolation never really makes sense when dealing with compiled code, you'll never be able to do an incremental build.

#156027 already replaced most use of `python setup.py develop`. This PR only adds a few more occurrences. Pull Request resolved: #156710 Approved by: https://github.com/atalman

pytorch#156027 already replaced most use of `python setup.py develop`. This PR only adds a few more occurrences. Pull Request resolved: pytorch#156710 Approved by: https://github.com/atalman

#156027 already replaced most use of `python setup.py install`. This PR only adds a few more occurrences and adds `--no-build-isolation` in a few places. Pull Request resolved: #156711 Approved by: https://github.com/atalman

Update

bbe70f0

[ghstack-poisoned]

XuehaiPan requested a review from a team as a code owner June 15, 2025 16:22

pytorch-bot bot added the release notes: onnx torch.onnx related changes that should show up in the release notes label Jun 15, 2025

XuehaiPan mentioned this pull request Jun 15, 2025

[build] modernize build-backend: setuptools.build_meta:__legacy__ -> setuptools.build_meta #155998

Closed

facebook-github-bot added the oncall: jit Add this issue/PR to JIT oncall triage queue label Jun 15, 2025

This was referenced Jun 15, 2025

[BE] add a minimal linter to check pyproject.toml consistency #156017

Closed

[BE] fix PYPROJECT linting errors in test/ and tools/ #156021

Closed

[BE][Easy] pin setuptools>=77 for PEP-639 support #155999

Closed

pytorchbot added the open source label Jun 15, 2025

Update

278b30e

[ghstack-poisoned]

Update

7e10ce3

[ghstack-poisoned]

XuehaiPan mentioned this pull request Jun 15, 2025

[RFC] Migrate to modern Python build system and replace setup.py commands with their modern alternatives #156029

Closed

Update

6386d08

[ghstack-poisoned]

Update

0822609

[ghstack-poisoned]

pytorchmergebot removed the merging label Jul 9, 2025

pytorchmergebot added the merging label Jul 9, 2025

XuehaiPan mentioned this pull request Jul 9, 2025

[BE][Easy] remove unused build-time dependency astunparse and change astunparse.unparse -> ast.unparse #157907

Closed

pytorchmergebot added the Merged label Jul 9, 2025

pytorchmergebot closed this in 4dce5b7 Jul 9, 2025

pytorchmergebot removed the merging label Jul 9, 2025

jinsun-yoo mentioned this pull request Jul 28, 2025

Lingering reference to setup.py in CONTRIBUTING.md #159234

Open

This was referenced Aug 11, 2025

Replace setup.py develop with pip install -e #156710

Closed

Replace setup.py install with pip install #156711

Closed

github-actions bot deleted the gh/XuehaiPan/283/head branch August 22, 2025 02:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[build] modernize build-frontend: `python setup.py develop/install` -> `[uv ]pip install --no-build-isolation [-e ].` #156027

[build] modernize build-frontend: `python setup.py develop/install` -> `[uv ]pip install --no-build-isolation [-e ].` #156027

Uh oh!

XuehaiPan commented Jun 15, 2025 •

edited

Loading

Uh oh!

pytorch-bot bot commented Jun 15, 2025 •

edited

Loading

Uh oh!

XuehaiPan commented Jul 9, 2025

Uh oh!

pytorchmergebot commented Jul 9, 2025

Uh oh!

pytorchmergebot commented Jul 9, 2025

Uh oh!

XuehaiPan commented Jul 9, 2025

Uh oh!

pytorchmergebot commented Jul 9, 2025

Uh oh!

albanD commented Jul 22, 2025

Uh oh!

rgommers commented Jul 22, 2025

Uh oh!

albanD commented Jul 22, 2025

Uh oh!

rgommers commented Jul 22, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

[build] modernize build-frontend: python setup.py develop/install -> [uv ]pip install --no-build-isolation [-e ]. #156027

[build] modernize build-frontend: python setup.py develop/install -> [uv ]pip install --no-build-isolation [-e ]. #156027

Uh oh!

Conversation

XuehaiPan commented Jun 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pytorch-bot bot commented Jun 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/156027

❌ 2 New Failures

Uh oh!

XuehaiPan commented Jul 9, 2025

Uh oh!

pytorchmergebot commented Jul 9, 2025

Merge started

Uh oh!

pytorchmergebot commented Jul 9, 2025

Uh oh!

XuehaiPan commented Jul 9, 2025

Uh oh!

pytorchmergebot commented Jul 9, 2025

Merge started

Uh oh!

albanD commented Jul 22, 2025

Uh oh!

rgommers commented Jul 22, 2025

Uh oh!

albanD commented Jul 22, 2025

Uh oh!

rgommers commented Jul 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

[build] modernize build-frontend: `python setup.py develop/install` -> `[uv ]pip install --no-build-isolation [-e ].` #156027

[build] modernize build-frontend: `python setup.py develop/install` -> `[uv ]pip install --no-build-isolation [-e ].` #156027

XuehaiPan commented Jun 15, 2025 •

edited

Loading

pytorch-bot bot commented Jun 15, 2025 •

edited

Loading

rgommers commented Jul 22, 2025 •

edited

Loading