Skip to main content

BNF parser and unparsers for DS - conversion between lisp-like and traditional syntax

Project description

BNF Support Package for DS

A bidirectional conversion library for the DS deductive system, providing seamless translation between two syntax formats:

  • Ds: The S-expression (lisp-like) syntax used internally by DS
  • Dsp: A traditional, human-readable syntax with infix operators

This package enables you to write logical rules in a more natural, mathematical notation and convert them to the DS internal format, or vice versa.

Features

  • Bidirectional Conversion: Convert between Ds and Dsp syntax formats
  • Multi-Language Support: Available for both Python and JavaScript/TypeScript
  • Parse: Convert from readable Dsp syntax to DS internal format
  • Unparse: Convert from DS internal format to readable Dsp syntax
  • Comprehensive Operator Support: Functions, subscripts, unary and binary operators
  • ANTLR-Based: Built on ANTLR 4.13.2 for robust parsing

Installation

Python (pip)

pip install apyds-bnf

Requires Python 3.11-3.14.

JavaScript/TypeScript (npm)

npm install atsds-bnf

Quick Start

Python Example

from apyds_bnf import parse, unparse

# Parse: Convert from readable Dsp to DS format
dsp_input = "a, b => c"
ds_output = parse(dsp_input)
print(ds_output)
# Output:
# a
# b
# ----
# c

# Unparse: Convert from DS format to readable Dsp
ds_input = "a\nb\n----\nc\n"
dsp_output = unparse(ds_input)
print(dsp_output)
# Output: a, b => c

JavaScript Example

import { parse, unparse } from "atsds-bnf";

// Parse: Convert from readable Dsp to DS format
const dsp_input = "a, b => c";
const ds_output = parse(dsp_input);
console.log(ds_output);
// Output:
// a
// b
// ----
// c

// Unparse: Convert from DS format to readable Dsp
const ds_input = "a\nb\n----\nc\n";
const dsp_output = unparse(ds_input);
console.log(dsp_output);
// Output: a, b => c

Syntax Formats

Ds Format (Internal)

The Ds format uses S-expressions (lisp-like syntax) for representing logical rules:

premise1
premise2
----------
conclusion

For structured terms:

  • Functions: (function f a b)
  • Subscripts: (subscript a i j)
  • Binary operators: (binary + a b)
  • Unary operators: (unary ~ a)

Dsp Format (Human-Readable)

The Dsp format uses traditional mathematical notation:

premise1, premise2 => conclusion

For structured terms:

  • Functions: f(a, b)
  • Subscripts: a[i, j]
  • Binary operators: (a + b) (parenthesized)
  • Unary operators: (~ a) (parenthesized)

Syntax Comparison Table

Description Dsp Format (parse input / unparse output) Ds Format
Simple rule a, b => c a\nb\n----\nc\n
Axiom a ----\na\n
Function call f(a, b) => c (function f a b)\n----------------\nc\n
Subscript a[i, j] => b (subscript a i j)\n-----------------\nb\n
Binary operator (a + b) => c (binary + a b)\n--------------\nc\n
Unary operator ~ a => b (unary ~ a)\n-----------\nb\n
Complex expression ((a + b) * c), d[i] => f(g, h) (binary * (binary + a b) c)\n(subscript d i)\n---------------------------\n(function f g h)\n

Building from Source

Prerequisites

  • Python 3.11-3.14 (for Python package)
  • Node.js (for JavaScript package)
  • Java (for ANTLR parser generation)
  • ANTLR 4.13.2

Python Package

cd bnf

# Install dependencies
uv sync --extra dev

# Build package
uv build

# Run tests
uv run pytest

# Run with coverage
uv run pytest --cov

JavaScript Package

cd bnf

# Install dependencies
npm install

# Build package
npm run build

# Run tests
npm test

Grammar Files

The conversion is based on ANTLR grammars:

  • Ds.g4: Grammar for the Ds format (S-expression syntax)
  • Dsp.g4: Grammar for the Dsp format (human-readable syntax)

These grammars are used to generate parsers for both Python and JavaScript.

License

This project is licensed under the GNU Affero General Public License v3.0 or later (AGPL-3.0-or-later).

Repository

Author

Hao Zhang hzhangxyz@outlook.com

Related

This package is a support library for the DS (Deductive System) project. For the main DS library with C++ core and bindings, see the main repository.

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

apyds_bnf-0.0.14.tar.gz (87.8 kB view details)

Uploaded Source

Built Distribution

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

apyds_bnf-0.0.14-py3-none-any.whl (17.2 kB view details)

Uploaded Python 3

File details

Details for the file apyds_bnf-0.0.14.tar.gz.

File metadata

  • Download URL: apyds_bnf-0.0.14.tar.gz
  • Upload date:
  • Size: 87.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for apyds_bnf-0.0.14.tar.gz
Algorithm Hash digest
SHA256 4b98d63e433b0bb8ec4076d23a7d0738ff8da72283a9b82e34fb8132a4b4d5d2
MD5 fb13d5905cd619d648985725cc0336d2
BLAKE2b-256 84f084e7802b34436aa64980ab6341bcb341c953b9dcaa83dff9b702e00b3829

See more details on using hashes here.

Provenance

The following attestation bundles were made for apyds_bnf-0.0.14.tar.gz:

Publisher: bnf-pytest.yml on USTC-KnowledgeComputingLab/ds

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file apyds_bnf-0.0.14-py3-none-any.whl.

File metadata

  • Download URL: apyds_bnf-0.0.14-py3-none-any.whl
  • Upload date:
  • Size: 17.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for apyds_bnf-0.0.14-py3-none-any.whl
Algorithm Hash digest
SHA256 8b845dd4edda7c1c81683e21989c8748ef184362ffaf9387e83d645a21c3cebe
MD5 3d55a59bb2c66d38bb408b3e295cb32d
BLAKE2b-256 f30d3daa2e4c466a0033871cd8d24ec67b0b6227d1926920fdf326be5da4f820

See more details on using hashes here.

Provenance

The following attestation bundles were made for apyds_bnf-0.0.14-py3-none-any.whl:

Publisher: bnf-pytest.yml on USTC-KnowledgeComputingLab/ds

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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