Python Specific Functionality#

Alongside the support for builtin egglog functionality, egglog also provides functionality to more easily integrate with the Python ecosystem.

Retrieving Primitive Values#

If you have a egglog primitive, you can turn it into a Python object by using egraph.eval(...) method:

from __future__ import annotations

from egglog import *

egraph = EGraph()
assert egraph.eval(i64(1) + 20) == 21

Python Object Sort#

We define a custom “primitive sort” (i.e. a builtin type) for PyObjects. This allows us to store any Python object in the e-graph.

Saving Python Objects#

To create an expression of type PyObject, we call the call the constructor with any Python object. It will save a reference to the object:

PyObject(1)

1

We see that this as saved internally as a pointer to the Python object. For hashable objects like int we store two integers, a hash of the type and a has of the value.

We can also store unhashable objects in the e-graph like lists.

lst = PyObject([1, 2, 3])
lst

[1, 2, 3]

We see that this is stored with one number, simply the id of the object.

Mutable Objects

While it is possible to store unhashable objects in the e-graph, you have to be careful defining any rules which create new unhashable objects. If each time a rule is run, it creates a new object, then the e-graph will never saturate.

Creating hashable objects is safer, since while the rule might create new Python objects each time it executes, they should have the same hash, i.e. be equal, so that the e-graph can saturate.

Retrieving Python Objects#

Like other primitives, we can retrieve the Python object from the e-graph by using the egraph.eval(...) method:

assert egraph.eval(lst) == [1, 2, 3]

Builtin methods#

Currently, we only support a few methods on PyObjects, but we plan to add more in the future.

Conversion to/from a string:

egraph.eval(PyObject('hi').to_string())

'hi'

egraph.eval(PyObject.from_string("1"))

'1'

Conversion from an int:

egraph.eval(PyObject.from_int(1))

1

We also support evaling arbitrary Python bode, given some locals and globals. This technically allows us to implement any Python method:

egraph.eval(py_eval("1 + 2"))

3

Execing Python code is also supported. In this case, the return value will be the updated globals dict, which will be copied first before using.

egraph.eval(py_exec("x = 1 + 2"))

{'x': 3}

Alongside this, we support a function dict_update method, which can allow you to combine some local local egglog expressions alongside, say, the locals and globals of the Python code you are evaling.

# Need this from our globals()
def my_add(a, b):
    return a + b

amended_globals = PyObject(globals()).dict_update("one", 1)
evalled = py_eval("my_add(one,  2)", locals(), amended_globals)
assert egraph.eval(evalled) == 3

Simpler Eval#

Instead of using the above low level primitive for evaling, there is a higher level wrapper function, egraph.eval_fn.

It takes in a Python function and converts it to a function of PyObjects, by using py_eval under the hood.

The above code code be re-written like this:

def my_add(a, b):
    return a + b

evalled = egraph.eval_fn(lambda a: my_add(a, 2))(1)
assert egraph.eval(evalled) == 3

Functions#

Type Promotion#

Similar to how an int can be automatically upcasted to an i64, we also support registering conversion to your custom types. For example:

@egraph.class_
class Math(Expr):
    def __init__(self, x: i64Like) -> None: ...

    @classmethod
    def var(cls, name: StringLike) -> Math: ...

    def __add__(self, other: Math) -> Math: ...

converter(i64, Math, Math)
converter(String, Math, Math.var)

Math(2) + i64(30) + String("x")
# equal to
Math(2) + Math(i64(30)) + Math.var(String("x"))

(Math(2) + Math(30)) + Math.var("x")

You can also specify a “cost” for a conversion, which will be used to determine which conversion to use when multiple are possible. For example convert(i64, Math, 10).

Regstering a conversion from A to B will also register all transitively reachable conversions from A to B, so you can also use:

Math(2) + 30 + "x"

(Math(2) + Math(30)) + Math.var("x")

