refactor: Replace usage of Pants with uv using workspaces #478
Conversation
This file contains hidden or 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
There was a problem hiding this comment.
Copilot reviewed 61 out of 75 changed files in this pull request and generated 1 comment.
Files not reviewed (14)
- BUILD: Language not supported
- scripts/get-pants.sh: Language not supported
- src/edx_sysadmin/BUILD: Language not supported
- src/edx_sysadmin/api/BUILD: Language not supported
- src/edx_sysadmin/conf/locale/BUILD: Language not supported
- src/edx_sysadmin/management/commands/BUILD: Language not supported
- src/edx_sysadmin/migrations/BUILD: Language not supported
- src/edx_sysadmin/settings/BUILD: Language not supported
- src/edx_sysadmin/static/edx_sysadmin/css/BUILD: Language not supported
- src/edx_sysadmin/static/edx_sysadmin/js/BUILD: Language not supported
- src/edx_sysadmin/templates/edx_sysadmin/BUILD: Language not supported
- src/edx_sysadmin/templatetags/BUILD: Language not supported
- src/edx_sysadmin/utils/BUILD: Language not supported
- src/edx_username_changer/BUILD: Language not supported
Comments suppressed due to low confidence (1)
pyproject.toml:64
- The project now requires Python >=3.11, so the ruff target version should be updated to reflect the current Python version (e.g., 'py311').
target-version = "py38"
blarghmatey
force-pushed
the
pants_to_uv
branch
2 times, most recently
from
5dfdf06 to
51486a9
Compare
feoh
reviewed
Apr 16, 2025
| # Extract members from root pyproject.toml (requires toml parser like yq or similar, or hardcode) | ||
| # For simplicity, listing them explicitly based on pyproject.toml: | ||
| PACKAGES=( | ||
| "src/edx_sysadmin" |
There was a problem hiding this comment.
tomllib comes bundled with Python now. Bet you could do this with a one liner and avoid the DRY violation.
There was a problem hiding this comment.
Here you go :)
import tomllib; pypr=open("pyproject.toml","rb"); t=tomllib.load(pypr); members = t['tool']['uv']['workspace']['members']; print([ member.removeprefix('src/') for member in members ])
feoh
approved these changes
Apr 16, 2025
Anas12091101
requested changes
Apr 17, 2025
Comment on lines
+7
to
+18
| To build a package locally (e.g., for testing): | ||
| ```bash | ||
| # Install build tool (if needed) | ||
| # python -m pip install build uv | ||
| # Navigate to the repository root | ||
| cd /path/to/your/repo | ||
| # Build the desired package (replace <plugin_dir> with the actual directory) | ||
| python -m build src/<plugin_dir> | ||
| # Or using uv (if installed) | ||
| # uv build src/<plugin_dir> | ||
| ``` | ||
| The built wheel and sdist will be placed in `src/<plugin_dir>/dist/`. |
There was a problem hiding this comment.
I suggest we move these instructions to open-edx-plugins/docs/README.rst and remove all the Pants-related steps in the doc
There was a problem hiding this comment.
The tests aren’t running because the run_edx_integration_tests.sh script is likely looking for a test directory at the top level of the plugin. Since we’ve moved the plugin files and tests into a subdirectory, the script no longer finds them. We should update the run_edx_integration_tests.sh script to reflect the new structure so the tests are properly discovered and executed.
Anas12091101
requested changes
Apr 21, 2025
The Pants build tool adds unnecessary complexity to this project. The core use case is multiple packages being able to be built and published which is easier to do with uv.
Co-authored-by: Copilot <[email protected]>
blarghmatey
force-pushed
the
pants_to_uv
branch
from
c4bd83a to
d70a293
Compare
blarghmatey
force-pushed
the
pants_to_uv
branch
from
d70a293 to
0357ab9
Compare
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.
What are the relevant tickets?
N/A
Description (What does it do?)
This replaces usage of Pants with UV for building and publishing the sub-packages. It also replaces Poetry for version and dependency management.
How can this be tested?
Run
uv build --all-packagesto ensure packages buildVerify that the packages install and the GH Actions complete successfully
Verify that the package metadata is consistent or better between the packages built by Pants and the ones build by UV
Verify that the expected files are still present in the package and the namespaces are properly maintained.
Additional Context
The Pants build tool adds unnecessary complexity to this project. The core use case is multiple packages being able to be built and published which is easier to do with uv.