ci: upgrade ruff (#1325)

Ruff was added at the beginning of the project in an experimental way
but it has demonstrated to be a robust, performant and great tool. Now
it is quitely outdated.
This is the minimal change required to upgrade it. I want to iterate
over its configuration to provide more coverage.
Includes:
- Upgrade ruff dependency in poetry
- Update the syntax of commands and configuration
- Refactor some parts of the code that would raise lint errors with the
current config - type-comparison (E721)

Signed-off-by: Alex <[email protected]>

Author: Alex-Izquierdo

.github/workflows/ci.yaml

@@ -40,7 +40,7 @@ jobs:
         run: poetry run isort --check .
 
       - name: Lint with ruff
-        run: poetry run ruff --show-source .
+        run: poetry run ruff check .
 
       - name: Lint with flake8
         run: poetry run flake8 . --count --show-source --statistics

Taskfile.dist.yaml

@@ -102,7 +102,7 @@ tasks:
   lint:ruff:
     desc: "Check code with `ruff`."
     cmds:
-      - poetry run ruff -- {{.CLI_ARGS | default "."}}
+      - poetry run ruff check -- {{.CLI_ARGS | default "."}}
 
   lint:flake8:
     desc: "Check code with `flake8`."

poetry.lock

@@ -120,6 +120,8 @@ line_length = 79
 
 [tool.ruff]
 line-length = 79
+
+[tool.ruff.lint]
 select = [
     "E",
     "F",
@@ -130,7 +132,8 @@ extend-ignore = [
     "D1", #  Missing docstrings errors
 ]
 
-[tool.ruff.per-file-ignores]
+
+[tool.ruff.lint.per-file-ignores]
 "__init__.py" = ["F401"]
 "src/aap_eda/core/migrations/*" = ["E501"]
 "tests/**/*.py" = [
@@ -140,8 +143,8 @@ extend-ignore = [
     "D",      # Docstrings are not required in tests
 ]
 
-[tool.ruff.flake8-tidy-imports]
+[tool.ruff.lint.flake8-tidy-imports]
 ban-relative-imports = "parents"
 
-[tool.ruff.pydocstyle]
+[tool.ruff.lint.pydocstyle]
 convention = "pep257"

pyproject.toml

@@ -388,19 +388,19 @@ def _set_resource_server(settings: Dynaconf) -> None:
 
 def _enforce_types(settings: Dynaconf) -> None:
     for key, key_type in get_type_hints(defaults).items():
-        if key_type == defaults.StrToList:
+        if key_type is defaults.StrToList:
             settings[key] = _get_list_from_str(settings, key)
-        elif key_type == bool:
+        elif key_type is bool:
             settings[key] = get_boolean(settings, key)
-        elif key_type == int:
+        elif key_type is int:
             settings[key] = _get_int(settings, key)
-        elif key_type == defaults.UrlSlash:
+        elif key_type is defaults.UrlSlash:
             settings[key] = _get_url_end_slash(settings, key)
         elif not isinstance(settings[key], key_type):
             raise ImproperlyConfigured(
                 f"{key} setting must be a {key_type.__name__}"
             )
-        elif key_type == str or key_type == Optional[str]:
+        elif key_type is str or key_type is Optional[str]:
             settings[key] = _get_stripped_str(settings, key)
 
 

src/aap_eda/settings/post_load.py

@@ -64,7 +64,7 @@ def test_application_setting_bad_type():
         settings_registry.get_setting_type(
             "_GATEWAY_ANALYTICS_SETTING_SYNC_TIME"
         )
-        == int
+        is int
     )
     with pytest.raises(InvalidValueError):
         application_settings._GATEWAY_ANALYTICS_SETTING_SYNC_TIME = "bad_type"