Add ruff fast linter and formatter (#1336)

* Add ruff fast linter and formatter in preparation for using it to replace black, isort, and flake8

* Fix mypy issue

* Replace black, isort, and flake8 with ruff and remove former three

* Fix typo in ruff linting

* Removed a couple empty .format() calls

Author: tleonhardt

.github/CONTRIBUTING.md

@@ -2,7 +2,7 @@
 # https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
 name: Format
 
-on: [push, pull_request]
+on: [ push, pull_request ]
 
 permissions:
   contents: read
@@ -11,8 +11,8 @@ jobs:
   lint:
     strategy:
       matrix:
-        os: [ubuntu-latest]
-        python-version: ["3.12"]
+        os: [ ubuntu-latest ]
+        python-version: [ "3.12" ]
       fail-fast: false
     runs-on: ${{ matrix.os }}
     steps:
@@ -26,8 +26,6 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install python prerequisites
-        run: pip install -U --user pip setuptools setuptools-scm black isort
-      - name: Black
-        run: python -m black --check --diff .
-      - name: isort
-        run: python -m isort --check-only .
+        run: pip install -U --user ruff
+      - name: Ruff format
+        run: ruff format --check

.github/workflows/format.yml

@@ -2,7 +2,7 @@
 # https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
 name: Lint
 
-on: [push, pull_request]
+on: [ push, pull_request ]
 
 permissions:
   contents: read
@@ -11,8 +11,8 @@ jobs:
   lint:
     strategy:
       matrix:
-        os: [ubuntu-latest]
-        python-version: ["3.12"]
+        os: [ ubuntu-latest ]
+        python-version: [ "3.12" ]
       fail-fast: false
     runs-on: ${{ matrix.os }}
     steps:
@@ -26,6 +26,6 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install python prerequisites
-        run: pip install -U --user pip setuptools setuptools-scm nox
-      - name: Lint
-        run: python -m nox --non-interactive --session validate-${{ matrix.python-version }} -k flake8
+        run: pip install -U --user ruff
+      - name: Ruff lint
+        run: ruff check

.github/workflows/lint.yml

@@ -43,3 +43,6 @@ Pipfile.lock
 
 # pyenv version file
 .python-version
+
+# uv
+uv.lock

.gitignore

@@ -9,18 +9,15 @@ setuptools = ">=34.4"
 wcwidth = ">=0.1.7"
 
 [dev-packages]
-black = "*"
-cmd2 = {editable = true,path = "."}
-cmd2_ext_test = {editable = true,path = "plugins/ext_test"}
+cmd2 = { editable = true, path = "." }
+cmd2_ext_test = { editable = true, path = "plugins/ext_test" }
 codecov = "*"
 doc8 = "*"
-flake8 = "*"
-gnureadline = {version = "*",sys_platform = "== 'darwin'"}
+gnureadline = { version = "*", sys_platform = "== 'darwin'" }
 invoke = "*"
 ipython = "*"
-isort = "*"
 mypy = "*"
-pyreadline3 = {version = ">=3.4",sys_platform = "== 'win32'"}
+pyreadline3 = { version = ">=3.4", sys_platform = "== 'win32'" }
 pytest = "*"
 pytest-cov = "*"
 pytest-mock = "*"

Pipfile

@@ -2,7 +2,8 @@
 """
 Support for ANSI escape sequences which are used for things like applying style to text,
 setting the window title, and asynchronous alerts.
- """
+"""
+
 import functools
 import re
 from enum import (
@@ -62,25 +63,25 @@ def __repr__(self) -> str:
 """
 
 # Regular expression to match ANSI style sequence
-ANSI_STYLE_RE = re.compile(fr'{ESC}\[[^m]*m')
+ANSI_STYLE_RE = re.compile(rf'{ESC}\[[^m]*m')
 
 # Matches standard foreground colors: CSI(30-37|90-97|39)m
-STD_FG_RE = re.compile(fr'{ESC}\[(?:[39][0-7]|39)m')
+STD_FG_RE = re.compile(rf'{ESC}\[(?:[39][0-7]|39)m')
 
 # Matches standard background colors: CSI(40-47|100-107|49)m
-STD_BG_RE = re.compile(fr'{ESC}\[(?:(?:4|10)[0-7]|49)m')
+STD_BG_RE = re.compile(rf'{ESC}\[(?:(?:4|10)[0-7]|49)m')
 
 # Matches eight-bit foreground colors: CSI38;5;(0-255)m
-EIGHT_BIT_FG_RE = re.compile(fr'{ESC}\[38;5;(?:1?[0-9]?[0-9]?|2[0-4][0-9]|25[0-5])m')
+EIGHT_BIT_FG_RE = re.compile(rf'{ESC}\[38;5;(?:1?[0-9]?[0-9]?|2[0-4][0-9]|25[0-5])m')
 
 # Matches eight-bit background colors: CSI48;5;(0-255)m
-EIGHT_BIT_BG_RE = re.compile(fr'{ESC}\[48;5;(?:1?[0-9]?[0-9]?|2[0-4][0-9]|25[0-5])m')
+EIGHT_BIT_BG_RE = re.compile(rf'{ESC}\[48;5;(?:1?[0-9]?[0-9]?|2[0-4][0-9]|25[0-5])m')
 
 # Matches RGB foreground colors: CSI38;2;(0-255);(0-255);(0-255)m
-RGB_FG_RE = re.compile(fr'{ESC}\[38;2(?:;(?:1?[0-9]?[0-9]?|2[0-4][0-9]|25[0-5])){{3}}m')
+RGB_FG_RE = re.compile(rf'{ESC}\[38;2(?:;(?:1?[0-9]?[0-9]?|2[0-4][0-9]|25[0-5])){{3}}m')
 
 # Matches RGB background colors: CSI48;2;(0-255);(0-255);(0-255)m
-RGB_BG_RE = re.compile(fr'{ESC}\[48;2(?:;(?:1?[0-9]?[0-9]?|2[0-4][0-9]|25[0-5])){{3}}m')
+RGB_BG_RE = re.compile(rf'{ESC}\[48;2(?:;(?:1?[0-9]?[0-9]?|2[0-4][0-9]|25[0-5])){{3}}m')
 
 
 def strip_style(text: str) -> str:

cmd2/ansi.py

@@ -92,7 +92,7 @@ def _looks_like_flag(token: str, parser: argparse.ArgumentParser) -> bool:
         return False
 
     # Flags have to start with a prefix character
-    if not token[0] in parser.prefix_chars:
+    if token[0] not in parser.prefix_chars:
         return False
 
     # If it looks like a negative number, it is not a flag unless there are negative-number-like flags

cmd2/argparse_completer.py

@@ -2,6 +2,7 @@
 """
 This module provides basic ability to copy from and paste to the clipboard/pastebuffer.
 """
+
 import typing
 
 import pyperclip  # type: ignore[import]

cmd2/clipboard.py

@@ -21,6 +21,7 @@
 
 Git repository on GitHub at https://github.com/python-cmd2/cmd2
 """
+
 # This module has many imports, quite a few of which are only
 # infrequently utilized. To reduce the initial overhead of
 # import this module, many of these imports are lazy-loaded
@@ -2019,9 +2020,8 @@ def _determine_ap_completer_type(parser: argparse.ArgumentParser) -> Type[argpar
         :param parser: the parser to examine
         :return: type of ArgparseCompleter
         """
-        completer_type: Optional[
-            Type[argparse_completer.ArgparseCompleter]
-        ] = parser.get_ap_completer_type()  # type: ignore[attr-defined]
+        Completer = Optional[Type[argparse_completer.ArgparseCompleter]]
+        completer_type: Completer = parser.get_ap_completer_type()  # type: ignore[attr-defined]
 
         if completer_type is None:
             completer_type = argparse_completer.DEFAULT_AP_COMPLETER
@@ -5537,7 +5537,7 @@ def cmdloop(self, intro: Optional[str] = None) -> int:  # type: ignore[override]
         """
         # cmdloop() expects to be run in the main thread to support extensive use of KeyboardInterrupts throughout the
         # other built-in functions. You are free to override cmdloop, but much of cmd2's features will be limited.
-        if not threading.current_thread() is threading.main_thread():
+        if threading.current_thread() is not threading.main_thread():
             raise RuntimeError("cmdloop must be run in the main thread")
 
         # Register signal handlers

cmd2/cmd2.py

@@ -2,6 +2,7 @@
 """
 Supports the definition of commands in separate classes to be composed into cmd2.Cmd
 """
+
 from typing import (
     TYPE_CHECKING,
     Callable,