Add new interactivity mode for ast. #10598

Carreau · 2017-05-24T19:20:13Z

Allow to display the result of the last assignment of it has a unique
target.

meh, I should write tests for that.

Carreau · 2017-05-24T19:21:23Z

@rgbkrk though on that ? I though about that because display() is long to type and I often do

df = some_operation(df)
df

Just to display it.

rgbkrk · 2017-05-24T20:42:11Z

docs/source/whatsnew/pr/interactive_assignment.rst

+Up until 6.0 the following code wouldn't show the value of the assigned
+variable:
+
+    >>> var = "something"


My brain almost broke because it was in JS mode while reading this.

I can change for let if you want ?

rgbkrk · 2017-05-24T20:49:21Z

If this behavior exists, out of old Matlab habit I will append ; in hopes that it will not show the result by default.

I too do the operation then display it pretty often. I'd hate to have to figure out how to suppress output though.

rgbkrk · 2017-05-24T20:50:15Z

Oh I see, this isn't the default setting, just a configurable. 🆒

Carreau · 2017-05-24T20:55:31Z

yeah, of course it's not the default :-)

$ ipython --InteractiveShell.ast_node_interactivity='last_expr_or_assign'
Python 3.6.0 |Continuum Analytics, Inc.| (default, Dec 23 2016, 13:19:00)
Type 'copyright', 'credits' or 'license' for more information
IPython 6.1.0.dev -- An enhanced Interactive Python. Type '?' for help.

In [1]: a = 1;

In [2]: a = 1
Out[2]: 1

In [3]:

; works, you can also do a newline / pass or newline / None

ssanderson · 2017-05-24T21:07:32Z

IPython/core/interactiveshell.py

+            if isinstance(nodelist[-1], ast.Assign):
+                asg = nodelist[-1]
+                if len(asg.targets) == 1:
+                    nnode = ast.Expr(ast.Name(asg.targets[0].id, ast.Load()))


I think this will crash if you try to do a multiple assignment. When I parse something like (a, b) = (1, 2), I get an assignment with a length-1 list of targets whose only entry is an instance of ast.Tuple, which has no id:

In [5]: sys.version_info Out[5]: sys.version_info(major=3, minor=5, micro=2, releaselevel='final', serial=0) In [6]: %%ast ...: (a, b) = (1, 2) ...: Module( body=[ Assign( targets=[ Tuple( elts=[ Name(id='a', ctx=Store()), Name(id='b', ctx=Store()), ], ctx=Store(), ), ], value=Tuple( elts=[ Num(1), Num(2), ], ctx=Load(), ), ), ], )

