Skip to content

feat: Add Python Virtual Environment Support: Installing User Defined Packages#4902

Merged
kunwp1 merged 36 commits into
apache:mainfrom
SarahAsad23:pve-add-user-packages
May 12, 2026
Merged

feat: Add Python Virtual Environment Support: Installing User Defined Packages#4902
kunwp1 merged 36 commits into
apache:mainfrom
SarahAsad23:pve-add-user-packages

Conversation

@SarahAsad23
Copy link
Copy Markdown
Contributor

@SarahAsad23 SarahAsad23 commented May 4, 2026

What changes were proposed in this PR?

This PR is an extension of PR #4484. Previously, we introduced support for creating Python Virtual Environments (PVEs) with system-level dependencies preinstalled. This PR builds on that foundation by enabling users to install custom Python packages within a PVE. In some cases, installing a user package may overwrite system-level packages. For this reason, System package versions are locked to prevent these conflicts.

Some duplicate lines of code (previously introduced in PR #4484) were removed from PveManager to improve clarity and reduce redundancy.

Any related issues, documentation, discussions?

This change is part of ongoing efforts to support environment isolation and reproducibility within Texera. Related issue includes #4296. This PR closes sub-issue #4465.

A GitHub CI sync check between requirements.txt and system-requirements-lock.txt will be added in a follow-up PR. Tracking issue: #5034.

How was this PR tested?

Tested Manually and PveResourceSpec test file updated.
To test:

  1. On CU click "+" Python Environments.
  2. Input environment name.
  3. Input package name and version.
  4. Click "OK" and wait for pip logs.

To test system dependency conflit management, install the following packages:

  • Scanpy 1.11.1 -> Successful
  • Tensorflow 2.16.1 -> Unsuccessful because of system level dependency conflict

Was this PR authored or co-authored using generative AI tooling?

Co-authored using: ChatGPT (OpenAI)

@github-actions github-actions Bot added engine frontend Changes related to the frontend GUI labels May 4, 2026
@chenlica chenlica requested a review from kunwp1 May 4, 2026 14:48
Copy link
Copy Markdown
Contributor

@kunwp1 kunwp1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The feature is working well! I left a few comments to improve the codebase and user experience.

@SarahAsad23 SarahAsad23 requested a review from kunwp1 May 4, 2026 21:32
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented May 4, 2026

Codecov Report

❌ Patch coverage is 26.25000% with 118 lines in your changes missing coverage. Please review.
✅ Project coverage is 42.72%. Comparing base (2b763e4) to head (e5546cd).

Files with missing lines Patch % Lines
...power-button/computing-unit-selection.component.ts 0.00% 62 Missing ⚠️
...wer-button/computing-unit-selection.component.html 0.00% 35 Missing ⚠️
...resource/pythonvirtualenvironment/PveManager.scala 76.36% 9 Missing and 4 partials ⚠️
...esource/pythonvirtualenvironment/PveResource.scala 0.00% 5 Missing ⚠️
...virtual-environment/virtual-environment.service.ts 0.00% 2 Missing ⚠️
...ythonvirtualenvironment/PveWebsocketResource.scala 0.00% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff              @@
##               main    #4902      +/-   ##
============================================
- Coverage     42.78%   42.72%   -0.07%     
+ Complexity     2189     2186       -3     
============================================
  Files          1045     1045              
  Lines         39876    39979     +103     
  Branches       4205     4218      +13     
============================================
+ Hits          17062    17080      +18     
- Misses        21757    21838      +81     
- Partials       1057     1061       +4     
Flag Coverage Δ *Carryforward flag
access-control-service 39.53% <ø> (ø) Carriedforward from 2b763e4
agent-service 33.72% <ø> (ø) Carriedforward from 2b763e4
amber 43.34% <68.85%> (+0.04%) ⬆️
computing-unit-managing-service 0.00% <ø> (ø) Carriedforward from 2b763e4
config-service 0.00% <ø> (ø) Carriedforward from 2b763e4
file-service 32.18% <ø> (ø) Carriedforward from 2b763e4
frontend 34.04% <0.00%> (-0.17%) ⬇️
python 88.90% <ø> (ø) Carriedforward from 2b763e4
workflow-compiling-service 47.72% <ø> (ø) Carriedforward from 2b763e4

*This pull request uses carry forward flags. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Copy Markdown
Contributor

@kunwp1 kunwp1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a few more comments.

@SarahAsad23 SarahAsad23 requested a review from kunwp1 May 8, 2026 15:47
Copy link
Copy Markdown
Contributor

@kunwp1 kunwp1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left more comments. Can you add more test cases that Codecov Report complains?

Also, this PR lacks sync check between requirements.txt and system-requirements-lock.txt. It's better to add a sync check in the github CI but totally up to you. If you are not going to add a github CI check on this PR, please mention it in the PR description and create an issue.

Comment thread amber/system-requirements-lock.txt Outdated
Comment thread amber/system-requirements-lock.txt
@SarahAsad23
Copy link
Copy Markdown
Contributor Author

SarahAsad23 commented May 12, 2026

Thanks for the comments. I reviewed the Codecov report, and the current PveResourceSpec test file already covers the main PVE functionality and backend behavior. The remaining uncovered lines are mostly UI-related or exercised indirectly through the existing resource-level tests, so I did not add additional test cases at this stage.

I also created issue #5034 to track adding a CI sync check between requirements.txt and system-requirements-lock.txt, and updated the PR description to mention that it will be added in a follow-up PR.

@SarahAsad23 SarahAsad23 requested a review from kunwp1 May 12, 2026 12:21
Copy link
Copy Markdown
Contributor

@kunwp1 kunwp1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@kunwp1 kunwp1 enabled auto-merge (squash) May 12, 2026 12:45
@kunwp1 kunwp1 merged commit 134d7d2 into apache:main May 12, 2026
17 checks passed
@SarahAsad23 SarahAsad23 deleted the pve-add-user-packages branch May 12, 2026 16:11
@kunwp1 kunwp1 linked an issue May 12, 2026 that may be closed by this pull request
5 tasks
kunwp1 added a commit that referenced this pull request May 13, 2026
…ed Packages (#5035)

<!--
Thanks for sending a pull request (PR)! Here are some tips for you:
1. If this is your first time, please read our contributor guidelines:
[Contributing to
Texera](https://github.com/apache/texera/blob/main/CONTRIBUTING.md)
  2. Ensure you have added or run the appropriate tests for your PR
  3. If the PR is work in progress, mark it a draft on GitHub.
  4. Please write your PR title to summarize what this PR proposes, we 
    are following Conventional Commits style for PR titles as well.
  5. Be sure to keep the PR description updated to reflect all changes.
-->

### What changes were proposed in this PR?
<!--
Please clarify what changes you are proposing. The purpose of this
section
is to outline the changes. Here are some tips for you:
  1. If you propose a new API, clarify the use case for a new API.
  2. If you fix a bug, you can clarify why it is a bug.
  3. If it is a refactoring, clarify what has been changed.
  3. It would be helpful to include a before-and-after comparison using 
     screenshots or GIFs.
  4. Please consider writing useful notes for better and faster reviews.
-->

This PR is an extension of PR #4484
and #4902. Previously, we introduced support for creating Python Virtual
Environments (PVEs) with system-level dependencies preinstalled, along
with support for installing user-defined packages. This PR extends that
functionality by allowing users to uninstall user-installed packages
from their PVEs.

### Any related issues, documentation, discussions?
<!--
Please use this section to link other resources if not mentioned
already.
1. If this PR fixes an issue, please include `Fixes #1234`, `Resolves
#1234`
or `Closes #1234`. If it is only related, simply mention the issue
number.
  2. If there is design documentation, please add the link.
  3. If there is a discussion in the mailing list, please add the link.
-->

This change is part of ongoing efforts to support environment isolation
and reproducibility within Texera. Related issue includes
#4296. This PR closes sub-issue
#4466.

### How was this PR tested?
<!--
If tests were added, say they were added here. Or simply mention that if
the PR
is tested with existing test cases. Make sure to include/update test
cases that
check the changes thoroughly including negative and positive cases if
possible.
If it was tested in a way different from regular unit tests, please
clarify how
you tested step by step, ideally copy and paste-able, so that other
reviewers can
test and check, and descendants can verify in the future. If tests were
not added,
please describe why they were not added and/or why it was difficult to
add.
-->

Tested Manually and PveResourceSpec test file updated.

To test:

On CU click "+" Python Environments.
Input environment name.
Input package name and version.
Click "OK" and wait for pip logs.
To delete click on "Delete Icon" and click "OK" 

### Was this PR authored or co-authored using generative AI tooling?
<!--
If generative AI tooling has been used in the process of authoring this
PR,
please include the phrase: 'Generated-by: ' followed by the name of the
tool
and its version. If no, write 'No'. 
Please refer to the [ASF Generative Tooling
Guidance](https://www.apache.org/legal/generative-tooling.html) for
details.
-->

Co-authored using: ChatGPT (OpenAI)

---------

Co-authored-by: Kunwoo (Chris) <143021053+kunwp1@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

engine frontend Changes related to the frontend GUI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Install Python Packages in Virtual Environment

3 participants