Module:core.magics.auto

Implementation of magic functions that control various automatic behaviors.

1 Class

classIPython.core.magics.auto.AutoMagics(**kwargs:Any)

Bases:Magics

Magics that control various autoX behaviors.

__init__(shell)

Create a configurable given a config config.

Parameters:
  • config (Config) – If this is empty, default values are used. If config is aConfig instance, it will be used to configure theinstance.

  • parent (Configurable instance,optional) – The parent Configurable instance of this object.

Notes

Subclasses of Configurable must call the__init__() method ofConfigurablebefore doing anything else and usingsuper():

classMyConfigurable(Configurable):def__init__(self,config=None):super(MyConfigurable,self).__init__(config=config)# Then any other code you need to finish initialization.

This ensures that instances will be configured properly.

autocall(parameter_s='')

Make functions callable without having to type parentheses.

Usage:

%autocall [mode]

The mode can be one of: 0->Off, 1->Smart, 2->Full. If not given, thevalue is toggled on and off (remembering the previous state).

In more detail, these values mean:

0 -> fully disabled

1 -> active, but do not apply if there are no arguments on the line.

In this mode, you get:

In[1]:callableOut[1]:<built-infunctioncallable>In[2]:callable'hello'------>callable('hello')Out[2]:False

2 -> Active always. Even if no arguments are present, the callableobject is called:

In[2]:float------>float()Out[2]:0.0

Note that even with autocall off, you can still use ‘/’ at the start ofa line to treat the first argument on the command line as a functionand add parentheses to it:

In[8]:/str43------>str(43)Out[8]:'43'

# all-random (note for auto-testing)

automagic(parameter_s='')

Make magic functions callable without having to type the initial %.

Without arguments toggles on/off (when off, you must call it as%automagic, of course). With arguments it sets the value, and you canuse any of (case insensitive):

  • on, 1, True: to activate

  • off, 0, False: to deactivate.

Note that magic functions have lowest priority, so if there’s avariable whose name collides with that of a magic fn, automagic won’twork for that function (you get the variable instead). However, if youdelete the variable (del var), the previously shadowed magic functionbecomes visible to automagic again.