Fix python FileAttachment example content_bytes b64 padding #9457
+1
−1
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
It seems that the python example content_bytes for FileAttachment is missing the expected b64 padding.
```py
In [2]: content_bytes = base64.urlsafe_b64decode("R0lGODdhEAYEAA7")
---------------------------------------------------------------------------
Error Traceback (most recent call last)
Cell In[2], line 1
----> 1 content_bytes = base64.urlsafe_b64decode("R0lGODdhEAYEAA7")
File ~/.pyenv/versions/3.12.7/lib/python3.12/base64.py:134, in urlsafe_b64decode(s)
132 s = _bytes_from_decode_data(s)
133 s = s.translate(_urlsafe_decode_translation)
--> 134 return b64decode(s)
File ~/.pyenv/versions/3.12.7/lib/python3.12/base64.py:88, in b64decode(s, altchars, validate)
86 assert len(altchars) == 2, repr(altchars)
87 s = s.translate(bytes.maketrans(altchars, b'+/'))
---> 88 return binascii.a2b_base64(s, strict_mode=validate)
Error: Incorrect padding
In [3]: content_bytes = base64.urlsafe_b64decode("R0lGODdhEAYEAA7=")
In [4]: content_bytes
Out[4]: b'GIF87a\x10\x06\x04\x00\x0e'
```
This can be easily fixed by adding the expected padding as shown.
This documentation is a little confusing as there are some SDKs where the b64 encoding has to be done
explicitly, fixing this into a working examples helps to communicate that `content_bytes` expects raw
data (not base64 encoded).
Hopefully there might be other additional steps that can be taken to communicate that as well.
(e.g. comments, explicit mentions in the text).
|
Learn Build status updates of commit 5c16a87: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
|
@andrueastman , FYI, I filed Issue #951 in the Python SDK repo to track this. |
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.
It seems that the python example content_bytes for FileAttachment is missing the expected b64 padding.
This can be easily fixed by adding the expected padding as shown.
This documentation is a little confusing as there are some SDKs where the b64 encoding has to be done explicitly, fixing this into a working examples helps to communicate that
content_bytesexpects raw data (not base64 encoded).Hopefully there might be other additional steps that can be taken to communicate that as well. (e.g. comments, explicit mentions in the text).