Add porting guide for users coming from orjson#1007
Merged
Conversation
Cover API mapping, option equivalents, typed decoding, error handling, and features without direct equivalent. Closes #642
Collaborator
|
It looks like Pydantic restructured their site to have documentation in the following format, one for each of their libraries: |
Collaborator
Author
added 3 commits
April 12, 2026 21:51
- Move docs/porting-from-orjson.rst to docs/porting/orjson.rst - Add docs/porting/index.rst as a landing page for future guides - Add "Porting" toctree section in docs/index.rst - Fix cross-references for the new file location - Fix incorrect workarounds in "Features with no direct equivalent": OPT_OMIT_MICROSECONDS, OPT_PASSTHROUGH_DATACLASS, OPT_PASSTHROUGH_SUBCLASS - Clarify pretty-printing two-step process
Both orjson and msgspec encode naive datetimes identically by default (without timezone). OPT_NAIVE_UTC is an opt-in flag, not the default.
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
2 participants
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.
Reopening #995 (auto-closed when fork was deleted).
Summary
docs/porting-from-orjson.rstcovering API mapping, option equivalents, typed decoding, error handling, and features without direct equivalentdocs/index.rstCloses #642
Note: @ofek suggested restructuring this into a dedicated "Porting" docs section to accommodate future guides (e.g. Pydantic). Happy to rework if that's the preferred approach.