Use ruff formatter

.github/workflows/build.yml

@@ -40,7 +40,6 @@ jobs:
       matrix:
         env:
           - build
-          - format
           - generate-integration-files
           - lint
           - type

.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+  "recommendations": [
+    "charliermarsh.ruff",
+    "esbenp.prettier-vscode",
+    "ms-python.python"
+  ]
+}

.vscode/settings.json

@@ -5,7 +5,9 @@
     ".eggs": true,
     "**/*.egg-info": true,
     ".coverage": true,
+    ".mypy_cache": true,
     ".pytest_cache": true,
+    ".ruff_cache": true,
     ".tox": true
   },
   "editor.detectIndentation": false,
@@ -23,17 +25,16 @@
     "editor.wordWrapColumn": 88
   },
   "[python]": {
+    "editor.defaultFormatter": "charliermarsh.ruff",
     "editor.codeActionsOnSave": {
-      "source.organizeImports": true
+      "source.organizeImports": "explicit"
     }
   },
   "[yaml]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode",
     "editor.tabSize": 2
   },
   "python.envFile": "${workspaceFolder}/.vscode/env",
-  "python.formatting.provider": "black",
   "python.linting.pylintEnabled": true,
-  "python.testing.pytestEnabled": true,
-  "python.sortImports.args": ["-sp .isort.cfg"]
+  "python.testing.pytestEnabled": true
 }

CHANGELOG.md

@@ -20,6 +20,7 @@ adheres to [Semantic Versioning](https://semver.org/).
 - Update GitHub actions dependencies
 - Add tests for PyPy 3.10 and 3.11
 - Improve tox & CI pipelines
+- Use ruff as formatter
 
 ## [0.5.0] - 2023-02-27
 

dev-requirements.txt

@@ -4,12 +4,9 @@
 # build
 build==1.3.0
 
-# format
-black==23.1.0
-isort==5.12.0
-
 # lint
 pylint==2.16.2
+ruff==0.13.1
 
 # typing
 mypy==1.0.1

pyproject.toml

@@ -0,0 +1,7 @@
+#
+# ruff
+#
+
+[tool.ruff]
+src = ["src"]
+target-version = "py39"

src/xz/open.py

@@ -79,8 +79,7 @@ def xz_open(
     encoding: Optional[str] = None,
     errors: Optional[str] = None,
     newline: Optional[str] = None,
-) -> XZFile:
-    ...  # pragma: no cover
+) -> XZFile: ...  # pragma: no cover
 
 
 @overload
@@ -97,8 +96,7 @@ def xz_open(
     encoding: Optional[str] = None,
     errors: Optional[str] = None,
     newline: Optional[str] = None,
-) -> _XZFileText:
-    ...  # pragma: no cover
+) -> _XZFileText: ...  # pragma: no cover
 
 
 @overload
