5

I want to replicate the functionality that happens when you do something like 'git commit'. It opens up your editor and you type some stuff and then save/exit to hand off that file back to the script that launched the editor.

How would I implement this functionality in Python?

EDIT:

Thanks for the suggestions, here's a working example based on the answers:

import os, subprocess, tempfile

(fd, path) = tempfile.mkstemp()
fp = os.fdopen(fd, 'w')
fp.write('default')
fp.close()

editor = os.getenv('EDITOR', 'vi')
print(editor, path)
subprocess.call('%s %s' % (editor, path), shell=True)

with open(path, 'r') as f:
  print(f.read())

os.unlink(path)
Scott Frazer
  • 2,145
  • 2
  • 23
  • 36

5 Answers5

4

The usual case is to:

  1. Create a temporary file, write default contents to it
  2. Launch the command stored in the environment variable "EDITOR". This usually is a shell command, so it might contain arguments -> run it thourgh the shell or parse it accordingly
  3. Once the process terminates, read back temporary file
  4. Remove temporary file

So something like this:

import os, subprocess, tempfile
f, fname = tempfile.mkstemp()
f.write('default')
f.close()
cmd = os.environ.get('EDITOR', 'vi') + ' ' + fname
subprocess.call(cmd, shell=True)
with open(fname, 'r') as f:
    #read file
os.unlink(fname)
Nils Ziehn
  • 4,118
  • 6
  • 26
  • 40
mensi
  • 9,580
  • 2
  • 34
  • 43
  • 1
    You may want to check the returncode of the subprocess.call to ensure that the user has not terminated the process. `returncode = subprocess.call(cmd, shell = True)` followed by checking if it is == 0 – Kannan Ekanath Apr 16 '14 at 11:02
  • I get `AttributeError: 'int' object has no attribute 'write'` at line `f.write('default')`. A better use of `tempfile.mkstemp` seems to be there: https://www.logilab.org/blogentry/17873 – Cédric Van Rompay Jul 19 '16 at 12:48
1

Save the text data you intend to be modified to a temporary file, open the editor (vi) as an external process pointing to that file, using os.system - or subprocess.Popen if you need more control over it, and read the temporary file back.

I'd advise you to open vi by default, but respect the contents of the "VISUAL" environment variable.

import os

name = os.tmpnam()
editor = "vi" if not ["VISUAL"] in os.environ else os.environ["VISUAL"]
os.system("%s %s" % (editor, name))
data = open(name).read()
os.unlink(name)
jsbueno
  • 99,910
  • 10
  • 151
  • 209
0
os.system("\bin\vi %s"%filename)

ftxt = open(filename,"r").read()
Joran Beasley
  • 110,522
  • 12
  • 160
  • 179
0

Install ipython and look at the %ed command. See also other suggestions in this similar question

Community
  • 1
  • 1
Doug Harris
  • 3,169
  • 5
  • 29
  • 31
0

One way to implement this is using subprocess. The code would looks something like this:

import subprocess
subprocess.call(['vi', 'filename.txt'])

The return from this will give the return status of vi.

angusiguess
  • 639
  • 5
  • 11