%load -s to load specific functions or classes #4311

mgaitan · 2013-09-30T16:39:41Z

This PR adds the optional parameter -s to the magic %load that loads specific function or classes from the python source given. It's a complementary option to #4295.

A simple demo could be seen here http://nbviewer.ipython.org/6766501

… function or classes from the python source given. forcing the patch ignoring whitespace changes

takluyver · 2013-09-30T17:09:21Z

Nice! I think there are cases where the end-of-block finding could go wrong, but they probably won't be a big problem in practice.

Carreau · 2013-09-30T17:10:44Z

travis is angry though :

Exception raised:
    Traceback (most recent call last):
      File "/usr/lib/python2.7/doctest.py", line 1289, in __run
        compileflags, 1) in test.globs
      File "<doctest IPython.core.magics.code.extract_symbols[0]>", line 1
        extract_symbols(code, 'A,b'):
                                    ^
    SyntaxError: invalid syntax

takluyver · 2013-09-30T17:12:11Z

IPython/core/magics/code.py

+    code = code.split('\n')
+    for symbol in symbols.split(','):
+        if symbol in symbols_lines:
+            blocks.append('\n'.join(code[slice(*symbols_lines[symbol])]))


I think this would be clearer broken up into a couple of lines. E.g.

start, end = symbols_lines[symbol] blocks.append('\n'.join(code[start:end])

Also, a few lines of spacing and explanatory comments wouldn't go amiss throughout the function.

right, simple is better than complex :)

Carreau · 2013-09-30T17:13:31Z

Can some code be shared with ?? (%pinfo) which already extract code IIRC ?

takluyver · 2013-09-30T17:20:05Z

That's finding the code for objects that are already loaded. We could run the module first, but that might have unwanted side effects.

However, it does use inspect.getblock() to find the end of blocks - that might be worth a look if we feel we need a better to find the end of a definition.

damianavila · 2013-09-30T17:30:49Z

Good idea! I am agree with the comments adressed by @takluyver regarding spacing and explanatory comments.

mgaitan · 2013-09-30T19:17:20Z

On mgaitan/ipython@04432cc I've refactor the symbol parser function to get a better end. Previous version set that to the line were the next symbol begin - 1, but that could include many empty lines

I've also updated the demo to show this http://nbviewer.ipython.org/6766501

Carreau · 2013-10-06T10:17:32Z

That looks really awesome.
I'm in favor in merging soon to get feedback.

minrk · 2013-10-06T19:51:31Z

IPython/core/magics/code.py

@@ -239,6 +288,9 @@ def load(self, arg_s):

        contents = self.shell.find_user_code(args)

+        if 's' in opts:
+            contents = '\n'.join(extract_symbols(contents, opts['s']))


There should be a message if any symbols are not found, maybe even an error.

done in mgaitan/ipython@7391345

takluyver · 2013-10-07T22:50:20Z

IPython/core/magics/code.py

+
+    # construct a dictionary with elements
+    # {'symbol_name': (start_lineno, end_lineno), ...}
+    end = len(code)


Another quick comment on this line, please - something like "step backwards to a non-blank line". It just took me a minute to work it out.

takluyver · 2013-10-07T22:59:36Z

This looks good. Apart from those couple of minor points, I'm in agreement with Matthias about merging this soon.

ellisonbg · 2013-10-09T20:05:42Z

I too am strongly +1 on this one. Is it ready to go?

mgaitan · 2013-10-09T20:11:51Z

On Wed, Oct 9, 2013 at 5:05 PM, Brian E. Granger
notifications@github.comwrote:

Is it ready to go?

I think so :)

btw, thanks for all the feedback guys.

mgaitan · 2013-10-09T20:21:01Z

Just, one question . On mgaitan/ipython@f7cd9ed I've catch a bug introduced in mgaitan/ipython@7391345 . But that involves a design decision: When -s is used with non-python code, should warn "The symbols x,y... were not found" or something more specific like "Unable to parse as python ..." ?

