Fix host string handling in save_key and add tests #1140
Merged
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
Improves host string processing in save_key by correctly removing trailing '/api' and whitespace. Adds unit tests to verify correct host handling and extends HostFormatter test coverage.
There was a problem hiding this comment.
Pull Request Overview
This PR refines how save_key normalizes the host string by removing trailing whitespace and an /api suffix, and it adds unit tests to validate this behavior and extend coverage for HostFormatter.
- Update
save_keyto strip whitespace and remove an/apisuffix from the host argument. - Add a
test_hostto verify correct host handling in.netrcand extendHostFormattertests. - Ensure existing HostFormatter tests include a plain domain scenario.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| test/unit/test_package.py | New test_host case for save_key and added HostFormatter assertion |
| swanlab/package.py | save_key now uses rstrip() and conditional suffix removal |
Comments suppressed due to low confidence (2)
swanlab/package.py:199
- Add tests for hosts ending with "/api/" (with a trailing slash) and for cases where
/apiis followed by whitespace to ensuresave_keystrips these variations correctly.
if host.endswith("/api"):
swanlab/package.py:187
- [nitpick] Update the
save_keydocstring to note that trailing whitespace is trimmed and any/apisuffix will be removed from the provided host.
def save_key(username: str, password: str, host: str = None) -> bool:
Zeyi-Lin
approved these changes
Jul 3, 2025
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.
Improves host string processing in save_key by correctly removing trailing '/api' and whitespace. Adds unit tests to verify correct host handling and extends HostFormatter test coverage.
Thanks to https://github.com/kingdee for the feedback.