docs: Replace deprecated ujson with orjson in client quickstart#12040
Closed
veeceey wants to merge 1 commit intoaio-libs:masterfrom
Closed
docs: Replace deprecated ujson with orjson in client quickstart#12040veeceey wants to merge 1 commit intoaio-libs:masterfrom
veeceey wants to merge 1 commit intoaio-libs:masterfrom
Conversation
Fixes aio-libs#10795 The ujson library is now in maintenance-only mode and users are encouraged to migrate to orjson. Updated the client_quickstart.rst documentation to: - Replace ujson example with orjson - Update the note to reflect that orjson is significantly faster - Clarify that orjson.dumps() returns bytes, which works with aiohttp
CodSpeed Performance ReportMerging this PR will not alter performanceComparing Summary
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #12040 +/- ##
==========================================
- Coverage 98.76% 98.75% -0.01%
==========================================
Files 127 127
Lines 44667 44667
Branches 2372 2372
==========================================
- Hits 44114 44113 -1
Misses 393 393
- Partials 160 161 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Contributor
Author
|
Closing as duplicate of #12041 which has slightly cleaner wording. |
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
1 participant
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.
Summary
Replaces the deprecated
ujsonlibrary withorjsonin the client quickstart documentation.Problem
The
ujsonlibrary mentioned in the documentation is now deprecated and in maintenance-only mode. The ujson maintainers recommend migrating toorjson, which is both faster and more secure.Changes
ujsonimport and usage example withorjsonorjsonis significantly faster than standardjsonorjson.dumps()returnsbytesinstead ofstr, which works with aiohttp's JSON handlingRelated Issues
Closes #10795
Testing
This is a documentation-only change. No code changes were made.