Refactor types for future ansible-core compatibility

Related: ansible/ansible#4548
Related: https://issues.redhat.com/browse/AAP-41586

Author: ssbarnea

.github/workflows/tox.yml

@@ -106,15 +106,15 @@ jobs:
 
       - name: Set ansible cache(s)
         uses: actions/cache@v4
-        if: ${{ matrix.name != 'pkg' &&  matrix.name != 'schemas' }}
         with:
           path: |
             .cache/eco
             examples/playbooks/collections/ansible_collections
             ~/.cache/ansible-compat
             ~/.ansible/collections
             ~/.ansible/roles
-          key: ${{ matrix.name }}-${{ hashFiles('tools/test-eco.sh', 'requirements.yml', 'examples/playbooks/collections/requirements.yml') }}
+            .tox
+          key: ${{ matrix.name }}-${{ matrix.os }}--${{ hashFiles('tools/test-eco.sh', 'requirements.yml', 'examples/playbooks/collections/requirements.yml') }}
 
       - name: Set up Python ${{ matrix.python_version || '3.10' }}
         if: "!contains(matrix.shell, 'wsl')"

.pre-commit-config.yaml

@@ -157,81 +157,40 @@ repos:
     rev: v1.15.0
     hooks:
       - id: mypy
-        # empty args needed in order to match mypy cli behavior
-        args: [--strict]
-        additional_dependencies:
+        # "." and pass_files are used to make pre-commit mypy behave the same as standalone mypy
+        args: ["."]
+        pass_filenames: false
+        additional_dependencies: &deps
           - ansible-compat>=25.1.3
           - 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
-          - pip>=22.3.1
+          - pyyaml>=6.0.2 # types-PyYAML is not enough
           - ruamel-yaml-clib>=0.2.8
           - ruamel-yaml>=0.18.6
           - subprocess-tee
-          - types-PyYAML
           - types-jsonschema>=4.20.0.0
           - types-setuptools
           - wcmatch
-        exclude: >
-          (?x)^(
-            .config/.*|
-            collections/.*|
-            test/local-content/.*|
-            plugins/.*
-          )$
+          - yamllint>=1.34.0
   - repo: https://github.com/RobertCraigie/pyright-python
-    rev: v1.1.396
+    rev: v1.1.397
     hooks:
       - id: pyright
-        additional_dependencies:
-          - nodejs-wheel-binaries
-          - ansible-compat>=25.1.3
-          - 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
-          - 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
+        additional_dependencies: *deps
   - repo: https://github.com/pycqa/pylint
-    rev: v3.3.5
+    rev: v3.3.6
     hooks:
       - id: pylint
         args:
           - --output-format=colorized
-        additional_dependencies:
-          - ansible-compat>=25.1.3
-          - ansible-core>=2.16.0
-          - black>=24.10.0
-          - docutils
-          - filelock>=3.12.2
-          - importlib_metadata
-          - jsonschema>=4.20.0
-          - license-expression >= 30.3.0
-          - pytest-mock
-          - pytest>=7.2.2
-          - pyyaml
-          - ruamel-yaml-clib>=0.2.7
-          - ruamel-yaml>=0.18.2
-          - setuptools # needed for pkg_resources import
-          - typing_extensions
-          - wcmatch
-          - yamllint
+        additional_dependencies: *deps
   - repo: https://github.com/jendrikseipp/vulture
     rev: v2.14
     hooks:

examples/playbooks/action_plugins/some_action.py

@@ -3,11 +3,11 @@
 from ansible.plugins.action import ActionBase
 
 
-class ActionModule(ActionBase):  # type: ignore[misc,no-any-unimported]
+class ActionModule(ActionBase):
     """Sample module."""
 
     def run(self, tmp=None, task_vars=None):  # type: ignore[no-untyped-def]
         """."""
-        super().run(tmp, task_vars)
+        super().run(tmp, task_vars)  # type: ignore[no-untyped-call]
         ret = {"foo": "bar"}
         return {"ansible_facts": ret}

examples/playbooks/command-check-success.yml

@@ -60,4 +60,4 @@
     - name: Restart something # noqa: fqcn[action-core] no-changed-when
       command: do something
     - name: Foo # noqa: fqcn[action-core] deprecated-module
