Use ruff for linting and formatting.

- Several fixes because of Ruff.
- Updated GitHub workflow to use ruff instead of isort and black.
- Added Python 3.10 to GitHub workflow.
- Ruff formatting.
- Removed unnecessary trailing comma.

.github/workflows/test.yaml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.7, 3.8, 3.9, "3.10"]
+        python-version: [3.7, 3.8, 3.9, "3.10", "3.11"]
 
     steps:
       - uses: actions/checkout@v2
@@ -22,21 +22,22 @@ jobs:
         run: |
           sudo apt remove python3-pip
           python -m pip install --upgrade pip
-          python -m pip install . black coverage codecov flake8 isort==5.6.4 mypy pytest readme_renderer types-contextvars asyncssh
+          python -m pip install . ruff coverage codecov mypy pytest readme_renderer types-contextvars asyncssh
           pip list
-      - name: Run Tests
+      - name: Ruff
+        run: |
+          ruff .
+          ruff format --check .
+      - name: Tests
         run: |
-          flake8 .
           coverage run -m pytest
-      - name: Type Checker
+      - name: Mypy
         # Check wheather the imports were sorted correctly.
         # When this fails, please run ./tools/sort-imports.sh
         run: |
           mypy --strict src/prompt_toolkit --platform win32
           mypy --strict src/prompt_toolkit --platform linux
           mypy --strict src/prompt_toolkit --platform darwin
-          isort -c --profile black src examples tests setup.py
-          black --check src examples tests setup.py
       - name: Validate README.md
         # Ensure that the README renders correctly (required for uploading to PyPI).
         run: |

docs/conf.py

@@ -12,7 +12,6 @@
 # serve to show the default.
 
 import os
-import sys
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the

examples/full-screen/calculator.py

@@ -49,8 +49,8 @@ def main():
     def accept(buff):
         # Evaluate "calculator" expression.
         try:
