Make git-cl more accurately imitate git's editor selection process, and respect $VISUAL.

gclient_utils.py

 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """Generic utils."""
 
 import codecs
 import logging
 import os
 import Queue
@@ skipping 660 matching lines @@
         work_queue.exceptions.put(sys.exc_info())
       logging.info('_Worker.run(%s) done' % self.item.name)
 
       work_queue.ready_cond.acquire()
       try:
         work_queue.ready_cond.notifyAll()
       finally:
         work_queue.ready_cond.release()
 
 
-def GetEditor(git):
-  """Returns the most plausible editor to use."""
+def GetEditor(git, git_editor=None):
+  """Returns the most plausible editor to use.
+
+  In order of preference:
+  - GIT_EDITOR/SVN_EDITOR environment variable
+  - core.editor git configuration variable (if supplied by git-cl)
+  - VISUAL environment variable
+  - EDITOR environment variable
+  - vim (non-Windows) or notepad (Windows)
+
+  In the case of git-cl, this matches git's behaviour, except that it does not
+  include dumb terminal detection.
+
+  In the case of gcl, this matches svn's behaviour, except that it does not
+  accept a command-line flag or check the editor-cmd configuration variable.
+  """
   if git:
-    editor = os.environ.get('GIT_EDITOR')
+    editor = os.environ.get('GIT_EDITOR') or git_editor
   else:
     editor = os.environ.get('SVN_EDITOR')
   if not editor:
+    editor = os.environ.get('VISUAL')
+  if not editor:
     editor = os.environ.get('EDITOR')
   if not editor:
     if sys.platform.startswith('win'):
       editor = 'notepad'
     else:
       editor = 'vim'
   return editor
 
 
-def RunEditor(content, git):
+def RunEditor(content, git, git_editor=None):
   """Opens up the default editor in the system to get the CL description."""
   file_handle, filename = tempfile.mkstemp(text=True)
   # Make sure CRLF is handled properly by requiring none.
   if '\r' in content:
     print >> sys.stderr, (
         '!! Please remove \\r from your change description !!')
   fileobj = os.fdopen(file_handle, 'w')
   # Still remove \r if present.
   fileobj.write(re.sub('\r?\n', '\n', content))
   fileobj.close()
 
   try:
-    cmd = '%s %s' % (GetEditor(git), filename)
+    editor = GetEditor(git, git_editor=git_editor)
+    if not editor:
+      return None
+    cmd = '%s %s' % (editor, filename)
     if sys.platform == 'win32' and os.environ.get('TERM') == 'msys':
       # Msysgit requires the usage of 'env' to be present.
       cmd = 'env ' + cmd
     try:
       # shell=True to allow the shell to handle all forms of quotes in
       # $EDITOR.
       subprocess2.check_call(cmd, shell=True)
     except subprocess2.CalledProcessError:
       return None
     return FileRead(filename)
@@ skipping 43 matching lines @@
 
   Python on OSX 10.6 raises a NotImplementedError exception.
   """
   try:
     import multiprocessing
     return multiprocessing.cpu_count()
   except:  # pylint: disable=W0702
     # Mac OS 10.6 only
     # pylint: disable=E1101
     return int(os.sysconf('SC_NPROCESSORS_ONLN'))