Add Ruff (#28)

.github/workflows/ci.yaml

@@ -25,14 +25,10 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install -r requirements.txt -r test-requirements.txt --upgrade --upgrade-strategy eager
-      - name: Check isort
-        run: isort tests pyheos --check-only
-      - name: Check black
-        run: black tests pyheos --check --fast --quiet
-      - name: Check pylint
-        run: pylint tests pyheos
-      - name: Check flake8
-        run: flake8 tests pyheos --doctests
+      - name: Lint (Ruff)
+        run: ruff check --select I
+      - name: Format (Ruff)
+        run: ruff format --check
 
   tests:
     name: "Run tests on ${{ matrix.python-version }}"

.vscode/settings.json

@@ -1,8 +1,4 @@
 {
-    "python.pythonPath": ".venv\\Scripts\\python.exe",
-    "python.linting.pylintEnabled": true,
-    "python.linting.enabled": true,
-    "python.formatting.provider": "black",
     "editor.formatOnPaste": false,
     "editor.formatOnSave": true,
     "editor.formatOnType": true,

CONTRIBUTING

@@ -6,7 +6,7 @@ Contributions welcome!
 
 ## Style
 
-This repository uses [Black](https://github.com/psf/black) for code style and formatting and [isort](https://readthedocs.org/projects/isort/) for organizing imports.  Commits and pull requests are automatically linted with pylint and flake8.
+This repository uses [Ruff](https://docs.astral.sh/ruff/) for code style and formatting. Commits and pull requests are automatically linted and checked using Ruff and must pass in order to be accepted.
 
 *Save time by checking for style/lint issues **before** committing.*:
 ```bash

pyheos/connection.py

@@ -1,10 +1,10 @@
 """Define the connection module."""
 
 import asyncio
-from collections import defaultdict
-from datetime import datetime, timedelta
 import json
 import logging
+from collections import defaultdict
+from datetime import datetime, timedelta
 from typing import Any, Dict, Optional
 
 from . import const
@@ -65,9 +65,7 @@ def __init__(
         self._reader = None  # type: asyncio.StreamReader
         self._writer = None  # type: asyncio.StreamWriter
         self._response_handler_task = None  # type: asyncio.Task
-        self._pending_commands = defaultdict(
-            list
-        )  # type: DefaultDict[str, List[ResponseEvent]]
+        self._pending_commands = defaultdict(list)  # type: DefaultDict[str, List[ResponseEvent]]
         self._sequence = 0  # type: int
         self._state = const.STATE_DISCONNECTED  # type: str
         self._auto_reconnect = False  # type: bool

pyheos/dispatch.py

@@ -1,8 +1,8 @@
 """Defines the dispatch component for notifying others of signals."""
 
 import asyncio
-from collections import defaultdict
 import functools
+from collections import defaultdict
 from typing import Any, Callable, Dict, List, Sequence
 
 TargetType = Callable[..., Any]
@@ -20,7 +20,7 @@ def __init__(
         connect: ConnectType = None,
         send: SendType = None,
         signal_prefix: str = "",
-        loop=None
+        loop=None,
     ):
         """Create a new instance of the dispatch component."""
         self._signal_prefix = signal_prefix

pyheos/heos.py

@@ -22,7 +22,7 @@ def __init__(
         timeout: float = const.DEFAULT_TIMEOUT,
         heart_beat: Optional[float] = const.DEFAULT_HEART_BEAT,
         all_progress_events=True,
-        dispatcher: Dispatcher = None
+        dispatcher: Dispatcher = None,
     ):
         """Init a new instance of the Heos CLI API."""
         self._connection = HeosConnection(
@@ -45,7 +45,7 @@ async def connect(
         self,
         *,
         auto_reconnect=False,
-        reconnect_delay: float = const.DEFAULT_RECONNECT_DELAY
+        reconnect_delay: float = const.DEFAULT_RECONNECT_DELAY,
     ):
         """Connect to the CLI."""
         await self._connection.connect(

pyproject.toml

@@ -0,0 +1,3 @@
+[tool.ruff]
+# Assume Python 3.11
+target-version = "py311"

script/lint.cmd

@@ -1,5 +1,3 @@
 @echo off
-isort tests pyheos
-black tests pyheos
-pylint tests pyheos
-flake8 tests pyheos --doctests
+ruff check --select I --fix
+ruff format

test-requirements.txt

@@ -1,10 +1,6 @@
-black==24.4.2
 coveralls==4.0.0
-flake8==7.0.0
-flake8-docstrings==1.7.0
-isort==5.13.2
-pylint==3.2.0
 pytest==8.2.0
 pytest-asyncio==0.23.6
 pytest-cov==5.0.0
-pytest-timeout==2.3.1
+pytest-timeout==2.3.1
+ruff==0.4.5