Add pylint and run it during CI

Author: nanomad

.github/workflows/ci.yml

@@ -65,11 +65,17 @@ jobs:
 
       - name: Lint with Ruff
         run: |
-          poetry run ruff check .
+          poetry run ruff check . --output-format=github
+
+      - name: Lint with pylint
+        run: |
+          poetry run pylint src/**/*.py
+        if: success() || failure()
 
       - name: Run tests with coverage
         run: |
           poetry run pytest tests --cov --junit-xml=junit/test-results-${{ matrix.python-version }}.xml
+        if: success() || failure()
 
       - name: Surface failing tests
         uses: pmeier/pytest-results-action@main
@@ -85,7 +91,7 @@ jobs:
 
           # (Optional) Fail the workflow if no JUnit XML was found.
           fail-on-empty: true
-        if: ${{ always() }}
+        if: success() || failure()
 
   release:
     name: Release to PyPi

poetry.lock

@@ -30,11 +30,12 @@ dacite = "^1.8.1"
 pytest = "^8.2.2"
 mock = "^5.1.0"
 coverage = "^7.5.4"
-ruff = "^0.6.0"
+ruff = "^0.11.7"
 pytest-cov = "^5.0.0"
 pytest-asyncio = "^0.24.0"
 pytest-mock = "^3.14.0"
 mypy = "^1.15.0"
+pylint = "^3.3.6"
 
 
 
@@ -78,8 +79,128 @@ exclude_lines = [
 ]
 ignore_errors = true
 
-[tool.ruff]
-output-format = "github"
+[tool.ruff.lint]
+select = ["ALL"]
+
+ignore = [
+    "ANN401", # Opinioated warning on disallowing dynamically typed expressions
+    "D203",   # Conflicts with other rules
+    "D213",   # Conflicts with other rules
+    "EM101",  # raw-string-in-exception
+
+    "D105", # Missing docstring in magic method
+    "D107", # Missing docstring in `__init__`
+    "E501", # line too long
+
+    "FBT", # flake8-boolean-trap
+
+    "PLR2004", # Magic value used in comparison, consider replacing {value} with a constant variable
+
+    # Conflicts with the Ruff formatter
+    "COM812",
+
+    # Remove later
+    "TD",     # Todos
+    "A",      # bultins
+    "DTZ",    # use tz need to test it first
+    "TRY",    # tryceratops
+    "FIX002", # Line contains TODO, consider resolving the issue
+    "BLE001", # Do not catch blind exception: `Exception`
+
+]
+
+[tool.ruff.lint.flake8-pytest-style]
+fixture-parentheses = false
+
+
+[tool.ruff.lint.isort]
+combine-as-imports = true
+force-sort-within-sections = true
+known-first-party = ["saic_ismart_client_ng"]
+required-imports = ["from __future__ import annotations"]
+
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = [
+    "D100",    # Missing docstring in public module
+    "D103",    # Missing docstring in public function
+    "D104",    # Missing docstring in public package
+    "N802",    # Function name {name} should be lowercase
+    "N816",    # Variable {name} in global scope should not be mixedCase
+    "PLR0913", # Too many arguments in function definition
+    "S101",    # Use of assert detected
+    "SLF001",  # Private member accessed: {access}
+    "T201",    # print found
+]
+
+[tool.ruff.lint.mccabe]
+max-complexity = 13
+
+[tool.ruff.lint.pylint]
+max-args = 7
 
 [tool.mypy]
 files = ["./src", "./tests"]
+python_version = 3.11
+show_error_codes = true
+strict_equality = true
+warn_incomplete_stub = true
+warn_redundant_casts = true
+warn_unused_configs = true
+warn_unused_ignores = true
+check_untyped_defs = true
+disallow_incomplete_defs = true
+disallow_subclassing_any = true
+disallow_untyped_calls = true
+disallow_untyped_decorators = true
+disallow_untyped_defs = true
+no_implicit_optional = true
+warn_return_any = true
+warn_unreachable = true
+strict = true
+
+[tool.pylint.MAIN]
+py-version = "3.11"
+ignore = ["tests"]
+fail-on = ["I"]
+
+[tool.pylint.BASIC]
+good-names = ["i", "j", "k", "ex", "_", "T", "x", "y", "id", "tg"]
+
+[tool.pylint."MESSAGES CONTROL"]
+# Reasons disabled:
+# format - handled by black
+# duplicate-code - unavoidable
+# cyclic-import - doesn't test if both import on load
+# abstract-class-little-used - prevents from setting right foundation
+# too-many-* - are not enforced for the sake of readability
+# too-few-* - same as too-many-*
+# abstract-method - with intro of async there are always methods missing
+# inconsistent-return-statements - doesn't handle raise
+# too-many-ancestors - it's too strict.
+# wrong-import-order - isort guards this
+# ---
+# Pylint CodeStyle plugin
+# consider-using-namedtuple-or-dataclass - too opinionated
+# consider-using-assignment-expr - decision to use := better left to devs
+disable = [
+    "format",
+    "cyclic-import",
+    "duplicate-code",
+    "too-many-arguments",
+    "too-many-instance-attributes",
+    "too-many-locals",
+    "too-many-ancestors",
+    "too-few-public-methods",
+    "invalid-name",
+]
+enable = ["useless-suppression", "use-symbolic-message-instead"]
+
+[tool.pylint.REPORTS]
+score = false
+
+[tool.pylint.FORMAT]
+expected-line-ending-format = "LF"
+
+[tool.pylint.EXCEPTIONS]
+overgeneral-exceptions = ["builtins.BaseException", "builtins.Exception"]