rnag / rnag/dataclass-wizard

Add optional `orjson` backend and `to_json_bytes` / `from_json_bytes` helpers

Open
#231 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement performance
Dominant language
Python
Stars
250
Forks
36
PR merge metrics
No merged PRs in 30d

Description

  • Goal: Faster JSON serialization + bytes I/O path.

  • Scope:

    • Optional extra: dataclass-wizard[orjson]
    • formats.json.dumps(..., backend="orjson") -> bytes (or separate dumps_bytes)
    • DataclassWizard.to_json_bytes() / DataclassWizard.from_json_bytes() (optional)
  • Acceptance criteria:

    • No required dependency changes for core users.
    • Clear behavior for bytes vs str.
    • Benchmarks or at least microbench + docs note.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the formats.json.dumps entry point and the DataclassWizard serialization methods. Check how the optional orjson extra would preserve core users' dependencies and define bytes versus str behavior for the proposed helpers. Confirm the work with a microbenchmark and a documentation note covering the new backend and I/O path.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.