Merge branch 'devel' into devel

ansible · Dec 6, 2024 · b2151f9 · b2151f9
2 parents 6156e93 + e7d5733
commit b2151f9
Show file tree

Hide file tree

Showing 134 changed files with 622 additions and 402 deletions.
diff --git a/.codecov.yml b/.codecov.yml
@@ -20,7 +20,7 @@ coverage:
       default:
         target: 100%
       pytest:
-        target: 100%
+        target: 50%
         flags:
         - pytest
       typing:

diff --git a/.darglint b/.darglint
@@ -5,5 +5,5 @@
 # * https://github.com/terrencepreilly/darglint/issues/186
 # * https://github.com/wemake-services/wemake-python-styleguide/issues/2287
 docstring_style = sphinx
-enable = DAR104
+# enable = DAR104  # covered by `sphinx_autodoc_typehints`
 strictness = full
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -193,8 +193,7 @@ repos:
     name: MyPy, for Python 3.13
     additional_dependencies:
     - >-  # standard interface declarations for AWX plugins
-      awx_plugins.interfaces
-      @ git+https://github.com/ansible/awx_plugins.interfaces.git@ad4a965
+      awx_plugins.interfaces == 0.0.1a2
     - azure-identity  # needed by credentials.azure_kv
     - azure-keyvault  # needed by credentials.azure_kv
     - boto3-stubs  # needed by credentials.awx_secretsmanager
@@ -225,8 +224,7 @@ repos:
     name: MyPy, for Python 3.12
     additional_dependencies:
     - >-  # standard interface declarations for AWX plugins
-      awx_plugins.interfaces
-      @ git+https://github.com/ansible/awx_plugins.interfaces.git@ad4a965
+      awx_plugins.interfaces == 0.0.1a2
     - azure-identity  # needed by credentials.azure_kv
     - azure-keyvault  # needed by credentials.azure_kv
     - boto3-stubs  # needed by credentials.awx_secretsmanager
@@ -257,8 +255,7 @@ repos:
     name: MyPy, for Python 3.11
     additional_dependencies:
     - >-  # standard interface declarations for AWX plugins
-      awx_plugins.interfaces
-      @ git+https://github.com/ansible/awx_plugins.interfaces.git@ad4a965
+      awx_plugins.interfaces == 0.0.1a2
     - azure-identity  # needed by credentials.azure_kv
     - azure-keyvault  # needed by credentials.azure_kv
     - boto3-stubs  # needed by credentials.awx_secretsmanager
@@ -291,8 +288,7 @@ repos:
   - id: pylint
     additional_dependencies:
     - >-  # standard interface declarations for AWX plugins
-      awx_plugins.interfaces
-      @ git+https://github.com/ansible/awx_plugins.interfaces.git@ad4a965
+      awx_plugins.interfaces == 0.0.1a2
     - azure-identity  # needed by credentials.azure_kv
     - azure-keyvault  # needed by credentials.azure_kv
     - boto3  # needed by credentials.awx_secretsmanager

