Skip to content

Improvements to printing using new infrastructure #593

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
May 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion kmir/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "hatchling.build"

[project]
name = "kmir"
version = "0.3.170"
version = "0.3.171"
description = ""
requires-python = "~=3.10"
dependencies = [
Expand Down
2 changes: 1 addition & 1 deletion kmir/src/kmir/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
from typing import Final

VERSION: Final = '0.3.170'
VERSION: Final = '0.3.171'
42 changes: 29 additions & 13 deletions kmir/src/kmir/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -114,25 +114,22 @@ def _kmir_prove_raw(opts: ProveRawOpts) -> None:
def _kmir_view(opts: ViewOpts) -> None:
kmir = KMIR(HASKELL_DEF_DIR, LLVM_LIB_DIR)
proof = APRProof.read_proof_data(opts.proof_dir, opts.id)
smir_info = None
if opts.smir_info is not None:
smir_info = SMIRInfo.from_file(opts.smir_info)
printer = PrettyPrinter(kmir.definition)
cterm_show = CTermShow(printer.print)
node_printer = KMIRAPRNodePrinter(cterm_show, proof, smir_info=smir_info, full_printer=False)
viewer = APRProofViewer(proof, kmir, node_printer=node_printer)
omit_labels = ('<currentBody>',) if opts.omit_current_body else ()
cterm_show = CTermShow(printer.print, omit_labels=omit_labels)
opts.full_printer = False
node_printer = KMIRAPRNodePrinter(cterm_show, proof, opts)
viewer = APRProofViewer(proof, kmir, node_printer=node_printer, cterm_show=cterm_show)
viewer.run()


def _kmir_show(opts: ShowOpts) -> None:
kmir = KMIR(HASKELL_DEF_DIR, LLVM_LIB_DIR)
proof = APRProof.read_proof_data(opts.proof_dir, opts.id)
smir_info = None
if opts.smir_info is not None:
smir_info = SMIRInfo.from_file(opts.smir_info)
printer = PrettyPrinter(kmir.definition)
cterm_show = CTermShow(printer.print)
node_printer = KMIRAPRNodePrinter(cterm_show, proof, smir_info=smir_info, full_printer=opts.full_printer)
omit_labels = ('<currentBody>',) if opts.omit_current_body else ()
cterm_show = CTermShow(printer.print, omit_labels=omit_labels)
node_printer = KMIRAPRNodePrinter(cterm_show, proof, opts)
shower = APRProofShow(kmir.definition, node_printer=node_printer)
lines = shower.show(proof)
print('\n'.join(lines))
Expand Down Expand Up @@ -232,6 +229,13 @@ def _arg_parser() -> ArgumentParser:
default=None,
help='Path to SMIR JSON file to improve debug messaging.',
)
display_args.add_argument(
'--no-omit-current-body',
dest='omit_current_body',
default=True,
action='store_false',
help='Display the <currentBody> cell completely.',
)
Comment on lines +232 to +238
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can modify this (in a later PR) to carry a list of omitted field names (default [ currentBody ], can be emptied for full printing or any field can be added). The use site in __main__ would just pass the list (with angle-brackets added) to CTermShow.

No need to do this now, though.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It could be possible, but making it a list wouldn't be the way. Using the CTermShow.let(...) method would be the way, which makes it so instances of CTermShow are immutable. But it would be nice to be able to dynamically control which cells are omitted...


