Skip to content
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

Allow specifying arguments to Cython cell_magic #38945

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from
Open
Changes from 5 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
80 changes: 75 additions & 5 deletions src/sage/repl/ipython_extension.py
Original file line number Diff line number Diff line change
Expand Up @@ -342,27 +342,97 @@ def cython(self, line, cell):

INPUT:

- ``line`` -- ignored
- ``line`` -- parsed as keyword arguments. The allowed arguments are:

- ``--verbose N`` / ``-v N``
- ``--compile-message`` / ``-m``
- ``--use-cache`` / ``-c``
- ``--create-local-c-file`` / ``-l``
- ``--annotate``
- ``--sage-namespace``
- ``--create-local-so-file`` / ``-o``
- ``--no-compile-message``, ``--no-use-cache``, etc. (there is no short form for the ``--no-*`` flags)

kwankyu marked this conversation as resolved.
Show resolved Hide resolved
See :func:`~sage.misc.cython.cython` for details.

- ``cell`` -- string; the Cython source code to process

OUTPUT: none; the Cython code is compiled and loaded

EXAMPLES::

sage: # needs sage.misc.cython
sage: from sage.repl.interpreter import get_test_shell
sage: shell = get_test_shell()
sage: shell.run_cell( # needs sage.misc.cython
sage: shell.run_cell(
....: '''
....: %%cython
....: %%cython -v1 --annotate --no-sage-namespace
....: def f():
....: print('test')
....: ''')
sage: f() # needs sage.misc.cython
Compiling ....pyx because it changed.
[1/1] Cythonizing ....pyx
sage: f()
test

TESTS:

See :mod:`sage.repl.interpreter` for explanation of the dummy line.

kwankyu marked this conversation as resolved.
Show resolved Hide resolved
Test unrecognized arguments::

sage: # needs sage.misc.cython
sage: shell.run_cell('''
....: %%cython --some-unrecognized-argument
....: print(1)
....: ''')
UsageError: unrecognized arguments: --some-unrecognized-argument

Test ``--help`` is disabled::

sage: # needs sage.misc.cython
sage: shell.run_cell('''
....: %%cython --help
....: print(1)
....: ''')
UsageError: unrecognized arguments: --help

Test invalid quotes::

sage: # needs sage.misc.cython
sage: print("dummy line"); shell.run_cell('''
....: %%cython --a='
....: print(1)
....: ''')
dummy line
...
ValueError...Traceback (most recent call last)
...
ValueError: No closing quotation
"""
from sage.misc.cython import cython_compile
return cython_compile(cell)
import shlex
import argparse

class ExitCatchingArgumentParser(argparse.ArgumentParser):
def error(self, message):
# exit_on_error=False does not work completely in some Python versions
# see https://stackoverflow.com/q/67890157
# we raise UsageError to make the interface similar to what happens when e.g.
# IPython's ``%run`` gets unrecognized arguments
from IPython.core.error import UsageError
raise UsageError(message)

parser = ExitCatchingArgumentParser(prog="%%cython", add_help=False)
parser.add_argument("--verbose", "-v", type=int)
parser.add_argument("--compile-message", "-m", action=argparse.BooleanOptionalAction)
parser.add_argument("--use-cache", "-c", action=argparse.BooleanOptionalAction)
parser.add_argument("--create-local-c-file", "-l", action=argparse.BooleanOptionalAction)
parser.add_argument("--annotate", action=argparse.BooleanOptionalAction)
parser.add_argument("--sage-namespace", action=argparse.BooleanOptionalAction)
parser.add_argument("--create-local-so-file", "-o", action=argparse.BooleanOptionalAction)
args = parser.parse_args(shlex.split(line))
return cython_compile(cell, **{k: v for k, v in args.__dict__.items() if v is not None})

@cell_magic
def fortran(self, line, cell):
Expand Down
Loading