Add proper URL encoding for upload and download #592
+33
−2
Conversation
This file contains 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
Signed-off-by: Daniel King <daniel@mosaicml.com>
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #592 +/- ##
==========================================
- Coverage 58.04% 58.04% -0.01%
==========================================
Files 44 44
Lines 30071 30077 +6
==========================================
+ Hits 17456 17458 +2
- Misses 12615 12619 +4 ☔ View full report in Codecov by Sentry. |
2 tasks
github-merge-queue bot
pushed a commit
that referenced
this pull request
Mar 28, 2024
## Changes Ports databricks/databricks-sdk-go#869 to Python SDK. Subsumes #592. Currently, path parameters are directly interpolated into the request URL without escaping. This means that characters like /, ? and # will not be percent-encoded and will affect the semantics of the URL, starting a new path segment, query parameters, or fragment, respectively. This means that it is impossible for users of the Files API to upload/download objects that contain ? or # in their name. / is allowed in the path of the Files API, so it does not need to be escaped. The Files API is currently marked with x-databricks-multi-segment, indicating that it should be permitted to have / characters but other characters need to be percent-encoded. This PR implements this. ## Tests - [x] Unit test for multi-segment path escaping behavior. - [x] Updated integration test to use # and ? symbols in the file name. This failed on main but succeeded on this PR.
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.
Changes
URL encode the file path before making the API request. This prevents issues with file paths that include characters like
?and#.I only added to
uploadanddownloadbecause those are the APIs I am using and could easily test, but happy to add to other places if the change seems ok and you'd like it in other places too.Closes #586
Tests
I manually tested upload/download with a file named
file with #? hi.txt.I also added integration tests, although I'm not entirely sure how to run them. Hoping they run in CI?
make testrun locally (some unrelated looking stuff failed locally, seems to be ok on CI)make fmtapplied