Switch to Ruff for linting, add MyPy type checking, update GitHub Actions workflow, and refine configuration files.

Author: james-ecd

.github/workflows/tests-and-linting.yml

@@ -11,15 +11,17 @@ permissions:
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python 3.11
-      uses: actions/setup-python@v3
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
       with:
-        python-version: "3.11"
+        python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
@@ -32,7 +34,7 @@ jobs:
       run: |
         poetry run pytest --cov=flare_explorer --cov-report xml:coverage.xml
     - name: Coverage
-      uses: codecov/codecov-action@v2.1.0
+      uses: codecov/codecov-action@v5
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
         file: ./coverage.xml

README.md

@@ -5,7 +5,7 @@
 <a href="https://pypi.org/project/flare-explorer-python" target="_blank">
     <img src="https://img.shields.io/pypi/pyversions/flare-explorer-python.svg?color=%2334D058" alt="Supported Python versions">
 </a>
-[![Code Style](https://img.shields.io/badge/code_style-black-black)](https://black.readthedocs.io/en/stable/)
+[![Code Style](https://img.shields.io/badge/code_style-ruff-orange)](https://docs.astral.sh/ruff/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 A lightweight library that works as a connector to the [Flare explorer api](https://flare-explorer.flare.network/graphiql)

flare_explorer/address.py

@@ -1,4 +1,7 @@
+from __future__ import annotations
+
 from decimal import Decimal
+from typing import List
 
 from pydantic import BaseModel
 
@@ -52,7 +55,7 @@ def get_address(address_hash: str) -> Address:
     return Address(**response["address"])
 
 
-def get_addresses(address_hashes: [str]) -> [Address]:
+def get_addresses(address_hashes: List[str]) -> List[Address]:
     """
     Get multiple addresses in one call.
     API complexity limit is 15 addresses at once

pyproject.toml

@@ -33,23 +33,46 @@ pytest = "^8.4.0"
 requests-mock = "^1.12.0"
 pytest-cov = "^6.2.0"
 ruff = "^0.12.0"
+mypy = "^1.13.0"
+types-requests = "^2.32.0"
 
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.ruff]
-select = ["E", "F"]
-ignore = ["E501"]
-fixable = []
-unfixable = ["B"]
-exclude = [
-    ".git",
-    "__pypackages__",
-    "_build",
-    "build",
-    "dist",
-]
-per-file-ignores = {}
 line-length = 88
 target-version = "py310"
+
+[tool.ruff.lint]
+select = [
+    "E",      # pycodestyle errors
+    "W",      # pycodestyle warnings
+    "F",      # Pyflakes
+    "I",      # isort
+    "B",      # flake8-bugbear
+    "C4",     # flake8-comprehensions
+    "UP",     # pyupgrade
+    "SIM",    # flake8-simplify
+]
+ignore = ["E501"]  # line too long
+fixable = ["ALL"]
+unfixable = []
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+
+[tool.mypy]
+python_version = "3.10"
+check_untyped_defs = true
+disallow_any_generics = true
+disallow_incomplete_defs = true
+disallow_untyped_defs = true
+no_implicit_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_return_any = true
+strict_equality = true