🧪 Run Ruff checks against Python files

Author: webknjaz

.pre-commit-config.yaml

@@ -4,6 +4,16 @@ ci:
   autoupdate_schedule: quarterly
 
 repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit.git
+  rev: v0.13.3
+  hooks:
+  - id: ruff-check
+    args:
+    # Ref: https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules
+    - --exit-non-zero-on-fix
+    - --fix  # NOTE: When `--fix` is used, linting should be before ruff-format
+    - --show-fixes
+
 - repo: https://github.com/astral-sh/ruff-pre-commit.git
   rev: v0.13.3
   hooks:

.ruff.toml

@@ -1,8 +1,78 @@
 line-length = 79  # Accessibility-friendly
 
+namespace-packages = [
+  "docs/",
+  "src/pylibsshext/",
+  "tests/",
+]
+
 [format]
 quote-style = "single"
 
+[lint]
+external = [
+  "WPS",  # Do not remove noqa for wemake-python-style (WPS) checks
+]
+ignore = [
+  "CPY001",  # Skip copyright notice requirement at top of files
+
+  # Legitimate cases, no need to "fix" these violations:
+  # E501: "line too long", its function is replaced by `flake8-length`
+  "E501",
+  # W505: "doc line too long", its function is replaced by `flake8-length`
+  "W505",
+
+  # FIXME: These `flake8-annotations` errors need fixing and removal
+  # ANN001: Missing type annotation for function argument 'argv'
+  "ANN001",
+  # ANN201: Missing return type annotation for public function
+  "ANN201",
+  # ANN202: Missing return type annotation for protected function
+  "ANN202",
+  "ANN401",  # any-type  # FIXME
+
+  # Refs:
+  # * https://github.com/astral-sh/ruff/issues/6606
+  # * https://github.com/astral-sh/ruff/pull/13286
+  "DOC201",  # Ruff doesn't understand sphinx-native param lists
+  "DOC402",  # docstring-missing-yields  # Ruff doesn't understand sphinx-native param lists
+  "DOC501",  # docstring-missing-exception  # Ruff doesn't understand sphinx-native param lists
+
+  "FIX001",  # line-contains-fixme  # FIXME
+  "FIX002",  # line-contains-todo  # FIXME / noqa
+
+  "PLR0914",  # too-many-locals  # FIXME / noqa
+  "PLR2004",  # magic-value-comparison  # FIXME
+
+  "RUF100",  # Ruff doesn't know about WPS
+
+  "SIM117",  # multiple-with-statements  # FIXME
+
+  "TD002",   # missing-todo-author  # FIXME
+  "TD004",   # missing-todo-colon  # FIXME
+
+  "TRY003",  # raise-vanilla-args  # controversial
+
+  "UP024",  # os-error-alias  # FIXME
+]
+preview = true  # Live dangerously
+select = [
+  "ALL",
+]
+task-tags = [
+  "FIXME",
+  "NOTE",
+  "Ref",
+  "Refs",
+  "TODO",
+]
+
+[lint.flake8-pytest-style]
+parametrize-values-type = "tuple"
+
+[lint.flake8-quotes]
+inline-quotes = "single"
+
 [lint.isort]
 combine-as-imports = true
 force-wrap-aliases = true
@@ -35,3 +105,30 @@ testing = [
   "unittest",
   "_service_utils",
 ]
+
+
+[lint.per-file-ignores]
+# Exceptions for code samples in the docs
+"docs/_samples/**.py" = [
+  "ERA001",  # commented-out-code
+  "S105",  # hardcoded-password-string
+  "S108",  # hardcoded-temp-file
+  "T201",  # print
+]
+
+# Exceptions for test files
+"tests/**.py" = [
+  "ARG002",  # Allow unused arguments in instance methods (required for test stubs)
+  "ARG004",  # unused-static-method-argument (hit in WSGI test apps)
+  "PLC1901",  # compare-to-empty-string (test accuracy)
+  "PLC2701",  # Allow importing internal files needed for testing
+  # "PLR6301",  # Allow 'self' parameter in method definitions (required for test stubs)
+  "S101",  # Allow use of `assert` in test files
+  "S311",  # suspicious-non-cryptographic-random-usage
+  "S404",  # Allow importing 'subprocess' module to testing call external tools needed by these hooks
+  "S603",  # subprocess-without-shell-equals-true
+  "SLF001",  # Private member accessed
+]
+
+[lint.pydocstyle]
+convention = "pep257"