Migrate from flake8/black/isort to ruff (#625)

* Migrate to ruff formatting

* Reformat using ruff

Author: Uxio0

.pre-commit-config.yaml

@@ -1,29 +1,21 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
-  - repo: https://github.com/PyCQA/isort
-    rev: 8.0.1
-    hooks:
-      - id: isort
-  - repo: https://github.com/psf/black
-    rev: 26.3.1
-    hooks:
-      - id: black
-  - repo: https://github.com/PyCQA/flake8
-    rev: 7.3.0
-    hooks:
-      - id: flake8
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v6.0.0
     hooks:
-      - id: check-added-large-files
-        args: ['--maxkb=1024']
       - id: check-docstring-first
       - id: check-merge-conflict
-      - id: check-symlinks
-      - id: check-yaml
       - id: debug-statements
       - id: detect-private-key
-      - id: end-of-file-fixer
-        types: [python]
-      - id: trailing-whitespace
+      - id: requirements-txt-fixer
+      - id: check-toml
+      - id: check-yaml
+      - id: check-added-large-files
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.8
+    hooks:
+    -   id: ruff
+        args:
+        - --fix
+    -   id: ruff-format

pyproject.toml

@@ -48,14 +48,14 @@ Homepage = "https://github.com/gnosis/safe-cli"
 [dependency-groups]
 dev = [
     "coverage",
-    "flake8",
     "hatch",
     "ipdb",
     "ipython",
-    "isort",
+    "mypy",
     "pre-commit",
     "pytest",
     "pytest-sugar",
+    "ruff",
 ]
 
 [tool.hatch.version]
@@ -103,22 +103,32 @@ exclude_lines = [
     "pass",
 ]
 
-[tool.isort]
-profile = "black"
-default_section = "THIRDPARTY"
-known_first_party = "safe_cli"
-known_safe_foundation = ["py_eth_sig_utils", "gnosis"]
-known_django = "django"
-sections = [
-    "FUTURE",
-    "STDLIB",
-    "DJANGO",
-    "THIRDPARTY",
-    "SAFE_FOUNDATION",
-    "FIRSTPARTY",
-    "LOCALFOLDER",
+[tool.ruff]
+line-length = 88
+target-version = "py310"
+exclude = [
+    ".tox", ".git", "*/static/CACHE/*",
+    "docs", "node_modules", ".venv"
 ]
 
+[tool.ruff.lint]
+extend-select = [
+    "E",  # pycodestyle errors
+    "W",  # pycodestyle warnings
+    "F",  # pyflakes
+    "I",  # isort
+    "B",  # flake8-bugbear
+    "C4",  # flake8-comprehensions
+    "UP",  # pyupgrade
+]
+ignore = ["E501", "B008"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["safe_cli"]
+known-third-party = ["py_eth_sig_utils", "safe", "fastapi", "pydantic"]
+combine-as-imports = true
+force-wrap-aliases = true
+
 [tool.mypy]
 python_version = "3.13"
 check_untyped_defs = true

setup.cfg

@@ -46,7 +46,9 @@ def check_private_key(private_key: str) -> str:
     try:
         Account.from_key(private_key)
     except (ValueError, Error):  # TODO Report `Error` exception as a bug of eth_account
-        raise argparse.ArgumentTypeError(f"{private_key} is not a valid private key")
+        raise argparse.ArgumentTypeError(
+            f"{private_key} is not a valid private key"
+        ) from None
     return private_key
 
 
@@ -60,7 +62,9 @@ def check_hex_str(hex_str: str) -> HexBytes:
     try:
         return HexBytes(hex_str)
     except ValueError:
-        raise argparse.ArgumentTypeError(f"{hex_str} is not a valid hexadecimal string")
+        raise argparse.ArgumentTypeError(
+            f"{hex_str} is not a valid hexadecimal string"
+        ) from None
 
 
 def check_keccak256_hash(hex_str: str) -> HexBytes:

src/safe_cli/argparse_validators.py

@@ -3,7 +3,7 @@
 import os
 import sys
 from pathlib import Path
-from typing import Annotated, List
+from typing import Annotated
 
 import typer
 from art import text2art
@@ -32,7 +32,7 @@
 def _build_safe_operator_and_load_keys(
     safe_address: ChecksumAddress,
     node_url: str,
-    private_keys: List[str],
+    private_keys: list[str],
     interactive: bool,
 ) -> SafeOperator:
     safe_operator = SafeOperator(safe_address, node_url, interactive=interactive)
@@ -98,7 +98,7 @@ def send_ether(
         int, typer.Argument(help="Amount of ether in wei to send.", show_default=False)
     ],
     private_key: Annotated[
-        List[str],
+        list[str],
         typer.Option(
             help="List of private keys of signers.",
             rich_help_panel="Optional Arguments",
@@ -143,7 +143,7 @@ def send_erc20(
         ),
     ],
     private_key: Annotated[
-        List[str],
+        list[str],
         typer.Option(
             help="List of private keys of signers.",
             rich_help_panel="Optional Arguments",
@@ -185,7 +185,7 @@ def send_erc721(
         int, typer.Argument(help="Erc721 token id.", show_default=False)
     ],
     private_key: Annotated[
-        List[str],
+        list[str],
         typer.Option(
             help="List of private keys of signers.",
             rich_help_panel="Optional Arguments",
@@ -225,7 +225,7 @@ def send_custom(
         ),
     ],
     private_key: Annotated[
-        List[str],
+        list[str],
         typer.Option(
             help="List of private keys of signers.",
             rich_help_panel="Optional Arguments",
@@ -276,7 +276,7 @@ def tx_builder(
         ),
     ],
     private_key: Annotated[
-        List[str],
+        list[str],
         typer.Option(
             help="List of private keys of signers.",
             rich_help_panel="Optional Arguments",
@@ -374,7 +374,7 @@ def default_attended_mode(
     safe_cli.loop()
 
 
-def _is_safe_cli_default_command(arguments: List[str]) -> bool:
+def _is_safe_cli_default_command(arguments: list[str]) -> bool:
     # safe-cli
     if len(arguments) == 1:
         return True

src/safe_cli/main.py

@@ -1,6 +1,5 @@
 from enum import Enum
-from functools import lru_cache
-from typing import Dict, List, Optional, Set, Tuple
+from functools import cache
 
 from eth_typing import ChecksumAddress
 from hexbytes import HexBytes
@@ -24,16 +23,16 @@ class HwWalletType(Enum):
     LEDGER = 1
 
 
-@lru_cache(maxsize=None)
+@cache
 def get_hw_wallet_manager():
     return HwWalletManager()
 
 
 class HwWalletManager:
     def __init__(self):
-        self.wallets: Set[HwWallet] = set()
-        self.supported_hw_wallet_types: Dict[str, HwWallet] = {}
-        self.sender: Optional[HwWallet] = None
+        self.wallets: set[HwWallet] = set()
+        self.supported_hw_wallet_types: dict[str, HwWallet] = {}
+        self.sender: HwWallet | None = None
         try:
             from .ledger_wallet import LedgerWallet
 
@@ -51,16 +50,16 @@ def __init__(self):
     def is_supported_hw_wallet(self, hw_wallet_type: HwWalletType) -> bool:
         return hw_wallet_type in self.supported_hw_wallet_types
 
-    def get_hw_wallet(self, hw_wallet_type: HwWalletType) -> Optional[HwWallet]:
+    def get_hw_wallet(self, hw_wallet_type: HwWalletType) -> HwWallet | None:
         if hw_wallet_type in self.supported_hw_wallet_types:
             return self.supported_hw_wallet_types[hw_wallet_type]
 
     def get_accounts(
         self,
         hw_wallet_type: HwWalletType,
         template_derivation_path: str,
-        number_accounts: Optional[int] = 5,
-    ) -> List[Tuple[ChecksumAddress, str]]:
+        number_accounts: int | None = 5,
+    ) -> list[tuple[ChecksumAddress, str]]:
         """
 
         :param hw_wallet: Trezor or Ledger
@@ -101,7 +100,7 @@ def set_sender(self, hw_wallet_type: HwWalletType, derivation_path: str):
         hw_wallet = self.get_hw_wallet(hw_wallet_type)
         self.sender = hw_wallet(derivation_path)
 
-    def delete_accounts(self, addresses: List[ChecksumAddress]) -> Set:
+    def delete_accounts(self, addresses: list[ChecksumAddress]) -> set:
         """
         Remove ledger accounts from address
 
@@ -119,8 +118,8 @@ def delete_accounts(self, addresses: List[ChecksumAddress]) -> Set:
         return accounts_to_remove
 
     def sign_eip712(
-        self, eip712_message: Dict, wallets: List[HwWallet]
-    ) -> List[SafeSignature]:
+        self, eip712_message: dict, wallets: list[HwWallet]
+    ) -> list[SafeSignature]:
         """
         Sign an EIP712 message
 
@@ -130,7 +129,7 @@ def sign_eip712(
         """
         _, domain_hash, message_hash = eip712_encode(eip712_message)
         eip712_message_hash = eip712_encode_hash(eip712_message)
-        safe_signatures: List[SafeSignature] = []
+        safe_signatures: list[SafeSignature] = []
         for wallet in wallets:
             print_formatted_text(
                 HTML(
@@ -148,7 +147,7 @@ def sign_eip712(
 
         return safe_signatures
 
-    def sign_safe_tx(self, safe_tx: SafeTx, wallets: List[HwWallet]) -> SafeTx:
+    def sign_safe_tx(self, safe_tx: SafeTx, wallets: list[HwWallet]) -> SafeTx:
         """
         Sign a safe transaction with the provided hardware wallets
 
@@ -169,11 +168,11 @@ def sign_safe_tx(self, safe_tx: SafeTx, wallets: List[HwWallet]) -> SafeTx:
     def execute_safe_tx(
         self,
         safe_tx: SafeTx,
-        tx_gas: Optional[int] = None,
-        tx_gas_price: Optional[int] = None,
-        tx_nonce: Optional[int] = None,
-        eip1559_speed: Optional[TxSpeed] = None,
-    ) -> Tuple[HexBytes, TxParams]:
+        tx_gas: int | None = None,
+        tx_gas_price: int | None = None,
+        tx_nonce: int | None = None,
+        eip1559_speed: TxSpeed | None = None,
+    ) -> tuple[HexBytes, TxParams]:
         """
         Send multisig tx to the Safe
 
@@ -223,16 +222,16 @@ def execute_safe_tx(
         return safe_tx.tx_hash, safe_tx.tx
 
     def sign_message(
-        self, message: bytes, wallets: List[HwWallet]
-    ) -> List[SafeSignature]:
+        self, message: bytes, wallets: list[HwWallet]
+    ) -> list[SafeSignature]:
         """
         Sign a message for all the provided wallets
 
         :param message:
         :param wallets:
         :return:
         """
-        signatures: List[SafeSignature] = []
+        signatures: list[SafeSignature] = []
         for wallet in wallets:
             print_formatted_text(
                 HTML(

src/safe_cli/operators/hw_wallets/hw_wallet_manager.py

@@ -17,18 +17,20 @@ def wrapper(*args, **kwargs):
         try:
             return function(*args, **kwargs)
         except LedgerNotFound as e:
-            raise HardwareWalletException(e.message)
+            raise HardwareWalletException(e.message) from e
         except LedgerLocked as e:
-            raise HardwareWalletException(e.message)
+            raise HardwareWalletException(e.message) from e
         except LedgerAppNotOpened as e:
-            raise HardwareWalletException(e.message)
+            raise HardwareWalletException(e.message) from e
         except LedgerCancel as e:
-            raise HardwareWalletException(e.message)
+            raise HardwareWalletException(e.message) from e
         except InvalidDerivationPath as e:
-            raise HardwareWalletException(e.message)
+            raise HardwareWalletException(e.message) from e
         except BaseException as e:
             if "Error while writing" in e.args:
-                raise HardwareWalletException("Ledger error writing, restart safe-cli")
+                raise HardwareWalletException(
+                    "Ledger error writing, restart safe-cli"
+                ) from e
             raise e
 
     return wrapper

src/safe_cli/operators/hw_wallets/ledger_exceptions.py

@@ -1,5 +1,3 @@
-from typing import Optional
-
 from eth_typing import ChecksumAddress
 from hexbytes import HexBytes
 from ledgerblue.Dongle import Dongle
@@ -16,7 +14,7 @@
 class LedgerWallet(HwWallet):
     @raise_ledger_exception_as_hw_wallet_exception
     def __init__(self, derivation_path: str):
-        self.dongle: Optional[Dongle] = None
+        self.dongle: Dongle | None = None
         self.connect()
         super().__init__(derivation_path)