Merge branch 'master' into etc-removal

invoke/cli.py

@@ -1,4 +1,5 @@
 from functools import partial
+import inspect
 import os
 import sys
 import textwrap
@@ -213,15 +214,14 @@ def parse(argv, collection=None, version=None):
         # Setup
         ctx = parser.contexts[name]
         tuples = ctx.help_tuples()
-        docstring = collection[name].__doc__
+        docstring = inspect.getdoc(collection[name])
         header = "Usage: inv[oke] [--core-opts] %s %%s[other tasks here ...]" % name
         print(header % ("[--options] " if tuples else ""))
         print("")
         print("Docstring:")
         if docstring:
             # Really wish textwrap worked better for this.
-            doclines = textwrap.dedent(docstring.lstrip('\n').rstrip()+'\n').splitlines()
-            for line in doclines:
+            for line in docstring.splitlines():
                 if line.strip():
                     print(indent + line)
                 else:

invoke/runner.py

@@ -81,8 +81,7 @@ def out_filter(text):
                 return text
             else:
                 return b""
-        wrapped_cmd = "/bin/bash -c \"%s\"" % command
-        p = pexpect.spawn(wrapped_cmd)
+        p = pexpect.spawn("/bin/bash", ["-c", command])
         # Ensure pexpect doesn't barf with OSError if we fall off the end of
         # the child's input on some platforms (e.g. Linux).
         exception = None

sites/www/changelog.rst

@@ -2,6 +2,13 @@
 Changelog
 =========
 
+* :bug:`191` Bypass ``pexpect``'s automatic command splitting to avoid issues
+  running complex nested/quoted commands under a pty. Credit to ``@mijikai``
+  for noticing the problem.
+* :bug:`183` Task docstrings whose first line started on the same line as the
+  opening quote(s) were incorrectly presented in ``invoke --help <task>``. This
+  has been fixed by using `inspect.getdoc`. Thanks to Pekka Klärck for the
+  catch & suggested fix.
 * :bug:`180` Empty invocation (e.g. just ``invoke`` with no flags or tasks, and
   when no default task is defined) no
   longer printed help output, instead complaining about the lack of default

sites/www/development.rst

@@ -39,4 +39,4 @@ see with ``inv --list``. Some specific tasks of note:
 .. _contribution-guide.org: http://contribution-guide.org
 
 .. _our GitHub page:
-.. _pyinvoke/invoke: https://github.cm/pyinvoke/invoke
+.. _pyinvoke/invoke: https://github.com/pyinvoke/invoke

tests/_support/decorator.py

@@ -19,6 +19,16 @@ def foo2():
     """
     pass
 
+@task
+def foo3():
+    """Foo the other bar:
+
+      example code
+
+    Added in 1.1
+    """
+    pass
+
 @task(default=True)
 def biz():
     pass

tests/cli.py

@@ -161,6 +161,23 @@ def per_task_help_dedents_correctly(self):
 """.lstrip()
         _output_eq('-c decorator -h foo2', expected)
 
+    def per_task_help_dedents_correctly_for_alternate_docstring_style(self):
+        expected = """
+Usage: inv[oke] [--core-opts] foo3 [other tasks here ...]
+
+Docstring:
+  Foo the other bar:
+
+    example code
+
+  Added in 1.1
+
+Options:
+  none
+
+""".lstrip()
+        _output_eq('-c decorator -h foo3', expected)
+
     def version_info(self):
         _output_eq('-V', "Invoke %s\n" % invoke.__version__)
 

tests/runner.py

@@ -186,6 +186,16 @@ def return_value_indicates_whether_pty_was_used(self):
         def pty_defaults_to_off(self):
             eq_(run("true").pty, False)
 
+        def complex_nesting_doesnt_break(self):
+            # GH issue 191
+            substr = "      hello\t\t\nworld with spaces"
+            cmd = """ eval 'echo "{0}" ' """.format(substr)
+            # TODO: consider just mocking os.execv here (and in the other
+            # tests) though that feels like too much of a tautology / testing
+            # pexpect
+            expected = '      hello\t\t\r\nworld with spaces\r\n'
+            eq_(run(cmd, pty=True, hide='both').stdout, expected)
+
     class command_echo:
         @trap
         def does_not_echo_commands_run_by_default(self):