-            output = "\n\nIn:  {}\nOut: {}".format(
-                input_field.text, eval(input_field.text)
+            output = (
+                f"\n\nIn:  {input_field.text}\nOut: {eval(input_field.text)}"
             )  # Don't do 'eval' in real code!
         except BaseException as e:
             output = f"\n\n{e}"

examples/prompts/asyncio-prompt.py

@@ -60,9 +60,4 @@ async def main():
 
 
 if __name__ == "__main__":
-    try:
-        from asyncio import run
-    except ImportError:
-        asyncio.run_until_complete(main())
-    else:
-        asyncio.run(main())
+    asyncio.run(main())

examples/prompts/custom-lexer.py

@@ -9,7 +9,7 @@
 
 class RainbowLexer(Lexer):
     def lex_document(self, document):
-        colors = list(sorted(NAMED_COLORS, key=NAMED_COLORS.get))
+        colors = sorted(NAMED_COLORS, key=NAMED_COLORS.get)
 
         def get_line(lineno):
             return [

examples/ssh/asyncssh-server.py

@@ -4,7 +4,6 @@
 """
 import asyncio
 import logging
-from asyncio import run
 
 import asyncssh
 from pygments.lexers.html import HtmlLexer

examples/telnet/hello-world.py

@@ -7,7 +7,7 @@
 That is probably the preferred way if you only need Python 3 support.
 """
 import logging
-from asyncio import Future, run
+from asyncio import run
 
 from prompt_toolkit.contrib.telnet.server import TelnetServer
 from prompt_toolkit.shortcuts import PromptSession, clear

examples/telnet/toolbar.py

@@ -4,7 +4,7 @@
 in the prompt.
 """
 import logging
-from asyncio import Future, run
+from asyncio import run
 
 from prompt_toolkit.completion import WordCompleter
 from prompt_toolkit.contrib.telnet.server import TelnetServer

pyproject.toml

@@ -1,13 +1,38 @@
-[tool.black]
-target-version = ['py36']
-
-
-[tool.isort]
-# isort configuration that is compatible with Black.
-multi_line_output = 3
-include_trailing_comma = true
-known_first_party = "prompt_toolkit"
-known_third_party = "asyncssh,pygments"
-force_grid_wrap = 0
-use_parentheses = true
-line_length = 88
+[tool.ruff]
+target-version = "py37"
+select = [
+    "E",  # pycodestyle errors
+    "W",  # pycodestyle warnings
+    "F",  # pyflakes
+    "C",  # flake8-comprehensions
+    "T",  # Print.
+    "I",  # isort
+    # "B",  # flake8-bugbear
+    "UP",  # pyupgrade
+    "RUF100",  # unused-noqa
+    # "Q", # quotes
+]
+ignore = [
+    "E501",  # Line too long, handled by black
+    "C901",  # Too complex
+    "E731",  # Assign lambda.
+    "E402", # Module level import not at the top.
+    "E741", # Ambiguous variable name.
+]
+
+
+[tool.ruff.per-file-ignores]
+"examples/*" = ["T201"]  # Print allowed in examples.
+"src/prompt_toolkit/application/application.py" = ["T100", "T201", "F821"]  # pdb and print allowed.
+"src/prompt_toolkit/contrib/telnet/server.py" = ["T201"]  # Print allowed.
+"src/prompt_toolkit/key_binding/bindings/named_commands.py" = ["T201"]  # Print allowed.
+"src/prompt_toolkit/shortcuts/progress_bar/base.py" = ["T201"]  # Print allowed.
+"tools/*" = ["T201"]  # Print allowed.
+"src/prompt_toolkit/filters/__init__.py" = ["F403", "F405"]  # Possibly undefined due to star import.
+"src/prompt_toolkit/filters/cli.py" = ["F403", "F405"]  # Possibly undefined due to star import.
+"src/prompt_toolkit/shortcuts/progress_bar/formatters.py" = ["UP031"] # %-style formatting.
+
+
+[tool.ruff.isort]
+known-first-party = ["prompt_toolkit"]
+known-third-party = ["pygments", "asyncssh"]

src/prompt_toolkit/application/application.py

@@ -655,7 +655,7 @@ async def run_async(
             # See: https://github.com/prompt-toolkit/python-prompt-toolkit/issues/1553
             handle_sigint = False
 
-        async def _run_async(f: "asyncio.Future[_AppResult]") -> _AppResult:
+        async def _run_async(f: asyncio.Future[_AppResult]) -> _AppResult:
             context = contextvars.copy_context()
             self.context = context
 

src/prompt_toolkit/application/current.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-import sys
 from contextlib import contextmanager
 from contextvars import ContextVar
 from typing import TYPE_CHECKING, Any, Generator
@@ -148,8 +147,6 @@ def create_app_session(
     Like in the case of an Telnet/SSH server. This functionality uses
     contextvars and requires at least Python 3.7.
     """
-    if sys.version_info <= (3, 6):
-        raise RuntimeError("Application sessions require Python 3.7.")
 
     # If no input/output is specified, fall back to the current input/output,
     # whatever that is.

src/prompt_toolkit/auto_suggest.py

@@ -72,7 +72,7 @@ def get_suggestion(self, buffer: Buffer, document: Document) -> Suggestion | Non
         """
 
     async def get_suggestion_async(
-        self, buff: "Buffer", document: Document
+        self, buff: Buffer, document: Document
     ) -> Suggestion | None:
         """
         Return a :class:`.Future` which is set when the suggestions are ready.
@@ -96,7 +96,7 @@ def get_suggestion(self, buff: Buffer, document: Document) -> Suggestion | None:
         return self.auto_suggest.get_suggestion(buff, document)
 
     async def get_suggestion_async(
-        self, buff: "Buffer", document: Document
+        self, buff: Buffer, document: Document
     ) -> Suggestion | None:
         """
         Run the `get_suggestion` function in a thread.
@@ -170,7 +170,7 @@ def get_suggestion(self, buff: Buffer, document: Document) -> Suggestion | None:
         return auto_suggest.get_suggestion(buff, document)
 
     async def get_suggestion_async(
-        self, buff: "Buffer", document: Document
+        self, buff: Buffer, document: Document
     ) -> Suggestion | None:
         auto_suggest = self.get_auto_suggest() or DummyAutoSuggest()
         return await auto_suggest.get_suggestion_async(buff, document)

src/prompt_toolkit/buffer.py

@@ -15,7 +15,7 @@
 from collections import deque
 from enum import Enum
 from functools import wraps
-from typing import Any, Awaitable, Callable, Coroutine, Deque, Iterable, TypeVar, cast
+from typing import Any, Awaitable, Callable, Coroutine, Iterable, TypeVar, cast
 
 from .application.current import get_app
 from .application.run_in_terminal import run_in_terminal
@@ -56,6 +56,7 @@ class EditReadOnlyBuffer(Exception):
 
 class ValidationState(Enum):
     "The validation state of a buffer. This is set after the validation."
+
     VALID = "VALID"
     INVALID = "INVALID"
     UNKNOWN = "UNKNOWN"
@@ -366,7 +367,7 @@ def reset(
         #: Ctrl-C should reset this, and copy the whole history back in here.
         #: Enter should process the current command and append to the real
         #: history.
-        self._working_lines: Deque[str] = deque([document.text])
+        self._working_lines: deque[str] = deque([document.text])
         self.__working_index = 0
 
     def load_history_if_not_yet_loaded(self) -> None:

src/prompt_toolkit/cache.py

@@ -2,7 +2,7 @@
 
 from collections import deque
 from functools import wraps
-from typing import Any, Callable, Deque, Dict, Generic, Hashable, Tuple, TypeVar, cast
+from typing import Any, Callable, Dict, Generic, Hashable, Tuple, TypeVar, cast
 
 __all__ = [
     "SimpleCache",
@@ -26,7 +26,7 @@ def __init__(self, maxsize: int = 8) -> None:
         assert maxsize > 0
 
         self._data: dict[_T, _U] = {}
-        self._keys: Deque[_T] = deque()
+        self._keys: deque[_T] = deque()
         self.maxsize: int = maxsize
 
     def get(self, key: _T, getter_func: Callable[[], _U]) -> _U:
@@ -86,7 +86,7 @@ class FastDictCache(Dict[_K, _V]):
     def __init__(self, get_value: Callable[..., _V], size: int = 1000000) -> None:
         assert size > 0
 
-        self._keys: Deque[_K] = deque()
+        self._keys: deque[_K] = deque()
         self.get_value = get_value
         self.size = size
 

src/prompt_toolkit/clipboard/in_memory.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 from collections import deque
-from typing import Deque
 
 from .base import Clipboard, ClipboardData
 
@@ -22,7 +21,7 @@ def __init__(self, data: ClipboardData | None = None, max_size: int = 60) -> Non
         assert max_size >= 1
 
         self.max_size = max_size
-        self._ring: Deque[ClipboardData] = deque()
+        self._ring: deque[ClipboardData] = deque()
 
         if data is not None:
             self.set_data(data)

src/prompt_toolkit/completion/filesystem.py

@@ -115,4 +115,4 @@ def __init__(self) -> None:
             get_paths=lambda: os.environ.get("PATH", "").split(os.pathsep),
             file_filter=lambda name: os.access(name, os.X_OK),
             expanduser=True,
-        ),
+        )

src/prompt_toolkit/contrib/regular_languages/compiler.py

@@ -41,9 +41,8 @@
 from __future__ import annotations
 
 import re
-from typing import Callable, Dict, Iterable, Iterator
+from typing import Callable, Dict, Iterable, Iterator, Pattern
 from typing import Match as RegexMatch
-from typing import Pattern
 
 from .regex_parser import (
     AnyNode,
@@ -170,10 +169,7 @@ def transform(node: Node) -> str:
 
             # A `Variable` wraps the children into a named group.
             elif isinstance(node, Variable):
-                return "(?P<{}>{})".format(
-                    create_group_func(node),
-                    transform(node.childnode),
-                )
+                return f"(?P<{create_group_func(node)}>{transform(node.childnode)})"
 
             # `Repeat`.
             elif isinstance(node, Repeat):

src/prompt_toolkit/contrib/telnet/server.py

@@ -186,7 +186,7 @@ def handle_incoming_data() -> None:
                 self.feed(data)
             else:
                 # Connection closed by client.
-                logger.info("Connection closed by client. %r %r" % self.addr)
+                logger.info("Connection closed by client. {!r} {!r}".format(*self.addr))
                 self.close()
 
         # Add reader.

src/prompt_toolkit/formatted_text/base.py

@@ -86,7 +86,7 @@ def to_formatted_text(
     else:
         raise ValueError(
             "No formatted text. Expecting a unicode object, "
-            "HTML, ANSI or a FormattedText instance. Got %r" % (value,)
+            f"HTML, ANSI or a FormattedText instance. Got {value!r}"
         )
 
     # Apply extra style.

src/prompt_toolkit/key_binding/bindings/mouse.py

@@ -25,7 +25,6 @@
 E = KeyPressEvent
 
 # fmt: off
-# flake8: noqa E201
 SCROLL_UP   = MouseEventType.SCROLL_UP
 SCROLL_DOWN = MouseEventType.SCROLL_DOWN
 MOUSE_DOWN  = MouseEventType.MOUSE_DOWN

src/prompt_toolkit/key_binding/key_processor.py

@@ -10,7 +10,7 @@
 import weakref
 from asyncio import Task, sleep
 from collections import deque
-from typing import TYPE_CHECKING, Any, Deque, Generator
+from typing import TYPE_CHECKING, Any, Generator
 
 from prompt_toolkit.application.current import get_app
 from prompt_toolkit.enums import EditingMode
@@ -103,7 +103,7 @@ def reset(self) -> None:
         self._previous_handler: Binding | None = None
 
         # The queue of keys not yet send to our _process generator/state machine.
-        self.input_queue: Deque[KeyPress] = deque()
+        self.input_queue: deque[KeyPress] = deque()
 
         # The key buffer that is matched in the generator state machine.
         # (This is at at most the amount of keys that make up for one key binding.)