User list of ipython, the enhanced interacitve Python shell

headers Tsviki Hirsh | 5 Jan 07:53 · /IPython/

_______________________________________________
IPython-user mailing list
IPython-user <at> scipy.org
http://mail.scipy.org/mailman/listinfo/ipython-user

On Mon, Jan 4, 2010 at 10:53 PM, Tsviki Hirsh <tsviki.hirsh <at> gmail.com> wrote:
> Dear list,
> The magic ? and ?? commands are among the most useful features in ipython
> (at least for me),
> I'm also using them to read my selfdocumentation on my own functions.
> Therefore I was surprised to learn that you cannot read the doc string of a
> decorated function using ? or ??
> for example, consider this decorator and function
>
> def deco(f):
> '''decorator docstring'''
> def _deco(*args,**kwargs):
> '''decorator inner function docstring'''
> print 'args=',args
> return f(*args,**kwargs)
> return _deco
> @deco
> def myfunc(x,y):
> '''function docstring'''
> return x+y
>
> if I try to call myfunc docstring using ? I get:
>
> In [18]: exem.myfunc?
> Type: function
> Base Class: <type 'function'>
> String Form: <function _deco at 0x868a5a4>
> Namespace: Interactive
> File: /home/tsviki/exem.py
> Definition: exem.myfunc(*args, **kwargs)
> Docstring:
>     decorator inner function docstring
>
> and if I try to call ??, it just gives me the decorator inner function.
> Is there a way to overlap this?
> linking the decorator __doc__ to myfunc.__doc__ won't help in case that I
> have several functions that use the same decorator.
> Any help?

hi,
decorate your decorator :)
http://pypi.python.org/pypi/decorator

i think something like:

from decorator import decorator

@decorator
def deco(f):
    '''decorator docstring'''
    @decorator
    def _deco(*args,**kwargs):
        '''decorator inner function docstring'''
        print 'args=',args
        return f(*args,**kwargs)
    return _deco

> Thanks a lot
> Tsviki Hirsh
>
> _______________________________________________
> IPython-user mailing list
> IPython-user <at> scipy.org
> http://mail.scipy.org/mailman/listinfo/ipython-user
>
>
_______________________________________________
IPython-user mailing list
IPython-user <at> scipy.org
http://mail.scipy.org/mailman/listinfo/ipython-user

_______________________________________________
IPython-user mailing list
IPython-user <at> scipy.org
http://mail.scipy.org/mailman/listinfo/ipython-user

_______________________________________________
IPython-user mailing list
IPython-user <at> scipy.org
http://mail.scipy.org/mailman/listinfo/ipython-user

Please help me get an embedded ipython console to run inside a doctest. The example code demonstrates the
problem and will hang your terminal. On bash shell I type ctrl-Z and then kill %1 to break out and kill, since
ctrl-C won't work.

def some_function():
    """
    >>> some_function()
    'someoutput'
    """
    # now try to drop into an ipython shell to help 
    # with development
    import IPython.Shell; IPython.Shell.IPShellEmbed(argv=[])()
    return 'someoutput'

if __name__ == '__main__':
    import doctest
    print "Running doctest . . ."
    doctest.testmod()

I like to use ipython to help write code. A common trick is to use ipython as a breakpoint in my code by calling
IPython.Shell.IPShellEmbed. This trick works everywhere I've tried (inside a django manage.py
runserver, unit tests), but it doesn't work within doctests. I think it has to do with doctest controlling stdin/stdout.

Thanks in advance for your help. 
- Philip

Hi Philip,

On Tue, Jan 5, 2010 at 11:25 PM, Philip Gatt <gattster <at> gmail.com> wrote:
> Please help me get an embedded ipython console to run inside a doctest. The example code demonstrates the
problem and will hang your terminal. On bash shell I type ctrl-Z and then kill %1 to break out and kill, since
ctrl-C won't work.
>
> def some_function():
>    """
>    >>> some_function()
>    'someoutput'
>    """
>    # now try to drop into an ipython shell to help
>    # with development
>    import IPython.Shell; IPython.Shell.IPShellEmbed(argv=[])()
>    return 'someoutput'
>
> if __name__ == '__main__':
>    import doctest
>    print "Running doctest . . ."
>    doctest.testmod()
>
> I like to use ipython to help write code. A common trick is to use ipython as a breakpoint in my code by calling
IPython.Shell.IPShellEmbed. This trick works everywhere I've tried (inside a django manage.py
runserver, unit tests), but it doesn't work within doctests. I think it has to do with doctest controlling stdin/stdout.
>
> Thanks in advance for your help.

