Add notebook and eval cmd, various other improvements

Author: tobiasdiez

src/sage/cli/__init__.py

@@ -4,7 +4,9 @@
 import logging
 import sys
 
+from sage.cli.eval_cmd import EvalCmd
 from sage.cli.interactive_shell_cmd import InteractiveShellCmd
+from sage.cli.notebook_cmd import JupyterNotebookCmd
 from sage.cli.options import CliOptions
 from sage.cli.version_cmd import VersionCmd
 
@@ -24,17 +26,19 @@ def main() -> int:
     )
 
     VersionCmd.extend_parser(parser)
+    JupyterNotebookCmd.extend_parser(parser)
+    EvalCmd.extend_parser(parser)
 
     if not input_args:
-        InteractiveShellCmd(CliOptions()).run()
+        return InteractiveShellCmd(CliOptions()).run()
 
     args = parser.parse_args(input_args)
     options = CliOptions(**vars(args))
 
     logging.basicConfig(level=logging.DEBUG if options.verbose else logging.INFO)
 
+    if args.command:
+        return EvalCmd(options).run()
+    elif args.notebook:
+        return JupyterNotebookCmd(options).run()
     return InteractiveShellCmd(options).run()
-
-
-if __name__ == "__main__":
-    sys.exit(main())

src/sage/cli/__main__.py

@@ -0,0 +1,5 @@
+import sys
+
+from sage.cli import main
+
+sys.exit(main())

src/sage/cli/eval_cmd.py

@@ -0,0 +1,45 @@
+import argparse
+
+from sage.cli.options import CliOptions
+from sage.repl.preparse import preparse
+from sage.all import sage_globals
+
+
+class EvalCmd:
+    @staticmethod
+    def extend_parser(parser: argparse.ArgumentParser):
+        r"""
+        Extend the parser with the "run" command.
+
+        INPUT:
+
+        - ``parsers`` -- the parsers to extend.
+
+        OUTPUT:
+
+        - the extended parser.
+        """
+        parser.add_argument(
+            "-c",
+            "--command",
+            nargs="?",
+            help="execute the given command as sage code",
+        )
+
+    def __init__(self, options: CliOptions):
+        r"""
+        Initialize the command.
+        """
+        self.options = options
+
+    def run(self) -> int:
+        r"""
+        Execute the given command.
+        """
+        code = preparse(self.options.command)
+        try:
+            eval(compile(code, "<cmdline>", "exec"), sage_globals())
+        except Exception as e:
+            print(f"An error occurred while executing the command: {e}")
+            return 1
+        return 0

src/sage/cli/eval_cmd_test.py

@@ -0,0 +1,21 @@
+from sage.cli.eval_cmd import EvalCmd
+from sage.cli.options import CliOptions
+
+
+def test_eval_cmd_print(capsys):
+    options = CliOptions(command="print(3^33)")
+    eval_cmd = EvalCmd(options)
+
+    result = eval_cmd.run()
+    captured = capsys.readouterr()
+    assert captured.out == "5559060566555523\n"
+    assert result == 0
+
+def test_eval_cmd_invalid_command(capsys):
+    options = CliOptions(command="invalid_command")
+    eval_cmd = EvalCmd(options)
+
+    result = eval_cmd.run()
+    captured = capsys.readouterr()
+    assert "An error occurred while executing the command: name 'invalid_command' is not defined" in captured.out
+    assert result == 1

src/sage/cli/meson.build

@@ -0,0 +1,52 @@
+import argparse
+
+from sage.cli.options import CliOptions
+
+
+class JupyterNotebookCmd:
+    @staticmethod
+    def extend_parser(parser: argparse.ArgumentParser):
+        r"""
+        Extend the parser with the Jupyter notebook command.
+
+        INPUT:
+
+        - ``parsers`` -- the parsers to extend.
+
+        OUTPUT:
+
+        - the extended parser.
+        """
+        parser.add_argument(
+            "-n",
+            "--notebook",
+            nargs="?",
+            const="jupyter",
+            choices=["jupyter", "jupyterlab"],
+            default="jupyter",
+            help="start the Jupyter notebook server (default: jupyter)",
+        )
+
+    def __init__(self, options: CliOptions):
+        r"""
+        Initialize the command.
+        """
+        self.options = options
+    
+    def run(self) -> int:
+        r"""
+        Start the Jupyter notebook server.
+        """
+        if self.options.notebook == "jupyter":
+            try:
+                # notebook 6
+                from notebook.notebookapp import main
+            except ImportError:
+                # notebook 7
+                from notebook.app import main
+        elif self.options.notebook == "jupyterlab":
+            from jupyterlab.labapp import main
+        else:
+            raise ValueError(f"Unknown notebook type: {self.options.notebook}")
+        
+        return main([])

