Prompt_toolkit 3.0: type annotations and asyncio natively.

This is a rewrite that starts taking advantage of Python 3 functionality. - It uses native asyncio coroutines and async generators everywhere. - We have type annotations in most of the code. - Python 2 support has been dropped (usage of six has been removed). - Use of ContextVars for keeping track of the currently running application.

Author: jonathanslenders

.travis.yml

@@ -8,27 +8,23 @@ matrix:
  dist: xenial
  sudo: required
  - python: 3.6
- - python: 3.5
- - python: 3.4
- - python: 2.7
- - python: 2.6
- - python: nightly
- - python: pypy
- - python: pypy3
 
 install:
- - pip install . pytest coverage codecov flake8
- - if [ "$TRAVIS_PYTHON_VERSION" != "2.6" ]; then pip install isort; fi
+ - pip install . pytest coverage codecov flake8 mypy
+ - pip install isort
  - pip list
 
 script:
  - echo "$TRAVIS_PYTHON_VERSION"
- - if [ "$TRAVIS_PYTHON_VERSION" != "2.6" ]; then flake8 prompt_toolkit; fi
+ - flake8 prompt_toolkit
  - coverage run -m pytest
 
+ # Run type checker
+ - mypy prompt_toolkit --ignore-missing-imports --platform win32 | grep -v 'already defined' | true
+
  # Check wheather the imports were sorted correctly.
  # When this fails, please run ./tools/sort-imports.sh
- - if [ "$TRAVIS_PYTHON_VERSION" != "2.6" ]; then isort -c -m 3 -tc -rc prompt_toolkit; fi
+ - isort -c -m 3 -tc -rc prompt_toolkit
 
 after_success:
  - codecov

CHANGELOG

@@ -1,6 +1,27 @@
 CHANGELOG
 =========
 
+3.x.x
+-----------------
+
+New features:
+- (almost) 100% type annotated.
+- Native asyncio instead of custom event loops.
+
+Breaking changes:
+- Python 2 support has been dropped. Minimal Python version is now 3.6,
+ although 3.7 is preferred (because of ContextVars).
+- Native asyncio, so some async code becomes slightly different.
+- The active `Application` became a contextvar. Which means that it should be
+ propagated correctly to the code that requires it. However, random other
+ threads or coroutines won't be able to know what the current application is.
+- The dialog shortcuts API changed. All dialog functions now return an
+ `Application`. You still have to call either `run()` or `run_async` on the
+ `Application` object.
+- The way inputhooks work is changed.
+- `patch_stdout` now requires an `Application` as input.
+
+
 2.0.9: 2019-02-19
 -----------------
 

README.rst

@@ -11,13 +11,13 @@ applications in Python.*
 Read the `documentation on readthedocs
 <http://python-prompt-toolkit.readthedocs.io/en/stable/>`_.
 
-NOTICE: prompt_toolkit 2.0
+NOTICE: prompt_toolkit 3.0
 **************************
 
-Please notice that this is prompt_toolkit 2.0. It is incompatible with the 1.0
-branch, but much better in many regards. Many applications are still using
-prompt_toolkit 1.0, but upgrading is strongly recommended. Feel free to open a
-new issue if you don't manage to upgrade to prompt_toolkit 2.0.
+Please notice that this branch is the prompt_toolkit 3.0 branch. For most
+users, it should be compatible with prompt_toolkit 2.0, but it requires at
+least Python 3.6. On the plus side, prompt_toolkit 3.0 is completly type
+annotated and uses asyncio natively.
 
 
 Ptpython

docs/conf.py

@@ -51,9 +51,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '2.0.9'
+version = '3.0.0'
 # The full version, including alpha/beta/rc tags.
-release = '2.0.9'
+release = '3.0.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

examples/dialogs/button_dialog.py

@@ -2,8 +2,6 @@
 """
 Example of button dialog window.
 """
-from __future__ import unicode_literals
-
 from prompt_toolkit.shortcuts import button_dialog
 
 
@@ -16,7 +14,7 @@ def main():
  ('No', False),
  ('Maybe...', None),
  ],
- )
+ ).run()
 
  print('Result = {}'.format(result))
 

examples/dialogs/input_dialog.py

@@ -2,15 +2,13 @@
 """
 Example of an input box dialog.
 """
-from __future__ import unicode_literals
-
 from prompt_toolkit.shortcuts import input_dialog
 
 
 def main():
  result = input_dialog(
  title='Input dialog example',
- text='Please type your name:')
+ text='Please type your name:').run()
 
  print('Result = {}'.format(result))
 

examples/dialogs/messagebox.py

@@ -2,15 +2,13 @@
 """
 Example of a message box window.
 """
-from __future__ import unicode_literals
-
 from prompt_toolkit.shortcuts import message_dialog
 
 
 def main():
  message_dialog(
  title='Example dialog window',
- text='Do you want to continue?\nPress ENTER to quit.')
+ text='Do you want to continue?\nPress ENTER to quit.').run()
 
 
 if __name__ == '__main__':

examples/dialogs/password_dialog.py

@@ -2,16 +2,14 @@
 """
 Example of an password input dialog.
 """
-from __future__ import unicode_literals
-
 from prompt_toolkit.shortcuts import input_dialog
 
 
 def main():
  result = input_dialog(
  title='Password dialog example',
  text='Please type your password:',
- password=True)
+ password=True).run()
 
  print('Result = {}'.format(result))
 

examples/dialogs/progress_dialog.py

@@ -2,8 +2,6 @@
 """
 Example of a progress bar dialog.
 """
-from __future__ import unicode_literals
-
 import os
 import time
 
@@ -34,15 +32,14 @@ def worker(set_percentage, log_text):
  # Show 100% for a second, before quitting.
  set_percentage(100)
  time.sleep(1)
- return
 
 
 def main():
  progress_dialog(
  title='Progress dialog example',
  text='As an examples, we walk through the filesystem and print '
  'all directories',
- run_callback=worker)
+ run_callback=worker).run()
 
 
 if __name__ == '__main__':

examples/dialogs/radio_dialog.py

@@ -2,8 +2,6 @@
 """
 Example of a radio list box dialog.
 """
-from __future__ import unicode_literals
-
 from prompt_toolkit.formatted_text import HTML
 from prompt_toolkit.shortcuts import radiolist_dialog
 
@@ -17,7 +15,7 @@ def main():
  ('orange', 'Orange'),
  ],
  title='Radiolist dialog example',
- text='Please select a color:')
+ text='Please select a color:').run()
 
  print('Result = {}'.format(result))
 
@@ -30,7 +28,7 @@ def main():
  ('orange', HTML('<style bg="orange" fg="white">Orange</style>')),
  ],
  title=HTML('Radiolist dialog example <reverse>with colors</reverse>'),
- text='Please select a color:')
+ text='Please select a color:').run()
 
  print('Result = {}'.format(result))