Merge pull request #97 from pyvisa/ruff

Use ruff for linting and formatting the codebase

.github/workflows/ci.yml

@@ -34,17 +34,13 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install -r dev-requirements.txt
-      - name: Isort
+      - name: Format
         run: |
-          isort pyvisa_sim -c;
-      - name: Black
+          ruff format pyvisa_sim;
+      - name: Lint
         if: always()
         run: |
-          black pyvisa_sim --check;
-      - name: Flake8
-        if: always()
-        run: |
-          flake8 pyvisa_sim;
+          ruff check pyvisa_sim;
       - name: Mypy
         if: always()
         run: |
@@ -58,7 +54,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
     steps:
       - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}

.pre-commit-config.yaml

@@ -1,16 +1,12 @@
 repos:
-  - repo: https://github.com/pre-commit/mirrors-isort
-    rev: v5.10.1
-    hooks:
-      - id: isort
-  - repo: https://github.com/psf/black
-    rev: 22.10.0
-    hooks:
-      - id: black
-  - repo: https://github.com/pycqa/flake8
-    rev: 6.0.0
-    hooks:
-      - id: flake8
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.3.0
+    hooks:
+      # Run the linter.
+      - id: ruff
+      # Run the formatter.
+      - id: ruff-format
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: v0.991 # Use the sha / tag you want to point at
     hooks:

dev-requirements.txt

@@ -1,9 +1,7 @@
 pyvisa
-black
-flake8
+ruff
 mypy
 types-PyYAML
-isort
 pytest
 sphinx
 sphinx-rtd-theme

pyproject.toml

