Skip to content

Update ujson to orjson in documentation#12039

Closed
veeceey wants to merge 1 commit intoaio-libs:masterfrom
veeceey:fix/issue-10795-update-ujson-to-orjson-in-docs
Closed

Update ujson to orjson in documentation#12039
veeceey wants to merge 1 commit intoaio-libs:masterfrom
veeceey:fix/issue-10795-update-ujson-to-orjson-in-docs

Conversation

@veeceey
Copy link
Contributor

@veeceey veeceey commented Feb 8, 2026

Summary

Motivation

The ujson library is now in maintenance-only mode, and its documentation explicitly recommends migrating to orjson, which is both faster and more secure.

From ujson's PyPI page:

UltraJSON's architecture is fundamentally ill-suited to making changes without risk of introducing new security vulnerabilities. As a result, this library has been put into a maintenance-only mode... Users are encouraged to migrate to orjson which is both much faster and less likely to introduce a surprise buffer overflow vulnerability in the future.

Changes

  • Updated code example in docs/client_quickstart.rst to use orjson.dumps instead of ujson.dumps
  • Updated documentation note to reference orjson instead of ujson

Testing

  • Documentation change only, no functional code changes
  • Verified the syntax and formatting are correct

Fixes #10795

Fixes aio-libs#10795

ujson is now in maintenance-only mode and users are encouraged to
migrate to orjson, which is faster and more secure. Updated the
client quickstart documentation to reflect this recommendation.
@codspeed-hq
Copy link

codspeed-hq bot commented Feb 8, 2026

Merging this PR will not alter performance

✅ 59 untouched benchmarks


Comparing veeceey:fix/issue-10795-update-ujson-to-orjson-in-docs (d73e208) with master (d92774f)

Open in CodSpeed

@codecov
Copy link

codecov bot commented Feb 8, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.76%. Comparing base (d92774f) to head (d73e208).
⚠️ Report is 4 commits behind head on master.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##           master   #12039   +/-   ##
=======================================
  Coverage   98.76%   98.76%           
=======================================
  Files         127      127           
  Lines       44667    44667           
  Branches     2372     2372           
=======================================
  Hits        44114    44114           
  Misses        393      393           
  Partials      160      160           
Flag Coverage Δ
CI-GHA 98.62% <ø> (ø)
OS-Linux 98.35% <ø> (ø)
OS-Windows 96.70% <ø> (ø)
OS-macOS 97.59% <ø> (ø)
Py-3.10.11 97.13% <ø> (-0.01%) ⬇️
Py-3.10.19 97.62% <ø> (ø)
Py-3.11.14 97.82% <ø> (-0.01%) ⬇️
Py-3.11.9 97.34% <ø> (ø)
Py-3.12.10 97.43% <ø> (-0.01%) ⬇️
Py-3.12.12 97.92% <ø> (ø)
Py-3.13.11 98.17% <ø> (-0.01%) ⬇️
Py-3.14.2 98.15% <ø> (-0.01%) ⬇️
Py-3.14.3t 97.24% <ø> (-0.01%) ⬇️
Py-pypy3.11.13-7.3.20 97.38% <ø> (-0.02%) ⬇️
VM-macos 97.59% <ø> (ø)
VM-ubuntu 98.35% <ø> (ø)
VM-windows 96.70% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@veeceey
Copy link
Contributor Author

veeceey commented Feb 14, 2026

Closing in favor of #12041 which has the same change with a cleaner commit history.

@veeceey veeceey closed this Feb 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ujson library mentioned in the documentation is deprecated

1 participant

Comments