Skip to main content

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.

Metadata

Release files for apyds-bnf 0.0.21

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for apyds-bnf 0.0.21
File Size Uploaded Provenance Actions
apyds_bnf-0.0.21.tar.gz 88.0 kB With provenance Details for apyds_bnf-0.0.21.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for apyds-bnf 0.0.21
File Interpreter ABI Platform Actions
apyds_bnf-0.0.21-py3-none-any.whl Python 3 none any Details for apyds_bnf-0.0.21-py3-none-any.whl

Total release size: 105.2 kB

Release files / apyds_bnf-0.0.21.tar.gz

Download URL apyds_bnf-0.0.21.tar.gz
Size 88.0 kB
Tags Source
SHA-256 checksum
How to use checksums
e880d79b97ef454852d3947f97ca02e691cf8385c12738436129607fdd19afff
BLAKE2b-256 checksum
How to use checksums
a8db19f62520000d92905bb1e5e57ce95415ab2ea23bba8e1beaecdb79de2b87
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Apr 7, 2026.

Transparency log

Release files / apyds_bnf-0.0.21-py3-none-any.whl

Download URL apyds_bnf-0.0.21-py3-none-any.whl
Size 17.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0a111ce3150d7f9b4874b0a96acc60dfc0ac7fc17febfdd6394235510bbd9453
BLAKE2b-256 checksum
How to use checksums
e8668c6c08071dcc4cd2b24826bc91e6d2c82cbba084aeaddcac8188f8906ae6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Apr 7, 2026.

Transparency log

Security for apyds-bnf 0.0.21

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for apyds_bnf-0.0.21.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Apr 7, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.21 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page