logic-asts 1.1.0__tar.gz

logic_asts-1.1.0/.envrc.recommended

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+info() {
+  DIRENV_LOG_FORMAT="envrc: %s" log_status "$@"
+}
+
+make dev
+watch_file uv.lock
+source ./.venv/bin/activate

logic_asts-1.1.0/.github/workflows/pypi.yml

@@ -0,0 +1,74 @@
+name: "Test, build, and deploy Python package"
+
+on:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+    tags:
+      - v*
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Test package
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      # checkout@v4.2.2
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
+      # setup-uv@v6.0.1
+      - uses: astral-sh/setup-uv@6b9c6063abd6010835644d4c2e1bef4cf5cd0fca
+        with:
+          version: "latest"
+          python-version: ${{ matrix.python-version }}
+      - name: lint
+        run: uv run --frozen --dev ruff check .
+      - name: format
+        run: uv run --frozen --dev ruff format --check .
+      - name: Test with Python ${{ matrix.python-version }}
+        run: uv run --frozen --dev pytest
+      - name: Run type checker with Python
+        run: uv run --frozen --dev mypy src tests
+
+  release-build:
+    name: Build and release package
+    runs-on: ubuntu-latest
+    needs:
+      - test
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    # Dedicated environments with protections for publishing are strongly recommended.
+    environment:
+      name: pypi
+      # OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
+      url: https://pypi.org/p/logic-asts
+
+    if: "startsWith(github.ref, 'refs/tags/')"
+
+    steps:
+      # checkout@v4.2.2
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
+      # setup-uv@v6.0.1
+      - uses: astral-sh/setup-uv@6b9c6063abd6010835644d4c2e1bef4cf5cd0fca
+        with:
+          version: "latest"
+      - name: Install dependencies
+        run: uv sync
+      - name: Build wheels and sdist
+        run: uv build
+      - name: Upload wheels and sdist
+        # upload-artifact@v4.6.2
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02
+        with:
+          name: release-dists
+          path: dist/
+      - name: Publish release distributions to PyPI
+        run: uv publish

logic_asts-1.1.0/.gitignore

@@ -0,0 +1,176 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python
+# Edit at https://www.toptal.com/developers/gitignore?templates=python
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+# End of https://www.toptal.com/developers/gitignore/api/python

logic_asts-1.1.0/.python-version

@@ -0,0 +1 @@
+3.12

logic_asts-1.1.0/Makefile

@@ -0,0 +1,33 @@
+SHELL := bash
+.ONESHELL:
+.SHELLFLAGS := -eu -o pipefail -c
+.DELETE_ON_ERROR:
+MAKEFLAGS += --warn-undefined-variables
+MAKEFLAGS += --no-builtin-rules
+
+# Default: create the dev environment
+dev: uv.lock | .venv
+.PHONY: dev
+
+fmt:
+	uv run --frozen ruff format 
+	uv run --frozen ruff check --fix .
+.PHONY: fmt
+
+typing:
+	uv run --frozen mypy src
+.PHONY: typing
+
+lint: fmt typing
+.PHONY: lint
+
+test:
+	uv run --dev --frozen pytest
+.PHONY: test
+
+uv.lock .venv &: pyproject.toml
+	uv sync --frozen --dev
+
+# Automatic make target for scripts with locking
+%.py.lock: %.py
+	uv lock --script $<

logic_asts-1.1.0/PKG-INFO

@@ -0,0 +1,34 @@
+Metadata-Version: 2.4
+Name: logic-asts
+Version: 1.1.0
+Summary: Grammars and parsers for various logic
+Author-email: Anand Balakrishnan <anandbala1597@gmail.com>
+Requires-Python: >=3.10
+Requires-Dist: attrs>=25.3.0
+Requires-Dist: lark>=1.2.2
+Requires-Dist: typing-extensions>=4.13.0
+Description-Content-Type: text/markdown
+
+# Abstract syntax trees for logical expressions
+
+A collection of grammars, parsers, and abstract syntax trees in Python for various
+logics. The goal of this package is to serve as a common utility for
+academics/developers to build their tools on, without having to create a new parser each
+time they make a library.
+
+Currently supported logics are:
+
+- `base`: the basic Boolean propositional logic.
+- `ltl`: Linear temporal logic
+- `strel`: Spatio-temporal reach escape logic
+
+## Usage
+
+Simply install the library, either as a git dependency or (once it is available) through
+PyPI. Then, the library can be used as:
+
+```python
+import logic_asts
+
+expr = logic_asts.parse_expr(expr_string, syntax="base"|"ltl"|"strel") # remember to pick the syntax
+```

