use ruff instead of black (#598)

Author: methane

.github/workflows/docs.yaml

@@ -10,22 +10,25 @@ jobs:
 
     runs-on: ubuntu-latest
     steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
       - name: Setup Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: '3.x'
           architecture: 'x64'
-
-      - name: Checkout
-        uses: actions/checkout@v4
+          cache: "pip"
+          cache-dependency-path: |
+            requirements.txt
+            docs/requirements.txt
 
       - name: Build
-        shell: bash
         run: |
           pip install -r requirements.txt
           make cython
 
       - name: Sphinx Documentation Generator
         run: |
-          pip install tox
-          tox -e sphinx
+          pip install -r docs/requirements.txt
+          make docs

.github/workflows/black.yaml renamed to .github/workflows/lint.yaml

@@ -1,25 +1,22 @@
-name: Black
+name: lint
 
 on: ["push", "pull_request"]
 
 jobs:
-  black:
+  lint:
     # We want to run on external PRs, but not on our own internal PRs as they'll be run
     # by the push to the branch.
     if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
 
     runs-on: ubuntu-latest
     steps:
-      - name: Setup Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.x'
-          architecture: 'x64'
-
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Black Code Formatter
+      - name: ruff check
+        run: |
+          pipx run ruff check --diff msgpack/ test/ setup.py
+
+      - name: ruff format
         run: |
-          pip install black==22.3.0
-          black -S --diff --check msgpack/ test/ setup.py
+          pipx run ruff format --diff msgpack/ test/ setup.py

Makefile

@@ -4,9 +4,17 @@ PYTHON_SOURCES = msgpack test setup.py
 all: cython
 	python setup.py build_ext -i -f
 
-.PHONY: black
-black:
-	black $(PYTHON_SOURCES)
+.PHONY: format
+format:
+	pipx run ruff format $(PYTHON_SOURCES)
+
+.PHONY: lint
+lint:
+	pipx run ruff check $(PYTHON_SOURCES)
+
+.PHONY: doc
+doc:
+	cd docs && sphinx-build -n -v -W --keep-going -b html -d doctrees . html
 
 .PHONY: pyupgrade
 pyupgrade:

docs/requirements.txt

@@ -1,2 +1,2 @@
-sphinx~=7.2
-sphinx-rtd-theme~=1.3.0
+sphinx~=7.3.7
+sphinx-rtd-theme~=2.0.0

msgpack/fallback.py

@@ -1,4 +1,5 @@
 """Fallback pure Python implementation of msgpack"""
+
 from datetime import datetime as _DateTime
 import sys
 import struct

pyproject.toml

@@ -54,9 +54,9 @@ skip_string_normalization = true
 [tool.ruff]
 line-length = 100
 target-version = "py38"
-ignore = []
+lint.ignore = []
 
-[tool.ruff.per-file-ignores]
+[tool.ruff.lint.per-file-ignores]
 "msgpack/__init__.py" = ["F401", "F403"]
 "msgpack/fallback.py" = ["E731"]
 "test/test_seq.py" = ["E501"]

requirements.txt

@@ -1,7 +1,2 @@
 # Also declared in pyproject.toml, if updating here please also update there.
-Cython~=3.0.8
-
-# Tools required only for development. No need to add it to pyproject.toml file.
-black==23.3.0
-pytest==7.3.1
-pyupgrade==3.3.2
+Cython~=3.0.10

test/test_memoryview.py

@@ -95,4 +95,4 @@ def test_multidim_memoryview():
     view = memoryview(b"\00" * 6)
     data = view.cast(view.format, (3, 2))
     packed = packb(data)
-    assert packed == b'\xc4\x06\x00\x00\x00\x00\x00\x00'
+    assert packed == b"\xc4\x06\x00\x00\x00\x00\x00\x00"

test/test_pack.py

@@ -89,7 +89,7 @@ def testStrictUnicodeUnpack():
 
 def testIgnoreErrorsPack():
     re = unpackb(
-        packb("abc\uDC80\uDCFFdef", use_bin_type=True, unicode_errors="ignore"),
+        packb("abc\udc80\udcffdef", use_bin_type=True, unicode_errors="ignore"),
         raw=False,
         use_list=1,
     )

test/test_read_size.py

@@ -1,4 +1,5 @@
 """Test Unpacker's read_array_header and read_map_header methods"""
+
 from msgpack import packb, Unpacker, OutOfData
 
 UnexpectedTypeException = ValueError