[azpysdk] Auto-install APIView dependencies if missing#47515
Open
tjprescott wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the azpysdk apistub check to ensure APIView/apistub tool dependencies are installed automatically when missing, while making --install-deps only responsible for installing the target package’s dev requirements.
Changes:
- Added
ensure_apistub_dependencies()to detect whetherapistubis importable and installeng/apiview_reqs.txtonly when needed. - Updated
apistub.run()so APIView/apistub dependencies are ensured regardless of--install-deps, and--install-depsonly installs target package dev requirements. - Expanded/adjusted unit tests to cover the new dependency-ensuring behavior and avoid unintended installs during other test scenarios.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| eng/tools/azure-sdk-tools/azpysdk/apistub.py | Adds ensure_apistub_dependencies() and updates run() flow so APIView requirements are auto-installed when missing; refines --install-deps behavior. |
| eng/tools/azure-sdk-tools/tests/test_apistub.py | Updates tests to reflect the new dependency installation flow and adds coverage for the “already installed vs missing” cases. |
Comment on lines
84
to
86
| help=( | ||
| "Install dev requirements and apiview dependencies before running. " | ||
| "Skipped by default for faster local iteration." | ||
| "Install target package dev requirements before running. " | ||
| ), |
| self, _env, install_into_venv, _create, _get_whl, _get_mapping, tmp_path, monkeypatch | ||
| ): | ||
| """When --install-deps is passed, apistub should install dependencies.""" | ||
| """When --install-deps is passed, apistub should install target package dependencies.""" |
tjprescott
force-pushed
the
FixApistubInvocation
branch
from
25e149c to
b729927
Compare
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
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.
Ensures the
azpysdk apistubcommand auto-installed APIView dependencies if missing. Ensures--install-depsis only used optionally for installing package dev dependencies.