Refactor types for future ansible-core compatibility (#4557)

Author: ssbarnea

.config/constraints.txt

@@ -6,6 +6,7 @@ attrs==25.3.0             # via jsonschema, referencing
 babel==2.17.0             # via mkdocs-material
 backrefs==5.8             # via mkdocs-material
 beautifulsoup4==4.13.3    # via linkchecker, mkdocs-htmlproofer-plugin
+bindep==2.13.0            # via tox-extra
 black==25.1.0             # via ansible-lint (pyproject.toml)
 boolean-py==4.0           # via license-expression
 bracex==2.5.post1         # via wcmatch
@@ -26,10 +27,13 @@ cssselect2==0.8.0         # via cairosvg
 defusedxml==0.7.1         # via cairosvg
 dill==0.3.9               # via pylint
 distlib==0.3.9            # via virtualenv
+distro==1.9.0             # via bindep
 dnspython==2.7.0          # via linkchecker
 execnet==2.1.1            # via pytest-xdist
 filelock==3.18.0          # via tox, virtualenv, ansible-lint (pyproject.toml)
 ghp-import==2.1.0         # via mkdocs
+gitdb==4.0.12             # via gitpython
+gitpython==3.1.44         # via tox-extra
 griffe==1.6.2             # via mkdocstrings-python
 hjson==3.1.0              # via mkdocs-macros-plugin, super-collections
 htmlmin2==0.1.13          # via mkdocs-minify-plugin
@@ -66,9 +70,11 @@ mkdocstrings-python==1.16.7  # via mkdocs-ansible
 mypy==1.15.0              # via ansible-lint (pyproject.toml)
 mypy-extensions==1.0.0    # via black, mypy
 netaddr==1.3.0            # via ansible-lint (pyproject.toml)
-packaging==24.2           # via ansible-compat, ansible-core, black, mkdocs, mkdocs-macros-plugin, pyproject-api, pytest, tox, ansible-lint (pyproject.toml)
+packaging==24.2           # via ansible-compat, ansible-core, bindep, black, mkdocs, mkdocs-macros-plugin, pyproject-api, pytest, tox, tox-extra, tox-uv, ansible-lint (pyproject.toml)
 paginate==0.5.7           # via mkdocs-material
+parsley==1.3              # via bindep
 pathspec==0.12.1          # via black, mkdocs, mkdocs-macros-plugin, yamllint, ansible-lint (pyproject.toml)
+pbr==6.1.1                # via bindep
 pillow==11.1.0            # via cairosvg, mkdocs-ansible
 platformdirs==4.3.7       # via black, mkdocs-get-deps, pylint, tox, virtualenv
 pluggy==1.5.0             # via pytest, tox
@@ -92,15 +98,19 @@ requests==2.32.3          # via linkchecker, mkdocs-htmlproofer-plugin, mkdocs-m
 rpds-py==0.23.1           # via jsonschema, referencing
 ruamel-yaml==0.18.10      # via ansible-lint (pyproject.toml)
 setproctitle==1.3.5       # via pytest-xdist
+setuptools==77.0.3        # via pbr
 six==1.17.0               # via python-dateutil
+smmap==5.0.2              # via gitdb
 soupsieve==2.6            # via beautifulsoup4
 subprocess-tee==0.4.2     # via ansible-compat, ansible-lint (pyproject.toml)
 super-collections==0.5.3  # via mkdocs-macros-plugin
 termcolor==2.5.0          # via mkdocs-macros-plugin
 text-unidecode==1.3       # via python-slugify
 tinycss2==1.4.0           # via cairosvg, cssselect2
 tomlkit==0.13.2           # via pylint
-tox==4.24.2               # via ansible-lint (pyproject.toml)
+tox==4.24.2               # via tox-extra, tox-uv, ansible-lint (pyproject.toml)
+tox-extra==2.1.0          # via ansible-lint (pyproject.toml)
+tox-uv==1.25.0            # via tox-extra, ansible-lint (pyproject.toml)
 types-jsonschema==4.23.0.20241208  # via ansible-lint (pyproject.toml)
 types-pyyaml==6.0.12.20241230  # via ansible-lint (pyproject.toml)
 urllib3==2.3.0            # via requests
@@ -119,3 +129,4 @@ zipp==3.21.0              # via importlib-metadata
 # ruamel-yaml-clib
 # tomli
 # typing-extensions
+# uv

.config/requirements-lock.txt

@@ -24,7 +24,7 @@ rpds-py==0.23.1           # via jsonschema, referencing
 ruamel-yaml==0.18.10      # via ansible-lint (pyproject.toml)
 subprocess-tee==0.4.2     # via ansible-compat, ansible-lint (pyproject.toml)
 wcmatch==10.0             # via ansible-lint (pyproject.toml)
-yamllint==1.36.2          # via ansible-lint (pyproject.toml)
+yamllint==1.37.0          # via ansible-lint (pyproject.toml)
 zipp==3.21.0              # via importlib-metadata
 
 # The following packages were excluded from the output:

.config/requirements-test.in

@@ -9,12 +9,15 @@ pip # tox command
 psutil # soft-dep of pytest-xdist
 pylint # IDE support
 pytest >= 7.2.2
+pytest-instafail >= 0.5.0 # only for local development, via PYTEST_ADDOPTS=-edit
 pytest-mock
 pytest-plus >= 0.6 # for PYTEST_REQPASS
 pytest-xdist[psutil,setproctitle] >= 2.1.0
-pytest-instafail >= 0.5.0 # only for local development, via PYTEST_ADDOPTS=-edit
-ruamel.yaml>=0.17.31
 ruamel-yaml-clib  # needed for mypy
+ruamel.yaml>=0.17.31
 tox >= 4.0.0
+tox-extra>=2.1
+tox-uv>=1.25
+tox>=4.24.2
 types-jsonschema # IDE support
 types-pyyaml # IDE support

.github/lower-constraints.txt

@@ -2,11 +2,11 @@
 # automatically updated by dependabot. This should be kept in sync with
 # minimal requirements configured inside .config/requirements.in
 ansible-core==2.16.0
-ansible-compat>=25.1.3 # GPLv3
+ansible-compat==25.1.4 # GPLv3
 black==24.3.0 # MIT (security)
-filelock==3.8.2 # The Unlicense
+filelock==3.16.1 # The Unlicense # due to tox-uv
 jsonschema==4.10.0 # MIT, version needed for improved errors
-packaging==22.0
+packaging==24.2 # Due to tox-uv
 pathspec==0.10.3
 pyyaml==6.0.2
 ruamel.yaml==0.18.5 # MIT

.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/collections/broken_no_runtime/CHANGELOG.md

@@ -0,0 +1,10 @@
+---
+name: broken_no_runtime
+namespace: fixtures
+version: 1.2.3
+authors:
+  - John
+readme: ../README.md
+tags: ["tools"]
+description: Lorem ipsum
+repository: https://www.github.com/my_org/my_collection

examples/collections/broken_no_runtime/galaxy.yml

@@ -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/action_plugins/some_action.py

@@ -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