Merge pull request #217 from python-cmd2/update_changelog

Updated CHANGELOG text regarding recent enhancements to transcript regexes

Author: tleonhardt

CHANGELOG.md

@@ -6,6 +6,10 @@
     * For ``edit`` command, both **editor** and **filename** can now have spaces in the name/path
 * Enhancements
     * ``feedback_to_output`` now defaults to ``False`` so info like command timing won't redirect
+    * Transcript regular expressions now have predictable, tested, and documented behavior
+        * This makes a breaking change to the format and expectations of transcript testing
+        * The prior behavior removed whitespace before making the comparison, now whitespace must match exactly
+        * Prior version did not allow regexes with whitespace, new version allows any regex
 
 ## 0.7.6 (August 11, 2017)
 

cmd2.py

@@ -98,7 +98,7 @@
 else:
     BROKEN_PIPE_ERROR = IOError
 
-__version__ = '0.7.7a'
+__version__ = '0.7.7'
 
 # Pyparsing enablePackrat() can greatly speed up parsing, but problems have been seen in Python 3 in the past
 pyparsing.ParserElement.enablePackrat()
@@ -2305,7 +2305,7 @@ def _test_transcript(self, fname, transcript):
                     break
                 line_num += 1
             expected = ''.join(expected)
-            
+
             # transform the expected text into a valid regular expression
             expected = self._transform_transcript_expected(expected)
             message = '\nFile {}, line {}\nCommand was:\n{}\nExpected:\n{}\nGot:\n{}\n'.format(
@@ -2318,7 +2318,7 @@ def _transform_transcript_expected(self, s):
         backslash = '\\'
         regex = ''
         start = 0
-        
+
         while True:
             (regex, first_slash_pos, start) = self._escaped_find(regex, s, start, False)
             if first_slash_pos == -1:
@@ -2349,12 +2349,12 @@ def _transform_transcript_expected(self, s):
     def _escaped_find(self, regex, s, start, in_regex):
         """
         Find the next slash in {s} after {start} that is not preceded by a backslash.
-        
+
         If we find an escaped slash, add everything up to and including it to regex,
         updating {start}. {start} therefore serves two purposes, tells us where to start
         looking for the next thing, and also tells us where in {s} we have already
         added things to {regex}
-        
+
         {in_regex} specifies whether we are currently searching in a regex, we behave
         differently if we are or if we aren't.
         """

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.7a'
+release = '0.7.7'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

setup.py

@@ -5,7 +5,7 @@
 """
 from setuptools import setup
 
-VERSION = '0.7.7a'
+VERSION = '0.7.7'
 DESCRIPTION = "cmd2 - a tool for building interactive command line applications in Python"
 LONG_DESCRIPTION = """cmd2 is a tool for building interactive command line applications in Python. Its goal is to make 
 it quick and easy for developers to build feature-rich and user-friendly interactive command line applications.  It 

tests/test_cmd2.py

@@ -23,7 +23,7 @@
 
 
 def test_ver():
-    assert cmd2.__version__ == '0.7.7a'
+    assert cmd2.__version__ == '0.7.7'
 
 
 def test_empty_statement(base_app):