egglog 8.0.1__cp310-cp310-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl

egglog/__init__.py

@@ -0,0 +1,10 @@
+"""
+Package for creating e-graphs in Python.
+"""
+
+from . import config, ipython_magic  # noqa: F401
+from .builtins import *  # noqa: UP029
+from .conversion import convert, converter  # noqa: F401
+from .egraph import *
+
+del ipython_magic

egglog/bindings.pyi

@@ -0,0 +1,587 @@
+from datetime import timedelta
+from fractions import Fraction
+from pathlib import Path
+from typing import TypeAlias
+
+from typing_extensions import final
+
+@final
+class SerializedEGraph:
+    def inline_leaves(self) -> None: ...
+    def saturate_inline_leaves(self) -> None: ...
+    def to_dot(self) -> str: ...
+    def to_json(self) -> str: ...
+    def map_ops(self, map: dict[str, str]) -> None: ...
+    def split_classes(self, egraph: EGraph, ops: set[str]) -> None: ...
+
+@final
+class PyObjectSort:
+    def __init__(self) -> None: ...
+    def store(self, __o: object, /) -> _Expr: ...
+
+def parse_program(__input: str, /, filename: str | None = None) -> list[_Command]: ...
+@final
+class EGraph:
+    def __init__(
+        self,
+        __py_object_sort: PyObjectSort | None = None,
+        *,
+        fact_directory: str | Path | None = None,
+        seminaive: bool = True,
+        record: bool = False,
+    ) -> None: ...
+    def commands(self) -> str | None: ...
+    def run_program(self, *commands: _Command) -> list[str]: ...
+    def extract_report(self) -> _ExtractReport | None: ...
+    def run_report(self) -> RunReport | None: ...
+    def serialize(
+        self,
+        root_eclasses: list[_Expr],
+        *,
+        max_functions: int | None = None,
+        max_calls_per_function: int | None = None,
+        include_temporary_functions: bool = False,
+    ) -> SerializedEGraph: ...
+    def eval_py_object(self, __expr: _Expr) -> object: ...
+    def eval_i64(self, __expr: _Expr) -> int: ...
+    def eval_f64(self, __expr: _Expr) -> float: ...
+    def eval_string(self, __expr: _Expr) -> str: ...
+    def eval_bool(self, __expr: _Expr) -> bool: ...
+    def eval_rational(self, __expr: _Expr) -> Fraction: ...
+
+@final
+class EggSmolError(Exception):
+    context: str
+
+##
+# Spans
+##
+
+@final
+class SrcFile:
+    def __init__(self, name: str, contents: str | None = None) -> None: ...
+    name: str
+    contents: str | None
+
+@final
+class Span:
+    def __init__(self, file: SrcFile, start: int, end: int) -> None: ...
+    file: SrcFile
+    start: int
+    end: int
+
+DUMMY_SPAN: Span = ...
+
+##
+# Literals
+##
+
+@final
+class Int:
+    def __init__(self, value: int) -> None: ...
+    value: int
+
+@final
+class F64:
+    value: float
+    def __init__(self, value: float) -> None: ...
+
+@final
+class String:
+    def __init__(self, value: str) -> None: ...
+    value: str
+
+@final
+class Unit:
+    def __init__(self) -> None: ...
+
+@final
+class Bool:
+    def __init__(self, b: bool) -> None: ...
+    value: bool
+
+_Literal: TypeAlias = Int | F64 | String | Bool | Unit
+
+##
+# Expressions
+##
+
+@final
+class Lit:
+    def __init__(self, span: Span, value: _Literal) -> None: ...
+    span: Span
+    value: _Literal
+
+@final
+class Var:
+    def __init__(self, span: Span, name: str) -> None: ...
+    span: Span
+    name: str
+
+@final
+class Call:
+    def __init__(self, span: Span, name: str, args: list[_Expr]) -> None: ...
+    span: Span
+    name: str
+    args: list[_Expr]
+
+# Unions must be private becuase it is not actually exposed by the runtime library.
+_Expr: TypeAlias = Lit | Var | Call
+
+##
+# Terms
+##
+
+@final
+class TermLit:
+    def __init__(self, value: _Literal) -> None: ...
+    value: _Literal
+
+@final
+class TermVar:
+    def __init__(self, name: str) -> None: ...
+    name: str
+
+@final
+class TermApp:
+    def __init__(self, name: str, args: list[int]) -> None: ...
+    name: str
+    args: list[int]
+
+_Term: TypeAlias = TermLit | TermVar | TermApp
+
+@final
+class TermDag:
+    nodes: list[_Term]
+    hashcons: dict[_Term, int]
+
+##
+# Facts
+##
+
+@final
+class Eq:
+    def __init__(self, span: Span, exprs: list[_Expr]) -> None: ...
+    span: Span
+    exprs: list[_Expr]
+
+@final
+class Fact:
+    def __init__(self, expr: _Expr) -> None: ...
+    expr: _Expr
+
+_Fact: TypeAlias = Fact | Eq
+
+##
+# Change
+##
+
+@final
+class Delete:
+    def __init__(self) -> None: ...
+
+@final
+class Subsume:
+    def __init__(self) -> None: ...
+
+_Change: TypeAlias = Delete | Subsume
+
+##
+# Actions
+##
+
+@final
+class Let:
+    def __init__(self, span: Span, lhs: str, rhs: _Expr) -> None: ...
+    span: Span
+    lhs: str
+    rhs: _Expr
+
+@final
+class Set:
+    def __init__(self, span: Span, lhs: str, args: list[_Expr], rhs: _Expr) -> None: ...
+    span: Span
+    lhs: str
+    args: list[_Expr]
+    rhs: _Expr
+
+@final
+class Change:
+    span: Span
+    change: _Change
+    sym: str
+    args: list[_Expr]
+    def __init__(self, span: Span, change: _Change, sym: str, args: list[_Expr]) -> None: ...
+
+@final
+class Union:
+    def __init__(self, span: Span, lhs: _Expr, rhs: _Expr) -> None: ...
+    span: Span
+    lhs: _Expr
+    rhs: _Expr
+
+@final
+class Panic:
+    def __init__(self, span: Span, msg: str) -> None: ...
+    span: Span
+    msg: str
+
+@final
+class Expr_:  # noqa: N801
+    def __init__(self, span: Span, expr: _Expr) -> None: ...
+    span: Span
+    expr: _Expr
+
+@final
+class Extract:
+    def __init__(self, span: Span, expr: _Expr, variants: _Expr) -> None: ...
+    span: Span
+    expr: _Expr
+    variants: _Expr
+
+_Action: TypeAlias = Let | Set | Change | Union | Panic | Expr_ | Extract
+
+##
+# Other Structs
+##
+
+@final
+class FunctionDecl:
+    span: Span
+    name: str
+    schema: Schema
+    default: _Expr | None
+    merge: _Expr | None
+    merge_action: list[_Action]
+    cost: int | None
+    unextractable: bool
+    ignore_viz: bool
+
+    def __init__(
+        self,
+        span: Span,
+        name: str,
+        schema: Schema,
+        default: _Expr | None = None,
+        merge: _Expr | None = None,
+        merge_action: list[_Action] = [],  # noqa: B006
+        cost: int | None = None,
+        unextractable: bool = False,
+        ignore_viz: bool = False,
+    ) -> None: ...
+
+@final
+class Variant:
+    def __init__(self, span: Span, name: str, types: list[str], cost: int | None = None) -> None: ...
+    span: Span
+    name: str
+    types: list[str]
+    cost: int | None
+
+@final
+class Schema:
+    input: list[str]
+    output: str
+    def __init__(self, input: list[str], output: str) -> None: ...
+
+@final
+class Rule:
+    span: Span
+    head: list[_Action]
+    body: list[_Fact]
+    def __init__(self, span: Span, head: list[_Action], body: list[_Fact]) -> None: ...
+
+@final
+class Rewrite:
+    span: Span
+    lhs: _Expr
+    rhs: _Expr
+    conditions: list[_Fact]
+
+    def __init__(self, span: Span, lhs: _Expr, rhs: _Expr, conditions: list[_Fact] = []) -> None: ...  # noqa: B006
+
+@final
+class RunConfig:
+    ruleset: str
+    until: list[_Fact] | None
+    def __init__(self, ruleset: str, until: list[_Fact] | None = None) -> None: ...
+
+@final
+class IdentSort:
+    ident: str
+    sort: str
+    def __init__(self, ident: str, sort: str) -> None: ...
+
+@final
+class RunReport:
+    updated: bool
+    search_time_per_rule: dict[str, timedelta]
+    apply_time_per_rule: dict[str, timedelta]
+    search_time_per_ruleset: dict[str, timedelta]
+    apply_time_per_ruleset: dict[str, timedelta]
+    rebuild_time_per_ruleset: dict[str, timedelta]
+    num_matches_per_rule: dict[str, int]
+
+    def __init__(
+        self,
+        updated: bool,
+        search_time_per_rule: dict[str, timedelta],
+        apply_time_per_rule: dict[str, timedelta],
+        search_time_per_ruleset: dict[str, timedelta],
+        apply_time_per_ruleset: dict[str, timedelta],
+        rebuild_time_per_ruleset: dict[str, timedelta],
+        num_matches_per_rule: dict[str, int],
+    ) -> None: ...
+
+@final
+class Variants:
+    termdag: TermDag
+    terms: list[_Term]
+    def __init__(self, termdag: TermDag, terms: list[_Term]) -> None: ...
+
+@final
+class Best:
+    termdag: TermDag
+    cost: int
+    term: _Term
+    def __init__(self, termdag: TermDag, cost: int, term: _Term) -> None: ...
+
+_ExtractReport: TypeAlias = Variants | Best
+
+##
+# Schedules
+##
+
+@final
+class Saturate:
+    span: Span
+    schedule: _Schedule
+    def __init__(self, span: Span, schedule: _Schedule) -> None: ...
+
+@final
+class Repeat:
+    span: Span
+    length: int
+    schedule: _Schedule
+    def __init__(self, span: Span, length: int, schedule: _Schedule) -> None: ...
+
+@final
+class Run:
+    span: Span
+    config: RunConfig
+    def __init__(self, span: Span, config: RunConfig) -> None: ...
+
+@final
+class Sequence:
+    span: Span
+    schedules: list[_Schedule]
+    def __init__(self, span: Span, schedules: list[_Schedule]) -> None: ...
+
+_Schedule: TypeAlias = Saturate | Repeat | Run | Sequence
+
+##
+# Subdatatypes
+##
+
+@final
+class SubVariants:
+    def __init__(self, variants: list[Variant]) -> None: ...
+    variants: list[Variant]
+
+@final
+class NewSort:
+    def __init__(self, name: str, args: list[_Expr]) -> None: ...
+    name: str
+    args: list[_Expr]
+
+_Subdatatypes: TypeAlias = SubVariants | NewSort
+
+##
+# Commands
+##
+
+@final
+class SetOption:
+    name: str
+    value: _Expr
+    def __init__(self, name: str, value: _Expr) -> None: ...
+
+@final
+class Datatype:
+    span: Span
+    name: str
+    variants: list[Variant]
+    def __init__(self, span: Span, name: str, variants: list[Variant]) -> None: ...
+
+@final
+class Datatypes:
+    span: Span
+    datatypes: list[tuple[Span, str, _Subdatatypes]]
+    def __init__(self, span: Span, datatypes: list[tuple[Span, str, _Subdatatypes]]) -> None: ...
+
+@final
+class Sort:
+    span: Span
+    name: str
+    presort_and_args: tuple[str, list[_Expr]] | None
+    def __init__(self, span: Span, name: str, presort_and_args: tuple[str, list[_Expr]] | None = None) -> None: ...
+
+@final
+class Function:
+    decl: FunctionDecl
+    def __init__(self, decl: FunctionDecl) -> None: ...
+
+@final
+class AddRuleset:
+    name: str
+    def __init__(self, name: str) -> None: ...
+
+@final
+class RuleCommand:
+    name: str
+    ruleset: str
+    rule: Rule
+    def __init__(self, name: str, ruleset: str, rule: Rule) -> None: ...
+
+@final
+class RewriteCommand:
+    # TODO: Rename to ruleset
+    name: str
+    rewrite: Rewrite
+    subsume: bool
+    def __init__(self, name: str, rewrite: Rewrite, subsume: bool) -> None: ...
+
+@final
+class BiRewriteCommand:
+    # TODO: Rename to ruleset
+    name: str
+    rewrite: Rewrite
+    def __init__(self, name: str, rewrite: Rewrite) -> None: ...
+
+@final
+class ActionCommand:
+    action: _Action
+    def __init__(self, action: _Action) -> None: ...
+
+@final
+class RunSchedule:
+    schedule: _Schedule
+    def __init__(self, schedule: _Schedule) -> None: ...
+
+@final
+class Simplify:
+    span: Span
+    expr: _Expr
+    schedule: _Schedule
+    def __init__(self, span: Span, expr: _Expr, schedule: _Schedule) -> None: ...
+
+@final
+class QueryExtract:
+    span: Span
+    variants: int
+    expr: _Expr
+    def __init__(self, span: Span, variants: int, expr: _Expr) -> None: ...
+
+@final
+class Check:
+    span: Span
+    facts: list[_Fact]
+    def __init__(self, span: Span, facts: list[_Fact]) -> None: ...
+
+@final
+class PrintFunction:
+    span: Span
+    name: str
+    length: int
+    def __init__(self, span: Span, name: str, length: int) -> None: ...
+
+@final
+class PrintSize:
+    span: Span
+    name: str | None
+    def __init__(self, span: Span, name: str | None) -> None: ...
+
+@final
+class Output:
+    span: Span
+    file: str
+    exprs: list[_Expr]
+    def __init__(self, span: Span, file: str, exprs: list[_Expr]) -> None: ...
+
+@final
+class Input:
+    span: Span
+    name: str
+    file: str
+    def __init__(self, span: Span, name: str, file: str) -> None: ...
+
+@final
+class Push:
+    length: int
+    def __init__(self, length: int) -> None: ...
+
+@final
+class Pop:
+    span: Span
+    length: int
+    def __init__(self, span: Span, length: int) -> None: ...
+
+@final
+class Fail:
+    span: Span
+    command: _Command
+    def __init__(self, span: Span, command: _Command) -> None: ...
+
+@final
+class Include:
+    span: Span
+    path: str
+    def __init__(self, span: Span, path: str) -> None: ...
+
+@final
+class Relation:
+    span: Span
+    constructor: str
+    inputs: list[str]
+
+    def __init__(self, span: Span, constructor: str, inputs: list[str]) -> None: ...
+
+@final
+class PrintOverallStatistics:
+    def __init__(self) -> None: ...
+
+@final
+class UnstableCombinedRuleset:
+    name: str
+    rulesets: list[str]
+    def __init__(self, name: str, rulesets: list[str]) -> None: ...
+
+_Command: TypeAlias = (
+    SetOption
+    | Datatype
+    | Datatypes
+    | Sort
+    | Function
+    | AddRuleset
+    | RuleCommand
+    | RewriteCommand
+    | BiRewriteCommand
+    | ActionCommand
+    | RunSchedule
+    | Simplify
+    | QueryExtract
+    | Check
+    | PrintFunction
+    | PrintSize
+    | Output
+    | Input
+    | Push
+    | Pop
+    | Fail
+    | Include
+    | Relation
+    | PrintOverallStatistics
+    | UnstableCombinedRuleset
+)
+
+def termdag_term_to_expr(termdag: TermDag, term: _Term) -> _Expr: ...