command_parser.add_parser(
'show', help='Show a saved proof', parents=[kcli_args.logging_args, proof_args, display_args]
Expand Down Expand Up @@ -291,13 +295,25 @@ def _parse_args(ns: Namespace) -> KMirOpts:
)
case 'view':
proof_dir = Path(ns.proof_dir).resolve()
return ViewOpts(proof_dir, ns.id, full_printer=ns.full_printer, smir_info=ns.smir_info)
return ViewOpts(
proof_dir,
ns.id,
full_printer=ns.full_printer,
smir_info=ns.smir_info,
omit_current_body=ns.omit_current_body,
)
case 'prune':
proof_dir = Path(ns.proof_dir).resolve()
return PruneOpts(proof_dir, ns.id, ns.node_id)
case 'show':
proof_dir = Path(ns.proof_dir).resolve()
return ShowOpts(proof_dir, ns.id, full_printer=ns.full_printer, smir_info=ns.smir_info)
return ShowOpts(
proof_dir,
ns.id,
full_printer=ns.full_printer,
smir_info=ns.smir_info,
omit_current_body=ns.omit_current_body,
)
case 'prove-rs':
return ProveRSOpts(
rs_file=Path(ns.rs_file).resolve(),
Expand Down
31 changes: 22 additions & 9 deletions kmir/src/kmir/kmir.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
from pyk.kore.syntax import Pattern
from pyk.utils import BugReport

from .options import ProveRSOpts
from .options import DisplayOpts, ProveRSOpts

_LOGGER: Final = logging.getLogger(__name__)

Expand Down Expand Up @@ -166,6 +166,8 @@ def prove_rs(self, opts: ProveRSOpts) -> APRProof:
apr_proof = self.apr_proof_from_kast(
label, kmir_kast, SMIRInfo(smir_json), start_symbol=opts.start_symbol, proof_dir=opts.proof_dir
)
if apr_proof.proof_dir is not None and (apr_proof.proof_dir / apr_proof.id).is_dir():
(apr_proof.proof_dir / apr_proof.id / 'smir.json').write_text(json.dumps(smir_json))
if apr_proof.passed:
return apr_proof
with self.kcfg_explore(label) as kcfg_explore:
Expand Down Expand Up @@ -195,14 +197,20 @@ def __init__(self, cterm_show: CTermShow, full_printer: bool = False) -> None:
class KMIRAPRNodePrinter(KMIRNodePrinter, APRProofNodePrinter):
smir_info: SMIRInfo | None

def __init__(
self, cterm_show: CTermShow, proof: APRProof, smir_info: SMIRInfo | None = None, full_printer: bool = False
) -> None:
KMIRNodePrinter.__init__(self, cterm_show, full_printer=full_printer)
APRProofNodePrinter.__init__(self, proof, cterm_show, full_printer=full_printer)
self.smir_info = smir_info
def __init__(self, cterm_show: CTermShow, proof: APRProof, opts: DisplayOpts) -> None:
KMIRNodePrinter.__init__(self, cterm_show, full_printer=opts.full_printer)
APRProofNodePrinter.__init__(self, proof, cterm_show, full_printer=opts.full_printer)
self.smir_info = None
if opts.smir_info:
self.smir_info = SMIRInfo.from_file(opts.smir_info)
elif (
proof.proof_dir is not None
and (proof.proof_dir / proof.id).is_dir()
and (proof.proof_dir / proof.id / 'smir.json').is_file()
):
self.smir_info = SMIRInfo.from_file(proof.proof_dir / proof.id / 'smir.json')

def _span(self, node: KCFG.Node) -> int | None:
def _span(self, node: KCFG.Node) -> str | None:
curr_span: int | None = None
span_worklist: list[KInner] = [node.cterm.cell('K_CELL')]
while span_worklist:
Expand All @@ -218,7 +226,12 @@ def _span(self, node: KCFG.Node) -> int | None:
span_worklist = list(next_item.args) + span_worklist
if type(next_item) is KSequence:
span_worklist = list(next_item.items) + span_worklist
return curr_span
if self.smir_info is not None and curr_span is not None and curr_span in self.smir_info.spans:
path, start_row, _start_column, _end_row, _end_column = self.smir_info.spans[curr_span]
return f'{str(path)[-30:]}:{start_row}'
if curr_span is not None:
return f'{curr_span}'
return None

def _function_name(self, node: KCFG.Node) -> str | None:
curr_func_ty_kast = node.cterm.cell('CURRENTFUNC_CELL')
Expand Down
3 changes: 3 additions & 0 deletions kmir/src/kmir/options.py
Original file line number Diff line number Diff line change
Expand Up @@ -132,18 +132,21 @@ def __init__(
class DisplayOpts(ProofOpts):
full_printer: bool
smir_info: Path | None
omit_current_body: bool

def __init__(
self,
proof_dir: Path | str,
id: str,
full_printer: bool = True,
smir_info: Path | None = None,
omit_current_body: bool = True,
) -> None:
self.proof_dir = Path(proof_dir).resolve() if proof_dir is not None else None
self.id = id
self.full_printer = full_printer
self.smir_info = smir_info
self.omit_current_body = omit_current_body


@dataclass
Expand Down
4 changes: 4 additions & 0 deletions kmir/src/kmir/smir.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,10 @@ def function_tys(self) -> dict[str, int]:
res[name] = fun_syms[sym]
return res

@cached_property
def spans(self) -> dict[int, tuple[Path, int, int, int, int]]:
return {id: (p, sr, sc, er, ec) for id, [p, sr, sc, er, ec] in self._smir['spans']}

@staticmethod
def _is_func(item: dict[str, dict]) -> bool:
return 'MonoItemFn' in item['mono_item_kind']
Expand Down
12 changes: 7 additions & 5 deletions kmir/src/tests/integration/test_integration.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
from kmir.__main__ import _kmir_gen_spec, _kmir_prove_raw
from kmir.build import HASKELL_DEF_DIR, LLVM_DEF_DIR
from kmir.kmir import KMIR, KMIRAPRNodePrinter
from kmir.options import GenSpecOpts, ProveRawOpts, ProveRSOpts
from kmir.options import GenSpecOpts, ProveRawOpts, ProveRSOpts, ShowOpts
from kmir.parse.parser import Parser
from kmir.testing.fixtures import assert_or_update_show_output

Expand Down Expand Up @@ -479,9 +479,10 @@ def test_prove_rs(rs_file: Path, kmir: KMIR, update_expected_output: bool) -> No
else:
assert apr_proof.failed

shower = APRProofShow(
kmir.definition, node_printer=KMIRAPRNodePrinter(cterm_show, apr_proof, full_printer=False)
display_opts = ShowOpts(
rs_file.parent, apr_proof.id, full_printer=False, smir_info=None, omit_current_body=False
)
shower = APRProofShow(kmir.definition, node_printer=KMIRAPRNodePrinter(cterm_show, apr_proof, display_opts))
show_res = '\n'.join(shower.show(apr_proof))
assert_or_update_show_output(
show_res, PROVING_DIR / f'show/{rs_file.stem}.expected', update=update_expected_output
Expand Down Expand Up @@ -511,9 +512,10 @@ def test_prove_pinocchio(kmir: KMIR, update_expected_output: bool) -> None:
for start_symbol in start_symbols:
prove_rs_opts.start_symbol = start_symbol
apr_proof = kmir.prove_rs(prove_rs_opts)
shower = APRProofShow(
kmir.definition, node_printer=KMIRAPRNodePrinter(cterm_show, apr_proof, full_printer=True)
display_opts = ShowOpts(
pinocchio_token_program.parent, apr_proof.id, full_printer=True, smir_info=None, omit_current_body=False
)
shower = APRProofShow(kmir.definition, node_printer=KMIRAPRNodePrinter(cterm_show, apr_proof, display_opts))
show_res = '\n'.join(shower.show(apr_proof))
assert_or_update_show_output(
show_res,
Expand Down
2 changes: 1 addition & 1 deletion kmir/uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package/version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.3.170
0.3.171