Merge branch 'master' into header_tabs

Author: tleonhardt

Pipfile

@@ -22,7 +22,8 @@ ipython = "*"
 isort = "*"
 mock = {version = "*",markers = "python_version < '3.6'"}
 plumbum = "*"
-pyreadline = {version = "*",sys_platform = "== 'win32'"}
+pyreadline = {version = "*",sys_platform = "== 'win32'",markers = "python_version < '3.8'"}
+pyreadline3 = {version = "*",sys_platform = "== 'win32'",markers = "python_version >= '3.8'"}
 pytest = "*"
 pytest-cov = "*"
 pytest-mock = "*"

cmd2/rl_utils.py

@@ -37,8 +37,8 @@ class RlType(Enum):
 # Explanation for why readline wasn't loaded
 _rl_warn_reason = ''
 
-# The order of this check matters since importing pyreadline will also show readline in the modules list
-if 'pyreadline' in sys.modules:
+# The order of this check matters since importing pyreadline/pyreadline3 will also show readline in the modules list
+if 'pyreadline' in sys.modules or 'pyreadline3' in sys.modules:
     rl_type = RlType.PYREADLINE
 
     from ctypes import byref

docs/features/commands.rst

@@ -127,7 +127,7 @@ without errors), and that ``cmd2`` should prompt the user for more input.
 If you return ``True`` from a command method, that indicates to ``cmd2`` that
 it should stop prompting for user input and cleanly exit. ``cmd2`` already
 includes a ``quit`` command, but if you wanted to make another one called
-``finis`` you could::
+``finish`` you could::
 
     def do_finish(self, line):
         """Exit the application"""
@@ -156,7 +156,7 @@ system shell::
         """A simple cmd2 application."""
 
     def do_bail(self, line):
-        """Exit the application""
+        """Exit the application"""
         self.perror("fatal error, exiting")
         self.exit_code = 2
         return true

docs/features/modular_commands.rst

@@ -29,7 +29,7 @@ Features
 
 See API documentation for :attr:`cmd2.command_definition.CommandSet`
 
-See the examples for more details: https://github.com/python-cmd2/cmd2/tree/master/plugins/command_sets/examples
+See [the examples](https://github.com/python-cmd2/cmd2/tree/master/examples/modular_commands) for more details.
 
 
 Defining Commands

docs/overview/integrating.rst

@@ -26,10 +26,13 @@ Windows Considerations
 
 If you would like to use :ref:`features/completion:Completion`, and you want
 your application to run on Windows, you will need to ensure you install the
-``pyreadline`` package. Make sure to include the following in your
-``setup.py``::
+``pyreadline3`` or ``pyreadline`` package. Make sure to include the following
+in your ``setup.py``::
 
   install_requires=[
     'cmd2>=1,<2',
-    ":sys_platform=='win32'": ['pyreadline'],
+    ":sys_platform=='win32'": [
+        "pyreadline ; python_version<'3.8'",
+        "pyreadline3 ; python_version>='3.8'",  # pyreadline3 is a drop-in replacement for Python 3.8 and above
+    ],
   ]

setup.py

@@ -44,8 +44,9 @@
 ]
 
 EXTRAS_REQUIRE = {
-    # Windows also requires pyreadline to ensure tab completion works
-    ":sys_platform=='win32'": ['pyreadline'],
+    # Windows also requires pyreadline or the replacement, pyreadline3, to ensure tab completion works
+    ":sys_platform=='win32' and python_version<'3.8'": ["pyreadline"],
+    ":sys_platform=='win32' and python_version>='3.8'": ["pyreadline3"],
     # Extra dependencies for running unit tests
     'test': [
         "gnureadline; sys_platform=='darwin'",  # include gnureadline on macOS to ensure it is available in nox env