Merge pull request #231 from python-cmd2/pyperclip_version

Added fix for changes in pyperclip project structure in latest version

Author: tleonhardt

CHANGELOG.md

@@ -1,8 +1,9 @@
-## 0.7.8 (TBD, 2017)
+## 0.7.8 (November TBD, 2017)
 
 * Bug Fixes
     * Fixed ``poutput()`` so it can print an integer zero and other **falsy** things
     * Fixed a bug which was causing autodoc to fail for building docs on Readthedocs
+    * Fixed bug due to ``pyperclip`` dependency radically changing its project structure in latest version
 * Enhancements
     * Improved documentation for user-settable environment parameters
     * Improved documentation for overriding the default supported comment styles

README.md

@@ -114,10 +114,9 @@ Tutorials
 
 A couple tutorials on using cmd2 exist:
 
-* A detailed PyCon 2010 talk by [Catherine Devlin](https://github.com/catherinedevlin), the original author
-    * http://pyvideo.org/pycon-us-2010/pycon-2010--easy-command-line-applications-with-c.html
-* A nice brief step-by-step tutorial
-    * https://kushaldas.in/posts/developing-command-line-interpreters-using-python-cmd2.html
+* Florida PyCon 2017 talk: [slides](https://archive.org/details/pyvideo_541___pyohio-2011-interactive-command-line-interpreters-with-cmd-and-cmd2)
+* PyCon 2010 talk by Catherine Devlin, the original author: [video](http://pyvideo.org/pycon-us-2010/pycon-2010--easy-command-line-applications-with-c.html)
+* A nice brief step-by-step tutorial: [blog](https://kushaldas.in/posts/developing-command-line-interpreters-using-python-cmd2.html)
 
 
 Example Application

cmd2.py

@@ -46,6 +46,13 @@
 import pyparsing
 import pyperclip
 
+# Newer versions of pyperclip are released as a single file, but older versions had a more complicated structure
+try:
+    from pyperclip.exceptions import PyperclipException
+except ImportError:
+    # noinspection PyUnresolvedReferences
+    from pyperclip import PyperclipException
+
 # On some systems, pyperclip will import gtk for its clipboard functionality.
 # The following code is a workaround for gtk interfering with printing from a background
 # thread while the CLI thread is blocking in raw_input() in Python 2 on Linux.
@@ -98,7 +105,7 @@
 else:
     BROKEN_PIPE_ERROR = IOError
 
-__version__ = '0.7.8a'
+__version__ = '0.7.8'
 
 # Pyparsing enablePackrat() can greatly speed up parsing, but problems have been seen in Python 3 in the past
 pyparsing.ParserElement.enablePackrat()
@@ -324,13 +331,17 @@ def new_func(instance, arg):
 # Can we access the clipboard?  Should always be true on Windows and Mac, but only sometimes on Linux
 # noinspection PyUnresolvedReferences
 try:
-    if sys.platform.startswith('linux'):
+    # Get the version of the pyperclip module as a float
+    pyperclip_ver = float('.'.join(pyperclip.__version__.split('.')[:2]))
+
+    # The extraneous output bug in pyperclip on Linux using xclip was fixed in more recent versions of pyperclip
+    if sys.platform.startswith('linux') and pyperclip_ver < 1.6:
         # Avoid extraneous output to stderr from xclip when clipboard is empty at cost of overwriting clipboard contents
         pyperclip.copy('')
     else:
         # Try getting the contents of the clipboard
         _ = pyperclip.paste()
-except pyperclip.exceptions.PyperclipException:
+except PyperclipException:
     can_clip = False
 else:
     can_clip = True
@@ -582,7 +593,7 @@ def poutput(self, msg, end='\n'):
         Also handles BrokenPipeError exceptions for when a commands's output has been piped to another process and
         that process terminates before the cmd2 command is finished executing.
 
-        :param msg: str - message to print to current stdout - anyting convertible to a str with '{}'.format() is OK
+        :param msg: str - message to print to current stdout - anything convertible to a str with '{}'.format() is OK
         :param end: str - string appended after the end of the message if not already present, default a newline
         """
         if msg is not None and msg != '':

docs/conf.py

@@ -62,7 +62,7 @@
 # The short X.Y version.
 version = '0.7'
 # The full version, including alpha/beta/rc tags.
-release = '0.7.7'
+release = '0.7.8'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/index.rst

@@ -46,9 +46,9 @@ Resources
 * cmd_
 * `cmd2 project page`_
 * `project bug tracker`_
-* `PyCon 2010 presentation <https://github.com/python-cmd2/cmd2/blob/master/docs/pycon2010/pycon2010.rst>`_,
-  *Easy Command-Line Applications with cmd and cmd2*:
-  :doc:`slides <pycon2010/pycon2010>`,
+* Florida PyCon 2017: `slides <https://docs.google.com/presentation/d/1LRmpfBt3V-pYQfgQHdczf16F3hcXmhK83tl77R6IJtE/edit?usp=sharing>`_
+* PyOhio 2011: `video <https://archive.org/details/pyvideo_541___pyohio-2011-interactive-command-line-interpreters-with-cmd-and-cmd2>`_
+* PyCon 2010: `presentation <https://github.com/python-cmd2/cmd2/blob/master/docs/pycon2010/pycon2010.rst>`_,
   `video <http://pyvideo.org/pycon-us-2010/pycon-2010--easy-command-line-applications-with-c.html>`_
 
 These docs will refer to ``App`` as your ``cmd2.Cmd``

docs/integrating.rst

@@ -46,10 +46,14 @@ code like the following::
 
         # Do this within whatever event loop mechanism you wish to run a single command
         cmd_line_text = "help history"
-        app.onecmd_plus_hooks(cmd_line_text)
+        app.runcmds_plus_hooks([cmd_line_text])
 
         app.postloop()
 
+The **runcmds_plus_hooks()** method is a convenience method to run multiple commands via **onecmd_plus_hooks()**.  It
+properly deals with ``load`` commands which under the hood put commands in a FIFO queue as it reads them in from a
+script file.
+
 The **onecmd_plus_hooks()** method will do the following to execute a single ``cmd2`` command in a normal fashion:
 
 #. Parse the command line text
@@ -70,4 +74,10 @@ several disadvantages, including:
 * Does not support transcript testing
 * Does not allow commands at invocation via command-line arguments
 
+Here is a little more info on ``runcmds_plus_hooks``:
+
+.. automethod:: cmd2.Cmd.runcmds_plus_hooks
+
+
+