Skip to main content

Convenience wrapper for exonware-xwjson - provides 'import xwjson' alias

Project description

xwjson

Binary JSON plus local data-engine behavior for real workloads. .xwjson is powered by the xwsystem parser engine for high-throughput reads/writes, lazy and path-scoped access, schema-aware validation, encrypted payload support, and atomic-first ACID-style transaction flows with WAL. In this repo, performance/stress suites include large-file scenarios validated up to 20GB, stdlib JSON comparisons, and conversion stress runs.

Longer tour, examples, and troubleshooting: README_LONG.md.

Company: eXonware.com · Author: eXonware Backend Team · Email: connect@exonware.com

Status Python License


Install

pip install exonware-xwjson
pip install exonware-xwjson[lazy]
pip install exonware-xwjson[full]

Quick start

from exonware.xwjson import XWJSONSerializer

serializer = XWJSONSerializer()
# Async (recommended)
data = await serializer.load_file_async("data.xwjson")
await serializer.save_file_async(data, "output.xwjson")
# Sync
data = serializer.load_file("data.xwjson")
serializer.save_file(data, "output.xwjson")

See docs/ for REF_*, guides, and examples.


What you get

Area What's in it
Binary engine xwsystem parser-driven binary encoding with fast serialization paths and metadata-aware payloads.
Lazy + path I/O Parse on access, stream/paging support, and path-level operations without full materialization.
References $ref, @href, *anchor preserved and resolved.
Security Password-based encrypted file support and encrypted payload detection helpers.
Atomic operations Atomic read/write/update/delete paths for safe state transitions under concurrent workloads.
Transactions ACID-style flows with WAL-backed transaction components, rollback support, and dependency-aware batch work.
Index/cache acceleration xwnode strategy integrations for faster lookups and cache-assisted repeated access.
Integration xwnode, xwschema, xwquery, xwdata, xwstorage; format metadata carried through.

Atomic operations - core strength

  • xwjson is designed around atomic state changes, not best-effort updates.
  • Single-file and path-level operations are built to commit safely or fail safely.
  • Transaction flows combine atomic steps with WAL-backed durability mechanics.
  • For local data-engine workloads, this is a headline capability: atomic operations are first-class, not optional.

Performance and benchmark posture

  • Built-in performance guidance and benchmark methodology: docs/_archive/GUIDE_PERFORMANCE.md.
  • Repo test artifacts include conversion/performance stress suites and large-file scenarios in tests/2.integration/scenarios/.
  • File size note: no hard file-size cap is enforced by xwjson; largest documented test scenario in this repo is 20GB.
  • Test summaries in tests/FINAL_TEST_SUMMARY.md and tests/TEST_SUMMARY.md document speed-oriented targets (including stdlib JSON comparison paths and cache/index speedups).
  • Positioning: xwjson can act like a database-like local data layer for many workloads; external database claims should stay workload-specific and benchmark-backed.

Docs and tests

  • Start: docs/INDEX.md or docs/.
  • Guides: Basic/advanced usage, performance, conversion, schema validation under docs/ when present.
  • Tests: From repo root, follow this package's runner or pytest layout.

License and links

MIT - see LICENSE. Homepage: https://exonware.com · Repository: https://github.com/exonware/xwjson

Async Support

  • xwjson includes asynchronous execution paths in production code.
  • Source validation: 46 async def definitions and 50 await usages under src/.
  • Use async APIs for I/O-heavy or concurrent workloads to improve throughput and responsiveness.

Version: 0.9.0.11 | Updated: 31-Mar-2026

Built with ❤️ by eXonware.com - Revolutionizing Python Development Since 2025

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xwjson-0.9.0.11.tar.gz (112.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

xwjson-0.9.0.11-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file xwjson-0.9.0.11.tar.gz.

File metadata

  • Download URL: xwjson-0.9.0.11.tar.gz
  • Upload date:
  • Size: 112.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for xwjson-0.9.0.11.tar.gz
Algorithm Hash digest
SHA256 a23e9c1ae1895efe8faee75e987026b88e9724942924cc16267992cf533002e2
MD5 913c4e10c9f657f2f1694a696fe12f32
BLAKE2b-256 9d811a3a9bb6e3689b04796f8aa626af09dc88568352c07cb856ccfc6274d439

See more details on using hashes here.

File details

Details for the file xwjson-0.9.0.11-py3-none-any.whl.

File metadata

  • Download URL: xwjson-0.9.0.11-py3-none-any.whl
  • Upload date:
  • Size: 6.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for xwjson-0.9.0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 ae784d64bc63a8154f3b1deec5305a245e38c4cd04707319adaf032207728d07
MD5 6fd62263d1723384b3b530ae9f26c5ed
BLAKE2b-256 ffe4aefdcb9e3315186af5bb1af36f663de8760fe71268780f98c4f1e78f4969

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page