Skip to content

docs: recommend the orjson extra next to logging on GIL builds - #354

Merged
lesnik512 merged 1 commit into
mainfrom
docs/recommend-orjson
Oct 28, 2026
Merged

lesnik512 merged 1 commit into
mainfrom
docs/recommend-orjson

Conversation

@lesnik512

Copy link
Copy Markdown
Member

Closes #339.

The issue asked to check first whether a dependency marker can skip orjson on free-threaded builds. As of 2026-10-28 none can:

  • The dependency specifiers spec defines no marker for free-threading, ABI features or sys.abiflags. The only marker added since PEP 508 is extras/dependency_groups for lock files.
  • PEP 780, which would add sys_abi_features with a gil-enabled value, is still a Draft. Its only implementation is a fork of packaging and a patched pip, and it expects tool support to take months or years after acceptance.

So the issue's fallback applies. logging and the *-all extras stay as they are, and docs/introduction/installation.md now recommends adding [orjson] on GIL builds, with the 2 µs per-call figure from the issue's measurement. The sentence carries the reason inline instead of linking ADR-0004, because docs/adr/ is excluded from the docs site.

PEP 780's acceptance plus pip and uv support would be the trigger to revisit ADR-0004's orjson half. This PR doesn't add that to the ADR.

Verified: just docs-build (strict) passes.

@lesnik512
lesnik512 merged commit fe3dccb into main Oct 28, 2026
35 checks passed
@lesnik512
lesnik512 deleted the docs/recommend-orjson branch October 28, 2026 15:18
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.

Install orjson with the logging and *-all extras where it has wheels

1 participant