@@ -36,6 +36,7 @@ classifiers = [
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
 ]
 dependencies = [
     "pyvisa>=1.11.0",
@@ -80,8 +81,21 @@ del namedtuple, _version_info, parts
 __version__ = "{version}"
 """
 
-[tool.black]
-line-length = 88  # Enforce the default value
+[tool.ruff]
+  src = ["src"]
+  extend-exclude = ["pyvisa/thirdparty/*"]
+  line-length = 88
+
+  [tool.ruff.lint]
+    select = ["C", "E", "F", "W", "I", "C90", "RUF"]
+    extend-ignore = ["E501", "RUF012"]
+
+    [tool.ruff.lint.isort]
+      combine-as-imports = true
+      known-first-party = ["pyvisa"]
+
+    [tool.ruff.lint.mccabe]
+      max-complexity = 20
 
 [tool.pytest.ini_options]
 minversion = "6.0"
@@ -96,6 +110,28 @@ module = [
 ]
 ignore_missing_imports = true
 
-[tool.isort]
-profile = "black"
+[tool.coverage]
+  [tool.coverage.run]
+    branch = true
+    source = ["pyvisa_sim"]
+
+  [tool.coverage.report]
+    # Regexes for lines to exclude from consideration
+    exclude_lines = [
+      # Have to re-enable the standard pragma
+      "pragma: no cover",
+
+      # Don't complain if tests don't hit defensive assertion code:
+      "raise NotImplementedError",
+      "pass",
+
+      # Don't complain about abstract methods, they aren't run:
+      "@(abc\\.)?abstractmethod",
+
+      # Don't complain about type checking
+      "if TYPE_CHECKING:",
+
+      # Don't complain about ellipsis in overload
+      "\\.\\.\\.",
+    ]
 

pyvisa_sim/__init__.py

@@ -5,6 +5,7 @@
 :license: MIT, see LICENSE for more details.
 
 """
+
 from importlib.metadata import PackageNotFoundError, version
 
 from .highlevel import SimVisaLibrary

pyvisa_sim/channels.py

@@ -5,6 +5,7 @@
 :license: MIT, see LICENSE for more details.
 
 """
+
 from collections import defaultdict
 from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple, TypeVar
 

pyvisa_sim/common.py

@@ -8,8 +8,9 @@
 :license: MIT, see LICENSE for more details.
 
 """
+
 import logging
-from typing import Callable, Iterator, Optional, Sequence
+from typing import Iterator, Optional, Sequence
 
 from pyvisa import logger
 
@@ -87,5 +88,7 @@ def iter_bytes(
             raise ValueError(f"Unknown 'send_end' value '{send_end}'")
 
 
-int_to_byte: Callable[[int], bytes] = lambda val: bytes([val])
-last_int: Callable[[Sequence[int]], int] = lambda val: val[-1]
+def int_to_byte(val: int) -> bytes:
+    return bytes([val])
+def last_int(val: Sequence[int]) -> int:
+    return val[-1]

pyvisa_sim/component.py

@@ -5,6 +5,7 @@
 :license: MIT, see LICENSE for more details.
 
 """
+
 import enum
 from typing import (
     Dict,
@@ -40,13 +41,11 @@ class Responses(enum.Enum):
 
 
 @overload
-def to_bytes(val: str) -> bytes:
-    ...
+def to_bytes(val: str) -> bytes: ...
 
 
 @overload
-def to_bytes(val: Literal[Responses.NO]) -> Literal[Responses.NO]:
-    ...
+def to_bytes(val: Literal[Responses.NO]) -> Literal[Responses.NO]: ...
 
 
 def to_bytes(val):
@@ -108,7 +107,7 @@ def __init__(self, specs: Dict[str, str]) -> None:
 
         self.min = specs_type(specs["min"]) if "min" in specs else None
         self.max = specs_type(specs["max"]) if "max" in specs else None
-        self.valid = set([specs_type(val) for val in specs.get("valid", ())])
+        self.valid = {specs_type(val) for val in specs.get("valid", ())}
 
 
 class Property(Generic[T]):

pyvisa_sim/devices.py

@@ -5,6 +5,7 @@
 :license: MIT, see LICENSE for more details.
 
 """
+
 from typing import Dict, List, Optional, Tuple, Union
 
 from pyvisa import constants, rname

pyvisa_sim/highlevel.py

@@ -5,6 +5,7 @@
 :license: MIT, see LICENSE for more details.
 
 """
+
 import random
 from collections import OrderedDict
 from traceback import format_exc
@@ -71,12 +72,10 @@ def _init(self) -> None:
             raise type(e)(msg % format_exc())
 
     @overload
-    def _register(self, obj: "SimVisaLibrary") -> VISARMSession:
-        ...
+    def _register(self, obj: "SimVisaLibrary") -> VISARMSession: ...
 
     @overload
-    def _register(self, obj: Session) -> VISASession:
-        ...
+    def _register(self, obj: Session) -> VISASession: ...
 
     def _register(self, obj):
         """Creates a random but unique session handle for a session object.

pyvisa_sim/parser.py

@@ -5,6 +5,7 @@
 :license: MIT, see LICENSE for more details.
 
 """
+
 import importlib.resources
 import os
 import pathlib
@@ -67,7 +68,7 @@ def _get_pair(dd: Dict[str, str]) -> Tuple[str, str]:
 
 
 def _get_triplet(
-    dd: Dict[str, str]
+    dd: Dict[str, str],
 ) -> Tuple[str, Union[str, Literal[Responses.NO]], Union[str, Literal[Responses.NO]]]:
     """Return a triplet from a dialogue dictionary."""
     return (

pyvisa_sim/sessions/gpib.py

@@ -5,6 +5,7 @@
 :license: MIT, see LICENSE for more details.
 
 """
+
 from pyvisa import constants, rname
 
 from . import session

pyvisa_sim/sessions/serial.py

@@ -5,6 +5,7 @@
 :license: MIT, see LICENSE for more details.
 
 """
+
 import time
 from typing import Tuple
 

pyvisa_sim/sessions/session.py

@@ -5,6 +5,7 @@
 :license: MIT, see LICENSE for more details.
 
 """
+
 import time
 from typing import Any, Callable, Dict, Optional, Tuple, Type, TypeVar
 
@@ -34,9 +35,9 @@ class Session:
 
     #: Maps (Interface Type, Resource Class) to Python class encapsulating that resource.
     #: dict[(Interface Type, Resource Class) , Session]
-    _session_classes: Dict[
-        Tuple[constants.InterfaceType, str], Type["Session"]
-    ] = dict()
+    _session_classes: Dict[Tuple[constants.InterfaceType, str], Type["Session"]] = (
+        {}
+    )
 
     #: Session handler for the resource manager.
     session_type: Tuple[constants.InterfaceType, str]

pyvisa_sim/sessions/tcpip.py

@@ -5,6 +5,7 @@
 :license: MIT, see LICENSE for more details.
 
 """
+
 from pyvisa import constants, rname
 
 from . import session
@@ -23,9 +24,9 @@ def after_parsing(self) -> None:
             self.parsed.board
         )
         self.attrs[constants.ResourceAttribute.tcpip_address] = self.parsed.host_address
-        self.attrs[
-            constants.ResourceAttribute.tcpip_device_name
-        ] = self.parsed.lan_device_name
+        self.attrs[constants.ResourceAttribute.tcpip_device_name] = (
+            self.parsed.lan_device_name
+        )
 
 
 @session.Session.register(constants.InterfaceType.tcpip, "SOCKET")

pyvisa_sim/sessions/usb.py

@@ -5,6 +5,7 @@
 :license: MIT, see LICENSE for more details.
 
 """
+
 from typing import Union
 
 from pyvisa import constants, rname
@@ -19,13 +20,13 @@ def after_parsing(self) -> None:
         self.attrs[constants.ResourceAttribute.interface_number] = int(
             self.parsed.board
         )
-        self.attrs[
-            constants.ResourceAttribute.manufacturer_id
-        ] = self.parsed.manufacturer_id
+        self.attrs[constants.ResourceAttribute.manufacturer_id] = (
+            self.parsed.manufacturer_id
+        )
         self.attrs[constants.ResourceAttribute.model_code] = self.parsed.model_code
-        self.attrs[
-            constants.ResourceAttribute.usb_serial_number
-        ] = self.parsed.serial_number
+        self.attrs[constants.ResourceAttribute.usb_serial_number] = (
+            self.parsed.serial_number
+        )
         self.attrs[constants.ResourceAttribute.usb_interface_number] = int(
             self.parsed.board
         )

pyvisa_sim/testsuite/conftest.py

@@ -1,6 +1,7 @@
 import os
 
 import pytest
+
 import pyvisa
 
 

pyvisa_sim/testsuite/test_all.py

@@ -2,6 +2,7 @@
 import logging
 
 import pytest
+
 from pyvisa.errors import VisaIOError
 
 

pyvisa_sim/testsuite/test_serial.py

@@ -1,6 +1,5 @@
 # -*- coding: utf-8 -*-
 import pyvisa
-
 from pyvisa_sim.sessions import serial
 
 serial.SerialInstrumentSession