logic_asts-1.1.0/README.md

@@ -0,0 +1,23 @@
+# Abstract syntax trees for logical expressions
+
+A collection of grammars, parsers, and abstract syntax trees in Python for various
+logics. The goal of this package is to serve as a common utility for
+academics/developers to build their tools on, without having to create a new parser each
+time they make a library.
+
+Currently supported logics are:
+
+- `base`: the basic Boolean propositional logic.
+- `ltl`: Linear temporal logic
+- `strel`: Spatio-temporal reach escape logic
+
+## Usage
+
+Simply install the library, either as a git dependency or (once it is available) through
+PyPI. Then, the library can be used as:
+
+```python
+import logic_asts
+
+expr = logic_asts.parse_expr(expr_string, syntax="base"|"ltl"|"strel") # remember to pick the syntax
+```

logic_asts-1.1.0/pyproject.toml

@@ -0,0 +1,47 @@
+[project]
+name = "logic-asts"
+version = "1.1.0"
+description = "Grammars and parsers for various logic"
+readme = "README.md"
+authors = [{ name = "Anand Balakrishnan", email = "anandbala1597@gmail.com" }]
+requires-python = ">=3.10"
+dependencies = ["attrs>=25.3.0", "lark>=1.2.2", "typing-extensions>=4.13.0"]
+
+[dependency-groups]
+dev = ["ipython", "mypy", "pytest", "rich", "ruff", "zuban"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.pytest.ini_options]
+addopts = "--import-mode=importlib"
+testpaths = ["tests"]
+
+[tool.mypy]
+strict = true
+packages = ["logic_asts"]
+files = ["tests/*.py", "tests/**/*.py"]
+exclude = ["^build/"]                   # add mypyc build directory
+show_error_codes = true
+namespace_packages = false
+
+[tool.ruff]
+line-length = 127
+
+[tool.ruff.lint]
+extend-select = ["E", "F", "W", "N", "B", "ANN", "PYI", "I"]
+extend-ignore = ["F722", "PYI041"]
+
+[tool.ruff.lint.extend-per-file-ignores]
+"*.py" = ["B905", "E203", "E501", "W291", "W293"]
+"*.pyi" = ["B", "E501", "E701"]
+
+[tool.pyright]
+pythonVersion = "3.10"
+pythonPlatform = "All"
+reportUnknownMemberType = false
+reportUnknownParameterType = false
+reportUnknownVariableType = false
+reportUnknownArgumentType = false
+reportAny = false

logic_asts-1.1.0/src/logic_asts/__init__.py

@@ -0,0 +1,28 @@
+# mypy: allow_untyped_calls
+import typing
+
+from lark import Lark, Transformer
+
+from logic_asts.base import Expr
+from logic_asts.grammars import SupportedGrammars
+
+SupportedGrammarsStr: typing.TypeAlias = typing.Literal["base", "ltl", "strel", "stl_go"]
+
+
+def parse_expr(
+    expr: str,
+    *,
+    syntax: SupportedGrammars | SupportedGrammarsStr = SupportedGrammars.BASE,
+) -> Expr:
+    syntax = SupportedGrammars(syntax)
+
+    grammar = Lark.open_from_package(
+        __name__,
+        f"{str(syntax.value)}.lark",
+        ["grammars"],
+    )
+    transformer = syntax.get_transformer()
+    assert isinstance(transformer, Transformer), f"{transformer=}"
+
+    parse_tree = grammar.parse(expr)
+    return transformer.transform(tree=parse_tree)