Add option to use ruff as formatter (#537)

Author: cdce8p

README.md

@@ -12,6 +12,7 @@ It uses token analysis and
 - [isort][isort]
 - [autoflake][autoflake]
 - [black][black]
+- [ruff][ruff]
 - git
 
 to try and update the typing syntax the best it can.
@@ -48,7 +49,8 @@ In particular, these need to be updated manually:
    unused. If not, revert changes with `git restore`.
 4. Remove unused imports with [autoflake][autoflake].
 5. Run [isort][isort] to try to restore the previous formatting.
-6. Optional: Run [black][black]. (Requires `black` to be added as `additional_dependency`)
+6. Optional: Run [black][black]. (Requires `black` to be added as `additional_dependency`)  
+   OR: Run [ruff][ruff]. (Requires `ruff` to be added as `additional_dependency`)
 7. Check `git diff` for modified comments.
    If one is detected, revert changes and print file name.
    Can be overwritten with `--force`.
@@ -101,6 +103,15 @@ To use it, add `black` as `additional_dependency` in your `.pre-commit-config.ya
           - black==<insert current version here!>
 ```
 
+**`--ruff`**  
+Run `ruff check --fix` and `ruff format` after updates.  
+To use it, add `ruff` as `additional_dependency` in your `.pre-commit-config.yaml`.
+
+```yaml
+        additional_dependencies:
+          - ruff==<insert current version here!>
+```
+
 **`--disable-committed-check`**  
 Don't abort with uncommitted changes. **Don't use it in production!**
 Risk of losing uncommitted changes.
@@ -154,6 +165,7 @@ See [LICENSE][LICENSE_FILE] for the full license text.
 [isort]: https://github.com/PyCQA/isort
 [autoflake]: https://github.com/PyCQA/autoflake
 [black]: https://github.com/psf/black
+[ruff]: https://github.com/astral-sh/ruff
 [PEP585]: https://www.python.org/dev/peps/pep-0585/
 [PEP604]: https://www.python.org/dev/peps/pep-0604/
 

pyproject.toml

@@ -36,6 +36,9 @@ dependencies    = [
 black = [
     "black==24.10.0",
 ]
+ruff = [
+    "ruff==0.6.9",
+]
 
 [project.scripts]
 python-typing-update = "python_typing_update.__main__:main"

python_typing_update/__main__.py

@@ -29,6 +29,7 @@ async def async_main(argv: list[str] | None = None) -> int:
         description="Tool to update Python typing syntax.",
         formatter_class=CustomHelpFormatter,
     )
+    formatter_options = parser.add_argument_group("select optional formatter")
     mode_options = parser.add_argument_group("select different mode")
     py_version_options = parser.add_argument_group("python version options")
 
@@ -60,14 +61,21 @@ async def async_main(argv: list[str] | None = None) -> int:
         help="Keep updates even if no import was removed",
     )
     parser.add_argument(
+        '--disable-committed-check',
+        action='store_true',
+        help="Don't abort with uncommitted changes. Don't use it in production!",
+    )
+
+    group_formatter = formatter_options.add_mutually_exclusive_group()
+    group_formatter.add_argument(
         '--black',
         action='store_true',
-        help="Run black formatting after update",
+        help="Run 'black' after update",
     )
-    parser.add_argument(
-        '--disable-committed-check',
+    group_formatter.add_argument(
+        '--ruff',
         action='store_true',
-        help="Don't abort with uncommitted changes. Don't use it in production!",
+        help="Run 'ruff check --fix' and 'ruff format' after update",
     )
 
     group_mode = mode_options.add_mutually_exclusive_group()
@@ -95,11 +103,11 @@ async def async_main(argv: list[str] | None = None) -> int:
     group_py_version.add_argument(
         '--py38-plus',
         action='store_const', dest='min_version', const=(3, 8),
-        help="Default"
     )
     group_py_version.add_argument(
         '--py39-plus',
         action='store_const', dest='min_version', const=(3, 9),
+        help="Default"
     )
     group_py_version.add_argument(
         '--py310-plus',
@@ -127,10 +135,17 @@ async def async_main(argv: list[str] | None = None) -> int:
 
     if args.black:
         try:
-            # pylint: disable=unused-import,import-outside-toplevel
+            # pylint: disable-next=unused-import,import-outside-toplevel
             import black  # noqa: F401
         except ImportError:
-            print("Error! Black is not installed")
+            print("Error! Black isn't installed")
+            return 2
+    elif args.ruff:
+        try:
+            # pylint: disable-next=unused-import,import-outside-toplevel
+            import ruff  # noqa: F401
+        except ImportError:
+            print("Error! Ruff isn't installed")
             return 2
 
     return await async_run(args)

python_typing_update/main.py

@@ -107,6 +107,14 @@ async def typing_update(
             stderr=asyncio.subprocess.DEVNULL,
         )
         await process.communicate()
+    elif args.ruff:
+        process = await asyncio.create_subprocess_shell(
+            f"ruff check --force-exclude --fix {filename} && "
+            f"ruff format --force-exclude {filename}",
+            stdout=asyncio.subprocess.DEVNULL,
+            stderr=asyncio.subprocess.DEVNULL,
+        )
+        await process.communicate()
 
     return 0, filename
 

requirements_ruff.txt

@@ -0,0 +1 @@
+ruff==0.6.9