diff --git a/bin/pip_constraint_helpers.py b/bin/pip_constraint_helpers.py
@@ -46,11 +46,8 @@ def get_constraint_file_path(  # noqa: WPS210 -- no way to drop vars
     """Identify the constraints filename for the current environment.
 
     :param req_dir: Requirements directory.
-    :type req_dir: pathlib.Path | str
     :param toxenv: tox testenv.
-    :type toxenv: str
     :param python_tag: Python tag.
-    :type python_tag: str
     :returns: Constraints filename for the current environment.
     """
     sys_platform = sys.platform
@@ -77,9 +74,7 @@ def make_pip_cmd(
     """Inject a lockfile constraint into the pip command if present.
 
     :param pip_args: pip arguments.
-    :type pip_args: list[str]
     :param constraint_file_path: Path to a ``constraints.txt``-compatible file.
-    :type constraint_file_path: pathlib.Path
 
     :returns: pip command.
     """
@@ -98,7 +93,6 @@ def run_cmd(cmd: list[str] | tuple[str, ...]) -> None:
     """Invoke a shell command after logging it.
 
     :param cmd: The command to invoke.
-    :type cmd: list[str] | tuple[str, ...]
     """
     escaped_cmd = shlex.join(cmd)
     print(f'Invoking the following command: {escaped_cmd !s}')  # noqa: WPS421

diff --git a/bin/pip_wrapper.py b/bin/pip_wrapper.py
@@ -16,11 +16,8 @@ def main(req_dir: str, toxenv: str, *pip_args: tuple[str, ...]) -> None:
     """Invoke pip with the matching constraints file, if present.
 
     :param req_dir: Requirements directory path.
-    :type req_dir: str
     :param toxenv: Tox env name.
-    :type toxenv: str
     :param pip_args: Iterable of args to bypass to pip.
-    :type pip_args: tuple[str, ...]
     """
     constraint_file_path = get_constraint_file_path(
         req_dir=req_dir,

diff --git a/bin/print_lockfile_base_name.py b/bin/print_lockfile_base_name.py
@@ -15,7 +15,6 @@ def compute_constraint_base_name(toxenv: str) -> str:
     """Get the lock file name stem.
 
     :param toxenv: Name of the tox env.
-    :type toxenv: str
     :returns: A platform-specific lock file base name for tox env.
     """
     return get_constraint_file_path(

diff --git a/bin/resolve_platform_lock_file.py b/bin/resolve_platform_lock_file.py
@@ -17,11 +17,9 @@ def generate_lock_for(
     """Generate a patform-specific lock file for given tox env.
 
     :param req_dir: Requirements directory path.
-    :type req_dir: str
     :param toxenv: Tox env name.
-    :type toxenv: str
-    :param pip_compile_extra_args: Iterable of args to bypass to pip-compile.
-    :type pip_compile_extra_args: tuple[str, ...]
+    :param pip_compile_extra_args: Iterable of args to bypass to pip-
+        compile.
     """
     lock_file_name = get_constraint_file_path(
         req_dir, toxenv, get_runtime_python_tag(),

diff --git a/dependencies/direct/build-docs.in b/dependencies/direct/build-docs.in
@@ -3,6 +3,7 @@
 furo  # modern Sphinx theme
 myst-parser[linkify]  # Markdown documents support w/ in-text link detector
 Sphinx  # main docs framework
+sphinx-autodoc-typehints  # gets function param types from annotations
 sphinx-issues  # Sphinx roles providing support for linking GitHub
 sphinx-tabs  # Sphinx directives providing support for HTML tabs
 sphinxcontrib-apidoc  # automatic API pages generator
diff --git a/dependencies/direct/py-constraints.in b/dependencies/direct/py-constraints.in
@@ -14,4 +14,4 @@
 #                                                                             #
 ###############################################################################
 
-awx_plugins.interfaces @ git+https://github.com/ansible/awx_plugins.interfaces.git
+sphinx-autodoc-typehints @ git+https://github.com/tox-dev/sphinx-autodoc-typehints.git@6c151583fb898731ebdb10bd6c36c2731fdd6180 # Workaround for docutils 0.21.2 while waiting for the fix to land in sphinx-autodoc-typehints 2.5.x release stream https://github.com/tox-dev/sphinx-autodoc-typehints/issues/454
diff --git a/dependencies/lock-files/build-dists-cp311-darwin-arm64.txt b/dependencies/lock-files/build-dists-cp311-darwin-arm64.txt
@@ -2,7 +2,7 @@
 # This file is autogenerated by pip-compile with Python 3.11
 # by the following command:
 #
-#    tox r -e pip-compile-tox-env-lock -- build-dists --upgrade
+#    tox r -e pip-compile-tox-env-lock -- build-dists --upgrade-package=awx_plugins.interfaces
 #
 build==1.2.2.post1
     # via -r dependencies/direct/build-dists.in

diff --git a/dependencies/lock-files/build-dists-cp311-darwin-x86_64.txt b/dependencies/lock-files/build-dists-cp311-darwin-x86_64.txt
@@ -2,7 +2,7 @@
 # This file is autogenerated by pip-compile with Python 3.11
 # by the following command:
 #
-#    tox r -e pip-compile-tox-env-lock -- build-dists --upgrade
+#    tox r -e pip-compile-tox-env-lock -- build-dists --upgrade-package=awx_plugins.interfaces
 #
 build==1.2.2.post1
     # via -r dependencies/direct/build-dists.in

diff --git a/dependencies/lock-files/build-dists-cp311-linux-x86_64.txt b/dependencies/lock-files/build-dists-cp311-linux-x86_64.txt
@@ -2,7 +2,7 @@
 # This file is autogenerated by pip-compile with Python 3.11
 # by the following command:
 #
-#    tox r -e pip-compile-tox-env-lock -- build-dists --upgrade
+#    tox r -e pip-compile-tox-env-lock -- build-dists --upgrade-package=awx_plugins.interfaces
 #
 build==1.2.2.post1
     # via -r dependencies/direct/build-dists.in

diff --git a/dependencies/lock-files/build-dists-cp312-darwin-arm64.txt b/dependencies/lock-files/build-dists-cp312-darwin-arm64.txt
@@ -2,7 +2,7 @@
 # This file is autogenerated by pip-compile with Python 3.12
 # by the following command:
 #
-#    tox r -e pip-compile-tox-env-lock -- build-dists --upgrade
+#    tox r -e pip-compile-tox-env-lock -- build-dists --upgrade-package=awx_plugins.interfaces
 #
 build==1.2.2.post1
     # via -r dependencies/direct/build-dists.in

diff --git a/dependencies/lock-files/build-dists-cp312-darwin-x86_64.txt b/dependencies/lock-files/build-dists-cp312-darwin-x86_64.txt
@@ -2,7 +2,7 @@
 # This file is autogenerated by pip-compile with Python 3.12
 # by the following command:
 #
-#    tox r -e pip-compile-tox-env-lock -- build-dists --upgrade
+#    tox r -e pip-compile-tox-env-lock -- build-dists --upgrade-package=awx_plugins.interfaces
 #
 build==1.2.2.post1
     # via -r dependencies/direct/build-dists.in

diff --git a/dependencies/lock-files/build-dists-cp312-linux-x86_64.txt b/dependencies/lock-files/build-dists-cp312-linux-x86_64.txt
@@ -2,7 +2,7 @@
 # This file is autogenerated by pip-compile with Python 3.12
 # by the following command:
 #
-#    tox r -e pip-compile-tox-env-lock -- build-dists --upgrade
+#    tox r -e pip-compile-tox-env-lock -- build-dists --upgrade-package=awx_plugins.interfaces
 #
 build==1.2.2.post1
     # via -r dependencies/direct/build-dists.in

diff --git a/dependencies/lock-files/build-dists-cp313-darwin-arm64.txt b/dependencies/lock-files/build-dists-cp313-darwin-arm64.txt
@@ -2,7 +2,7 @@
 # This file is autogenerated by pip-compile with Python 3.13
 # by the following command:
 #
-#    tox r -e pip-compile-tox-env-lock -- build-dists --upgrade
+#    tox r -e pip-compile-tox-env-lock -- build-dists --upgrade-package=awx_plugins.interfaces
 #
 build==1.2.2.post1
     # via -r dependencies/direct/build-dists.in

diff --git a/dependencies/lock-files/build-dists-cp313-darwin-x86_64.txt b/dependencies/lock-files/build-dists-cp313-darwin-x86_64.txt
@@ -2,7 +2,7 @@
 # This file is autogenerated by pip-compile with Python 3.13
 # by the following command:
 #
-#    tox r -e pip-compile-tox-env-lock -- build-dists --upgrade
+#    tox r -e pip-compile-tox-env-lock -- build-dists --upgrade-package=awx_plugins.interfaces
 #
 build==1.2.2.post1
     # via -r dependencies/direct/build-dists.in

diff --git a/dependencies/lock-files/build-dists-cp313-linux-x86_64.txt b/dependencies/lock-files/build-dists-cp313-linux-x86_64.txt
@@ -2,7 +2,7 @@
 # This file is autogenerated by pip-compile with Python 3.13
 # by the following command:
 #
-#    tox r -e pip-compile-tox-env-lock -- build-dists --upgrade
+#    tox r -e pip-compile-tox-env-lock -- build-dists --upgrade-package=awx_plugins.interfaces
 #
 build==1.2.2.post1
     # via -r dependencies/direct/build-dists.in

diff --git a/dependencies/lock-files/build-docs-cp311-darwin-arm64.txt b/dependencies/lock-files/build-docs-cp311-darwin-arm64.txt
@@ -2,16 +2,14 @@
 # This file is autogenerated by pip-compile with Python 3.11
 # by the following command:
 #
-#    tox r -e pip-compile-tox-env-lock -- build-docs pyproject.toml --upgrade
+#    tox r -e pip-compile-tox-env-lock -- build-docs pyproject.toml --upgrade-package=awx_plugins.interfaces
 #
 adal==1.2.7
     # via msrestazure
 alabaster==1.0.0
     # via sphinx
-awx-plugins-interfaces @ git+https://github.com/ansible/awx_plugins.interfaces.git
-    # via
-    #   -c dependencies/direct/py-constraints.in
-    #   awx-plugins-core (pyproject.toml)
+awx-plugins-interfaces==0.0.1a2
+    # via awx-plugins-core (pyproject.toml)
 azure-core==1.31.0
     # via
     #   azure-identity
@@ -163,10 +161,15 @@ sphinx==8.1.3
     #   -r dependencies/direct/build-docs.in
     #   furo
     #   myst-parser
+    #   sphinx-autodoc-typehints
     #   sphinx-basic-ng
     #   sphinx-issues
     #   sphinx-tabs
     #   sphinxcontrib-apidoc
+sphinx-autodoc-typehints @ git+https://github.com/tox-dev/sphinx-autodoc-typehints.git@6c151583fb898731ebdb10bd6c36c2731fdd6180
+    # via
+    #   -c dependencies/direct/py-constraints.in
+    #   -r dependencies/direct/build-docs.in
 sphinx-basic-ng==1.0.0b2
     # via furo
 sphinx-issues==5.0.0

diff --git a/dependencies/lock-files/build-docs-cp311-darwin-x86_64.txt b/dependencies/lock-files/build-docs-cp311-darwin-x86_64.txt
@@ -2,16 +2,14 @@
 # This file is autogenerated by pip-compile with Python 3.11
 # by the following command:
 #
-#    tox r -e pip-compile-tox-env-lock -- build-docs pyproject.toml --upgrade
+#    tox r -e pip-compile-tox-env-lock -- build-docs pyproject.toml --upgrade-package=awx_plugins.interfaces
 #
 adal==1.2.7
     # via msrestazure
 alabaster==1.0.0
     # via sphinx
-awx-plugins-interfaces @ git+https://github.com/ansible/awx_plugins.interfaces.git
-    # via
-    #   -c dependencies/direct/py-constraints.in
-    #   awx-plugins-core (pyproject.toml)
+awx-plugins-interfaces==0.0.1a2
+    # via awx-plugins-core (pyproject.toml)
 azure-core==1.31.0
     # via
     #   azure-identity
@@ -163,10 +161,15 @@ sphinx==8.1.3
     #   -r dependencies/direct/build-docs.in
     #   furo
     #   myst-parser
+    #   sphinx-autodoc-typehints
     #   sphinx-basic-ng
     #   sphinx-issues
     #   sphinx-tabs
     #   sphinxcontrib-apidoc
+sphinx-autodoc-typehints @ git+https://github.com/tox-dev/sphinx-autodoc-typehints.git@6c151583fb898731ebdb10bd6c36c2731fdd6180
+    # via
+    #   -c dependencies/direct/py-constraints.in
+    #   -r dependencies/direct/build-docs.in
 sphinx-basic-ng==1.0.0b2
     # via furo
 sphinx-issues==5.0.0

diff --git a/dependencies/lock-files/build-docs-cp311-linux-x86_64.txt b/dependencies/lock-files/build-docs-cp311-linux-x86_64.txt
@@ -2,16 +2,14 @@
 # This file is autogenerated by pip-compile with Python 3.11
 # by the following command:
 #
-#    tox r -e pip-compile-tox-env-lock -- build-docs pyproject.toml --upgrade
+#    tox r -e pip-compile-tox-env-lock -- build-docs pyproject.toml --upgrade-package=awx_plugins.interfaces
 #
 adal==1.2.7
     # via msrestazure
 alabaster==1.0.0
     # via sphinx
-awx-plugins-interfaces @ git+https://github.com/ansible/awx_plugins.interfaces.git
-    # via
-    #   -c dependencies/direct/py-constraints.in
-    #   awx-plugins-core (pyproject.toml)
+awx-plugins-interfaces==0.0.1a2
+    # via awx-plugins-core (pyproject.toml)
 azure-core==1.31.0
     # via
     #   azure-identity
@@ -163,10 +161,15 @@ sphinx==8.1.3
     #   -r dependencies/direct/build-docs.in
     #   furo
     #   myst-parser
+    #   sphinx-autodoc-typehints
     #   sphinx-basic-ng
     #   sphinx-issues
     #   sphinx-tabs
     #   sphinxcontrib-apidoc
+sphinx-autodoc-typehints @ git+https://github.com/tox-dev/sphinx-autodoc-typehints.git@6c151583fb898731ebdb10bd6c36c2731fdd6180
+    # via
+    #   -c dependencies/direct/py-constraints.in
+    #   -r dependencies/direct/build-docs.in
 sphinx-basic-ng==1.0.0b2
     # via furo
 sphinx-issues==5.0.0

diff --git a/dependencies/lock-files/build-docs-cp312-darwin-arm64.txt b/dependencies/lock-files/build-docs-cp312-darwin-arm64.txt
@@ -2,16 +2,14 @@
 # This file is autogenerated by pip-compile with Python 3.12
 # by the following command:
 #
-#    tox r -e pip-compile-tox-env-lock -- build-docs pyproject.toml --upgrade
+#    tox r -e pip-compile-tox-env-lock -- build-docs pyproject.toml --upgrade-package=awx_plugins.interfaces
 #
 adal==1.2.7
     # via msrestazure
 alabaster==1.0.0
     # via sphinx
-awx-plugins-interfaces @ git+https://github.com/ansible/awx_plugins.interfaces.git
-    # via
-    #   -c dependencies/direct/py-constraints.in
-    #   awx-plugins-core (pyproject.toml)
+awx-plugins-interfaces==0.0.1a2
+    # via awx-plugins-core (pyproject.toml)
 azure-core==1.31.0
     # via
     #   azure-identity
@@ -163,10 +161,15 @@ sphinx==8.1.3
     #   -r dependencies/direct/build-docs.in
     #   furo
     #   myst-parser
+    #   sphinx-autodoc-typehints
     #   sphinx-basic-ng
     #   sphinx-issues
     #   sphinx-tabs
     #   sphinxcontrib-apidoc
+sphinx-autodoc-typehints @ git+https://github.com/tox-dev/sphinx-autodoc-typehints.git@6c151583fb898731ebdb10bd6c36c2731fdd6180
+    # via
+    #   -c dependencies/direct/py-constraints.in
+    #   -r dependencies/direct/build-docs.in
 sphinx-basic-ng==1.0.0b2
     # via furo
 sphinx-issues==5.0.0

diff --git a/dependencies/lock-files/build-docs-cp312-darwin-x86_64.txt b/dependencies/lock-files/build-docs-cp312-darwin-x86_64.txt
@@ -2,16 +2,14 @@
 # This file is autogenerated by pip-compile with Python 3.12
 # by the following command:
 #
-#    tox r -e pip-compile-tox-env-lock -- build-docs pyproject.toml --upgrade
+#    tox r -e pip-compile-tox-env-lock -- build-docs pyproject.toml --upgrade-package=awx_plugins.interfaces
 #
 adal==1.2.7
     # via msrestazure
 alabaster==1.0.0
     # via sphinx
-awx-plugins-interfaces @ git+https://github.com/ansible/awx_plugins.interfaces.git
-    # via
-    #   -c dependencies/direct/py-constraints.in
-    #   awx-plugins-core (pyproject.toml)
+awx-plugins-interfaces==0.0.1a2
+    # via awx-plugins-core (pyproject.toml)
 azure-core==1.31.0
     # via
     #   azure-identity
@@ -163,10 +161,15 @@ sphinx==8.1.3
     #   -r dependencies/direct/build-docs.in
     #   furo
     #   myst-parser
+    #   sphinx-autodoc-typehints
     #   sphinx-basic-ng
     #   sphinx-issues
     #   sphinx-tabs
     #   sphinxcontrib-apidoc
+sphinx-autodoc-typehints @ git+https://github.com/tox-dev/sphinx-autodoc-typehints.git@6c151583fb898731ebdb10bd6c36c2731fdd6180
+    # via
+    #   -c dependencies/direct/py-constraints.in
+    #   -r dependencies/direct/build-docs.in
 sphinx-basic-ng==1.0.0b2
     # via furo
 sphinx-issues==5.0.0