Merged PR posit-dev/positron-python#114: Add ipython magics view

Merge pull request #114 from posit-dev/magic-viewer


--------------------
Commit message for posit-dev/positron-python@6bab2da:

add all requirements from positron_jedilsp

--------------------
Commit message for posit-dev/positron-python@7f92125:

add pygls to build requirements

--------------------
Commit message for posit-dev/positron-python@38571ec:

Merge branch 'main' into magic-viewer

--------------------
Commit message for posit-dev/positron-python@c01c112:

add build requirements

--------------------
Commit message for posit-dev/positron-python@41122f6:

linting

--------------------
Commit message for posit-dev/positron-python@2ae5dd5:

add beginning of tests

These tests run an ipython kernel with a magic registered. They will
check to see if the %view magic exists and not error on run for pandas
dataframes and expressions. It will also check that a TypeError is
thrown if an incorrect type is used.

--------------------
Commit message for posit-dev/positron-python@934b395:

changes from suggestions

--------------------
Commit message for posit-dev/positron-python@194754a:

Apply suggestions from code review

Co-authored-by: Wasim Lorgat <[email protected]>
--------------------
Commit message for posit-dev/positron-python@495b2b3:

linting

--------------------
Commit message for posit-dev/positron-python@067e02d:

add ipython ViewerMagic

Create a linemagic that ingests user input and opens up in DataViewer tab


Authored-by: Isabel Zimmerman <[email protected]>
Signed-off-by: Isabel Zimmerman <[email protected]>

Author: isabelizimm

extensions/positron-python/build/test-requirements.txt

@@ -11,6 +11,7 @@ yapf
 pylint
 pycodestyle
 pydocstyle
+pygls
 prospector
 pytest
 flask
@@ -29,6 +30,11 @@ freezegun
 # --- Start Positron ---
 # iPython Kernel tests
 ipykernel
+jedi
+jedi_language_server
+lsprotocol
 matplotlib
+pandas
 pytest-mock
+polars
 # --- End Positron ---

extensions/positron-python/pythonFiles/positron/inspectors.py

@@ -118,7 +118,7 @@ def copy(self, value: Any) -> Any:
         return copy.copy(value)
 
     def to_dataset(self, value: Any, title: str) -> Optional[DataSet]:
-        return None
+        raise TypeError(f"Type {type(value)} is not supported by `View()`.")
 
     def to_html(self, value: Any) -> str:
         return repr(value)

extensions/positron-python/pythonFiles/positron/positron_ipkernel.py

@@ -8,11 +8,13 @@
 import logging
 from collections.abc import Iterable, Sequence
 from itertools import chain
-from typing import Any, Optional, Tuple
+from typing import Any, Optional, Tuple, Dict
 
 from ipykernel.ipkernel import IPythonKernel
 from ipykernel.zmqshell import ZMQInteractiveShell
 
+from IPython.core.magic import Magics, magics_class, line_magic, needs_local_scope
+
 from .dataviewer import DataViewerService
 from .environment import EnvironmentService
 from .inspectors import get_inspector
@@ -76,6 +78,7 @@ def __init__(self, **kwargs):
 
         # Setup Positron's dataviewer service
         self.dataviewer_service = DataViewerService(POSITRON_DATA_VIEWER_COMM)
+        load_ipython_extension(self.shell)
 
     def do_shutdown(self, restart) -> dict:
         """
@@ -358,3 +361,34 @@ async def _soft_reset(self, parent) -> dict:
         self.env_service.send_list()
 
         return coro
+
+
+@magics_class
+class ViewerMagic(Magics):
+    @needs_local_scope
+    @line_magic
+    def view(self, value: str, local_ns: Dict[str, Any]):
+        """Open DataViewerService through %view magic command"""
+
+        try:
+            local_value = local_ns[value]
+            inspector = get_inspector(local_value)
+            dataset = inspector.to_dataset(local_value, value)
+        except KeyError:  # not in namespace
+            eval_value = eval(value, local_ns, local_ns)
+            inspector = get_inspector(eval_value)
+            dataset = inspector.to_dataset(eval_value, value)
+
+        if dataset is not None:
+            DataViewerService(POSITRON_DATA_VIEWER_COMM).register_dataset(dataset)
+
+
+def load_ipython_extension(ipython):
+    """
+    Any module file that define a function named `load_ipython_extension`
+    can be loaded via `%load_ext module.path` or be configured to be
+    autoloaded by IPython at startup time.
+    """
+    # You can register the class itself without instantiating it.  IPython will
+    # call the default constructor on it.
+    ipython.register_magics(ViewerMagic)

extensions/positron-python/pythonFiles/tests/test_magic.py

@@ -0,0 +1,43 @@
+import pytest
+
+import pandas as pd
+import polars as pl
+from IPython.conftest import get_ipython
+
+from positron.positron_ipkernel import ViewerMagic
+
+
+@pytest.fixture(scope="session")
+def get_ip():
+    ip = get_ipython()
+    ip.register_magics(ViewerMagic)
+    return ip
+
+
+def test_pandas_df_expression(get_ip):
+    get_ip.run_cell("import pandas as pd\n" "%view pd.DataFrame({'x': [1,2,3]})")
+
+    assert "view" in get_ip.magics_manager.magics["line"]
+
+
+def test_pandas_df_var(get_ip):
+    get_ip.run_cell(
+        "import pandas as pd\n" "a = pd.DataFrame({'x': [1,2,3]})\n" "%view a", store_history=True
+    )
+
+    assert "view" in get_ip.magics_manager.magics["line"]
+    assert "view" in get_ip.user_ns["In"][1]
+    assert isinstance(get_ip.user_ns["a"], pd.DataFrame)
+
+
+def test_polars_df_var(get_ip):
+    get_ip.run_cell("import polars as pl\n" "a = pl.DataFrame()\n" "%view a", store_history=True)
+
+    assert "view" in get_ip.magics_manager.magics["line"]
+    assert "view" in get_ip.user_ns["In"][1]
+    assert isinstance(get_ip.user_ns["a"], pl.DataFrame)
+
+
+def test_unsupported_type(get_ip):
+    with pytest.raises(TypeError):
+        get_ip.run_line_magic("view", "12")