FilesExpand file tree

 master

/

builtin_trap.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

114 lines (95 loc) · 4.18 KB

 master

/

builtin_trap.py

Copy path

Top

File metadata and controls

• Code
• Blame

114 lines (95 loc) · 4.18 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

"""

A context manager for managing things injected into :mod:`__builtin__`.

Authors:

* Brian Granger

* Fernando Perez

"""

#-----------------------------------------------------------------------------

# Copyright (C) 2010-2011 The IPython Development Team.

#

# Distributed under the terms of the BSD License.

#

# Complete license in the file COPYING.txt, distributed with this software.

#-----------------------------------------------------------------------------

#-----------------------------------------------------------------------------

# Imports

#-----------------------------------------------------------------------------

from traitlets.config.configurable import Configurable

from IPython.utils.py3compat import builtin_mod, iteritems

from traitlets import Instance

#-----------------------------------------------------------------------------

# Classes and functions

#-----------------------------------------------------------------------------

class __BuiltinUndefined(object): pass

BuiltinUndefined = __BuiltinUndefined()

class __HideBuiltin(object): pass

HideBuiltin = __HideBuiltin()

class BuiltinTrap(Configurable):

shell = Instance('IPython.core.interactiveshell.InteractiveShellABC',

allow_none=True)

def __init__(self, shell=None):

super(BuiltinTrap, self).__init__(shell=shell, config=None)

self._orig_builtins = {}

# We define this to track if a single BuiltinTrap is nested.

# Only turn off the trap when the outermost call to __exit__ is made.

self._nested_level = 0

self.shell = shell

# builtins we always add - if set to HideBuiltin, they will just

# be removed instead of being replaced by something else

self.auto_builtins = {'exit': HideBuiltin,

'quit': HideBuiltin,

'get_ipython': self.shell.get_ipython,

}

# Recursive reload function

try:

from IPython.lib import deepreload

if self.shell.deep_reload:

from warnings import warn

warn("Automatically replacing builtin `reload` by `deepreload.reload` is deprecated and will be removed in IPython 6.0, please import `reload` explicitly from `IPython.lib.deeprelaod", DeprecationWarning)

self.auto_builtins['reload'] = deepreload._dreload

else:

self.auto_builtins['dreload']= deepreload._dreload

except ImportError:

pass

def __enter__(self):

if self._nested_level == 0:

self.activate()

self._nested_level += 1

# I return self, so callers can use add_builtin in a with clause.

return self

def __exit__(self, type, value, traceback):

if self._nested_level == 1:

self.deactivate()

self._nested_level -= 1

# Returning False will cause exceptions to propagate

return False

def add_builtin(self, key, value):

"""Add a builtin and save the original."""

bdict = builtin_mod.__dict__

orig = bdict.get(key, BuiltinUndefined)

if value is HideBuiltin:

if orig is not BuiltinUndefined: #same as 'key in bdict'

self._orig_builtins[key] = orig

del bdict[key]

else:

self._orig_builtins[key] = orig

bdict[key] = value

def remove_builtin(self, key, orig):

"""Remove an added builtin and re-set the original."""

if orig is BuiltinUndefined:

del builtin_mod.__dict__[key]

else:

builtin_mod.__dict__[key] = orig

def activate(self):

"""Store ipython references in the __builtin__ namespace."""

add_builtin = self.add_builtin

for name, func in iteritems(self.auto_builtins):

add_builtin(name, func)

def deactivate(self):

"""Remove any builtins which might have been added by add_builtins, or

restore overwritten ones to their previous values."""

remove_builtin = self.remove_builtin

for key, val in iteritems(self._orig_builtins):

remove_builtin(key, val)

self._orig_builtins.clear()

self._builtins_added = False