zhangyiss/spack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Support VISUAL environment variable for editing. (#10898)

Browse Source 
If the user has set the environment variable VISUAL, it will be used
in preference to EDITOR for all Spack editing activities. If VISUAL
is not set or fails (perhaps due to a lack of graphical editing
capabilities),EDITOR will be used instead. We fall back to one of
several common editors if neither bears fruit.

This feature has been tailored to:

* Provide identical behavior to the previous implementation in the
  case that VISUAL is not set.
* Not require any change to code utilizing the editor feature.
* Follow usual UNIX behavior concerning VISUAL and EDITOR.
This commit is contained in:
Chris Green 2019-03-14 16:16:26 -05:00 committed by Peter Scheibel
parent 1d73868333
commit 9b51fb09f1
1 changed files with 26 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
lib/spack/spack/util/editor.py
View File

@ -5,31 +5,37 @@
"""Module for finding the user's preferred text editor. """Module for finding the user's preferred text editor.
Defines one variable: ``editor``, which is a Defines one function, editor(), which invokes the editor defined by the
``spack.util.executable.Executable`` object that can be called to invoke user's VISUAL environment variable if set. We fall back to the editor
the editor. defined by the EDITOR environment variable if VISUAL is not set or the
specified editor fails (e.g. no DISPLAY for a graphical editor). If
If no ``editor`` is found, an ``EnvironmentError`` is raised when neither variable is set, we fall back to one of several common editors,
``editor`` is invoked. raising an EnvironmentError if we are unable to find one.
""" """
import copy
import os import os
from spack.util.executable import Executable, which from spack.util.executable import Executable, which
# Set up the user's editor _visual_exe\
# $EDITOR environment variable has the highest precedence = Executable(os.environ['VISUAL']) if 'VISUAL' in os.environ else None
editor = os.environ.get('EDITOR') _editor_exe\
= Executable(os.environ['EDITOR']) \
if 'EDITOR' in os.environ else which('vim', 'vi', 'emacs', 'nano')
# if editor is not set, use some sensible defaults
if editor is not None:
editor = Executable(editor)
else:
editor = which('vim', 'vi', 'emacs', 'nano')
# If there is no editor, only raise an error if we actually try to use it. # Invoke the user's editor.
if not editor: def editor(*args, **kwargs):
def editor_not_found(*args, **kwargs): if _visual_exe:
visual_kwargs = copy.copy(kwargs)
visual_kwargs['fail_on_error'] = False
_visual_exe(*args, **visual_kwargs)
if _visual_exe.returncode == 0:
return # Otherwise, fall back to EDITOR.
if _editor_exe:
_editor_exe(*args, **kwargs)
else:
raise EnvironmentError( raise EnvironmentError(
'No text editor found! Please set the EDITOR environment variable ' 'No text editor found! Please set the VISUAL and/or EDITOR '
'to your preferred text editor.') 'environment variable(s) to your preferred text editor.')
editor = editor_not_found