sohang3112 / iforth Goto Github PK

Support standard IPython magic functions like %cd, %pwd, %env. Also, additional magic functions like %forth_version, %display_html can be used.

• Added Dockerfile
• Make Dockerfile work with pip install in development verison (currently, only testing version builds, for which git clone has to be done before building forth_kernel)
• Publish Docker image

deb-get provides apt-get functionality for 3rd party Debian packages.

Various providers which can be tried: MyBinder, JupyterHub, BinderHub

• Build Conda package using environment.yml
• Upload Conda package (to condaforge ?)
• Try running Forth notebooks online at https://mybinder.org/ using environment.yml

Implement optional methods in ForthKernel class.

For example:

• do_inspect() to inspect source code of the symbol under cursor
• do_shutdown() to kill the internal gforth process

• Mypy
• Organise Imports using autoflake
• Remove unused imports
• Warn about unused variables

For example, if an invalid shell command !lsd is entered in a cell, kernel hangs due to uncaught error:

Traceback (most recent call last):
  File "/home/sohang/.local/lib/python3.10/site-packages/ipykernel/kernelbase.py", line 412, in dispatch_shell
    await result
  File "/home/sohang/.local/lib/python3.10/site-packages/ipykernel/kernelbase.py", line 731, in execute_request
    reply_content = self.do_execute(
  File "/mnt/d/iforth/forth_kernel/forth_kernel.py", line 113, in do_execute
    self.answer_text(check_output(code[1:], encoding='utf-8'), 'stdout')
  File "/usr/lib/python3.10/subprocess.py", line 421, in check_output
    return run(*popenargs, stdout=PIPE, timeout=timeout, check=True,
  File "/usr/lib/python3.10/subprocess.py", line 503, in run
    with Popen(*popenargs, **kwargs) as process:
  File "/usr/lib/python3.10/subprocess.py", line 971, in __init__
    self._execute_child(args, executable, preexec_fn, close_fds,
  File "/usr/lib/python3.10/subprocess.py", line 1863, in _execute_child
    raise child_exception_type(errno_num, err_msg, err_filename)
FileNotFoundError: [Errno 2] No such file or directory: 'lsd'

If the output for a line is just the line followed by " ok" or " compiled", don't show it in output cell.

And then link to that website in the "website" section of this Github repo!

In this example screenshot, when running this code:

clear .
1 2 + .

GForth raises a Stack Underflow error on first line clear ., but the second line 1 2 + . is still run. This should not happen.

• if an error occurs on a line, stop execution
• ensure catch word (which handles errors in Forth) still works

Jupyter Notebooks usually allow block comments using Ctrl+/. But this is not working in Forth cells (while using the Forth kernel).
Block Comments should work by prepending with line comment character \.

This probably requires a change in the Jupyter frontend, which can be done by making a Jupyter Lab/Notebook extension.

• Do pen Testing
• Write security tests

Currently, GForth is used to evaluate all code input from Jupyter Notebook. Other Forth implementations, such as PForth, could also be allowed (maybe using an environment variable?).

PForth has the advantage that it can be built and run on Windows also.

Currently, in Jupyter cell output, things like the code input, GForth remarks like ok and compiled are shown. These things shouldn't be shown - only actual program output should be shown.

This is because kernel waits for GForth output and shows it all at once after it's done. This won't work for long-running output.
In the extreme case, the output may never show in case of an infinite loop.

To fix this, show cell output as soon as it's available instead of waiting for output and showing it all at once.

Use jupyter_kernel_test with unittest module for testing.