Skip to main content

PDDL parser

Project description

pddl

PyPI PyPI - Python Version PyPI - Status PyPI - Implementation PyPI - Wheel GitHub

test lint docs codecov

black

pddl aims to be an unquestionable and complete parser for PDDL 3.1.

Install

  • from PyPI:
pip install pddl
  • from source (main branch):
pip install git+https://github.com/AI-Planning/pddl.git
  • or, clone the repository and install:
git clone https://github.com/AI-Planning/pddl.git
cd pddl
pip install .

Quickstart

You can use the pddl package in two ways: as a library, and as a CLI tool.

As a library

This is an example of how you can build a PDDL domain or problem programmatically:

from pddl.logic import Predicate, constants, variables
from pddl.core import Domain, Problem
from pddl.action import Action
from pddl.requirements import Requirements

# set up variables and constants
x, y, z = variables("x y z", types=["type_1"])
a, b, c = constants("a b c", type_="type_1")

# define predicates
p1 = Predicate("p1", x, y, z)
p2 = Predicate("p2", x, y)

# define actions
a1 = Action(
    "action-1",
    parameters=[x, y, z],
    precondition=p1(x, y, z) & ~p2(y, z),
    effect=p2(y, z)
)

# define the domain object.
requirements = [Requirements.STRIPS, Requirements.TYPING]
domain = Domain("my_domain",
                requirements=requirements,
                types={"type_1": None},
                constants=[a, b, c],
                predicates=[p1, p2],
                actions=[a1])

print(domain)

that gives:

(define (domain my_domain)
    (:requirements :strips :typing)
    (:types type_1)
    (:constants a b c - type_1)
    (:predicates (p1 ?x - type_1 ?y - type_1 ?z - type_1)  (p2 ?x - type_1 ?y - type_1))
    (:action action-1
        :parameters (?x - type_1 ?y - type_1 ?z - type_1)
        :precondition (and (p1 ?x ?y ?z) (not (p2 ?y ?z)))
        :effect (p2 ?y ?z)
    )
)

As well as a PDDL problem:

problem = Problem(
    "problem-1",
    domain=domain,
    requirements=requirements,
    objects=[a, b, c],
    init=[p1(a, b, c), ~p2(b, c)],
    goal=p2(b, c)
)
print(problem)

Output:

(define (problem problem-1)
    (:domain my_domain)
    (:requirements :strips :typing)
    (:objects a b c - type_1)
    (:init (not (p2 b c)) (p1 a b c))
    (:goal (p2 b c))
)

Example parsing:

from pddl import parse_domain, parse_problem
domain = parse_domain('d.pddl')
problem = parse_problem('p.pddl')

As CLI tool

The package can also be used as a CLI tool. Supported commands are:

  • pddl domain FILE: validate a PDDL domain file, and print it formatted.
  • pddl problem FILE: validate a PDDL problem file, and print it formatted.

Features

Supported PDDL 3.1 requirements:

  • :strips
  • :typing
  • :negative-preconditions
  • :disjunctive-preconditions
  • :equality
  • :existential-preconditions
  • :universal-preconditions
  • :quantified-preconditions
  • :conditional-effects
  • :fluents
  • :numeric-fluents
  • :non-deterministic (see 6th IPC: Uncertainty Part)
  • :adl
  • :durative-actions
  • :duration-inequalities
  • :derived-predicates
  • :timed-initial-literals
  • :preferences
  • :constraints
  • :action-costs

Development

If you want to contribute, here's how to set up your development environment.

  • Install Pipenv
  • Clone the repository: git clone https://github.com/AI-Planning/pddl.git && cd pddl
  • Install development dependencies: pipenv shell --python 3.8 && pipenv install --dev

Tests

To run tests: tox

To run only the code tests: tox -e py37

To run only the code style checks: tox -e flake8

Docs

To build the docs: mkdocs build

To view documentation in a browser: mkdocs serve and then go to http://localhost:8000

Authors

License

pddl is released under the MIT License.

Copyright (c) 2021-2023 WhiteMech

Acknowledgements

The pddl project is partially supported by the ERC Advanced Grant WhiteMech (No. 834228), the EU ICT-48 2020 project TAILOR (No. 952215), the PRIN project RIPER (No. 20203FFYLK), and the JPMorgan AI Faculty Research Award "Resilience-based Generalized Planning and Strategic Reasoning".

Change Log

0.1.0 (2021-06-21)

The first official release of pddl.

Main features:

  • Specify PDDL domains and problems programmatically.
  • Parsing for PDDL domains and problems.

0.0.1 (2020-07-30)

  • First commit on the package.

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

pddl-0.4.1.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

pddl-0.4.1-py2.py3-none-any.whl (51.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pddl-0.4.1.tar.gz.

File metadata

  • Download URL: pddl-0.4.1.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for pddl-0.4.1.tar.gz
Algorithm Hash digest
SHA256 cfdefd8b5274ede0685f5e3dab0b0933c98bf0cd24cc140fec0241c154675092
MD5 44cb9814d8659b4aac9cd4192fc36dbd
BLAKE2b-256 480a0a8932bc753e701149f08b0368866fa475e30f48b4a4e9d283ca5915faf4

See more details on using hashes here.

File details

Details for the file pddl-0.4.1-py2.py3-none-any.whl.

File metadata

  • Download URL: pddl-0.4.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 51.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for pddl-0.4.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 39528337b516211197bf4b7b4a0ad4abf54f2c97348894950c7467917a58ed0c
MD5 190108187531a0efe226ece30707308e
BLAKE2b-256 fa3a68f845c37b43a3d336a5fcefd52235fe05cc605abc8053aaae7b21a92e52

See more details on using hashes here.

Supported by

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