FilesExpand file tree

 master

/

editorhooks.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

122 lines (88 loc) · 3.69 KB

 master

/

editorhooks.py

Copy path

Top

File metadata and controls

• Code
• Blame

122 lines (88 loc) · 3.69 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

115

116

117

118

119

120

121

122

""" 'editor' hooks for common editors that work well with ipython

They should honor the line number argument, at least.

Contributions are *very* welcome.

"""

import os

import pipes

import subprocess

from IPython import get_ipython

from IPython.core.error import TryNext

def install_editor(template, wait=False):

"""Installs the editor that is called by IPython for the %edit magic.

This overrides the default editor, which is generally set by your EDITOR

environment variable or is notepad (windows) or vi (linux). By supplying a

template string `run_template`, you can control how the editor is invoked

by IPython -- (e.g. the format in which it accepts command line options)

Parameters

----------

template : basestring

run_template acts as a template for how your editor is invoked by

the shell. It should contain '{filename}', which will be replaced on

invokation with the file name, and '{line}', $line by line number

(or 0) to invoke the file with.

wait : bool

If `wait` is true, wait until the user presses enter before returning,

to facilitate non-blocking editors that exit immediately after

the call.

"""

# not all editors support $line, so we'll leave out this check

# for substitution in ['$file', '$line']:

# if not substitution in run_template:

# raise ValueError(('run_template should contain %s'

# ' for string substitution. You supplied "%s"' % (substitution,

# run_template)))

def call_editor(self, filename, line=0):

if line is None:

line = 0

cmd = template.format(filename=pipes.quote(filename), line=line)

print ">", cmd

proc = subprocess.Popen(cmd, shell=True)

if wait and proc.wait() != 0:

raise TryNext()

if wait:

raw_input("Press Enter when done editing:")

get_ipython().set_hook('editor', call_editor)

get_ipython().editor = template

# in these, exe is always the path/name of the executable. Useful

# if you don't have the editor directory in your path

def komodo(exe=u'komodo'):

""" Activestate Komodo [Edit] """

install_editor(exe + u' -l {line} {filename}', wait=True)

def scite(exe=u"scite"):

""" SciTE or Sc1 """

install_editor(exe + u' {filename} -goto:{line}')

def notepadplusplus(exe=u'notepad++'):

""" Notepad++ http://notepad-plus.sourceforge.net """

install_editor(exe + u' -n{line} {filename}')

def jed(exe=u'jed'):

""" JED, the lightweight emacsish editor """

install_editor(exe + u' +{line} {filename}')

def idle(exe=u'idle'):

""" Idle, the editor bundled with python

Parameters

----------

exe : str, None

If none, should be pretty smart about finding the executable.

"""

if exe is None:

import idlelib

p = os.path.dirname(idlelib.__filename__)

# i'm not sure if this actually works. Is this idle.py script

# guarenteed to be executable?

exe = os.path.join(p, 'idle.py')

install_editor(exe + u' {filename}')

def mate(exe=u'mate'):

""" TextMate, the missing editor"""

# wait=True is not required since we're using the -w flag to mate

install_editor(exe + u' -w -l {line} {filename}')

# ##########################################

# these are untested, report any problems

# ##########################################

def emacs(exe=u'emacs'):

install_editor(exe + u' +{line} {filename}')

def gnuclient(exe=u'gnuclient'):

install_editor(exe + u' -nw +{line} {filename}')

def crimson_editor(exe=u'cedt.exe'):

install_editor(exe + u' /L:{line} {filename}')

def kate(exe=u'kate'):

install_editor(exe + u' -u -l {line} {filename}')