Thanks for the report, it's now:
https://bugs.launchpad.net/ipython/+bug/503698

Here's a workaround you can use for now, just put this little subclass
in your utilities:

import sys

from IPython.Shell import IPShellEmbed

class IPShellDoctest(IPShellEmbed):
    def __call__(self, *a, **kw):
        sys_stdout_saved = sys.stdout
        sys.stdout = sys.stderr
        try:
            IPShellEmbed.__call__(self, *a, **kw)
        finally:
            sys.stdout = sys_stdout_saved

def some_function():
   """
   >>> some_function()
   'someoutput'
   """
   # now try to drop into an ipython shell to help
   # with development
   IPShellDoctest()()
   return 'someoutput'

if __name__ == '__main__':
   import doctest
   print "Running doctest . . ."
   doctest.testmod()

Awesome, thanks for the help. 

On Jan 5, 2010, at 11:48 PM, Fernando Perez wrote:

> Hi Philip,
> 
> On Tue, Jan 5, 2010 at 11:25 PM, Philip Gatt <gattster <at> gmail.com> wrote:
>> Please help me get an embedded ipython console to run inside a doctest. The example code demonstrates the
problem and will hang your terminal. On bash shell I type ctrl-Z and then kill %1 to break out and kill, since
ctrl-C won't work.
>> 
>> def some_function():
>>    """
>>    >>> some_function()
>>    'someoutput'
>>    """
>>    # now try to drop into an ipython shell to help
>>    # with development
>>    import IPython.Shell; IPython.Shell.IPShellEmbed(argv=[])()
>>    return 'someoutput'
>> 
>> if __name__ == '__main__':
>>    import doctest
>>    print "Running doctest . . ."
>>    doctest.testmod()
>> 
>> I like to use ipython to help write code. A common trick is to use ipython as a breakpoint in my code by
calling IPython.Shell.IPShellEmbed. This trick works everywhere I've tried (inside a django
manage.py runserver, unit tests), but it doesn't work within doctests. I think it has to do with doctest
controlling stdin/stdout.
>> 
>> Thanks in advance for your help.
> 
> Thanks for the report, it's now:
> https://bugs.launchpad.net/ipython/+bug/503698
> 
> 
> Here's a workaround you can use for now, just put this little subclass
> in your utilities:
> 
> import sys
> 
> from IPython.Shell import IPShellEmbed
> 
> class IPShellDoctest(IPShellEmbed):
>    def __call__(self, *a, **kw):
>        sys_stdout_saved = sys.stdout
>        sys.stdout = sys.stderr
>        try:
>            IPShellEmbed.__call__(self, *a, **kw)
>        finally:
>            sys.stdout = sys_stdout_saved
> 
> 
> def some_function():
>   """
>>>> some_function()
>   'someoutput'
>   """
>   # now try to drop into an ipython shell to help
>   # with development
>   IPShellDoctest()()
>   return 'someoutput'
> 
> if __name__ == '__main__':
>   import doctest
>   print "Running doctest . . ."
>   doctest.testmod()

I am having a surprising problem on ubuntu karmic (9.10) 32bit using
ipython 0.10 (same in the development branch BTW)   In the session
below, I type::

for i in  range(10):
    print i

relying on ipython to autoindent the print line for me -- this works
fine.  But if I then "up arrow" to recall the entire "for" block, the
block execution fails with an indentation error.  Something about
recalling the block from history is causing it to lose the proper
indentation.  This is something I do a lot (on other machines) and
have not seen this so it may be platform/version specific.

msierig <at> pinchiepie:~> ipython
Python 2.6.4 (r264:75706, Dec  7 2009, 18:45:15)
Type "copyright", "credits" or "license" for more information.

IPython 0.10 -- An enhanced Interactive Python.
?         -> Introduction and overview of IPython's features.
%quickref -> Quick reference.
help      -> Python's own help system.
object?   -> Details about 'object'. ?object also works, ?? prints more.

In [1]: for i in range(10):
   ...:     print i
   ...:
   ...:
0
1
2
3
4
5
6
7
8
9

# this input clock came from readline history
In [2]: for i in range(10):
    print i
------> print(i)
------------------------------------------------------------
IndentationError: expected an indented block (<ipython console>, line 2)

In [4]: import IPython

In [5]: print IPython.__file__
------> print(IPython.__file__)
/usr/lib/pymodules/python2.6/IPython/__init__.pyc

In [6]:

On Sun, Jan 10, 2010 at 7:04 PM, John Hunter <jdh2358 <at> gmail.com> wrote:
> I am having a surprising problem on ubuntu karmic (9.10) 32bit using
> ipython 0.10 (same in the development branch BTW)   In the session
> below, I type::
>
> for i in  range(10):
>    print i
>
> relying on ipython to autoindent the print line for me -- this works
> fine.  But if I then "up arrow" to recall the entire "for" block, the
> block execution fails with an indentation error.  Something about
> recalling the block from history is causing it to lose the proper
> indentation.  This is something I do a lot (on other machines) and
> have not seen this so it may be platform/version specific.

It's this stupid problem:

https://bugs.launchpad.net/ipython/+bug/414967

Your options:

- disable autocall permanently

- start using the future print_function and print() everywhere (except
for single-lines, where autocall works for you)

Here, on dev-branch:

In [2]: for i in range(10):
    print i,
------> print(i,)
------------------------------------------------------------
IndentationError: expected an indented block (<ipython console>, line 2)

In [4]: autocall 0
Automatic calling is: OFF

# now it's ok:
In [5]: for i in range(10):
    print i,
   ...:
0 1 2 3 4 5 6 7 8 9

Since we'll have to get used to print() anyway, might as well do it early...

Cheers,

f

> Your options:
>
> - disable autocall permanently
>
> - start using the future print_function and print() everywhere (except
> for single-lines, where autocall works for you)

Or, update to trunk-dev as soon as I commit :) Fixed:

In [1]: for i in range(10):
   ...:     print i,
   ...:
0 1 2 3 4 5 6 7 8 9

In [2]: for i in range(10):
    print i,
   ...:
0 1 2 3 4 5 6 7 8 9

#####

I'll ping when it's committed so you can pull.  I'm afraid I may not
backport this to 0.10.1, at least not right away (no time, I'll take
patches if anyone does the backport, but that part of the code is
substantially rewritten so it's not a simple copy/paste).

Cheers,

f

Mon	Tue	Wed	Thu	Fri	Sat	Sun

				1	2	3
4	5	6	7	8	9	10
11	12	13	14	15	16	17
18	19	20	21	22	23	24
25	26	27	28	29	30	31

82	February 2012
423	January 2012
174	December 2011
76	November 2011
187	October 2011
156	September 2011
324	August 2011
185	July 2011
157	June 2011
113	May 2011
102	April 2011
75	March 2011
31	February 2011
36	January 2011
51	December 2010
41	November 2010
48	October 2010
78	September 2010
60	August 2010
62	July 2010
29	June 2010
45	May 2010
11	April 2010
38	March 2010
38	February 2010
56	January 2010
49	December 2009
39	November 2009
61	October 2009
56	September 2009
53	August 2009
64	July 2009
26	June 2009
68	May 2009
63	April 2009
71	March 2009
73	February 2009
31	January 2009
79	December 2008
89	November 2008
78	October 2008
119	September 2008
77	August 2008
86	July 2008
131	June 2008
68	May 2008
74	April 2008
134	March 2008
80	February 2008
183	January 2008
63	December 2007
93	November 2007
46	October 2007
62	September 2007
124	August 2007
14	July 2007
30	June 2007
142	May 2007
104	April 2007
108	March 2007
65	February 2007
72	January 2007
94	December 2006
74	November 2006
72	October 2006
40	September 2006
16	August 2006
11	July 2006
118	June 2006
86	May 2006
37	April 2006
87	March 2006
59	February 2006
209	January 2006
82	December 2005
21	November 2005
44	October 2005
47	September 2005
57	August 2005
57	July 2005
69	June 2005
35	May 2005
46	April 2005
77	March 2005
64	February 2005
52	January 2005
39	December 2004
18	November 2004
41	October 2004
66	September 2004
16	August 2004
13	July 2004
67	June 2004
47	May 2004
20	April 2004
50	March 2004
5	February 2004
9	January 2004
15	December 2003
3	November 2003
12	October 2003
5	September 2003
17	August 2003
11	July 2003
15	June 2003
29	May 2003
48	April 2003

docstring of decorated functions

Re: docstring of decorated functions

Re: docstring of decorated functions

Re: docstring of decorated functions

How to use ipython's IPShellEmbed from within a running doctest

Re: How to use ipython's IPShellEmbed from within a running doctest

Re: How to use ipython's IPShellEmbed from within a running doctest

recalling indented blocks -- strange bug

Re: recalling indented blocks -- strange bug

Re: recalling indented blocks -- strange bug