aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/python/ipython/py3/IPython/core/macro.py
blob: 1fc2df2db408bd32060b7d6f1be6aead0132119a (plain) (blame)
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
"""Support for interactive macros in IPython""" 
 
#***************************************************************************** 
#       Copyright (C) 2001-2005 Fernando Perez <fperez@colorado.edu> 
# 
#  Distributed under the terms of the BSD License.  The full license is in 
#  the file COPYING, distributed as part of this software. 
#***************************************************************************** 
 
import re 
 
from IPython.utils.encoding import DEFAULT_ENCODING 
 
coding_declaration = re.compile(r"#\s*coding[:=]\s*([-\w.]+)") 
 
class Macro(object): 
    """Simple class to store the value of macros as strings. 
 
    Macro is just a callable that executes a string of IPython 
    input when called. 
    """ 
 
    def __init__(self,code): 
        """store the macro value, as a single string which can be executed""" 
        lines = [] 
        enc = None 
        for line in code.splitlines(): 
            coding_match = coding_declaration.match(line) 
            if coding_match: 
                enc = coding_match.group(1) 
            else: 
                lines.append(line) 
        code = "\n".join(lines) 
        if isinstance(code, bytes): 
            code = code.decode(enc or DEFAULT_ENCODING) 
        self.value = code + '\n' 
     
    def __str__(self): 
        return self.value 
 
    def __repr__(self): 
        return 'IPython.macro.Macro(%s)' % repr(self.value) 
     
    def __getstate__(self): 
        """ needed for safe pickling via %store """ 
        return {'value': self.value} 
     
    def __add__(self, other): 
        if isinstance(other, Macro): 
            return Macro(self.value + other.value) 
        elif isinstance(other, str): 
            return Macro(self.value + other) 
        raise TypeError