Merge pull request #25 from CITGuru/dev

Dev

Author: CITGuru

.vscode/settings.json

@@ -1,3 +1,3 @@
 {
-    "python.pythonPath": "/usr/bin/python"
+    "python.pythonPath": "/home/oyetoke/.virtualenvs/PyInquirer/bin/python"
 }

PyInquirer/prompt.py

@@ -63,7 +63,7 @@ def prompt(questions, answers=None, **kwargs):
 
             if callable(question.get('default')):
                 _kwargs['default'] = question['default'](answers)
-
+            
             application = getattr(prompts, type).question(message, **_kwargs)
 
             answer = run_application(

PyInquirer/prompts/editor.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-`input` type question
+`editor` type question
 """
 from __future__ import print_function, unicode_literals
 import os
@@ -12,21 +12,24 @@
 
 from .common import default_style
 
+
 # use std prompt-toolkit control
 
 WIN = sys.platform.startswith('win')
 
+class EditorArgumentsError(Exception):
+    pass
+
 class Editor(object):
 
-    def __init__(self, editor=None, env=None, require_save=True,
-                 extension='.txt'):
+    def __init__(self, editor=None, env=None, require_save=True, extension='.txt'):
         self.editor = editor
         self.env = env
         self.require_save = require_save
         self.extension = extension
 
     def get_editor(self):
-        if self.editor is not None:
+        if self.editor is not None and self.editor.lower() != "default":
             return self.editor
         for key in 'VISUAL', 'EDITOR':
             rv = os.environ.get(key)
@@ -92,10 +95,45 @@ def edit(self, text):
         finally:
             os.unlink(name)
 
-
+def edit(text=None, editor=None, env=None, require_save=True,
+         extension='.txt', filename=None):
+    r"""Edits the given text in the defined editor.  If an editor is given
+    (should be the full path to the executable but the regular operating
+    system search path is used for finding the executable) it overrides
+    the detected editor.  Optionally, some environment variables can be
+    used.  If the editor is closed without changes, `None` is returned.  In
+    case a file is edited directly the return value is always `None` and
+    `require_save` and `extension` are ignored.
+
+    If the editor cannot be opened a :exc:`UsageError` is raised.
+
+    Note for Windows: to simplify cross-platform usage, the newlines are
+    automatically converted from POSIX to Windows and vice versa.  As such,
+    the message here will have ``\n`` as newline markers.
+
+    :param text: the text to edit.
+    :param editor: optionally the editor to use.  Defaults to automatic
+                   detection.
+    :param env: environment variables to forward to the editor.
+    :param require_save: if this is true, then not saving in the editor
+                         will make the return value become `None`.
+    :param extension: the extension to tell the editor about.  This defaults
+                      to `.txt` but changing this might change syntax
+                      highlighting.
+    :param filename: if provided it will edit this file instead of the
+                     provided text contents.  It will not use a temporary
+                     file as an indirection in that case.
+    """
+
+    editor = Editor(editor=editor, env=env, require_save=require_save,
+                    extension=extension)
+    if filename is None:
+        return editor.edit(text)
+    editor.edit_file(filename)
 
 def question(message, **kwargs):
     default = kwargs.pop('default', '')
+    eargs = kwargs.pop('eargs', {})
     validate_prompt = kwargs.pop('validate', None)
     if validate_prompt:
         if issubclass(validate_prompt, Validator):
@@ -112,11 +150,38 @@ def validate(self, document):
                             cursor_position=len(document.text))
             kwargs['validator'] = _InputValidator()
 
+    for k, v in eargs.items():
+        if v == "" or v == " ":
+            raise EditorArgumentsError(
+                "Args '{}' value should not be empty".format(k)
+            )
+    
+    editor = eargs.get("editor", None)
+    ext = eargs.get("ext", ".txt")
+    env = eargs.get("env", None)
+    text = default
+    filename = eargs.get("filename", None)
+    multiline = True if not editor else False
+    save = eargs.get("save", None)
+
+    if editor:
+        _text = edit(
+            editor=editor, 
+            extension=ext,
+            text=text,
+            env=env,
+            filename=filename,
+            require_save=save
+        )
+        if filename:
+            default = filename
+        else:
+            default = _text
+
     # TODO style defaults on detail level
     kwargs['style'] = kwargs.pop('style', default_style)
     qmark = kwargs.pop('qmark', '?')
-
-
+    
     def _get_prompt_tokens(cli):
         return [
             (Token.QuestionMark, qmark),
@@ -127,5 +192,6 @@ def _get_prompt_tokens(cli):
         get_prompt_tokens=_get_prompt_tokens,
         lexer=SimpleLexer(Token.Answer),
         default=default,
+        multiline=multiline,
         **kwargs
     )

README.rst

@@ -235,12 +235,32 @@ Editor - ``{type: 'editor'}``
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Take ``type``, ``name``, ``message``\ [, ``default``, ``filter``,
-``validate``] properties
+``validate``, ``eargs``] properties
+
+### Editor Arguments - ``eargs``
+
+Opens an empty or edits the default text in the defined editor.  If an editor is given
+(should be the full path to the executable but the regular operating
+system search path is used for finding the executable) it overrides
+the detected editor.  Optionally, some environment variables can be
+used.  If the editor is closed without changes, ``None`` is returned.  In
+case a file is edited directly the return value is always ``None`` and
+``save`` and ``ext`` are ignored.
+
+Takes:
+
+-  editor: accepts ``default`` to get the default platform editor. But 
+   you can also provide the path to an editor e.g ``vi``.
+-  ext: the extension to tell the editor about. This defaults to `.txt` 
+   but changing this might change syntax highlighting e.g ".py"
+-  save: accepts ``True`` or ``False`` to determine to save a file.
+-  filename: accepts the path of a file you'd like to edit.
+-  env: accepts any given environment variables to pass to the editor
 
 Launches an instance of the users preferred editor on a temporary file.
 Once the user exits their editor, the contents of the temporary file are
 read in as the result. The editor to use is determined by reading the
-:math:`VISUAL or `\ EDITOR environment variables. If neither of those
+:math:``VISUAL or ``\ EDITOR environment variables. If neither of those
 are present, notepad (on Windows) or vim (Linux or Mac) is used.
 
 Question Properties

examples/editor.py

@@ -14,7 +14,12 @@
         'type': 'editor',
         'name': 'bio',
         'message': 'Please write a short bio of at least 3 lines.',
-        # 'validate': lambda text: len(text.split('\n')) >= 3 or 'Must be at least 3 lines.'
+        'default': 'Hello World',
+        'validate': lambda text: len(text.split('\n')) >= 3 or 'Must be at least 3 lines.',
+        'eargs': {
+            'editor':'default',
+            'ext':'.py'
+        }
     }
 ]
 

examples/expand.py

@@ -9,7 +9,7 @@
 
 from examples import custom_style_2
 
-
+# questions - 
 questions = [
     {
         'type': 'expand',

requirements_dev.txt

@@ -1,6 +1,8 @@
 # this file contains additional dependencies (not in requirements.txt)
 # please list all dependencies necessary to test and build this package
 
+-r requirements.txt
+
 # test-tools
 testfixtures
 pytest>=3.0.7
@@ -14,3 +16,4 @@ ptyprocess==0.5.1
 pep8>=1.7.0
 bumpversion>=0.5.3
 pypandoc>=1.3.3
+