If you want to have this work with the static type checker, you can define your own Union type, which MUST include have the `Expr`` class as the first item in the union. For example, in this case you could then define:

from typing import Union
MathLike = Union[Math, i64Like, StringLike]

@egraph.function
def some_math_fn(x: MathLike) -> MathLike:
    ...

some_math_fn(10)

some_math_fn(Math(10))

Keyword arguments#

All arguments for egg functions must be declared positional or keyword (the default argument type) currently. You can pass arguments variably or also as keyword arguments:

# egg: (function bar (i64 i64) i64)
@egraph.function
def bar(a: i64Like, b: i64Like) -> i64:
    pass

# egg: (bar 1 2)
bar(1, 2)
bar(b=2, a=1)

bar(1, 2)

Default arguments#

Default argument values are also supported. They are not translated to egglog definition, which has no notion of optional values. Instead, they are added to the args when the functions is called.

# egg: (function bar (i64 i64) i64)
@egraph.function
def baz(a: i64Like, b: i64Like=i64(0)) -> i64:
    pass

# egg: (baz 1 0)
baz(1)

baz(1)

Methods#

When defining a custom class, you are free to use any method names you like.

Builtin Methods#

Most of the Python special dunder methods are supported as well:

  • __lt__

  • __le__

  • __eq__

  • __ne__

  • __gt__

  • __ge__

  • __add__

  • __sub__

  • __mul__

  • __matmul__

  • __truediv__

  • __floordiv__

  • __mod__

  • __pow__

  • __lshift__

  • __rshift__

  • __and__

  • __xor__

  • __or__

  • __pos__

  • __neg__

  • __invert__

  • __getitem__

  • __call__

  • __setitem__

  • __delitem__

Currently __divmod__ is not supported, since it returns multiple results and __ne__ will shadow the builtin != egglog operator.

Also thse methods are currently used in the runtime class and cannot be overriden currently, although we could change this if the need arrises:

  • __getattr__

  • __repr__

  • __str__

  • _ipython_display_

  • __dir__

  • __getstate__

  • __setstate__

“Preserved” methods#

You can use the the @egraph.method(preserve=True) decorator to mark a method as “preserved”, meaning that calling it will actually execute the body of the function and a coresponding egglog function will not be created,

Normally, all methods defined on a egglog Expr will ignore their bodies and simply build an expression object based on the arguments.

However, there are times in Python when you need the return type of a method to be an instance of a particular Python type, and some similar acting expression won’t cut it.

For example, let’s say you are implementing a Bool expression, but you want to be able to use it in if statements in Python. That means it needs to define a __bool__ methods which returns a Python bool, based on evaluating the expression.

@egraph.class_
class Boolean(Expr):
    @egraph.method(preserve=True)
    def __bool__(self) -> bool:
        # Add this expression converted to a Python object to the e-graph
        egraph.register(self)
        # Run until the e-graph saturates
        egraph.run(10)
        # Extract the Python object from the e-graph
        return egraph.eval(self.to_py())

    def to_py(self) -> PyObject:
        ...

    def __or__(self, other: Boolean) -> Boolean:
        ...

TRUE = egraph.constant("TRUE", Boolean)
FALSE = egraph.constant("FALSE", Boolean)


@egraph.register
def _bool(x: Boolean):
    return [
        set_(TRUE.to_py()).to(PyObject(True)),
        set_(FALSE.to_py()).to(PyObject(False)),
        rewrite(TRUE | x).to(TRUE),
        rewrite(FALSE | x).to(x),
    ]

Now whenever the __bool__ method is called, it will actually execute the body of the function, and return a Python bool based on the result.

if TRUE | FALSE:
    print("True!")

True!

Note that the following list of methods are only supported as “preserved” since thy have to return a specific Python object type:

  • __bool__

  • __len__

  • __complex_

  • __int_

  • __float_

  • __hash_

  • __iter_

  • __index__

Reflected methods#

Note that reflected methods (i.e. __radd__) are handled as a special case. If defined, they won’t create their own egglog functions.

Instead, whenever a reflected method is called, we will try to find the corresponding non-reflected method and call that instead.

Also, if a normal method fails because the arguments cannot be converted to the right types, the reflected version of the second arg will be tried.

egraph = EGraph()

@egraph.class_
class Int(Expr):
    def __init__(self, i: i64Like) -> None:
        ...

    @classmethod
    def var(cls, name: StringLike) -> Int:
        ...

    def __add__(self, other: Int) -> Int:
        ...


@egraph.class_
class Float(Expr):
    def __init__(self, i: f64Like) -> None:
        ...

    @classmethod
    def var(cls, name: StringLike) -> Float:
        ...

    @classmethod
    def from_int(cls, i: Int) -> Float:
        ...

    def __add__(self, other: Float) -> Float:
        ...


converter(f64, Float, Float)
converter(Int, Float, Float.from_int)


assert str(-1.0 + Int.var("x")) == "Float(-1.0) + Float.from_int(Int.var(\"x\"))"

For methods which allow returning NotImplemented, i.e. the comparision + binary math methods, we will also try upcasting both types to the type which is lowest cost to convert both to.

For example, if you have Float and Int wrapper types and you have write the expr -1.0 + Int.var("x") you might want the result to be Float(-1.0) + Float.from_int(Int.var("x")):

Mutating arguments#

In order to support Python functions and methods which mutate their arguments, you can pass in the mutate_first_arg keyword argument to the @egraph.function decorator and the mutates_self argument to the @egraph.method decorator. This will cause the first argument to be mutated in place, instead of being copied.

from copy import copy
mutate_egraph = EGraph()

@mutate_egraph.class_
class Int(Expr):
    def __init__(self, i: i64Like) -> None:
        ...

    def __add__(self, other: Int) -> Int:  # type: ignore[empty-body]
        ...

@mutate_egraph.function(mutates_first_arg=True)
def incr(x: Int) -> None:
    ...

i = var("i", Int)
incr_i = copy(i)
incr(incr_i)

x = Int(10)
incr(x)
mutate_egraph.register(rewrite(incr_i).to(i + Int(1)), x)
mutate_egraph.run(10)
mutate_egraph.check(eq(x).to(Int(10) + Int(1)))
mutate_egraph
%3 outer_cluster_1 cluster_1 outer_cluster_0 cluster_0 outer_cluster_2 cluster_2 outer_cluster_i64-5871781006564002453 cluster_i64-5871781006564002453 outer_cluster_i64-3377577844511369682 cluster_i64-3377577844511369682 Int___add__-11743562013128004906:s->Int___init__-3377577844511369682 Int___add__-11743562013128004906:s->Int___init__-5871781006564002453 Int___init__-3377577844511369682:s->i64-3377577844511369682 Int___init__-5871781006564002453:s->i64-5871781006564002453 incr-0:s->Int___init__-3377577844511369682 Int___add__-11743562013128004906 (· + ·) Int___init__-3377577844511369682 Int Int___init__-5871781006564002453 Int incr-0 incr i64-3377577844511369682 10 i64-5871781006564002453 1

Any function which mutates its first argument must return None. In egglog, this is translated into a function which returns the type of its first argument.

Note that dunder methods such as __setitem__ will automatically be marked as mutating their first argument.