Enable ruff (#276)

* feat: upgrade to latest version of ruff

* fix: run ruff --fix

* fix(ruff): avoid using print in production code

* fix(ruff): chain expection to avoid shadowing

* fix(ruff): avoid 'except:'

* feat: activate ruff

* style(ruff): don't use + for concatenaiting strings

* style(ruff): split too long lines

* fix(ruff): chain exceptions to avoid shadowing

* fix: don't create a datetime without a timezone

* fix: avoid os.system

* fix(ruff): avoid shadowing inner variable

* fix(ruff/PLR1704): shadow chain argument

* feat: integrate mypy.ini into pyproject.toml

* feat: migrate test-docker to hatch

* fix(ruff): use isintance for type comparison

* fixup! feat: integrate mypy.ini into pyproject.toml

* fixup! feat: integrate mypy.ini into pyproject.toml

* fix(mypy): avoid changing variable type

Author: Psycojoker

.github/workflows/test-docker.yml

@@ -41,8 +41,8 @@ jobs:
 
       - name: Pytest in the Docker image
         run: |
-          docker run --entrypoint /opt/venv/bin/pytest aleph-client:${GITHUB_REF##*/} /opt/aleph-client/
+          docker run -w /opt/aleph-client --entrypoint /opt/venv/bin/hatch aleph-client:${GITHUB_REF##*/} run testing:test
 
       - name: MyPy in the Docker image
         run: |-
-          docker run --entrypoint /opt/venv/bin/mypy aleph-client:${GITHUB_REF##*/} --config-file /opt/aleph-client/mypy.ini /opt/aleph-client/src/ /opt/aleph-client/tests/
+          docker run -w /opt/aleph-client --entrypoint /opt/venv/bin/hatch aleph-client:${GITHUB_REF##*/} run linting:all

docker/Dockerfile

@@ -21,7 +21,7 @@ RUN pip install --upgrade pip wheel twine
 # Preinstall dependencies for faster steps
 RUN pip install --upgrade secp256k1 coincurve aiohttp eciespy python-magic typer
 RUN pip install --upgrade 'aleph-message~=0.3.2' eth_account pynacl base58
-RUN pip install --upgrade pytest pytest-cov pytest-asyncio mypy types-setuptools pytest-asyncio fastapi httpx requests
+RUN pip install --upgrade hatch
 
 WORKDIR /opt/aleph-client/
 COPY . .

docs/conf.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 #
 # This file is execfile()d with the current directory set to its containing dir.
 #
@@ -52,8 +51,8 @@
         args = args[1:]
 
     apidoc.main(args)
-except Exception as e:
-    print("Running `sphinx-apidoc` failed!\n{}".format(e))
+except Exception:
+    pass
 
 # -- General configuration -----------------------------------------------------
 

mypy.ini

@@ -117,7 +117,7 @@ python = [ "3.9", "3.10", "3.11", "3.12" ]
 dependencies = [
   "black==24.4.2",
   "mypy==1.10.0",
-  "ruff==0.4.9",
+  "ruff==0.9.*",
   "isort==5.13.2",
   "yamlfix==1.16.1",
   "pyproject-fmt==2.2.1",
@@ -129,15 +129,15 @@ dependencies = [
 [tool.hatch.envs.linting.scripts]
 typing = "mypy --config-file=pyproject.toml {args:} ./src/ ./tests/"
 style = [
-  # "ruff {args:}",
+  "ruff check {args:}",
   "black --check --diff {args:} ./src/ ./tests/",
   "isort --check-only --profile black {args:} ./src/ ./tests/",
   "yamlfix --check .",
   "pyproject-fmt --check pyproject.toml",
 ]
 fmt = [
   "black {args:} ./src/ ./tests/",
-  # "ruff --fix {args:}",
+  "ruff check --fix {args:}",
   "isort --profile black {args:} ./src/ ./tests/",
   "yamlfix .",
   "pyproject-fmt pyproject.toml",
@@ -155,7 +155,9 @@ target-version = [ "py39" ]
 [tool.ruff]
 target-version = "py39"
 line-length = 120
-select = [
+exclude = [ "docs/", "scripts/gendoc.py" ]
+
+lint.select = [
   "A",
   "ARG",
   "B",
@@ -182,21 +184,44 @@ select = [
   "W",
   "YTT",
 ]
-ignore = [
-  #  # Allow non-abstract empty methods in abstract base classes
-  #  "B027",
-  #  # Allow boolean positional values in function calls, like `dict.get(... True)`
-  #  "FBT003",
-  #  # Ignore checks for possible passwords
-  #  "S105", "S106", "S107",
-  #  # Ignore complexity
-  #  "C901", "PLR0911", "PLR0912", "PLR0913", "PLR0915",
+lint.ignore = [
+  "A001",
+  "A002",
+  "ARG001",
+  "ARG002",
+  # Be compatible with typer
+  "B008",
+  # Ignore complexity
+  "C901",
+  # Allow boolean arguments in functions definitions
+  "FBT001",
+  "FBT002",
+  "FBT003",
+  # to avoid errors on variables like total_kB
+  "N815",
+  "PLR0911",
+  "PLR0912",
+  "PLR0913",
+  "PLR0915",
+  "PLR2004",
+  "RUF012",
   # Allow the use of assert statements
   "S101",
+  # Ignore checks for possible passwords
+  "S105", # "S106", "S107",
+  # ignore false positive
+  "S603",
+  # don't perform this modification:
+  # Union[a, b] -> a | b /Optional[type] -> type | None
+  # since python 3.9 doesn't support it
+  "UP007",
 ]
-
 #[tool.ruff.isort]
 #known-first-party = ["aleph_client"]
+lint.per-file-ignores."src/aleph_client/commands/help_strings.py" = [ "E501" ]
+lint.per-file-ignores."tests/unit/*" = [ "T201" ]
+
+lint.per-file-ignores."tests/unit/test_instance.py" = [ "S106", "T201" ]
 
 [tool.pytest.ini_options]
 pythonpath = [
@@ -227,9 +252,60 @@ exclude_lines = [
 python_version = "3.9"
 install_types = true
 non_interactive = true
-ignore_missing_imports = true
 explicit_package_bases = true
+exclude = "conftest.py"
+show_column_numbers = true
+
+# Suppressing errors
+# Shows errors related to strict None checking, if the global strict_optional flag is enabled
+strict_optional = true
+no_implicit_optional = true
+
+# Import discovery
+# Suppresses error messages about imports that cannot be resolved
+ignore_missing_imports = true
+# Forces import to reference the original source file
+no_implicit_reexport = true
+# show error messages from unrelated files
+follow_imports = "silent"
+follow_imports_for_stubs = false
+
+# Disallow dynamic typing
+# Disallows usage of types that come from unfollowed imports
+disallow_any_unimported = false
+# Disallows all expressions in the module that have type Any
+disallow_any_expr = false
+# Disallows functions that have Any in their signature after decorator transformation.
+disallow_any_decorated = false
+# Disallows explicit Any in type positions such as type annotations and generic type parameters.
+disallow_any_explicit = false
+# Disallows usage of generic types that do not specify explicit type parameters.
+disallow_any_generics = false
+# Disallows subclassing a value of type Any.
+disallow_subclassing_any = false
+
+# Untyped definitions and calls
+# Disallows calling functions without type annotations from functions with type annotations.
+disallow_untyped_calls = false
+# Disallows defining functions without type annotations or with incomplete type annotations
+disallow_untyped_defs = false
+# Disallows defining functions with incomplete type annotations.
 check_untyped_defs = true
+# Type-checks the interior of functions without type annotations.
+disallow_incomplete_defs = false
+# Reports an error whenever a function with type annotations is decorated with a decorator without annotations.
+disallow_untyped_decorators = false
+
+# Prohibit comparisons of non-overlapping types (ex: 42 == "no")
+strict_equality = true
+
+# Configuring warnings
+# Warns about unneeded # type: ignore comments.
+warn_unused_ignores = true
+# Shows errors for missing return statements on some execution paths.
+warn_no_return = true
+# Shows a warning when returning a value with type Any from a function declared with a non- Any return type.
+warn_return_any = false
 
 [tool.spinx]
 source-dir = "docs"

pyproject.toml

@@ -4,11 +4,10 @@
 """
 
 import importlib.util
-import os
 import re
 import sys
 from pathlib import Path
-from typing import Any, List, Optional
+from typing import Any, Optional
 
 import click
 import typer
@@ -52,7 +51,7 @@ def maybe_update_state(ctx: click.Context) -> None:
 
 
 class TyperCLIGroup(typer.core.TyperGroup):
-    def list_commands(self, ctx: click.Context) -> List[str]:
+    def list_commands(self, ctx: click.Context) -> list[str]:
         self.maybe_add_run(ctx)
         return super().list_commands(ctx)
 
@@ -273,7 +272,7 @@ def docs(
     ),
     title: Optional[str] = typer.Option(
         None,
-        help="The title for the documentation page. If not provided, the name of " "the program is used.",
+        help="The title for the documentation page. If not provided, the name of the program is used.",
     ),
 ) -> None:
     """

scripts/gendoc.py

@@ -12,6 +12,8 @@
 
 def __getattr__(name):
     if name in moved_types:
-        raise ImportError(
-            f"The 'aleph_client.{name}' type is deprecated and has been removed from aleph_client. Please use `aleph.sdk.{name}` instead."
+        msg = (
+            f"The 'aleph_client.{name}' type is deprecated and has been removed from "
+            f"aleph_client. Please use `aleph.sdk.{name}` instead."
         )
+        raise ImportError(msg)