src/sage/cli/notebook_cmd.py

@@ -0,0 +1,35 @@
+import argparse
+
+import pytest
+
+from sage.cli.notebook_cmd import JupyterNotebookCmd
+
+
+def test_jupyter_as_default():
+    parser = argparse.ArgumentParser()
+    JupyterNotebookCmd.extend_parser(parser)
+    args = parser.parse_args(["--notebook"])
+    assert args.notebook == "jupyter"
+
+def test_jupyter_explicitly():
+    parser = argparse.ArgumentParser()
+    JupyterNotebookCmd.extend_parser(parser)
+    args = parser.parse_args(["--notebook", "jupyter"])
+    assert args.notebook == "jupyter"
+
+def test_jupyterlab_explicitly():
+    parser = argparse.ArgumentParser()
+    JupyterNotebookCmd.extend_parser(parser)
+    args = parser.parse_args(["--notebook", "jupyterlab"])
+    assert args.notebook == "jupyterlab"
+
+def test_invalid_notebook_choice():
+    parser = argparse.ArgumentParser()
+    JupyterNotebookCmd.extend_parser(parser)
+    with pytest.raises(SystemExit):
+        parser.parse_args(["--notebook", "invalid"])
+
+def test_help():
+    parser = argparse.ArgumentParser()
+    JupyterNotebookCmd.extend_parser(parser)
+    assert parser.format_usage() == "usage: pytest [-h] [-n [{jupyter,jupyterlab}]]\n"

src/sage/cli/notebook_cmd_test.py

@@ -5,9 +5,13 @@
 class CliOptions:
     """
     A TypedDict for command-line interface options.
-
-    Attributes:
-        verbose (bool): Indicates whether verbose output is enabled.
     """
 
+    """Indicates whether verbose output is enabled."""
     verbose: bool = False
+
+    """The notebook type to start."""
+    notebook: str = "jupyter"
+
+    """The command to execute."""
+    command: str | None = None

src/sage/cli/options.py

@@ -142,4 +142,4 @@ subdir('symbolic')
 subdir('tests')
 subdir('dynamics')
 subdir('sat')
-subdir('cli')
+install_subdir('cli', install_dir: sage_install_dir)

src/sage/meson.build

@@ -13,7 +13,8 @@
 # ****************************************************************************
 import sys
 
-from sage.env import (SAGE_VERSION, SAGE_VERSION_BANNER, SAGE_BANNER)
+from sage.env import SAGE_BANNER, SAGE_VERSION
+from sage.version import banner as sage_banner
 
 
 def version():
@@ -25,12 +26,16 @@ def version():
     EXAMPLES::
 
        sage: version()
+       doctest:warning
+       ...
+       DeprecationWarning: Use sage.version instead.
+       ...
        'SageMath version ..., Release Date: ...'
     """
     from sage.misc.superseded import deprecation
 
-    deprecation(1, "Use sage.version instead.")
-    return SAGE_VERSION_BANNER
+    deprecation(39015, "Use sage.version instead.")
+    return sage_banner
 
 
 def banner_text(full=True):
@@ -57,13 +62,13 @@ def banner_text(full=True):
         SageMath version ..., Release Date: ...
     """
     if not full:
-        return version()
+        return sage_banner
 
     bars = "─" * 68
     s = []
     a = s.append
     a('┌' + bars + '┐')
-    a("\n│ %-66s │\n" % version())
+    a("\n│ %-66s │\n" % sage_banner)
     python_version = sys.version_info[:3]
     a("│ %-66s │\n" % 'Using Python {}.{}.{}. Type "help()" for help.'.format(*python_version))
     a('└' + bars + '┘')