@@ -115,8 +113,7 @@ def xz_open(
     encoding: Optional[str] = None,
     errors: Optional[str] = None,
     newline: Optional[str] = None,
-) -> Union[XZFile, _XZFileText]:
-    ...  # pragma: no cover
+) -> Union[XZFile, _XZFileText]: ...  # pragma: no cover
 
 
 def xz_open(

src/xz/typing.py

@@ -24,11 +24,8 @@
 
 
 class _BlockReadStrategyType(Protocol):
-    def on_create(self, block: "XZBlock") -> None:
-        ...  # pragma: no cover
+    def on_create(self, block: "XZBlock") -> None: ...  # pragma: no cover
 
-    def on_delete(self, block: "XZBlock") -> None:
-        ...  # pragma: no cover
+    def on_delete(self, block: "XZBlock") -> None: ...  # pragma: no cover
 
-    def on_read(self, block: "XZBlock") -> None:
-        ...  # pragma: no cover
+    def on_read(self, block: "XZBlock") -> None: ...  # pragma: no cover

tests/integration/test_ram_usage.py

@@ -67,8 +67,7 @@ def test_read_linear(
         while xz_file.read(DEFAULT_BUFFER_SIZE):
             assert (
                 # should not use much more memory, take 2 as error margin
-                ram_usage()
-                < one_block_memory * 2
+                ram_usage() < one_block_memory * 2
             ), f"Consumes too much RAM (at {100 * xz_file.tell() / len(xz_file):.0f}%)"
 
 
@@ -89,9 +88,10 @@ def test_partial_read_each_block(
             else:
                 assert (
                     # default strategy is max 8 blocks, take 10 as error margin
-                    ram_usage()
-                    < one_block_memory * 10
-                ), f"Consumes too much RAM (at {100 * xz_file.tell() / len(xz_file):.0f}%)"
+                    ram_usage() < one_block_memory * 10
+                ), (
+                    f"Consumes too much RAM (at {100 * xz_file.tell() / len(xz_file):.0f}%)"
+                )
 
 
 def test_write(
@@ -115,6 +115,5 @@ def test_write(
             else:
                 assert (
                     # should not use much more memory, take 2 as error margin
-                    ram_usage()
-                    < one_block_memory * 2
+                    ram_usage() < one_block_memory * 2
                 ), f"Consumes too much RAM (at {i / nb_blocks:.0f}%)"

tests/integration/test_readme.py

@@ -48,9 +48,7 @@ def _parse_readme() -> List[Tuple[int, str]]:
         for line_no, code_block in _README_CODE_BLOCKS
     ],
 )
-def test_readme(
-    code_block: str, tmp_path: Path
-) -> None:  # pylint: disable=redefined-outer-name
+def test_readme(code_block: str, tmp_path: Path) -> None:  # pylint: disable=redefined-outer-name
     path = tmp_path / "block.txt"
     path.write_text(code_block)
     failure_count, test_count = doctest.testfile(

tests/unit/test_block.py

@@ -213,7 +213,7 @@ def test_read_wrong_uncompressed_size_too_big(
 
 
 def test_read_wrong_block_padding(
-    data_pattern_locate: Callable[[bytes], Tuple[int, int]]
+    data_pattern_locate: Callable[[bytes], Tuple[int, int]],
 ) -> None:
     fileobj = IOStatic(BLOCK_BYTES[:-5] + b"\xff" + BLOCK_BYTES[-4:])
     block = XZBlock(fileobj, 1, 89, 100)
@@ -228,7 +228,7 @@ def test_read_wrong_block_padding(
 
 
 def test_read_wrong_check(
-    data_pattern_locate: Callable[[bytes], Tuple[int, int]]
+    data_pattern_locate: Callable[[bytes], Tuple[int, int]],
 ) -> None:
     fileobj = IOStatic(BLOCK_BYTES[:-4] + b"\xff" * 4)
 
@@ -261,7 +261,7 @@ def test_read_truncated_data() -> None:
 
 
 def test_read_decompressor_eof(
-    data_pattern_locate: Callable[[bytes], Tuple[int, int]]
+    data_pattern_locate: Callable[[bytes], Tuple[int, int]],
 ) -> None:
     fileobj = IOStatic(
         bytes.fromhex(

tox.ini

@@ -3,7 +3,7 @@
 [tox]
 envlist =
     py, py39, py310, py311, pypy3
-    build, format, generate-integration-files, lint, type
+    build, generate-integration-files, lint, type
 
 [testenv]
 package = wheel
@@ -27,16 +27,6 @@ deps =
 commands =
     python -m build
 
-[testenv:format]
-basepython = python3.11
-skip_install = true
-deps =
-    black==23.1.0
-    isort==5.12.0
-commands =
-    black {posargs:--check --diff} src tests
-    isort {posargs:--check --diff} src tests
-
 [testenv:generate-integration-files]
 basepython = python3.11
 deps =
@@ -53,7 +43,9 @@ basepython = python3.11
 deps =
     pylint==2.16.2
     pytest==7.2.1 # to avoid import errors
+    ruff==0.13.1
 commands =
+    ruff format --check src tests
     pylint src
     pylint -d duplicate-code,too-many-statements,use-implicit-booleaness-not-comparison tests