-      include: handlers/included-handlers.yml
+      include_tasks: handlers/included-handlers.yml

examples/playbooks/test_import_with_malformed.yml

@@ -1,4 +1,6 @@
 ---
-- hosts: all
+- name: Some test fixture
+  hosts: all
   tasks:
-    - import_tasks: tasks/malformed.yml
+    - name: Some import
+      ansible.builtin.import_tasks: tasks/malformed.yml

pyproject.toml

@@ -89,8 +89,9 @@ disallow_untyped_calls = true
 disallow_untyped_defs = true
 error_summary = true
 # site-packages is here to help vscode mypy integration getting confused
-exclude = "(.cache|.config|.eggs|.tox|_readthedocs|build|dist|test/local-content|site|site-packages|~/.pyenv|examples|plugins/modules)"
+exclude = "(.cache|.config|.eggs|.tox|_readthedocs|build|dist|test/local-content|site|site-packages|~/.pyenv|examples|plugins/modules).*"
 # https://github.com/python/mypy/issues/12664
+follow_untyped_imports = true
 incremental = false
 no_implicit_optional = true
 python_version = "3.10"
@@ -105,10 +106,15 @@ warn_unused_configs = true
 ignore_errors = true
 ignore_missing_imports = true
 module = [
-  "ansible.*",
   "ansiblelint._version", # generated
   "license_expression",
-  "ruamel.yaml",
+  "ruamel.yaml"
+]
+
+[[tool.mypy.overrides]]
+implicit_reexport = true
+module = [
+  "ansible.*",
   "yamllint.*"
 ]
 
@@ -364,7 +370,10 @@ exclude = [
   ".ansible",
   ".cache",
   ".config",
+  ".direnv",
+  ".eggs",
   ".tox",
+  ".venv",
   "ansible_collections",
   "build",
   "dist",

requirements.yml

@@ -4,7 +4,8 @@ collections:
   - ansible.posix
   - ansible.windows
   - community.crypto
-  - community.docker
+  - name: community.docker
+    version: ">=4.5.1"
   - community.general
   - community.molecule
   - community.windows

src/ansiblelint/_internal/rules.py

@@ -187,6 +187,9 @@ def rule_config(self) -> dict[str, Any]:
     @property
     def options(self) -> Options | None:
         """Used to access linter configuration."""
+        if self.unloadable:
+            # internal rules are not configurable
+            return None
         if self._collection is None:
             msg = f"A rule ({self.id}) that is not part of a collection cannot access its configuration."
             _logger.warning(msg)

src/ansiblelint/file_utils.py

@@ -436,10 +436,11 @@ def data(self) -> Any:
                         from ansiblelint.skip_utils import append_skipped_rules
 
                     # pylint: disable=possibly-used-before-assignment
-                    self.state = append_skipped_rules(
-                        self.state,
-                        self,
-                    )
+                    if self.state:
+                        self.state = append_skipped_rules(
+                            self.state,
+                            self,
+                        )
                 else:
                     _logger.debug(
                         "data set to None for %s due to being '%s' (%s) kind.",

src/ansiblelint/rules/args.py

@@ -70,13 +70,13 @@ class ValidationPassedError(Exception):
     """Exception to be raised when validation passes."""
 
 
-class CustomAnsibleModule(basic.AnsibleModule):  # type: ignore[misc,no-any-unimported]
+class CustomAnsibleModule(basic.AnsibleModule):
     """Mock AnsibleModule class."""
 
     def __init__(self, *args: Any, **kwargs: Any) -> None:
         """Initialize AnsibleModule mock."""
         kwargs["no_log"] = True
-        super().__init__(*args, **kwargs)
+        super().__init__(*args, **kwargs)  # type: ignore[no-untyped-call]
         raise ValidationPassedError
 
 
@@ -106,7 +106,7 @@ def matchtask(
         if module_name in self.module_aliases:
             return []
 
-        loaded_module: PluginLoadContext = load_plugin(module_name)  # type: ignore[no-any-unimported]
+        loaded_module: PluginLoadContext = load_plugin(module_name)
 
         # https://github.com/ansible/ansible-lint/issues/3200
         # since "ps1" modules cannot be executed on POSIX platforms, we will