Migrate to ruff and pre-commit (#17)

.github/workflows/release.yml

@@ -14,7 +14,7 @@ jobs:
         python-version: '3.10'
     - run: poetry install
     - uses: tschm/token-mint-action@v1.0.3
-      id: mint          
+      id: mint
     - run: poetry publish --build -u __token__ -p $PYPI_TOKEN
       env:
         PYPI_TOKEN: ${{ steps.mint.outputs.api-token }}

.github/workflows/test.yml

@@ -10,8 +10,6 @@ jobs:
     strategy:
       matrix:
         action:
-        - style
-        - lint
         - test
         - coverage
     steps:
@@ -23,3 +21,10 @@ jobs:
         python-version: '3.10'
     - run: poetry install
     - run: poetry run poe ${{ matrix.action }}
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pre-commit/action@v3.0.1
+        env:
+          SKIP: poetry-lock

.pre-commit-config.yaml

@@ -0,0 +1,26 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v5.0.0
+  hooks:
+    - id: check-json
+    - id: check-toml
+    - id: check-yaml
+    - id: end-of-file-fixer
+      exclude: ^tests/.*\.data/
+    - id: mixed-line-ending
+    - id: trailing-whitespace
+- repo: https://github.com/python-poetry/poetry
+  rev: 2.0.1
+  hooks:
+  - id: poetry-check
+  - id: poetry-lock
+- repo: https://github.com/python-poetry/poetry
+  rev: 2.0.1
+  hooks:
+  - id: poetry-install
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.9.4
+  hooks:
+  - id: ruff
+    args: [--fix, --exit-non-zero-on-fix]
+  - id: ruff-format

README.md

@@ -10,9 +10,6 @@
     <a href="https://www.gnu.org/licenses/gpl-3.0">
         <img alt="license" src="https://img.shields.io/badge/license-GPL3-blue.svg">
     </a>
-    <a href="https://github.com/psf/black">
-        <img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg">
-    </a>
 </p>
 
 ## Description

blobopera/backend/__init__.py

@@ -5,3 +5,5 @@
 """
 
 from .backend import Backend
+
+__all__ = ["Backend"]

blobopera/command/common.py

@@ -3,6 +3,7 @@
 This file provides data import functions and some shared defaults and
 enumerations used by choice-like subcommand options.
 """
+
 from enum import Enum
 from typing import Type
 
@@ -73,8 +74,8 @@ class FillPhoneme(str, Enum):
     SILENCE = "SILENCE"
     A = "A"
     E = "E"
-    I = "I"
-    O = "O"
+    I = "I"  # noqa: E741
+    O = "O"  # noqa: E741
     U = "U"
 
 

blobopera/command/libretto.py

@@ -1,4 +1,5 @@
 """Inspect the default corpus of libretto texts."""
+
 import requests
 import typer
 

blobopera/command/recording.py

@@ -1,4 +1,5 @@
 """Operate with recording files and scores."""
+
 import tempfile
 from pathlib import Path
 
@@ -149,7 +150,7 @@ def _import(  # Prepend an underscore because import is a reserved keyword.
         tempo=tempo,
         parts=parts,
         fill=Phoneme[fill.value],
-        location=Location[location.value]
+        location=Location[location.value],
     )
 
     output.write(

blobopera/jitter.py

@@ -5,6 +5,7 @@
 be used to serialize and deserialize the ``jittertemplates.proto`` file from
 the original Blob Opera application.
 """
+
 from functools import partial
 from random import Random
 from typing import Any, Callable, Iterator
@@ -90,7 +91,6 @@ def __iter__(self) -> Iterator[float]:
 
         # Iterate over randomly chosen templates with (previous, current) pairs
         for previous, current in pairwise(random):  # (0, 1), (1, 2), (2, 3)...
-
             # Get the tail (last values) of the previous template and the head
             # (first values) of the current template. Due to an off-by-one
             # error in the original code, the tail from the previous template

blobopera/languages/__init__.py

@@ -3,6 +3,9 @@
 These modules provide parsers for converting lyrics from different languages
 into sequences of phonemes following the Blob Opera phoneme format.
 """
+
 from .generic import GenericLanguage
 from .language import Language
 from .random import RandomLanguage
+
+__all__ = ["GenericLanguage", "Language", "RandomLanguage"]

blobopera/languages/generic.py

@@ -3,6 +3,7 @@
 This language module aims to achieve a good enough universal phoneme conversion
 if there isn't a better alternative.
 """
+
 import re
 import unicodedata
 from typing import List

blobopera/languages/language.py

@@ -3,6 +3,7 @@
 This file describes a protocol for the interaction between the recording
 importer and the different language classes.
 """
+
 from abc import abstractmethod
 from typing import List, Protocol
 

blobopera/languages/random.py

@@ -3,6 +3,7 @@
 This language module provides random lyrics as seen in the default Blob Opera
 carols. It should be avoided, whenever desirable, in favor of actual lyrics.
 """
+
 import random
 from typing import Callable, List
 

blobopera/libretto.py

@@ -10,6 +10,7 @@
     a good reference for translating Italian lyrics to phonemes with the
     :py:class:`Phoneme` syntax.
 """
+
 import proto  # type: ignore
 
 from .phoneme import Phoneme

blobopera/location.py

@@ -3,6 +3,7 @@
 This module describes the location pictures that can be used in
 the Blob Opera application user interface.
 """
+
 import proto  # type: ignore
 
 __protobuf__ = proto.module(package=__name__)

blobopera/phoneme.py

@@ -5,6 +5,7 @@
     Eclesiastical Latin in mind, so it's quite hard to describe certain sounds
     from other languages, like the German vowels ü, ö and ä.
 """
+
 import proto  # type: ignore
 
 __protobuf__ = proto.module(package=__name__)
@@ -18,10 +19,10 @@ class Phoneme(proto.Enum):
         the total absence of sound.
     """
 
-    I = 0
+    I = 0  # noqa: E741
     A = 1
     E = 2
-    O = 3
+    O = 3  # noqa: E741
     SILENCE = 4
     R = 5
     N = 6

blobopera/theme.py

@@ -3,6 +3,7 @@
 This module describes the themes that can be used in the Blob Opera application
 user interface.
 """
+
 import proto  # type: ignore
 
 __protobuf__ = proto.module(package=__name__)

documentation/steganography/README.md

@@ -24,7 +24,7 @@ Users that are in the know can build an extended descriptor in order to retrieve
     ```
     00000000: 0a0d 4865 6c6c 6f2c 2077 6f72 6c64 21    ..Hello, world!
     ```
-    
+
 2. Bob uploads a crafted message, which includes a valid greeting along with a hidden string, by using the following descriptor:
     ```proto
     syntax = "proto2";
@@ -40,7 +40,7 @@ Users that are in the know can build an extended descriptor in order to retrieve
     00000010: 134a 6f68 616e 6e65 7320 5472 6974 6865  .Johannes Trithe
     00000020: 6d69 7573                                mius
     ```
-    
+
 3. Alice stores the uploaded message as-is on her public server because she's able to parse it without noticing any difference.
 4. Charles downloads the message and parses it with the extended descriptor in order to recover the hidden text.
 

documentation/steganography/example.ipynb

@@ -1,9 +1,11 @@
 {
   "nbformat": 4,
   "nbformat_minor": 0,
+  "metadata" : {},
   "cells": [
     {
       "cell_type": "code",
+      "metadata" : {},
       "source": [
         "%%bash\n",
         "cat > alice.proto <<-END\n",
@@ -19,6 +21,7 @@
     },
     {
       "cell_type": "code",
+      "metadata" : {},
       "source": [
         "%%bash\n",
         "cat > bob.proto <<-END\n",
@@ -35,6 +38,7 @@
     },
     {
       "cell_type": "code",
+      "metadata" : {},
       "source": [
         "%%bash\n",
         "protoc --encode InconspicuousMessage bob.proto > message.bin <<-END\n",
@@ -47,6 +51,7 @@
     },
     {
       "cell_type": "code",
+      "metadata" : {},
       "source": [
         "%%bash\n",
         "protoc --decode InconspicuousMessage alice.proto < message.bin"
@@ -65,6 +70,7 @@
     },
     {
       "cell_type": "code",
+      "metadata" : {},
       "source": [
         "%%bash\n",
         "protoc --decode InconspicuousMessage bob.proto < message.bin"
@@ -83,6 +89,7 @@
     },
     {
       "cell_type": "code",
+      "metadata" : {},
       "source": [
         "%%bash\n",
         "protoc --decode_raw < message.bin"