in any case, if no symbol were found (because the input isn't python or the symbol/s is/are not present) should the empty cell be inserted anyway?

ellisonbg · 2013-10-09T20:27:08Z

I think it should say something like "Unable to parse the file as Python..." and not insert the empty cell of the input file is not valid Python. Good catch.

damianavila · 2013-10-09T20:39:35Z

I agree with @ellisonbg...

mgaitan · 2013-10-09T20:53:19Z

Ok, done.

ellisonbg · 2013-10-09T21:08:02Z

Great, thanks.

%load -s to load specific functions or classes

adds the optional parameter -s to the magic %load that loads specific…

c88200d

… function or classes from the python source given. forcing the patch ignoring whitespace changes

takluyver reviewed Sep 30, 2013
View reviewed changes

mgaitan added 3 commits September 30, 2013 15:15

skip doctests. comments on the function

adff808

fix docstring

8f03d11

better end block detection, ignoring blank lines

04432cc

add extra blank lines on the test to proof they are ignored

73c1ae4

minrk reviewed Oct 6, 2013
View reviewed changes

mgaitan added 2 commits October 7, 2013 09:43

adding get_text_list helper inspired in django's one

348e90f

As @minrk recommends, warning if one or more symbol are not found

7391345

takluyver reviewed Oct 7, 2013
View reviewed changes

mgaitan and others added 3 commits October 7, 2013 20:21

generalizing get_text_list helper

3ced24d

better comment for the algorithm

94fd6a9

bugfix. parse of non python code returns a tuple as expected

f7cd9ed

return an specific error for non python

f243434

ellisonbg added a commit that referenced this pull request Oct 9, 2013

Merge pull request #4311 from mgaitan/load_symbol_extractor

446be78

%load -s to load specific functions or classes

ellisonbg merged commit 446be78 into ipython:master Oct 9, 2013

mgaitan deleted the load_symbol_extractor branch October 9, 2013 21:10

mattvonrocketstein pushed a commit to mattvonrocketstein/ipython that referenced this pull request Nov 3, 2014

Merge pull request ipython#4311 from mgaitan/load_symbol_extractor

3ffcb7b

%load -s to load specific functions or classes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

%load -s to load specific functions or classes #4311

%load -s to load specific functions or classes #4311

mgaitan commented Sep 30, 2013

takluyver commented Sep 30, 2013

Carreau commented Sep 30, 2013

takluyver Sep 30, 2013

mgaitan Sep 30, 2013

Carreau commented Sep 30, 2013

takluyver commented Sep 30, 2013

damianavila commented Sep 30, 2013

mgaitan commented Sep 30, 2013

Carreau commented Oct 6, 2013

minrk Oct 6, 2013

mgaitan Oct 7, 2013

takluyver Oct 7, 2013

takluyver commented Oct 7, 2013

ellisonbg commented Oct 9, 2013

mgaitan commented Oct 9, 2013

mgaitan commented Oct 9, 2013

ellisonbg commented Oct 9, 2013

damianavila commented Oct 9, 2013

mgaitan commented Oct 9, 2013

ellisonbg commented Oct 9, 2013

%load -s to load specific functions or classes #4311

%load -s to load specific functions or classes #4311

Conversation

mgaitan commented Sep 30, 2013

takluyver commented Sep 30, 2013

Carreau commented Sep 30, 2013

takluyver Sep 30, 2013

Choose a reason for hiding this comment

mgaitan Sep 30, 2013

Choose a reason for hiding this comment

Carreau commented Sep 30, 2013

takluyver commented Sep 30, 2013

damianavila commented Sep 30, 2013

mgaitan commented Sep 30, 2013

Carreau commented Oct 6, 2013

minrk Oct 6, 2013

Choose a reason for hiding this comment

mgaitan Oct 7, 2013

Choose a reason for hiding this comment

takluyver Oct 7, 2013

Choose a reason for hiding this comment

takluyver commented Oct 7, 2013

ellisonbg commented Oct 9, 2013

mgaitan commented Oct 9, 2013

mgaitan commented Oct 9, 2013

ellisonbg commented Oct 9, 2013

damianavila commented Oct 9, 2013

mgaitan commented Oct 9, 2013

ellisonbg commented Oct 9, 2013