David Spickett 210a383e18 [LLVM][TableGen] Add jupyter kernel for llvm-tblgen
This is based on the MLIR opt kernel:
https://github.com/llvm/llvm-project/tree/main/mlir/utils/jupyter

The inent of this is to enable experimentation and the creation
of interactive tutorials for the basics of tablegen.

Noteable changes from that:
* Removed the codemirror mode settings since those won't exist
  for tablegen.
* Added "%args" "magic" to control arguments sent to llvm-tblgen.

(magics are directives, see
https://ipython.readthedocs.io/en/stable/interactive/magics.html)

For example the following:
```
%args --print-detailed-records
class Stuff {}

def water_bottle : Stuff {}
```
Produces:
```
DETAILED RECORDS for file -

-------------------- Global Variables (0) --------------------

-------------------- Classes (1) --------------------

Stuff  |<stdin>:1|
  Template args: (none)
  Superclasses: (none)
  Fields: (none)

-------------------- Records (1) --------------------

water_bottle  |<stdin>:3|
  Superclasses: Stuff
  Fields: (none)
```

Reviewed By: jpienaar, awarzynski

Differential Revision: https://reviews.llvm.org/D132378
2023-01-23 14:15:55 +00:00

51 lines
1.4 KiB
Python

# Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
# See https://llvm.org/LICENSE.txt for license information.
# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
import os
import argparse
from jupyter_client.kernelspec import KernelSpecManager
def install_my_kernel_spec(user=True, prefix=None):
"""Install the kernel spec for user in given prefix."""
print("Installing llvm-tblgen IPython kernel spec")
pkgroot = os.path.dirname(__file__)
KernelSpecManager().install_kernel_spec(
os.path.join(pkgroot, "assets"), "tablegen", user=user, prefix=prefix
)
def _is_root():
"""Returns whether the current user is root."""
try:
return os.geteuid() == 0
except AttributeError:
# Return false wherever unknown.
return False
def main(argv=None):
parser = argparse.ArgumentParser(
description="Install KernelSpec for LLVM TableGen Kernel"
)
prefix_locations = parser.add_mutually_exclusive_group()
prefix_locations.add_argument(
"--user", help="Install in user home directory", action="store_true"
)
prefix_locations.add_argument(
"--prefix", help="Install directory prefix", default=None
)
args = parser.parse_args(argv)
user = args.user or not _is_root()
prefix = args.prefix
install_my_kernel_spec(user=user, prefix=prefix)
if __name__ == "__main__":
main()