Skip to main content

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

Project description

xwsyntax

Bidirectional grammars: parse text to an AST, emit text again, or hop formats by reusing the same tree (for example JSON in, SQL out). 100+ grammars (300+ files) covering query languages, data formats, and code. Used by xwquery and editor/Monaco flows.

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

Status Python License


📦 Install

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

Runtime deps are declared in pyproject.toml (lark, exonware-xwsystem, exonware-xwnode, exonware-xwlazy wiring). See docs/GUIDE_01_USAGE.md for modes and troubleshooting.


🚀 Quick start

from exonware.xwsyntax import BidirectionalGrammar

grammar = BidirectionalGrammar.load('json')
ast = grammar.parse('{"name": "Alice", "age": 30}')
json_str = grammar.generate(ast)

sql_grammar = BidirectionalGrammar.load('sql')
sql = sql_grammar.generate(ast)

Facade: XWSyntax().parse(text, format_name) or validate(text, format_name).
Discovery: list_grammars_quick(), load_grammar_quick(name).
More code paths: REF_14_DX, API: REF_15_API.


📄 Examples

Facade parse/validate

from exonware.xwsyntax import XWSyntax

engine = XWSyntax()
ast = engine.parse("a = 1 + 2", format_name="python")
is_valid = engine.validate("a = 1 + 2", format_name="python")

List and load grammars

from exonware.xwsyntax import list_grammars_quick, load_grammar_quick

names = list_grammars_quick()
grammar = load_grammar_quick(names[0])

JSON to SQL via shared AST

from exonware.xwsyntax import BidirectionalGrammar

ast = BidirectionalGrammar.load("json").parse('{"name": "Alice", "age": 30}')
sql = BidirectionalGrammar.load("sql").generate(ast)

✨ What you get

Area Contents
Read/write Grammar-driven parse and generate; avoid hand-maintained per-format maps.
Bidirectional Round-trip or cross-syntax by swapping grammars on the same AST.
Large grammar set SQL, Cypher, GraphQL, xwqueryscript, configs, programming languages, markup, storage dialects; 300+ .lark / .json assets.
Downstream xwquery parsing; Monaco export and codec hooks via xwsystem.

Phase: Alpha. Milestones: REF_22_PROJECT.


📖 Docs and tests


📜 License and links

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

⏱️ Async Support

  • xwsyntax is primarily synchronous in its current implementation.
  • Source validation: 0 async def definitions and 0 await usages under src/.
  • This module still composes with async-capable xw libraries at integration boundaries when needed.

Version: 0.6.0.26 | Updated: 11-Apr-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

xwsyntax-0.6.0.26.tar.gz (217.1 kB view details)

Uploaded Source

Built Distribution

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

xwsyntax-0.6.0.26-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

Details for the file xwsyntax-0.6.0.26.tar.gz.

File metadata

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

File hashes

Hashes for xwsyntax-0.6.0.26.tar.gz
Algorithm Hash digest
SHA256 1c0dc640b38c028f17a8ed2e1f3d1adeb3088914098c57fa69fc84e4c6ef209f
MD5 6771192e8a9a1f39e7ae16676a4bc849
BLAKE2b-256 5d67969d0bccc79096150e678213dcb318b3f9a24fed002f45ce9172a2616189

See more details on using hashes here.

File details

Details for the file xwsyntax-0.6.0.26-py3-none-any.whl.

File metadata

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

File hashes

Hashes for xwsyntax-0.6.0.26-py3-none-any.whl
Algorithm Hash digest
SHA256 8a6db455ac5045a8b3236760768fed40f5529f0a5ebab6dc6e5909d8fa916cdf
MD5 7d3a2940e34cc56036343c61508a0abb
BLAKE2b-256 b3b83765f2d56c53264a583bce66fece69a03fb7d18de46cbdd697789e84ff08

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