(That %%ast magic comes from https://github.com/llllllllll/codetransformer/blob/master/codetransformer/__init__.py#L23-L35, btw. That might be relevant to your interests if you're working on ast stuff.)

Oh, sweet. Thanks. Does it also define a pretty formatter for ast objects that are returned ?

It doesn't at the moment, but that could be added pretty easily. The logic that does the actual formatting lives here: https://github.com/llllllllll/codetransformer/blob/master/codetransformer/utils/pretty.py#L31.

Hey ! ... it's not in the released version ! It's been merged a year ago, why no release?

Oh, TIL. @llllllllll we should probably do a codetransformer release...

codetransformer 0.7.0 has been released

Carreau · 2017-05-24T23:36:06Z

codetransformer 0.7.0 has been released

Thanks ! Though I'm on 3.6, so can't import it :-(

Pushed new commits that test the various behavior.

takluyver

Nice work 👍

takluyver · 2017-05-25T12:29:33Z

docs/source/whatsnew/pr/interactive_assignment.rst

+With the option ``InteractiveShell.ast_node_interactivity='last_expr_or_assign'``
+you can now do::
+
+    >>> df = pandas.load_csv(...)


Make this example match the others above? And use IPython prompts instead of >>>?

takluyver · 2017-05-25T12:31:44Z

IPython/core/interactiveshell.py

@@ -2781,6 +2787,15 @@ def run_ast_nodes(self, nodelist, cell_name, interactivity='last_expr',
        if not nodelist:
            return

+        if interactivity == 'last_expr_or_assign':
+            if isinstance(nodelist[-1], ast.Assign):


I think this is fine for getting this feature in and letting people experiment with it, but be aware that it won't catch a += 1 (which is an AugAssign node), or a : int = 1 (new in Python 3.6, AnnAssign node).

Good call. Fixed. It should work on all of these.

takluyver · 2017-05-26T13:43:26Z

IPython/core/tests/test_displayhook.py

+            ip.run_cell('(u,v) = (41+1, 43-1)')
+
+    finally:
+        ip.run_cell('a = 1+1', store_history=True)


Why is this in the finally block?

No reasons, bad copy past likely. Fixed.

Carreau · 2017-05-29T22:07:50Z

@fperez would prefer for this to not assign to Out[] and _.
I'm unsure about that. So I can rewrite the Ast to actually do display(ast_name).
I'll see what I can do.

Carreau · 2017-05-29T22:50:00Z

Hum inject something at the end like that:

In [10]: %%ast
    ...: __import__('IPython').display.display(whatever)
Module(
  body=[
    Expr(
      value=Call(
        func=Attribute(
          value=Attribute(
            value=Call(
              func=Name(id='__import__', ctx=Load()),
              args=[
                Str(
                  s='IPython',
                ),
              ],
              keywords=[],
            ),
            attr='display',
            ctx=Load(),
          ),
          attr='display',
          ctx=Load(),
        ),
        args=[
          Name(id='whatever', ctx=Load()),
        ],
        keywords=[],
      ),
    ),
  ],
)

At the same time when the expression of a of a cell display something there is always an Out[], so I"m unsure.

takluyver · 2017-05-30T13:56:59Z

If we're injecting display() into the builtins, that could be simpler. Although then I guess it would be susceptible to someone overriding display =.

Maybe there's a nicer way to do this - instead of modifying the AST, inspect it to find the target of the final assignment, and then record some information which says 'if this code completes successfully, print the value of foo'.

Carreau · 2017-05-30T17:13:48Z

Maybe there's a nicer way to do this - instead of modifying the AST, inspect it to find the target of the final assignment, and then record some information which says 'if this code completes successfully, print the value of foo'

Well that's almost exactly what the above do. it calls display on the last assignment target.

Here is my argument against having it displayed and not triggerd as part of display hook.

One the the two below methods are doing

def load_something():
    display(...)

The other

def load_somethingelse():
    return ...

$ ipython
Python 3.6.0 |Continuum Analytics, Inc.| (default, Dec 23 2016, 13:19:00)
Type 'copyright', 'credits' or 'license' for more information
IPython 6.1.0.dev -- An enhanced Interactive Python. Type '?' for help.

In [1]: %config TerminalInteractiveShell.ast_node_interactivity='display_last_expr_or_assign'
In [2]: from dummymod import load_cars, load_iris

In [3]: a = load_iris()

=================
 Id    |  types
=================
1      |    A
2      |    B
3      |    A
None

In [4]: b = load_cars()

=================
 Id    |  types
=================
I      |    E
II     |    F
III    |    G

With the current implementation that would be disambiguated by having (or not) an Out:

In [6]: a = load_iris()

=================
 Id    |  types
=================
1      |    A
2      |    B
3      |    A

In [7]: b = load_cars()
Out[7]:

=================
 Id    |  types
=================
I      |    E
II     |    F
III    |    G

Well now both are implemented so I can push 2 options.

rgbkrk · 2017-05-30T17:15:37Z

Ok I'm totally going to set this in my personal defaults.

Carreau · 2017-05-30T21:33:13Z

Note, the current code will also not work if the LHS is an arbitrary assignment like a.b = 1

Carreau · 2017-05-30T23:11:22Z

So @fperez agree with the original proposal. I'm going to revert ca387c8

takluyver · 2017-05-31T11:12:01Z

docs/source/whatsnew/pr/interactive_assignment.rst

+you can now do::
+
+    In[2]: xyz = "something else"
+    "something else"


This example (and the second one above) should have an Out[2]: prompt, right?

Yes ! I s/>>>/In[1] stupidly.

Allow to display the result of the last assignment of it has a unique target.

Carreau · 2017-06-01T19:34:19Z

Now that 6.1 is released, I'm getting this in to play with it.

Carreau force-pushed the ast-interactivity branch from cc82cfc to 2e8d986 Compare May 24, 2017 19:24

rgbkrk reviewed May 24, 2017

View reviewed changes

Carreau requested review from ivanov and takluyver May 24, 2017 20:55

ssanderson reviewed May 24, 2017

View reviewed changes

Carreau force-pushed the ast-interactivity branch 2 times, most recently from 1f5d398 to 5260f5a Compare May 24, 2017 23:35

takluyver reviewed May 25, 2017

View reviewed changes

Carreau force-pushed the ast-interactivity branch 2 times, most recently from 435916a to faaa345 Compare May 25, 2017 18:06

takluyver reviewed May 26, 2017

View reviewed changes

Carreau modified the milestone: 6.2 May 29, 2017

Carreau force-pushed the ast-interactivity branch from faaa345 to 81a07e3 Compare May 29, 2017 21:28

Carreau force-pushed the ast-interactivity branch from ca387c8 to 81a07e3 Compare May 30, 2017 23:12

takluyver reviewed May 31, 2017

View reviewed changes

Carreau force-pushed the ast-interactivity branch from 81a07e3 to 2a668e5 Compare May 31, 2017 17:53

Add new interactivity mode for ast.

a137755

Allow to display the result of the last assignment of it has a unique target.

Carreau force-pushed the ast-interactivity branch from 2a668e5 to a137755 Compare May 31, 2017 17:53

Carreau merged commit beb08ba into ipython:master Jun 1, 2017

Carreau mentioned this pull request Jun 1, 2017

Update ast_interactivity for more complex assignments. #10633

Open

Carreau deleted the ast-interactivity branch July 20, 2017 22:20

ihnorton mentioned this pull request Jan 20, 2018

Support display of assignment result (for didactic resons) jupyter/notebook#93

Closed

stevengj mentioned this pull request Apr 16, 2018

do not show output for assignment? JuliaLang/IJulia.jl#649

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add new interactivity mode for ast. #10598

Add new interactivity mode for ast. #10598

Carreau commented May 24, 2017

Carreau commented May 24, 2017

rgbkrk May 24, 2017

Carreau May 24, 2017

rgbkrk commented May 24, 2017

rgbkrk commented May 24, 2017

Carreau commented May 24, 2017

ssanderson May 24, 2017

ssanderson May 24, 2017

Carreau May 24, 2017

ssanderson May 24, 2017

Carreau May 24, 2017

ssanderson May 24, 2017

ssanderson May 24, 2017

Carreau commented May 24, 2017

takluyver left a comment

takluyver May 25, 2017

Carreau May 25, 2017

takluyver May 25, 2017

Carreau May 25, 2017

takluyver May 26, 2017

Carreau May 29, 2017

Carreau commented May 29, 2017

Carreau commented May 29, 2017

takluyver commented May 30, 2017

Carreau commented May 30, 2017

rgbkrk commented May 30, 2017

Carreau commented May 30, 2017

Carreau commented May 30, 2017

takluyver May 31, 2017

Carreau May 31, 2017

Carreau commented Jun 1, 2017

Add new interactivity mode for ast. #10598

Add new interactivity mode for ast. #10598

Conversation

Carreau commented May 24, 2017

Carreau commented May 24, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rgbkrk commented May 24, 2017

rgbkrk commented May 24, 2017

Carreau commented May 24, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Carreau commented May 24, 2017

takluyver left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Carreau commented May 29, 2017

Carreau commented May 29, 2017

takluyver commented May 30, 2017

Carreau commented May 30, 2017

rgbkrk commented May 30, 2017

Carreau commented May 30, 2017

Carreau commented May 30, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Carreau commented Jun 1, 2017