Enable pyright hook

Author: ssbarnea

.pre-commit-config.yaml

@@ -177,6 +177,31 @@ repos:
             test/local-content/.*|
             plugins/.*
           )$
+  # - repo: https://github.com/RobertCraigie/pyright-python
+  #   rev: v1.1.389
+  #   hooks:
+  #     - id: pyright
+  #       additional_dependencies:
+  #         - nodejs-wheel-binaries
+  #         - ansible-compat>=24.8.0
+  #         - black>=22.10.0
+  #         - cryptography>=39.0.1
+  #         - filelock>=3.12.2
+  #         - importlib_metadata
+  #         - jinja2
+  #         - license-expression >= 30.3.0
+  #         - pip>=22.3.1
+  #         - pytest-mock
+  #         - pytest>=7.2.2
+  #         - rich>=13.2.0
+  #         - ruamel-yaml-clib>=0.2.8
+  #         - ruamel-yaml>=0.18.6
+  #         - subprocess-tee
+  #         - types-PyYAML
+  #         - types-jsonschema>=4.20.0.0
+  #         - types-setuptools
+  #         - wcmatch
+  #         - yamllint
   - repo: https://github.com/pycqa/pylint
     rev: v3.3.1
     hooks:
@@ -186,7 +211,7 @@ repos:
         additional_dependencies:
           - ansible-compat>=24.8.0
           - ansible-core>=2.14.0
-          - black>=22.10.0
+          - black>=24.10.0
           - docutils
           - filelock>=3.12.2
           - importlib_metadata

.taplo.toml

@@ -1,2 +1,6 @@
 [formatting]
+# compatibility with toml-sort-fix pre-commit hook
 array_trailing_comma = false
+compact_arrays = true
+compact_inline_tables = true
+inline_table_expand = false

.vscode/settings.json

@@ -42,5 +42,6 @@
         },
         "editor.defaultFormatter": "ms-python.black-formatter",
         "editor.formatOnSave": true
-    }
+    },
+    "evenBetterToml.formatter.arrayTrailingComma": true
 }

conftest.py

@@ -1,11 +1,11 @@
 """PyTest Fixtures."""
 
-import importlib
 import os
 import platform
 import subprocess
 import sys
 import warnings
+from importlib.util import find_spec
 from pathlib import Path
 
 import pytest
@@ -16,9 +16,7 @@
 
 # checking if user is running pytest without installing test dependencies:
 missing = [
-    module
-    for module in ["ansible", "black", "mypy", "pylint"]
-    if not importlib.util.find_spec(module)
+    module for module in ["ansible", "black", "mypy", "pylint"] if not find_spec(module)
 ]
 if missing:
     pytest.exit(

pyproject.toml

@@ -113,9 +113,6 @@ module = [
 [tool.pylint.IMPORTS]
 preferred-modules = ["py:pathlib", "unittest:pytest"]
 
-[tool.pylint.MAIN]
-extension-pkg-allow-list = ["black.parsing"]
-
 [tool.pylint.MASTER]
 bad-names = [
   # spell-checker:ignore linenumber
@@ -133,6 +130,7 @@ disable = [
   "line-too-long", # covered by black
   "protected-access", # covered by ruff SLF001
   "too-many-branches", # covered by ruff C901
+  "wrong-import-order", # covered by ruff
   # TODO(ssbarnea): remove temporary skips adding during initial adoption:
   "duplicate-code",
   # unable to disable it inside tests
@@ -155,17 +153,20 @@ output-format = "colorized"
 score = "n"
 
 [tool.pyright]
+exclude = ["venv", ".cache"]
 include = ["src"]
+mode = "standard"
 # https://github.com/microsoft/pyright/blob/main/docs/configuration.md#sample-pyprojecttoml-file
-pythonVersion = "3.10"
-# https://github.com/microsoft/pyright/issues/777
-"stubPath" = ""
+# pythonVersion = "3.10"
+# reportMissingImports = false
+# https://github.com/microsoft/pyright/issues/9494
+reportPossiblyUnboundVariable = false
 
 # spell-checker:ignore filterwarnings norecursedirs optionflags
 [tool.pytest.ini_options]
 # do not add options here as this will likely break either console runs or IDE
 # integration like vscode or pycharm
-addopts = "-p no:pytest_cov"
+addopts = "-p no:pytest_cov --failed-first"
 # https://code.visualstudio.com/docs/python/testing
 # coverage is re-enabled in `tox.ini`. That approach is safer than
 # `--no-cov` which prevents activation from tox.ini and which also fails

src/ansiblelint/_internal/rules.py

@@ -56,6 +56,8 @@ class BaseRule:
     _help: str | None = None
     # Added when a rule is registered into a collection, gives access to options
     _collection: RulesCollection | None = None
+    # Allow rules to provide a custom short description instead of using __doc__
+    _shortdesc: str = ""
 
     @property
     def help(self) -> str:
@@ -83,7 +85,7 @@ def url(self) -> str:
     @property
     def shortdesc(self) -> str:
         """Return the short description of the rule, basically the docstring."""
-        return self.__doc__ or ""
+        return self._shortdesc or self.__doc__ or ""
 
     def getmatches(self, file: Lintable) -> list[MatchError]:
         """Return all matches while ignoring exceptions."""
@@ -190,7 +192,7 @@ class RuntimeErrorRule(BaseRule):
     """Unexpected internal error."""
 
     id = "internal-error"
-    shortdesc = "Unexpected internal error"
+    _shortdesc = "Unexpected internal error"
     severity = "VERY_HIGH"
     tags = ["core"]
     version_added = "v5.0.0"

src/ansiblelint/rules/args.py

@@ -73,7 +73,7 @@ class ValidationPassedError(Exception):
 class CustomAnsibleModule(basic.AnsibleModule):  # type: ignore[misc]
     """Mock AnsibleModule class."""
 
-    def __init__(self, *args: str, **kwargs: Any) -> None:
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
         """Initialize AnsibleModule mock."""
         kwargs["no_log"] = True
         super().__init__(*args, **kwargs)

src/ansiblelint/rules/avoid_implicit.py

@@ -17,7 +17,7 @@ class AvoidImplicitRule(AnsibleLintRule):
     """Rule that identifies use of undocumented or discouraged implicit behaviors."""
 
     id = "avoid-implicit"
-    shortdesc = "Avoid implicit behaviors"
+    _shortdesc = "Avoid implicit behaviors"
     description = (
         "Items which are templated should use ``template`` instead of "
         "``copy`` with ``content`` to ensure correctness."

src/ansiblelint/rules/fqcn.py

@@ -126,6 +126,10 @@ def matchtask(
 
         if module not in self.module_aliases:
             loaded_module = load_plugin(module)
+            if not isinstance(loaded_module.resolved_fqcn, str):
+                msg = f"Invalid value ({loaded_module.resolved_fqcn})for resolved_fqcn attribute of {module} module."
+                _logger.warning(msg)
+                return []
             target = loaded_module.resolved_fqcn
             self.module_aliases[module] = target
             if target is None:

src/ansiblelint/rules/key_order.py

@@ -69,7 +69,6 @@ class KeyOrderRule(AnsibleLintRule, TransformMixin):
     """Ensure specific order of keys in mappings."""
 
     id = "key-order"
-    shortdesc = __doc__
     severity = "LOW"
     tags = ["formatting"]
     version_added = "v6.6.2"