Skip to content

Support Python editable builds #5558

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 33 commits into from
Sep 7, 2023
Merged

Support Python editable builds #5558

merged 33 commits into from
Sep 7, 2023

Conversation

justinchuby
Copy link
Member

@justinchuby justinchuby commented Aug 31, 2023 •
edited
Loading

Enable editable builds for pip install -e . by fixing a path not found error in setup.py.

Previously Develop calls BuildExt which assumes the directory {build_lib}/onnx exists because BuildPy would create it. However BuildPy is not called in editable build, thus not creating the directory for BuildExt to put the artifacts in. This change updates BuildExt to create the directory for its own use independent of previous steps.

  • Remove CreateVersion and moved the logic into a function to parameterize it
  • General cleanup and refactor logic

Tested with

pip install -e .
pip install .
python -m build
python -m build --sdist
python setup.py develop

Reference: pypa/setuptools#3606

Fixes #4539

justinchuby and others added 18 commits April 5, 2023 18:49
@justinchuby
Clean up setup
a3dd5eb 
Signed-off-by: Justin Chu <justinchu@microsoft.com>
@justinchuby
Apply suggestions from code review
846d91a 
Signed-off-by: Justin Chu <justinchuby@users.noreply.github.com>
@justinchuby
Update
a56527d 
Signed-off-by: Justin Chu <justinchu@microsoft.com>
@justinchuby
Merge branch 'main' into justinchu/cleanup-setup
25e925e
@justinchuby
lint
40d48e7 
Signed-off-by: Justin Chu <justinchu@microsoft.com>
@justinchuby
Merge branch 'main' into justinchu/cleanup-setup
dc45bbf
@justinchuby
Optional dependencies
880586f 
Signed-off-by: Justin Chu <justinchu@microsoft.com>
@justinchuby
Remove --use-deprecated=legacy-resolver --no-use-pep517
894f892 
Signed-off-by: Justin Chu <justinchu@microsoft.com>
@justinchuby
Use build to build
2375314 
Signed-off-by: Justin Chu <justinchu@microsoft.com>
@justinchuby
Merge branch 'main' into justinchu/cleanup-setup
54712ce
@justinchuby
Better print
0fc3425 
Signed-off-by: Justin Chu <justinchu@microsoft.com>
@justinchuby
Remove setup cfg
755fe26 
Signed-off-by: Justin Chu <justinchu@microsoft.com>
@justinchuby
Add build to requirements
38709bf 
Signed-off-by: Justin Chu <justinchu@microsoft.com>
@justinchuby
Use sed to rename wheel
3b89502 
Signed-off-by: Justin Chu <justinchu@microsoft.com>
@justinchuby
Rename package
8a62183 
Signed-off-by: Justin Chu <justinchu@microsoft.com>
@justinchuby
Authors
bfe4a3a 
Signed-off-by: Justin Chu <justinchu@microsoft.com>
@justinchuby
Use new_name
5f1434f 
Signed-off-by: Justin Chu <justinchu@microsoft.com>
@justinchuby
Editable install
c1a3d88 
Signed-off-by: Justin Chu <justinchu@microsoft.com>
@justinchuby justinchuby requested a review from a team as a code owner August 31, 2023 23:19
@justinchuby justinchuby marked this pull request as draft August 31, 2023 23:19
@justinchuby
Editable install
92ddfa2 
Signed-off-by: Justin Chu <justinchu@microsoft.com>
@justinchuby justinchuby mentioned this pull request Sep 5, 2023
Merged
@jcwchen jcwchen mentioned this pull request Sep 5, 2023
Closed
@justinchuby
Merge branch 'main' into justinchu/cleanup-setup-editable
71628b6
@justinchuby
Clean up
afdda2a 
Signed-off-by: Justin Chu <justinchu@microsoft.com>
@justinchuby justinchuby marked this pull request as ready for review September 5, 2023 17:32
@justinchuby justinchuby requested a review from jcwchen September 5, 2023 17:35
justinchuby
justinchuby commented Sep 5, 2023
View reviewed changes
@jcwchen jcwchen added run release CIs Use this label to trigger release tests in CI topic: build Issues related to ONNX builds and packages labels Sep 5, 2023
@justinchuby
Snapshot
60fdfaa 
Signed-off-by: Justin Chu <justinchu@microsoft.com>
justinchuby
justinchuby commented Sep 5, 2023
View reviewed changes
justinchuby
justinchuby commented Sep 5, 2023
View reviewed changes
justinchuby
justinchuby commented Sep 5, 2023
View reviewed changes
@justinchuby
Update setup.py
26ae251 
Signed-off-by: Justin Chu <justinchuby@users.noreply.github.com>
justinchuby
justinchuby commented Sep 5, 2023
View reviewed changes
github-advanced-security[bot]
github-advanced-security bot found potential problems Sep 7, 2023
View reviewed changes
@justinchuby
Editable install
156a62a 
Signed-off-by: Justin Chu <justinchu@microsoft.com>
@justinchuby justinchuby force-pushed the justinchu/cleanup-setup-editable branch from a17d8ad to 156a62a Compare September 7, 2023 00:37
@justinchuby
lint
17ff201 
Signed-off-by: Justin Chu <justinchu@microsoft.com>
justinchuby
justinchuby commented Sep 7, 2023
View reviewed changes
justinchuby and others added 4 commits September 6, 2023 18:13
@justinchuby
Update setup.py
baab557 
Signed-off-by: Justin Chu <justinchuby@users.noreply.github.com>
@justinchuby
ONNXCommand
38b9641 
Signed-off-by: Justin Chu <justinchu@microsoft.com>
@justinchuby
Revert
e68478e 
Signed-off-by: Justin Chu <justinchu@microsoft.com>
@justinchuby
Merge branch 'main' into justinchu/cleanup-setup-editable
c4615b7
@justinchuby
Copy link
Member Author

@jcwchen this should be ready

@justinchuby
Fix develop
ef67a8f 
Signed-off-by: Justin Chu <justinchu@microsoft.com>
@justinchuby
Naming
1b457e3 
Signed-off-by: Justin Chu <justinchu@microsoft.com>
@justinchuby
Copy link
Member Author

Windows not working

@justinchuby
Fix paths for windows
61a2708 
Signed-off-by: Justin Chu <justinchu@microsoft.com>
@justinchuby justinchuby force-pushed the justinchu/cleanup-setup-editable branch from 242a562 to 61a2708 Compare September 7, 2023 18:37
@justinchuby justinchuby disabled auto-merge September 7, 2023 18:38
@justinchuby justinchuby changed the title Support editable builds Support Python editable builds Sep 7, 2023
@justinchuby justinchuby added this pull request to the merge queue Sep 7, 2023
Merged via the queue into onnx:main with commit a39995c Sep 7, 2023
@justinchuby justinchuby deleted the justinchu/cleanup-setup-editable branch September 7, 2023 19:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@liqunfu liqunfu liqunfu approved these changes

@jcwchen jcwchen Awaiting requested review from jcwchen

Assignees
No one assigned
Labels
run release CIs Use this label to trigger release tests in CI topic: build Issues related to ONNX builds and packages
Projects
PR Tracker
Status: Done
Milestone
1.15
Development

Successfully merging this pull request may close these issues.

Build error with the latest setuptool
3 participants
@justinchuby @liqunfu @jcwchen