SG-38306 Python2 Removal - Part 8 - Remove deprecated ensure_ascii parameter from SG object #405
+14
−63
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
This was referenced Jul 16, 2025
8ac9c8d to
5d8b18d
Compare
2f109c4 to
f6275cd
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR removes the legacy ensure_ascii parameter from the Shotgun client and its mock, cleans up related JSON decoding code, and updates tests to reflect the new default JSON encoding behavior.
- Drop
ensure_asciiargument and methods inShotgunandMockgun - Remove old tests and helper for Python 2
ensure_asciibehavior; add a new test verifying non-ASCII payload encoding - Update client and API code to always use
json.dumps(..., ensure_ascii=False)
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| tests/test_client.py | Remove passing ensure_ascii to Shotgun in tests |
| tests/test_api.py | Remove old ensure_ascii tests and add new JSON dump test |
| shotgun_api3/shotgun.py | Remove ensure_ascii parameter, related methods, and logic |
| shotgun_api3/lib/mockgun/mockgun.py | Remove ensure_ascii parameter from mock client constructor |
Comments suppressed due to low confidence (2)
tests/test_client.py:649
- [nitpick] The
ensure_asciiparameter is no longer used inside this helper; consider removing it from the signature to avoid unused parameters.
def _assert_decode_resonse(self, ensure_ascii, data):
tests/test_api.py:831
- [nitpick] The docstring is inaccurate and has a grammar typo (
SG'payload). Please reword to clearly state that the JSON payload is dumped withensure_ascii=Falseto allow non-ASCII characters.
"""Make sure SG'payload is using ensure_ascii for json dumps"""
carlos-villavicencio-adsk
approved these changes
Jul 17, 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.
The ensure_ascii parameter was added in the Python 2 world when strings and bytes could be confusing when loading/dumping JSON.
Now, in the Python 3 world, this complexity does not exist anymore as there is clear different between the 2 types. Json dump will always return a string. And loader will convert any "json string" type to a default Python string (i.e. a unicode type in Py2).
PR orders
WIP