diff --git a/changelogs/fragments/1144-private.yml b/changelogs/fragments/1144-private.yml new file mode 100644 index 00000000..f3d7a222 --- /dev/null +++ b/changelogs/fragments/1144-private.yml @@ -0,0 +1,3 @@ +breaking_changes: + - "All doc fragments, module utils, and plugin utils are from now on private. They can change at any time, and have breaking changes even in bugfix releases + (https://github.com/ansible-collections/community.docker/pull/1144)." diff --git a/plugins/connection/docker.py b/plugins/connection/docker.py index cd516bbc..fb36118d 100644 --- a/plugins/connection/docker.py +++ b/plugins/connection/docker.py @@ -125,7 +125,7 @@ from ansible.module_utils.common.process import get_bin_path from ansible.module_utils.common.text.converters import to_bytes, to_native, to_text from ansible.plugins.connection import BUFSIZE, ConnectionBase from ansible.utils.display import Display -from ansible_collections.community.docker.plugins.module_utils.version import ( +from ansible_collections.community.docker.plugins.module_utils._version import ( LooseVersion, ) diff --git a/plugins/connection/docker_api.py b/plugins/connection/docker_api.py index b0d06bca..3f5920bb 100644 --- a/plugins/connection/docker_api.py +++ b/plugins/connection/docker_api.py @@ -19,8 +19,8 @@ notes: - Does B(not work with TCP TLS sockets)! This is caused by the inability to send C(close_notify) without closing the connection with Python's C(SSLSocket)s. See U(https://github.com/ansible-collections/community.docker/issues/605) for more information. extends_documentation_fragment: - - community.docker.docker.api_documentation - - community.docker.docker.var_names + - community.docker._docker.api_documentation + - community.docker._docker.var_names options: remote_user: type: str @@ -117,22 +117,22 @@ from ansible_collections.community.docker.plugins.module_utils._api.errors impor DockerException, NotFound, ) -from ansible_collections.community.docker.plugins.module_utils.common_api import ( +from ansible_collections.community.docker.plugins.module_utils._common_api import ( RequestException, ) -from ansible_collections.community.docker.plugins.module_utils.copy import ( +from ansible_collections.community.docker.plugins.module_utils._copy import ( DockerFileCopyError, DockerFileNotFound, fetch_file, put_file, ) -from ansible_collections.community.docker.plugins.module_utils.version import ( +from ansible_collections.community.docker.plugins.module_utils._version import ( LooseVersion, ) -from ansible_collections.community.docker.plugins.plugin_utils.common_api import ( +from ansible_collections.community.docker.plugins.plugin_utils._common_api import ( AnsibleDockerClient, ) -from ansible_collections.community.docker.plugins.plugin_utils.socket_handler import ( +from ansible_collections.community.docker.plugins.plugin_utils._socket_handler import ( DockerSocketHandler, ) diff --git a/plugins/doc_fragments/attributes.py b/plugins/doc_fragments/_attributes.py similarity index 94% rename from plugins/doc_fragments/attributes.py rename to plugins/doc_fragments/_attributes.py index 709a28e8..fa2c9b5f 100644 --- a/plugins/doc_fragments/attributes.py +++ b/plugins/doc_fragments/_attributes.py @@ -4,6 +4,9 @@ # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations diff --git a/plugins/doc_fragments/compose_v2.py b/plugins/doc_fragments/_compose_v2.py similarity index 95% rename from plugins/doc_fragments/compose_v2.py rename to plugins/doc_fragments/_compose_v2.py index eca77e32..26018ae3 100644 --- a/plugins/doc_fragments/compose_v2.py +++ b/plugins/doc_fragments/_compose_v2.py @@ -4,6 +4,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations diff --git a/plugins/doc_fragments/docker.py b/plugins/doc_fragments/_docker.py similarity index 99% rename from plugins/doc_fragments/docker.py rename to plugins/doc_fragments/_docker.py index c94b97ef..ceafb05e 100644 --- a/plugins/doc_fragments/docker.py +++ b/plugins/doc_fragments/_docker.py @@ -4,6 +4,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations diff --git a/plugins/inventory/docker_containers.py b/plugins/inventory/docker_containers.py index 1d5a2388..3f7c0405 100644 --- a/plugins/inventory/docker_containers.py +++ b/plugins/inventory/docker_containers.py @@ -18,7 +18,7 @@ author: - Felix Fontein (@felixfontein) extends_documentation_fragment: - ansible.builtin.constructed - - community.docker.docker.api_documentation + - community.docker._docker.api_documentation - community.library_inventory_filtering_v1.inventory_filter description: - Reads inventories from the Docker API. @@ -177,16 +177,18 @@ from ansible_collections.community.docker.plugins.module_utils._api.errors impor APIError, DockerException, ) -from ansible_collections.community.docker.plugins.module_utils.common_api import ( +from ansible_collections.community.docker.plugins.module_utils._common_api import ( RequestException, ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( DOCKER_COMMON_ARGS_VARS, ) -from ansible_collections.community.docker.plugins.plugin_utils.common_api import ( +from ansible_collections.community.docker.plugins.plugin_utils._common_api import ( AnsibleDockerClient, ) -from ansible_collections.community.docker.plugins.plugin_utils.unsafe import make_unsafe +from ansible_collections.community.docker.plugins.plugin_utils._unsafe import ( + make_unsafe, +) from ansible_collections.community.library_inventory_filtering_v1.plugins.plugin_utils.inventory_filter import ( filter_host, parse_filters, diff --git a/plugins/inventory/docker_machine.py b/plugins/inventory/docker_machine.py index c704b1d8..fc77e7ba 100644 --- a/plugins/inventory/docker_machine.py +++ b/plugins/inventory/docker_machine.py @@ -108,7 +108,9 @@ from ansible.module_utils.common.process import get_bin_path from ansible.module_utils.common.text.converters import to_native, to_text from ansible.plugins.inventory import BaseInventoryPlugin, Cacheable, Constructable from ansible.utils.display import Display -from ansible_collections.community.docker.plugins.plugin_utils.unsafe import make_unsafe +from ansible_collections.community.docker.plugins.plugin_utils._unsafe import ( + make_unsafe, +) from ansible_collections.community.library_inventory_filtering_v1.plugins.plugin_utils.inventory_filter import ( filter_host, parse_filters, diff --git a/plugins/inventory/docker_swarm.py b/plugins/inventory/docker_swarm.py index 47716839..3c711d02 100644 --- a/plugins/inventory/docker_swarm.py +++ b/plugins/inventory/docker_swarm.py @@ -152,13 +152,15 @@ keyed_groups: from ansible.errors import AnsibleError from ansible.parsing.utils.addresses import parse_address from ansible.plugins.inventory import BaseInventoryPlugin, Constructable -from ansible_collections.community.docker.plugins.module_utils.common import ( +from ansible_collections.community.docker.plugins.module_utils._common import ( get_connect_params, ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( update_tls_hostname, ) -from ansible_collections.community.docker.plugins.plugin_utils.unsafe import make_unsafe +from ansible_collections.community.docker.plugins.plugin_utils._unsafe import ( + make_unsafe, +) from ansible_collections.community.library_inventory_filtering_v1.plugins.plugin_utils.inventory_filter import ( filter_host, parse_filters, diff --git a/plugins/module_utils/_api/_import_helper.py b/plugins/module_utils/_api/_import_helper.py index 15c87a95..86b23899 100644 --- a/plugins/module_utils/_api/_import_helper.py +++ b/plugins/module_utils/_api/_import_helper.py @@ -7,6 +7,9 @@ # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # SPDX-License-Identifier: Apache-2.0 +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import traceback diff --git a/plugins/module_utils/_api/api/client.py b/plugins/module_utils/_api/api/client.py index 14cb3b06..fd648113 100644 --- a/plugins/module_utils/_api/api/client.py +++ b/plugins/module_utils/_api/api/client.py @@ -7,6 +7,9 @@ # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # SPDX-License-Identifier: Apache-2.0 +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import json diff --git a/plugins/module_utils/_api/api/daemon.py b/plugins/module_utils/_api/api/daemon.py index 035955da..9a6cfb85 100644 --- a/plugins/module_utils/_api/api/daemon.py +++ b/plugins/module_utils/_api/api/daemon.py @@ -7,6 +7,9 @@ # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # SPDX-License-Identifier: Apache-2.0 +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import os diff --git a/plugins/module_utils/_api/auth.py b/plugins/module_utils/_api/auth.py index e8826d45..8977ec93 100644 --- a/plugins/module_utils/_api/auth.py +++ b/plugins/module_utils/_api/auth.py @@ -7,6 +7,9 @@ # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # SPDX-License-Identifier: Apache-2.0 +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import base64 diff --git a/plugins/module_utils/_api/constants.py b/plugins/module_utils/_api/constants.py index 67afa16d..f524fdc5 100644 --- a/plugins/module_utils/_api/constants.py +++ b/plugins/module_utils/_api/constants.py @@ -7,6 +7,9 @@ # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # SPDX-License-Identifier: Apache-2.0 +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import sys diff --git a/plugins/module_utils/_api/context/api.py b/plugins/module_utils/_api/context/api.py index 743672c5..360392f8 100644 --- a/plugins/module_utils/_api/context/api.py +++ b/plugins/module_utils/_api/context/api.py @@ -7,6 +7,9 @@ # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # SPDX-License-Identifier: Apache-2.0 +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import json diff --git a/plugins/module_utils/_api/context/config.py b/plugins/module_utils/_api/context/config.py index 2c965a74..117d49bf 100644 --- a/plugins/module_utils/_api/context/config.py +++ b/plugins/module_utils/_api/context/config.py @@ -7,6 +7,9 @@ # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # SPDX-License-Identifier: Apache-2.0 +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import hashlib diff --git a/plugins/module_utils/_api/context/context.py b/plugins/module_utils/_api/context/context.py index 8a8d05e7..b1314052 100644 --- a/plugins/module_utils/_api/context/context.py +++ b/plugins/module_utils/_api/context/context.py @@ -7,6 +7,9 @@ # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # SPDX-License-Identifier: Apache-2.0 +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import json diff --git a/plugins/module_utils/_api/credentials/constants.py b/plugins/module_utils/_api/credentials/constants.py index dac2a513..b1eb2096 100644 --- a/plugins/module_utils/_api/credentials/constants.py +++ b/plugins/module_utils/_api/credentials/constants.py @@ -7,6 +7,9 @@ # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # SPDX-License-Identifier: Apache-2.0 +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations diff --git a/plugins/module_utils/_api/credentials/errors.py b/plugins/module_utils/_api/credentials/errors.py index b5fda8d9..8abde391 100644 --- a/plugins/module_utils/_api/credentials/errors.py +++ b/plugins/module_utils/_api/credentials/errors.py @@ -7,6 +7,9 @@ # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # SPDX-License-Identifier: Apache-2.0 +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations diff --git a/plugins/module_utils/_api/credentials/store.py b/plugins/module_utils/_api/credentials/store.py index e07084aa..27de2762 100644 --- a/plugins/module_utils/_api/credentials/store.py +++ b/plugins/module_utils/_api/credentials/store.py @@ -7,6 +7,9 @@ # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # SPDX-License-Identifier: Apache-2.0 +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import errno diff --git a/plugins/module_utils/_api/credentials/utils.py b/plugins/module_utils/_api/credentials/utils.py index 24792311..a1b879d4 100644 --- a/plugins/module_utils/_api/credentials/utils.py +++ b/plugins/module_utils/_api/credentials/utils.py @@ -7,6 +7,9 @@ # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # SPDX-License-Identifier: Apache-2.0 +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import os diff --git a/plugins/module_utils/_api/errors.py b/plugins/module_utils/_api/errors.py index 1097a494..1785fd4c 100644 --- a/plugins/module_utils/_api/errors.py +++ b/plugins/module_utils/_api/errors.py @@ -7,6 +7,9 @@ # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # SPDX-License-Identifier: Apache-2.0 +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations from ansible.module_utils.common.text.converters import to_native diff --git a/plugins/module_utils/_api/tls.py b/plugins/module_utils/_api/tls.py index 5ba608e3..62559951 100644 --- a/plugins/module_utils/_api/tls.py +++ b/plugins/module_utils/_api/tls.py @@ -7,6 +7,9 @@ # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # SPDX-License-Identifier: Apache-2.0 +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import os diff --git a/plugins/module_utils/_api/transport/basehttpadapter.py b/plugins/module_utils/_api/transport/basehttpadapter.py index f9943d7f..2a8e2f5a 100644 --- a/plugins/module_utils/_api/transport/basehttpadapter.py +++ b/plugins/module_utils/_api/transport/basehttpadapter.py @@ -7,6 +7,9 @@ # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # SPDX-License-Identifier: Apache-2.0 +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations from .._import_helper import HTTPAdapter as _HTTPAdapter diff --git a/plugins/module_utils/_api/transport/npipeconn.py b/plugins/module_utils/_api/transport/npipeconn.py index c31dbbe2..0be36892 100644 --- a/plugins/module_utils/_api/transport/npipeconn.py +++ b/plugins/module_utils/_api/transport/npipeconn.py @@ -7,6 +7,9 @@ # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # SPDX-License-Identifier: Apache-2.0 +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations from queue import Empty diff --git a/plugins/module_utils/_api/transport/npipesocket.py b/plugins/module_utils/_api/transport/npipesocket.py index 9d18a9d6..98e38361 100644 --- a/plugins/module_utils/_api/transport/npipesocket.py +++ b/plugins/module_utils/_api/transport/npipesocket.py @@ -7,6 +7,9 @@ # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # SPDX-License-Identifier: Apache-2.0 +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import functools diff --git a/plugins/module_utils/_api/transport/sshconn.py b/plugins/module_utils/_api/transport/sshconn.py index 16e4e7eb..57ed17d4 100644 --- a/plugins/module_utils/_api/transport/sshconn.py +++ b/plugins/module_utils/_api/transport/sshconn.py @@ -7,6 +7,9 @@ # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # SPDX-License-Identifier: Apache-2.0 +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import logging diff --git a/plugins/module_utils/_api/transport/ssladapter.py b/plugins/module_utils/_api/transport/ssladapter.py index 3ee9cdb5..fe894ebf 100644 --- a/plugins/module_utils/_api/transport/ssladapter.py +++ b/plugins/module_utils/_api/transport/ssladapter.py @@ -7,6 +7,9 @@ # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # SPDX-License-Identifier: Apache-2.0 +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations @@ -15,7 +18,7 @@ from __future__ import annotations https://github.com/kennethreitz/requests/pull/799 """ -from ansible_collections.community.docker.plugins.module_utils.version import ( +from ansible_collections.community.docker.plugins.module_utils._version import ( LooseVersion, ) diff --git a/plugins/module_utils/_api/transport/unixconn.py b/plugins/module_utils/_api/transport/unixconn.py index 97335992..c70db842 100644 --- a/plugins/module_utils/_api/transport/unixconn.py +++ b/plugins/module_utils/_api/transport/unixconn.py @@ -7,6 +7,9 @@ # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # SPDX-License-Identifier: Apache-2.0 +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import socket diff --git a/plugins/module_utils/_api/types/daemon.py b/plugins/module_utils/_api/types/daemon.py index c8f7c2d8..09187cfc 100644 --- a/plugins/module_utils/_api/types/daemon.py +++ b/plugins/module_utils/_api/types/daemon.py @@ -7,6 +7,9 @@ # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # SPDX-License-Identifier: Apache-2.0 +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import socket diff --git a/plugins/module_utils/_api/utils/build.py b/plugins/module_utils/_api/utils/build.py index 425232db..9cb6948f 100644 --- a/plugins/module_utils/_api/utils/build.py +++ b/plugins/module_utils/_api/utils/build.py @@ -7,6 +7,9 @@ # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # SPDX-License-Identifier: Apache-2.0 +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import io diff --git a/plugins/module_utils/_api/utils/config.py b/plugins/module_utils/_api/utils/config.py index d0ccf82b..0fce7087 100644 --- a/plugins/module_utils/_api/utils/config.py +++ b/plugins/module_utils/_api/utils/config.py @@ -7,6 +7,9 @@ # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # SPDX-License-Identifier: Apache-2.0 +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import json diff --git a/plugins/module_utils/_api/utils/decorators.py b/plugins/module_utils/_api/utils/decorators.py index 11d7b64d..4d7a6e58 100644 --- a/plugins/module_utils/_api/utils/decorators.py +++ b/plugins/module_utils/_api/utils/decorators.py @@ -7,6 +7,9 @@ # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # SPDX-License-Identifier: Apache-2.0 +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import functools diff --git a/plugins/module_utils/_api/utils/fnmatch.py b/plugins/module_utils/_api/utils/fnmatch.py index 379f1b4e..4f3c1704 100644 --- a/plugins/module_utils/_api/utils/fnmatch.py +++ b/plugins/module_utils/_api/utils/fnmatch.py @@ -7,6 +7,9 @@ # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # SPDX-License-Identifier: Apache-2.0 +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations diff --git a/plugins/module_utils/_api/utils/json_stream.py b/plugins/module_utils/_api/utils/json_stream.py index 1271d48d..d5d18be4 100644 --- a/plugins/module_utils/_api/utils/json_stream.py +++ b/plugins/module_utils/_api/utils/json_stream.py @@ -7,6 +7,9 @@ # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # SPDX-License-Identifier: Apache-2.0 +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import json diff --git a/plugins/module_utils/_api/utils/ports.py b/plugins/module_utils/_api/utils/ports.py index 857466d4..056795f9 100644 --- a/plugins/module_utils/_api/utils/ports.py +++ b/plugins/module_utils/_api/utils/ports.py @@ -7,6 +7,9 @@ # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # SPDX-License-Identifier: Apache-2.0 +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import re diff --git a/plugins/module_utils/_api/utils/proxy.py b/plugins/module_utils/_api/utils/proxy.py index 01b0454e..8c96c2dd 100644 --- a/plugins/module_utils/_api/utils/proxy.py +++ b/plugins/module_utils/_api/utils/proxy.py @@ -7,6 +7,9 @@ # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # SPDX-License-Identifier: Apache-2.0 +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations from .utils import format_environment diff --git a/plugins/module_utils/_api/utils/socket.py b/plugins/module_utils/_api/utils/socket.py index a373dba8..bddc1497 100644 --- a/plugins/module_utils/_api/utils/socket.py +++ b/plugins/module_utils/_api/utils/socket.py @@ -7,6 +7,9 @@ # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # SPDX-License-Identifier: Apache-2.0 +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import errno diff --git a/plugins/module_utils/_api/utils/utils.py b/plugins/module_utils/_api/utils/utils.py index 386e3f81..625143c8 100644 --- a/plugins/module_utils/_api/utils/utils.py +++ b/plugins/module_utils/_api/utils/utils.py @@ -7,6 +7,9 @@ # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # SPDX-License-Identifier: Apache-2.0 +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import base64 @@ -18,7 +21,7 @@ import shlex import string from urllib.parse import urlparse, urlunparse -from ansible_collections.community.docker.plugins.module_utils.version import ( +from ansible_collections.community.docker.plugins.module_utils._version import ( StrictVersion, ) diff --git a/plugins/module_utils/common.py b/plugins/module_utils/_common.py similarity index 95% rename from plugins/module_utils/common.py rename to plugins/module_utils/_common.py index dbf16e44..30e9753d 100644 --- a/plugins/module_utils/common.py +++ b/plugins/module_utils/_common.py @@ -2,6 +2,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import abc @@ -14,7 +17,7 @@ from collections.abc import Mapping, Sequence from ansible.module_utils.basic import AnsibleModule, missing_required_lib from ansible.module_utils.parsing.convert_bool import BOOLEANS_FALSE, BOOLEANS_TRUE -from ansible_collections.community.docker.plugins.module_utils.version import ( +from ansible_collections.community.docker.plugins.module_utils._version import ( LooseVersion, ) @@ -81,49 +84,49 @@ except ImportError: # pylint: disable=unused-import -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( BYTE_SUFFIXES, # TODO: remove ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( DEFAULT_DOCKER_REGISTRY, # TODO: remove ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( DEFAULT_TLS_HOSTNAME, # TODO: remove ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( DOCKER_COMMON_ARGS_VARS, # TODO: remove ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( DifferenceTracker, # TODO: remove ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( DockerBaseClass, # TODO: remove ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( clean_dict_booleans_for_docker_api, # TODO: remove ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( compare_dict_allow_more_present, # TODO: remove ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( compare_generic, # TODO: remove ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( convert_duration_to_nanosecond, # TODO: remove ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( is_image_name_id, # TODO: remove ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( is_valid_tag, # TODO: remove ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( omit_none_from_dict, # TODO: remove ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( parse_healthcheck, # TODO: remove ) -from ansible_collections.community.docker.plugins.module_utils.util import ( # noqa: F401 +from ansible_collections.community.docker.plugins.module_utils._util import ( # noqa: F401 DEFAULT_DOCKER_HOST, DEFAULT_TIMEOUT_SECONDS, DEFAULT_TLS, diff --git a/plugins/module_utils/common_api.py b/plugins/module_utils/_common_api.py similarity index 97% rename from plugins/module_utils/common_api.py rename to plugins/module_utils/_common_api.py index f4174a6b..7c89ee6f 100644 --- a/plugins/module_utils/common_api.py +++ b/plugins/module_utils/_common_api.py @@ -3,6 +3,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import abc @@ -12,7 +15,7 @@ from collections.abc import Mapping, Sequence from ansible.module_utils.basic import AnsibleModule, missing_required_lib from ansible.module_utils.parsing.convert_bool import BOOLEANS_FALSE, BOOLEANS_TRUE -from ansible_collections.community.docker.plugins.module_utils.version import ( +from ansible_collections.community.docker.plugins.module_utils._version import ( LooseVersion, ) @@ -45,19 +48,19 @@ from ansible_collections.community.docker.plugins.module_utils._api.utils.utils ) # pylint: disable=unused-import -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( DEFAULT_DOCKER_REGISTRY, # TODO: remove ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( DEFAULT_TLS_HOSTNAME, # TODO: remove ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( is_image_name_id, # TODO: remove ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( is_valid_tag, # TODO: remove ) -from ansible_collections.community.docker.plugins.module_utils.util import ( # noqa: F401 +from ansible_collections.community.docker.plugins.module_utils._util import ( # noqa: F401 DEFAULT_DOCKER_HOST, DEFAULT_TIMEOUT_SECONDS, DEFAULT_TLS, diff --git a/plugins/module_utils/common_cli.py b/plugins/module_utils/_common_cli.py similarity index 97% rename from plugins/module_utils/common_cli.py rename to plugins/module_utils/_common_cli.py index f4d91b5c..0b5ba89b 100644 --- a/plugins/module_utils/common_cli.py +++ b/plugins/module_utils/_common_cli.py @@ -2,6 +2,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import abc @@ -14,7 +17,7 @@ from ansible.module_utils.common.text.converters import to_native from ansible_collections.community.docker.plugins.module_utils._api.auth import ( resolve_repository_name, ) -from ansible_collections.community.docker.plugins.module_utils.util import ( # noqa: F401, pylint: disable=unused-import +from ansible_collections.community.docker.plugins.module_utils._util import ( # noqa: F401, pylint: disable=unused-import DEFAULT_DOCKER_HOST, DEFAULT_TLS, DEFAULT_TLS_VERIFY, @@ -22,7 +25,7 @@ from ansible_collections.community.docker.plugins.module_utils.util import ( # DOCKER_REQUIRED_TOGETHER, sanitize_result, ) -from ansible_collections.community.docker.plugins.module_utils.version import ( +from ansible_collections.community.docker.plugins.module_utils._version import ( LooseVersion, ) diff --git a/plugins/module_utils/compose_v2.py b/plugins/module_utils/_compose_v2.py similarity index 98% rename from plugins/module_utils/compose_v2.py rename to plugins/module_utils/_compose_v2.py index bb872ee4..300d50c9 100644 --- a/plugins/module_utils/compose_v2.py +++ b/plugins/module_utils/_compose_v2.py @@ -3,6 +3,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import json @@ -22,10 +25,10 @@ from ansible_collections.community.docker.plugins.module_utils._logfmt import ( from ansible_collections.community.docker.plugins.module_utils._logfmt import ( parse_line as _parse_logfmt_line, ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( DockerBaseClass, ) -from ansible_collections.community.docker.plugins.module_utils.version import ( +from ansible_collections.community.docker.plugins.module_utils._version import ( LooseVersion, ) diff --git a/plugins/module_utils/copy.py b/plugins/module_utils/_copy.py similarity index 98% rename from plugins/module_utils/copy.py rename to plugins/module_utils/_copy.py index 077db76c..ae3e8939 100644 --- a/plugins/module_utils/copy.py +++ b/plugins/module_utils/_copy.py @@ -2,6 +2,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import base64 diff --git a/plugins/module_utils/image_archive.py b/plugins/module_utils/_image_archive.py similarity index 97% rename from plugins/module_utils/image_archive.py rename to plugins/module_utils/_image_archive.py index 7e3a47db..087db623 100644 --- a/plugins/module_utils/image_archive.py +++ b/plugins/module_utils/_image_archive.py @@ -2,6 +2,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import json diff --git a/plugins/module_utils/_logfmt.py b/plugins/module_utils/_logfmt.py index ce3c0689..b4fb205a 100644 --- a/plugins/module_utils/_logfmt.py +++ b/plugins/module_utils/_logfmt.py @@ -2,6 +2,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + """ Parse go logfmt messages. diff --git a/plugins/module_utils/module_container/base.py b/plugins/module_utils/_module_container/base.py similarity index 99% rename from plugins/module_utils/module_container/base.py rename to plugins/module_utils/_module_container/base.py index 61e3e84f..f3d9751d 100644 --- a/plugins/module_utils/module_container/base.py +++ b/plugins/module_utils/_module_container/base.py @@ -3,6 +3,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import abc @@ -19,7 +22,7 @@ from ansible_collections.community.docker.plugins.module_utils._api.utils.utils from ansible_collections.community.docker.plugins.module_utils._platform import ( compare_platform_strings, ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( clean_dict_booleans_for_docker_api, compare_generic, normalize_healthcheck, diff --git a/plugins/module_utils/module_container/docker_api.py b/plugins/module_utils/_module_container/docker_api.py similarity index 99% rename from plugins/module_utils/module_container/docker_api.py rename to plugins/module_utils/_module_container/docker_api.py index 204dfc8b..459a04bd 100644 --- a/plugins/module_utils/module_container/docker_api.py +++ b/plugins/module_utils/_module_container/docker_api.py @@ -3,6 +3,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import json @@ -19,15 +22,11 @@ from ansible_collections.community.docker.plugins.module_utils._api.utils.utils convert_port_bindings, normalize_links, ) -from ansible_collections.community.docker.plugins.module_utils._platform import ( - compose_platform_string, - normalize_platform_string, -) -from ansible_collections.community.docker.plugins.module_utils.common_api import ( +from ansible_collections.community.docker.plugins.module_utils._common_api import ( AnsibleDockerClient, RequestException, ) -from ansible_collections.community.docker.plugins.module_utils.module_container.base import ( +from ansible_collections.community.docker.plugins.module_utils._module_container.base import ( OPTION_AUTO_REMOVE, OPTION_BLKIO_WEIGHT, OPTION_CAP_DROP, @@ -102,11 +101,15 @@ from ansible_collections.community.docker.plugins.module_utils.module_container. Engine, EngineDriver, ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._platform import ( + compose_platform_string, + normalize_platform_string, +) +from ansible_collections.community.docker.plugins.module_utils._util import ( normalize_healthcheck_test, omit_none_from_dict, ) -from ansible_collections.community.docker.plugins.module_utils.version import ( +from ansible_collections.community.docker.plugins.module_utils._version import ( LooseVersion, ) diff --git a/plugins/module_utils/module_container/module.py b/plugins/module_utils/_module_container/module.py similarity index 99% rename from plugins/module_utils/module_container/module.py rename to plugins/module_utils/_module_container/module.py index d31a27fe..90eb39fd 100644 --- a/plugins/module_utils/module_container/module.py +++ b/plugins/module_utils/_module_container/module.py @@ -3,6 +3,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import re @@ -12,7 +15,7 @@ from ansible.module_utils.common.text.converters import to_text from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import ( parse_repository_tag, ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( DifferenceTracker, DockerBaseClass, compare_generic, diff --git a/plugins/module_utils/_platform.py b/plugins/module_utils/_platform.py index d1990d70..8d4de681 100644 --- a/plugins/module_utils/_platform.py +++ b/plugins/module_utils/_platform.py @@ -8,6 +8,9 @@ # It is licensed under the Apache 2.0 license (see LICENSES/Apache-2.0.txt in this collection) # SPDX-License-Identifier: Apache-2.0 +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import re diff --git a/plugins/module_utils/_scramble.py b/plugins/module_utils/_scramble.py index f90cea63..621f459f 100644 --- a/plugins/module_utils/_scramble.py +++ b/plugins/module_utils/_scramble.py @@ -2,6 +2,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import base64 diff --git a/plugins/module_utils/selectors.py b/plugins/module_utils/_selectors.py similarity index 67% rename from plugins/module_utils/selectors.py rename to plugins/module_utils/_selectors.py index d4954f75..9fe4e89c 100644 --- a/plugins/module_utils/selectors.py +++ b/plugins/module_utils/_selectors.py @@ -4,6 +4,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + """Provide selectors import.""" from __future__ import annotations diff --git a/plugins/module_utils/socket_handler.py b/plugins/module_utils/_socket_handler.py similarity index 96% rename from plugins/module_utils/socket_handler.py rename to plugins/module_utils/_socket_handler.py index 46fd3e96..f8bcc235 100644 --- a/plugins/module_utils/socket_handler.py +++ b/plugins/module_utils/_socket_handler.py @@ -2,6 +2,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import os @@ -12,7 +15,7 @@ import struct from ansible_collections.community.docker.plugins.module_utils._api.utils import ( socket as docker_socket, ) -from ansible_collections.community.docker.plugins.module_utils.socket_helper import ( +from ansible_collections.community.docker.plugins.module_utils._socket_helper import ( make_unblocking, shutdown_writing, write_to_socket, diff --git a/plugins/module_utils/socket_helper.py b/plugins/module_utils/_socket_helper.py similarity index 92% rename from plugins/module_utils/socket_helper.py rename to plugins/module_utils/_socket_helper.py index 2c5e06db..abd95800 100644 --- a/plugins/module_utils/socket_helper.py +++ b/plugins/module_utils/_socket_helper.py @@ -2,6 +2,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import fcntl diff --git a/plugins/module_utils/swarm.py b/plugins/module_utils/_swarm.py similarity index 97% rename from plugins/module_utils/swarm.py rename to plugins/module_utils/_swarm.py index 301e34c3..31b3d3b1 100644 --- a/plugins/module_utils/swarm.py +++ b/plugins/module_utils/_swarm.py @@ -3,6 +3,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import json @@ -15,10 +18,10 @@ except ImportError: # missing Docker SDK for Python handled in ansible.module_utils.docker.common pass -from ansible_collections.community.docker.plugins.module_utils.common import ( +from ansible_collections.community.docker.plugins.module_utils._common import ( AnsibleDockerClient, ) -from ansible_collections.community.docker.plugins.module_utils.version import ( +from ansible_collections.community.docker.plugins.module_utils._version import ( LooseVersion, ) diff --git a/plugins/module_utils/util.py b/plugins/module_utils/_util.py similarity index 98% rename from plugins/module_utils/util.py rename to plugins/module_utils/_util.py index 2cee3160..4139a245 100644 --- a/plugins/module_utils/util.py +++ b/plugins/module_utils/_util.py @@ -2,6 +2,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import json diff --git a/plugins/module_utils/version.py b/plugins/module_utils/_version.py similarity index 72% rename from plugins/module_utils/version.py rename to plugins/module_utils/_version.py index b17b796d..9458f5e0 100644 --- a/plugins/module_utils/version.py +++ b/plugins/module_utils/_version.py @@ -4,6 +4,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + """Provide version object to compare version numbers.""" from __future__ import annotations diff --git a/plugins/modules/current_container_facts.py b/plugins/modules/current_container_facts.py index b52e82cd..2a4139da 100644 --- a/plugins/modules/current_container_facts.py +++ b/plugins/modules/current_container_facts.py @@ -19,10 +19,10 @@ description: author: - Felix Fontein (@felixfontein) extends_documentation_fragment: - - community.docker.attributes - - community.docker.attributes.facts - - community.docker.attributes.facts_module - - community.docker.attributes.idempotent_not_modify_state + - community.docker._attributes + - community.docker._attributes.facts + - community.docker._attributes.facts_module + - community.docker._attributes.idempotent_not_modify_state """ EXAMPLES = r""" diff --git a/plugins/modules/docker_compose_v2.py b/plugins/modules/docker_compose_v2.py index 61b0fc7b..585193f4 100644 --- a/plugins/modules/docker_compose_v2.py +++ b/plugins/modules/docker_compose_v2.py @@ -19,11 +19,11 @@ version_added: 3.6.0 description: - Uses Docker Compose to start or shutdown services. extends_documentation_fragment: - - community.docker.compose_v2 - - community.docker.compose_v2.minimum_version - - community.docker.docker.cli_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker + - community.docker._compose_v2 + - community.docker._compose_v2.minimum_version + - community.docker._docker.cli_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker attributes: check_mode: @@ -439,16 +439,16 @@ actions: import traceback from ansible.module_utils.common.validation import check_type_int -from ansible_collections.community.docker.plugins.module_utils.common_cli import ( +from ansible_collections.community.docker.plugins.module_utils._common_cli import ( AnsibleModuleDockerClient, DockerException, ) -from ansible_collections.community.docker.plugins.module_utils.compose_v2 import ( +from ansible_collections.community.docker.plugins.module_utils._compose_v2 import ( BaseComposeManager, common_compose_argspec_ex, is_failed, ) -from ansible_collections.community.docker.plugins.module_utils.version import ( +from ansible_collections.community.docker.plugins.module_utils._version import ( LooseVersion, ) diff --git a/plugins/modules/docker_compose_v2_exec.py b/plugins/modules/docker_compose_v2_exec.py index 7bc3c813..61e0ec20 100644 --- a/plugins/modules/docker_compose_v2_exec.py +++ b/plugins/modules/docker_compose_v2_exec.py @@ -18,11 +18,11 @@ description: - Uses Docker Compose to run a command in a service's container. - This can be used to run one-off commands in an existing service's container, and encapsulates C(docker compose exec). extends_documentation_fragment: - - community.docker.compose_v2 - - community.docker.compose_v2.minimum_version - - community.docker.docker.cli_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker + - community.docker._compose_v2 + - community.docker._compose_v2.minimum_version + - community.docker._docker.cli_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker attributes: check_mode: @@ -168,11 +168,11 @@ import shlex import traceback from ansible.module_utils.common.text.converters import to_text -from ansible_collections.community.docker.plugins.module_utils.common_cli import ( +from ansible_collections.community.docker.plugins.module_utils._common_cli import ( AnsibleModuleDockerClient, DockerException, ) -from ansible_collections.community.docker.plugins.module_utils.compose_v2 import ( +from ansible_collections.community.docker.plugins.module_utils._compose_v2 import ( BaseComposeManager, common_compose_argspec_ex, ) diff --git a/plugins/modules/docker_compose_v2_pull.py b/plugins/modules/docker_compose_v2_pull.py index c6493ff3..16bb2c6a 100644 --- a/plugins/modules/docker_compose_v2_pull.py +++ b/plugins/modules/docker_compose_v2_pull.py @@ -17,11 +17,11 @@ version_added: 3.6.0 description: - Uses Docker Compose to pull images for a project. extends_documentation_fragment: - - community.docker.compose_v2 - - community.docker.compose_v2.minimum_version - - community.docker.docker.cli_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker + - community.docker._compose_v2 + - community.docker._compose_v2.minimum_version + - community.docker._docker.cli_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker attributes: check_mode: @@ -112,15 +112,15 @@ actions: import traceback -from ansible_collections.community.docker.plugins.module_utils.common_cli import ( +from ansible_collections.community.docker.plugins.module_utils._common_cli import ( AnsibleModuleDockerClient, DockerException, ) -from ansible_collections.community.docker.plugins.module_utils.compose_v2 import ( +from ansible_collections.community.docker.plugins.module_utils._compose_v2 import ( BaseComposeManager, common_compose_argspec_ex, ) -from ansible_collections.community.docker.plugins.module_utils.version import ( +from ansible_collections.community.docker.plugins.module_utils._version import ( LooseVersion, ) diff --git a/plugins/modules/docker_compose_v2_run.py b/plugins/modules/docker_compose_v2_run.py index 765b18ce..4ffaefbb 100644 --- a/plugins/modules/docker_compose_v2_run.py +++ b/plugins/modules/docker_compose_v2_run.py @@ -18,11 +18,11 @@ description: - Uses Docker Compose to run a command in a new container for a service. - This encapsulates C(docker compose run). extends_documentation_fragment: - - community.docker.compose_v2 - - community.docker.compose_v2.minimum_version - - community.docker.docker.cli_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker + - community.docker._compose_v2 + - community.docker._compose_v2.minimum_version + - community.docker._docker.cli_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker attributes: check_mode: @@ -241,11 +241,11 @@ import shlex import traceback from ansible.module_utils.common.text.converters import to_text -from ansible_collections.community.docker.plugins.module_utils.common_cli import ( +from ansible_collections.community.docker.plugins.module_utils._common_cli import ( AnsibleModuleDockerClient, DockerException, ) -from ansible_collections.community.docker.plugins.module_utils.compose_v2 import ( +from ansible_collections.community.docker.plugins.module_utils._compose_v2 import ( BaseComposeManager, common_compose_argspec_ex, ) diff --git a/plugins/modules/docker_config.py b/plugins/modules/docker_config.py index 0d1b6231..6dd0b674 100644 --- a/plugins/modules/docker_config.py +++ b/plugins/modules/docker_config.py @@ -19,10 +19,10 @@ description: the O(force) option is set. - Updates to configs are performed by removing the config and creating it again. extends_documentation_fragment: - - community.docker.docker - - community.docker.docker.docker_py_2_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker + - community.docker._docker + - community.docker._docker.docker_py_2_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker attributes: check_mode: @@ -207,11 +207,11 @@ except ImportError: pass from ansible.module_utils.common.text.converters import to_bytes -from ansible_collections.community.docker.plugins.module_utils.common import ( +from ansible_collections.community.docker.plugins.module_utils._common import ( AnsibleDockerClient, RequestException, ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( DockerBaseClass, compare_generic, sanitize_labels, diff --git a/plugins/modules/docker_container.py b/plugins/modules/docker_container.py index 1c1f5ec1..3ff02226 100644 --- a/plugins/modules/docker_container.py +++ b/plugins/modules/docker_container.py @@ -23,9 +23,9 @@ notes: (except O(image)). Therefore, always specify B(all) options relevant to the container. - When O(restart) is set to V(true), the module will only restart the container if no config changes are detected. extends_documentation_fragment: - - community.docker.docker.api_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker + - community.docker._docker.api_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker attributes: check_mode: @@ -1331,10 +1331,10 @@ status: sample: 0 """ -from ansible_collections.community.docker.plugins.module_utils.module_container.docker_api import ( +from ansible_collections.community.docker.plugins.module_utils._module_container.docker_api import ( DockerAPIEngineDriver, ) -from ansible_collections.community.docker.plugins.module_utils.module_container.module import ( +from ansible_collections.community.docker.plugins.module_utils._module_container.module import ( run_module, ) diff --git a/plugins/modules/docker_container_copy_into.py b/plugins/modules/docker_container_copy_into.py index e5548a43..d493d677 100644 --- a/plugins/modules/docker_container_copy_into.py +++ b/plugins/modules/docker_container_copy_into.py @@ -125,9 +125,9 @@ options: type: bool extends_documentation_fragment: - - community.docker.docker.api_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker + - community.docker._docker.api_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker author: - "Felix Fontein (@felixfontein)" @@ -177,15 +177,11 @@ from ansible_collections.community.docker.plugins.module_utils._api.errors impor DockerException, NotFound, ) -from ansible_collections.community.docker.plugins.module_utils._scramble import ( - generate_insecure_key, - scramble, -) -from ansible_collections.community.docker.plugins.module_utils.common_api import ( +from ansible_collections.community.docker.plugins.module_utils._common_api import ( AnsibleDockerClient, RequestException, ) -from ansible_collections.community.docker.plugins.module_utils.copy import ( +from ansible_collections.community.docker.plugins.module_utils._copy import ( DockerFileCopyError, DockerFileNotFound, DockerUnexpectedError, @@ -195,6 +191,10 @@ from ansible_collections.community.docker.plugins.module_utils.copy import ( put_file_content, stat_file, ) +from ansible_collections.community.docker.plugins.module_utils._scramble import ( + generate_insecure_key, + scramble, +) def are_fileobjs_equal(f1, f2): diff --git a/plugins/modules/docker_container_exec.py b/plugins/modules/docker_container_exec.py index 092a3d58..cd68f8f8 100644 --- a/plugins/modules/docker_container_exec.py +++ b/plugins/modules/docker_container_exec.py @@ -17,9 +17,9 @@ version_added: 1.5.0 description: - Executes a command in a Docker container. extends_documentation_fragment: - - community.docker.docker.api_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker + - community.docker._docker.api_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker attributes: check_mode: @@ -176,11 +176,11 @@ from ansible_collections.community.docker.plugins.module_utils._api.errors impor from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import ( format_environment, ) -from ansible_collections.community.docker.plugins.module_utils.common_api import ( +from ansible_collections.community.docker.plugins.module_utils._common_api import ( AnsibleDockerClient, RequestException, ) -from ansible_collections.community.docker.plugins.module_utils.socket_handler import ( +from ansible_collections.community.docker.plugins.module_utils._socket_handler import ( DockerSocketHandlerModule, ) diff --git a/plugins/modules/docker_container_info.py b/plugins/modules/docker_container_info.py index ac9ef90c..077afe63 100644 --- a/plugins/modules/docker_container_info.py +++ b/plugins/modules/docker_container_info.py @@ -17,11 +17,11 @@ description: - Essentially returns the output of C(docker inspect ), similar to what M(community.docker.docker_container) returns for a non-absent container. extends_documentation_fragment: - - community.docker.docker.api_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker - - community.docker.attributes.info_module - - community.docker.attributes.idempotent_not_modify_state + - community.docker._docker.api_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker + - community.docker._attributes.info_module + - community.docker._attributes.idempotent_not_modify_state options: name: @@ -80,7 +80,7 @@ import traceback from ansible_collections.community.docker.plugins.module_utils._api.errors import ( DockerException, ) -from ansible_collections.community.docker.plugins.module_utils.common_api import ( +from ansible_collections.community.docker.plugins.module_utils._common_api import ( AnsibleDockerClient, RequestException, ) diff --git a/plugins/modules/docker_context_info.py b/plugins/modules/docker_context_info.py index 60585afe..832bc439 100644 --- a/plugins/modules/docker_context_info.py +++ b/plugins/modules/docker_context_info.py @@ -19,9 +19,9 @@ description: - This includes some generic information, as well as a RV(contexts[].config) dictionary that can be used for module defaults for all community.docker modules that use the C(community.docker.docker) module defaults group. extends_documentation_fragment: - - community.docker.attributes - - community.docker.attributes.info_module - - community.docker.attributes.idempotent_not_modify_state + - community.docker._attributes + - community.docker._attributes.info_module + - community.docker._attributes.idempotent_not_modify_state options: only_current: diff --git a/plugins/modules/docker_host_info.py b/plugins/modules/docker_host_info.py index 3c3b2ab2..f04ca672 100644 --- a/plugins/modules/docker_host_info.py +++ b/plugins/modules/docker_host_info.py @@ -20,10 +20,10 @@ description: - The output differs depending on API version of the docker daemon. - If the docker daemon cannot be contacted or does not meet the API version requirements, the module will fail. extends_documentation_fragment: - - community.docker.docker.api_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker - - community.docker.attributes.idempotent_not_modify_state + - community.docker._docker.api_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker + - community.docker._attributes.idempotent_not_modify_state attributes: check_mode: @@ -220,11 +220,11 @@ from ansible_collections.community.docker.plugins.module_utils._api.errors impor from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import ( convert_filters, ) -from ansible_collections.community.docker.plugins.module_utils.common_api import ( +from ansible_collections.community.docker.plugins.module_utils._common_api import ( AnsibleDockerClient, RequestException, ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( DockerBaseClass, clean_dict_booleans_for_docker_api, ) diff --git a/plugins/modules/docker_image.py b/plugins/modules/docker_image.py index 8d478213..d0a8188f 100644 --- a/plugins/modules/docker_image.py +++ b/plugins/modules/docker_image.py @@ -22,9 +22,9 @@ notes: - Building images is done using Docker daemon's API. It is not possible to use BuildKit / buildx this way. Use M(community.docker.docker_image_build) to build images with BuildKit. extends_documentation_fragment: - - community.docker.docker.api_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker + - community.docker._docker.api_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker attributes: check_mode: @@ -390,22 +390,22 @@ from ansible_collections.community.docker.plugins.module_utils._api.utils.utils format_extra_hosts, parse_repository_tag, ) -from ansible_collections.community.docker.plugins.module_utils.common_api import ( +from ansible_collections.community.docker.plugins.module_utils._common_api import ( AnsibleDockerClient, RequestException, ) -from ansible_collections.community.docker.plugins.module_utils.image_archive import ( +from ansible_collections.community.docker.plugins.module_utils._image_archive import ( ImageArchiveInvalidException, api_image_id, archived_image_manifest, ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( DockerBaseClass, clean_dict_booleans_for_docker_api, is_image_name_id, is_valid_tag, ) -from ansible_collections.community.docker.plugins.module_utils.version import ( +from ansible_collections.community.docker.plugins.module_utils._version import ( LooseVersion, ) diff --git a/plugins/modules/docker_image_build.py b/plugins/modules/docker_image_build.py index 0ebd6fe3..1fe60548 100644 --- a/plugins/modules/docker_image_build.py +++ b/plugins/modules/docker_image_build.py @@ -19,9 +19,9 @@ description: - Note that the module is B(not idempotent) in the sense of classical Ansible modules. The only idempotence check is whether the built image already exists. This check can be disabled with the O(rebuild) option. extends_documentation_fragment: - - community.docker.docker.cli_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker + - community.docker._docker.cli_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker attributes: check_mode: @@ -288,17 +288,17 @@ from ansible.module_utils.common.text.formatters import human_to_bytes from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import ( parse_repository_tag, ) -from ansible_collections.community.docker.plugins.module_utils.common_cli import ( +from ansible_collections.community.docker.plugins.module_utils._common_cli import ( AnsibleModuleDockerClient, DockerException, ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( DockerBaseClass, clean_dict_booleans_for_docker_api, is_image_name_id, is_valid_tag, ) -from ansible_collections.community.docker.plugins.module_utils.version import ( +from ansible_collections.community.docker.plugins.module_utils._version import ( LooseVersion, ) diff --git a/plugins/modules/docker_image_export.py b/plugins/modules/docker_image_export.py index 581959d0..cfd86e8e 100644 --- a/plugins/modules/docker_image_export.py +++ b/plugins/modules/docker_image_export.py @@ -18,9 +18,9 @@ description: - Creates an archive (tarball) from one or more Docker images. - This can be copied to another machine and loaded with M(community.docker.docker_image_load). extends_documentation_fragment: - - community.docker.docker.api_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker + - community.docker._docker.api_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker attributes: check_mode: @@ -104,16 +104,16 @@ from ansible_collections.community.docker.plugins.module_utils._api.errors impor from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import ( parse_repository_tag, ) -from ansible_collections.community.docker.plugins.module_utils.common_api import ( +from ansible_collections.community.docker.plugins.module_utils._common_api import ( AnsibleDockerClient, RequestException, ) -from ansible_collections.community.docker.plugins.module_utils.image_archive import ( +from ansible_collections.community.docker.plugins.module_utils._image_archive import ( ImageArchiveInvalidException, api_image_id, load_archived_image_manifest, ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( DockerBaseClass, is_image_name_id, is_valid_tag, diff --git a/plugins/modules/docker_image_info.py b/plugins/modules/docker_image_info.py index 7247b9f1..b30c0333 100644 --- a/plugins/modules/docker_image_info.py +++ b/plugins/modules/docker_image_info.py @@ -22,11 +22,11 @@ description: notes: - This module was called C(docker_image_facts) before Ansible 2.8. The usage did not change. extends_documentation_fragment: - - community.docker.docker.api_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker - - community.docker.attributes.info_module - - community.docker.attributes.idempotent_not_modify_state + - community.docker._docker.api_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker + - community.docker._attributes.info_module + - community.docker._attributes.idempotent_not_modify_state options: name: @@ -144,11 +144,11 @@ from ansible_collections.community.docker.plugins.module_utils._api.errors impor from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import ( parse_repository_tag, ) -from ansible_collections.community.docker.plugins.module_utils.common_api import ( +from ansible_collections.community.docker.plugins.module_utils._common_api import ( AnsibleDockerClient, RequestException, ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( DockerBaseClass, is_image_name_id, ) diff --git a/plugins/modules/docker_image_load.py b/plugins/modules/docker_image_load.py index fb89ca6e..25ae0282 100644 --- a/plugins/modules/docker_image_load.py +++ b/plugins/modules/docker_image_load.py @@ -18,9 +18,9 @@ version_added: 1.3.0 description: - Load one or multiple Docker images from a C(.tar) archive, and return information on the loaded image(s). extends_documentation_fragment: - - community.docker.docker.api_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker + - community.docker._docker.api_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker attributes: check_mode: @@ -85,11 +85,11 @@ import traceback from ansible_collections.community.docker.plugins.module_utils._api.errors import ( DockerException, ) -from ansible_collections.community.docker.plugins.module_utils.common_api import ( +from ansible_collections.community.docker.plugins.module_utils._common_api import ( AnsibleDockerClient, RequestException, ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( DockerBaseClass, is_image_name_id, ) diff --git a/plugins/modules/docker_image_pull.py b/plugins/modules/docker_image_pull.py index 824b6a60..ec68f494 100644 --- a/plugins/modules/docker_image_pull.py +++ b/plugins/modules/docker_image_pull.py @@ -17,9 +17,9 @@ version_added: 3.6.0 description: - Pulls a Docker image from a registry. extends_documentation_fragment: - - community.docker.docker.api_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker + - community.docker._docker.api_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker attributes: check_mode: @@ -98,16 +98,16 @@ from ansible_collections.community.docker.plugins.module_utils._api.errors impor from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import ( parse_repository_tag, ) +from ansible_collections.community.docker.plugins.module_utils._common_api import ( + AnsibleDockerClient, + RequestException, +) from ansible_collections.community.docker.plugins.module_utils._platform import ( compare_platform_strings, compose_platform_string, normalize_platform_string, ) -from ansible_collections.community.docker.plugins.module_utils.common_api import ( - AnsibleDockerClient, - RequestException, -) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( DockerBaseClass, is_image_name_id, is_valid_tag, diff --git a/plugins/modules/docker_image_push.py b/plugins/modules/docker_image_push.py index 26fe7b47..0dfc604a 100644 --- a/plugins/modules/docker_image_push.py +++ b/plugins/modules/docker_image_push.py @@ -17,9 +17,9 @@ version_added: 3.6.0 description: - Pushes a Docker image to a registry. extends_documentation_fragment: - - community.docker.docker.api_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker + - community.docker._docker.api_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker attributes: check_mode: @@ -84,11 +84,11 @@ from ansible_collections.community.docker.plugins.module_utils._api.errors impor from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import ( parse_repository_tag, ) -from ansible_collections.community.docker.plugins.module_utils.common_api import ( +from ansible_collections.community.docker.plugins.module_utils._common_api import ( AnsibleDockerClient, RequestException, ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( DockerBaseClass, is_image_name_id, is_valid_tag, diff --git a/plugins/modules/docker_image_remove.py b/plugins/modules/docker_image_remove.py index fa7e4225..a0d7ef1b 100644 --- a/plugins/modules/docker_image_remove.py +++ b/plugins/modules/docker_image_remove.py @@ -17,9 +17,9 @@ version_added: 3.6.0 description: - Remove Docker images from the Docker daemon. extends_documentation_fragment: - - community.docker.docker.api_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker + - community.docker._docker.api_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker attributes: check_mode: @@ -106,11 +106,11 @@ from ansible_collections.community.docker.plugins.module_utils._api.errors impor from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import ( parse_repository_tag, ) -from ansible_collections.community.docker.plugins.module_utils.common_api import ( +from ansible_collections.community.docker.plugins.module_utils._common_api import ( AnsibleDockerClient, RequestException, ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( DockerBaseClass, is_image_name_id, is_valid_tag, diff --git a/plugins/modules/docker_image_tag.py b/plugins/modules/docker_image_tag.py index 4daae0d3..214bc1a7 100644 --- a/plugins/modules/docker_image_tag.py +++ b/plugins/modules/docker_image_tag.py @@ -17,9 +17,9 @@ version_added: 3.6.0 description: - This module allows to tag Docker images with new names and/or tags. extends_documentation_fragment: - - community.docker.docker.api_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker + - community.docker._docker.api_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker attributes: check_mode: @@ -109,11 +109,11 @@ from ansible_collections.community.docker.plugins.module_utils._api.errors impor from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import ( parse_repository_tag, ) -from ansible_collections.community.docker.plugins.module_utils.common_api import ( +from ansible_collections.community.docker.plugins.module_utils._common_api import ( AnsibleDockerClient, RequestException, ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( DockerBaseClass, is_image_name_id, is_valid_tag, diff --git a/plugins/modules/docker_login.py b/plugins/modules/docker_login.py index 1a2b6e74..355466a0 100644 --- a/plugins/modules/docker_login.py +++ b/plugins/modules/docker_login.py @@ -21,9 +21,9 @@ description: needing to provide credentials. - Running in check mode will perform the authentication without updating the config file. extends_documentation_fragment: - - community.docker.docker.api_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker + - community.docker._docker.api_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker attributes: check_mode: @@ -135,11 +135,11 @@ from ansible_collections.community.docker.plugins.module_utils._api.credentials. from ansible_collections.community.docker.plugins.module_utils._api.errors import ( DockerException, ) -from ansible_collections.community.docker.plugins.module_utils.common_api import ( +from ansible_collections.community.docker.plugins.module_utils._common_api import ( AnsibleDockerClient, RequestException, ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( DEFAULT_DOCKER_REGISTRY, DockerBaseClass, ) diff --git a/plugins/modules/docker_network.py b/plugins/modules/docker_network.py index 3c02e9b5..d67511cf 100644 --- a/plugins/modules/docker_network.py +++ b/plugins/modules/docker_network.py @@ -14,9 +14,9 @@ description: - Create/remove Docker networks and connect containers to them. - Performs largely the same function as the C(docker network) CLI subcommand. extends_documentation_fragment: - - community.docker.docker.api_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker + - community.docker._docker.api_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker attributes: check_mode: @@ -289,11 +289,11 @@ from ansible.module_utils.common.text.converters import to_native from ansible_collections.community.docker.plugins.module_utils._api.errors import ( DockerException, ) -from ansible_collections.community.docker.plugins.module_utils.common_api import ( +from ansible_collections.community.docker.plugins.module_utils._common_api import ( AnsibleDockerClient, RequestException, ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( DifferenceTracker, DockerBaseClass, clean_dict_booleans_for_docker_api, diff --git a/plugins/modules/docker_network_info.py b/plugins/modules/docker_network_info.py index 05890bfc..52d4848f 100644 --- a/plugins/modules/docker_network_info.py +++ b/plugins/modules/docker_network_info.py @@ -17,11 +17,11 @@ description: - Essentially returns the output of C(docker network inspect ), similar to what M(community.docker.docker_network) returns for a non-absent network. extends_documentation_fragment: - - community.docker.docker.api_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker - - community.docker.attributes.info_module - - community.docker.attributes.idempotent_not_modify_state + - community.docker._docker.api_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker + - community.docker._attributes.info_module + - community.docker._attributes.idempotent_not_modify_state options: name: @@ -101,7 +101,7 @@ import traceback from ansible_collections.community.docker.plugins.module_utils._api.errors import ( DockerException, ) -from ansible_collections.community.docker.plugins.module_utils.common_api import ( +from ansible_collections.community.docker.plugins.module_utils._common_api import ( AnsibleDockerClient, RequestException, ) diff --git a/plugins/modules/docker_node.py b/plugins/modules/docker_node.py index 9f28f201..13fcc717 100644 --- a/plugins/modules/docker_node.py +++ b/plugins/modules/docker_node.py @@ -14,10 +14,10 @@ description: - Manages the Docker nodes through a Swarm Manager. - This module allows to change the node's role, its availability, and to modify, add or remove node labels. extends_documentation_fragment: - - community.docker.docker - - community.docker.docker.docker_py_1_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker + - community.docker._docker + - community.docker._docker.docker_py_1_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker attributes: check_mode: @@ -143,14 +143,14 @@ except ImportError: pass from ansible.module_utils.common.text.converters import to_native -from ansible_collections.community.docker.plugins.module_utils.common import ( +from ansible_collections.community.docker.plugins.module_utils._common import ( DockerBaseClass, RequestException, ) -from ansible_collections.community.docker.plugins.module_utils.swarm import ( +from ansible_collections.community.docker.plugins.module_utils._swarm import ( AnsibleDockerSwarmClient, ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( sanitize_labels, ) diff --git a/plugins/modules/docker_node_info.py b/plugins/modules/docker_node_info.py index 34f1a776..1e3e678b 100644 --- a/plugins/modules/docker_node_info.py +++ b/plugins/modules/docker_node_info.py @@ -17,12 +17,12 @@ description: - Essentially returns the output of C(docker node inspect ). - Must be executed on a host running as Swarm Manager, otherwise the module will fail. extends_documentation_fragment: - - community.docker.docker - - community.docker.docker.docker_py_1_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker - - community.docker.attributes.info_module - - community.docker.attributes.idempotent_not_modify_state + - community.docker._docker + - community.docker._docker.docker_py_1_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker + - community.docker._attributes.info_module + - community.docker._attributes.idempotent_not_modify_state options: name: @@ -88,10 +88,10 @@ nodes: import traceback -from ansible_collections.community.docker.plugins.module_utils.common import ( +from ansible_collections.community.docker.plugins.module_utils._common import ( RequestException, ) -from ansible_collections.community.docker.plugins.module_utils.swarm import ( +from ansible_collections.community.docker.plugins.module_utils._swarm import ( AnsibleDockerSwarmClient, ) diff --git a/plugins/modules/docker_plugin.py b/plugins/modules/docker_plugin.py index b4d41418..daccb64f 100644 --- a/plugins/modules/docker_plugin.py +++ b/plugins/modules/docker_plugin.py @@ -19,9 +19,9 @@ description: notes: - The C(--grant-all-permissions) CLI flag is true by default in this module. extends_documentation_fragment: - - community.docker.docker.api_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker + - community.docker._docker.api_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker attributes: check_mode: @@ -137,11 +137,11 @@ from ansible_collections.community.docker.plugins.module_utils._api.errors impor DockerException, NotFound, ) -from ansible_collections.community.docker.plugins.module_utils.common_api import ( +from ansible_collections.community.docker.plugins.module_utils._common_api import ( AnsibleDockerClient, RequestException, ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( DifferenceTracker, DockerBaseClass, ) diff --git a/plugins/modules/docker_prune.py b/plugins/modules/docker_prune.py index b8c06cae..6ec06d95 100644 --- a/plugins/modules/docker_prune.py +++ b/plugins/modules/docker_prune.py @@ -16,9 +16,9 @@ description: - Allows to run C(docker container prune), C(docker image prune), C(docker network prune) and C(docker volume prune) through the Docker API. extends_documentation_fragment: - - community.docker.docker.api_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker + - community.docker._docker.api_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker attributes: check_mode: @@ -237,11 +237,11 @@ from ansible_collections.community.docker.plugins.module_utils._api.errors impor from ansible_collections.community.docker.plugins.module_utils._api.utils.utils import ( convert_filters, ) -from ansible_collections.community.docker.plugins.module_utils.common_api import ( +from ansible_collections.community.docker.plugins.module_utils._common_api import ( AnsibleDockerClient, RequestException, ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( clean_dict_booleans_for_docker_api, ) diff --git a/plugins/modules/docker_secret.py b/plugins/modules/docker_secret.py index e8965e81..3d04b26b 100644 --- a/plugins/modules/docker_secret.py +++ b/plugins/modules/docker_secret.py @@ -19,10 +19,10 @@ description: the O(force) option is set. - Updates to secrets are performed by removing the secret and creating it again. extends_documentation_fragment: - - community.docker.docker - - community.docker.docker.docker_py_2_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker + - community.docker._docker + - community.docker._docker.docker_py_2_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker attributes: check_mode: @@ -199,11 +199,11 @@ except ImportError: pass from ansible.module_utils.common.text.converters import to_bytes -from ansible_collections.community.docker.plugins.module_utils.common import ( +from ansible_collections.community.docker.plugins.module_utils._common import ( AnsibleDockerClient, RequestException, ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( DockerBaseClass, compare_generic, sanitize_labels, diff --git a/plugins/modules/docker_stack.py b/plugins/modules/docker_stack.py index 6a951380..62bae464 100644 --- a/plugins/modules/docker_stack.py +++ b/plugins/modules/docker_stack.py @@ -15,9 +15,9 @@ short_description: docker stack module description: - Manage docker stacks using the C(docker stack) command on the target node (see examples). extends_documentation_fragment: - - community.docker.docker.cli_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker + - community.docker._docker.cli_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker attributes: check_mode: support: none @@ -162,7 +162,7 @@ import traceback from time import sleep from ansible.module_utils.common.text.converters import to_native -from ansible_collections.community.docker.plugins.module_utils.common_cli import ( +from ansible_collections.community.docker.plugins.module_utils._common_cli import ( AnsibleModuleDockerClient, DockerException, ) diff --git a/plugins/modules/docker_stack_info.py b/plugins/modules/docker_stack_info.py index 174e8a23..c7b3713f 100644 --- a/plugins/modules/docker_stack_info.py +++ b/plugins/modules/docker_stack_info.py @@ -17,11 +17,11 @@ description: requirements: - Docker CLI tool C(docker) extends_documentation_fragment: - - community.docker.docker.cli_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker - - community.docker.attributes.info_module - - community.docker.attributes.idempotent_not_modify_state + - community.docker._docker.cli_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker + - community.docker._attributes.info_module + - community.docker._attributes.idempotent_not_modify_state attributes: action_group: version_added: 3.6.0 @@ -79,7 +79,7 @@ import json import traceback from ansible.module_utils.common.text.converters import to_native -from ansible_collections.community.docker.plugins.module_utils.common_cli import ( +from ansible_collections.community.docker.plugins.module_utils._common_cli import ( AnsibleModuleDockerClient, DockerException, ) diff --git a/plugins/modules/docker_stack_task_info.py b/plugins/modules/docker_stack_task_info.py index ba89dc14..c7b4b2a3 100644 --- a/plugins/modules/docker_stack_task_info.py +++ b/plugins/modules/docker_stack_task_info.py @@ -15,11 +15,11 @@ short_description: Return information of the tasks on a docker stack description: - Retrieve information on docker stacks tasks using the C(docker stack) command on the target node (see examples). extends_documentation_fragment: - - community.docker.docker.cli_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker - - community.docker.attributes.info_module - - community.docker.attributes.idempotent_not_modify_state + - community.docker._docker.cli_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker + - community.docker._attributes.info_module + - community.docker._attributes.idempotent_not_modify_state attributes: action_group: version_added: 3.6.0 @@ -87,7 +87,7 @@ import json import traceback from ansible.module_utils.common.text.converters import to_native -from ansible_collections.community.docker.plugins.module_utils.common_cli import ( +from ansible_collections.community.docker.plugins.module_utils._common_cli import ( AnsibleModuleDockerClient, DockerException, ) diff --git a/plugins/modules/docker_swarm.py b/plugins/modules/docker_swarm.py index d9d560bf..b69fc772 100644 --- a/plugins/modules/docker_swarm.py +++ b/plugins/modules/docker_swarm.py @@ -14,10 +14,10 @@ description: - Create a new Swarm cluster. - Add/Remove nodes or managers to an existing cluster. extends_documentation_fragment: - - community.docker.docker - - community.docker.docker.docker_py_1_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker + - community.docker._docker + - community.docker._docker.docker_py_1_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker attributes: check_mode: @@ -300,14 +300,14 @@ except ImportError: # missing Docker SDK for Python handled in ansible.module_utils.docker.common pass -from ansible_collections.community.docker.plugins.module_utils.common import ( +from ansible_collections.community.docker.plugins.module_utils._common import ( DockerBaseClass, RequestException, ) -from ansible_collections.community.docker.plugins.module_utils.swarm import ( +from ansible_collections.community.docker.plugins.module_utils._swarm import ( AnsibleDockerSwarmClient, ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( DifferenceTracker, sanitize_labels, ) diff --git a/plugins/modules/docker_swarm_info.py b/plugins/modules/docker_swarm_info.py index 83df531a..4dad674e 100644 --- a/plugins/modules/docker_swarm_info.py +++ b/plugins/modules/docker_swarm_info.py @@ -23,12 +23,12 @@ author: - Piotr Wojciechowski (@WojciechowskiPiotr) extends_documentation_fragment: - - community.docker.docker - - community.docker.docker.docker_py_1_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker - - community.docker.attributes.info_module - - community.docker.attributes.idempotent_not_modify_state + - community.docker._docker + - community.docker._docker.docker_py_1_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker + - community.docker._attributes.info_module + - community.docker._attributes.idempotent_not_modify_state options: nodes: @@ -194,13 +194,13 @@ except ImportError: # missing Docker SDK for Python handled in ansible.module_utils.docker_common pass -from ansible_collections.community.docker.plugins.module_utils.common import ( +from ansible_collections.community.docker.plugins.module_utils._common import ( RequestException, ) -from ansible_collections.community.docker.plugins.module_utils.swarm import ( +from ansible_collections.community.docker.plugins.module_utils._swarm import ( AnsibleDockerSwarmClient, ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( DockerBaseClass, clean_dict_booleans_for_docker_api, ) diff --git a/plugins/modules/docker_swarm_service.py b/plugins/modules/docker_swarm_service.py index c4920bf2..c4719b68 100644 --- a/plugins/modules/docker_swarm_service.py +++ b/plugins/modules/docker_swarm_service.py @@ -19,10 +19,10 @@ description: - Manages docker services through a swarm manager node. - This modules does not support updating services in a stack. extends_documentation_fragment: - - community.docker.docker - - community.docker.docker.docker_py_2_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker + - community.docker._docker + - community.docker._docker.docker_py_2_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker attributes: check_mode: @@ -856,11 +856,11 @@ import traceback from ansible.module_utils.basic import human_to_bytes from ansible.module_utils.common.text.converters import to_text -from ansible_collections.community.docker.plugins.module_utils.common import ( +from ansible_collections.community.docker.plugins.module_utils._common import ( AnsibleDockerClient, RequestException, ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( DifferenceTracker, DockerBaseClass, clean_dict_booleans_for_docker_api, @@ -868,7 +868,7 @@ from ansible_collections.community.docker.plugins.module_utils.util import ( parse_healthcheck, sanitize_labels, ) -from ansible_collections.community.docker.plugins.module_utils.version import ( +from ansible_collections.community.docker.plugins.module_utils._version import ( LooseVersion, ) diff --git a/plugins/modules/docker_swarm_service_info.py b/plugins/modules/docker_swarm_service_info.py index 85a2f3f8..81f1b081 100644 --- a/plugins/modules/docker_swarm_service_info.py +++ b/plugins/modules/docker_swarm_service_info.py @@ -17,12 +17,12 @@ description: - Essentially returns the output of C(docker service inspect ). - Must be executed on a host running as Swarm Manager, otherwise the module will fail. extends_documentation_fragment: - - community.docker.docker - - community.docker.docker.docker_py_1_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker - - community.docker.attributes.info_module - - community.docker.attributes.idempotent_not_modify_state + - community.docker._docker + - community.docker._docker.docker_py_1_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker + - community.docker._attributes.info_module + - community.docker._attributes.idempotent_not_modify_state options: name: @@ -71,10 +71,10 @@ except ImportError: # missing Docker SDK for Python handled in ansible.module_utils.docker.common pass -from ansible_collections.community.docker.plugins.module_utils.common import ( +from ansible_collections.community.docker.plugins.module_utils._common import ( RequestException, ) -from ansible_collections.community.docker.plugins.module_utils.swarm import ( +from ansible_collections.community.docker.plugins.module_utils._swarm import ( AnsibleDockerSwarmClient, ) diff --git a/plugins/modules/docker_volume.py b/plugins/modules/docker_volume.py index 9c896df6..2918a0f5 100644 --- a/plugins/modules/docker_volume.py +++ b/plugins/modules/docker_volume.py @@ -15,9 +15,9 @@ description: - Create/remove Docker volumes. - Performs largely the same function as the C(docker volume) CLI subcommand. extends_documentation_fragment: - - community.docker.docker.api_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker + - community.docker._docker.api_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker attributes: check_mode: @@ -124,11 +124,11 @@ from ansible_collections.community.docker.plugins.module_utils._api.errors impor APIError, DockerException, ) -from ansible_collections.community.docker.plugins.module_utils.common_api import ( +from ansible_collections.community.docker.plugins.module_utils._common_api import ( AnsibleDockerClient, RequestException, ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( DifferenceTracker, DockerBaseClass, sanitize_labels, diff --git a/plugins/modules/docker_volume_info.py b/plugins/modules/docker_volume_info.py index e595f707..c3171891 100644 --- a/plugins/modules/docker_volume_info.py +++ b/plugins/modules/docker_volume_info.py @@ -14,11 +14,11 @@ short_description: Retrieve facts about Docker volumes description: - Performs largely the same function as the C(docker volume inspect) CLI subcommand. extends_documentation_fragment: - - community.docker.docker.api_documentation - - community.docker.attributes - - community.docker.attributes.actiongroup_docker - - community.docker.attributes.info_module - - community.docker.attributes.idempotent_not_modify_state + - community.docker._docker.api_documentation + - community.docker._attributes + - community.docker._attributes.actiongroup_docker + - community.docker._attributes.info_module + - community.docker._attributes.idempotent_not_modify_state options: name: @@ -76,7 +76,7 @@ from ansible_collections.community.docker.plugins.module_utils._api.errors impor DockerException, NotFound, ) -from ansible_collections.community.docker.plugins.module_utils.common_api import ( +from ansible_collections.community.docker.plugins.module_utils._common_api import ( AnsibleDockerClient, RequestException, ) diff --git a/plugins/plugin_utils/common.py b/plugins/plugin_utils/_common.py similarity index 80% rename from plugins/plugin_utils/common.py rename to plugins/plugin_utils/_common.py index 0ac5bd0b..b2fc3a5c 100644 --- a/plugins/plugin_utils/common.py +++ b/plugins/plugin_utils/_common.py @@ -2,6 +2,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import absolute_import, division, print_function @@ -10,10 +13,10 @@ __metaclass__ = type from ansible.errors import AnsibleConnectionFailure from ansible.utils.display import Display -from ansible_collections.community.docker.plugins.module_utils.common import ( +from ansible_collections.community.docker.plugins.module_utils._common import ( AnsibleDockerClientBase, ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( DOCKER_COMMON_ARGS, ) diff --git a/plugins/plugin_utils/common_api.py b/plugins/plugin_utils/_common_api.py similarity index 78% rename from plugins/plugin_utils/common_api.py rename to plugins/plugin_utils/_common_api.py index 99740a6d..dada21c1 100644 --- a/plugins/plugin_utils/common_api.py +++ b/plugins/plugin_utils/_common_api.py @@ -2,14 +2,17 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations from ansible.errors import AnsibleConnectionFailure from ansible.utils.display import Display -from ansible_collections.community.docker.plugins.module_utils.common_api import ( +from ansible_collections.community.docker.plugins.module_utils._common_api import ( AnsibleDockerClientBase, ) -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( DOCKER_COMMON_ARGS, ) diff --git a/plugins/plugin_utils/socket_handler.py b/plugins/plugin_utils/_socket_handler.py similarity index 69% rename from plugins/plugin_utils/socket_handler.py rename to plugins/plugin_utils/_socket_handler.py index 4050ed8d..69e407c9 100644 --- a/plugins/plugin_utils/socket_handler.py +++ b/plugins/plugin_utils/_socket_handler.py @@ -2,6 +2,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import absolute_import, division, print_function @@ -10,7 +13,7 @@ __metaclass__ = type import selectors -from ansible_collections.community.docker.plugins.module_utils.socket_handler import ( +from ansible_collections.community.docker.plugins.module_utils._socket_handler import ( DockerSocketHandlerBase, ) diff --git a/plugins/plugin_utils/unsafe.py b/plugins/plugin_utils/_unsafe.py similarity index 87% rename from plugins/plugin_utils/unsafe.py rename to plugins/plugin_utils/_unsafe.py index 6c3c658f..c70959d6 100644 --- a/plugins/plugin_utils/unsafe.py +++ b/plugins/plugin_utils/_unsafe.py @@ -2,6 +2,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import re diff --git a/tests/unit/plugins/module_utils/compose_v2_test_cases.py b/tests/unit/plugins/module_utils/compose_v2_test_cases.py index f7eed495..c2c841c6 100644 --- a/tests/unit/plugins/module_utils/compose_v2_test_cases.py +++ b/tests/unit/plugins/module_utils/compose_v2_test_cases.py @@ -7,7 +7,7 @@ from __future__ import absolute_import, division, print_function __metaclass__ = type -from ansible_collections.community.docker.plugins.module_utils.compose_v2 import ( +from ansible_collections.community.docker.plugins.module_utils._compose_v2 import ( Event, ) diff --git a/tests/unit/plugins/module_utils/test_compose_v2.py b/tests/unit/plugins/module_utils/test__compose_v2.py similarity index 99% rename from tests/unit/plugins/module_utils/test_compose_v2.py rename to tests/unit/plugins/module_utils/test__compose_v2.py index c6234e1c..3296b00a 100644 --- a/tests/unit/plugins/module_utils/test_compose_v2.py +++ b/tests/unit/plugins/module_utils/test__compose_v2.py @@ -8,7 +8,7 @@ from __future__ import absolute_import, division, print_function __metaclass__ = type import pytest -from ansible_collections.community.docker.plugins.module_utils.compose_v2 import ( +from ansible_collections.community.docker.plugins.module_utils._compose_v2 import ( Event, parse_events, ) diff --git a/tests/unit/plugins/module_utils/test_copy.py b/tests/unit/plugins/module_utils/test__copy.py similarity index 96% rename from tests/unit/plugins/module_utils/test_copy.py rename to tests/unit/plugins/module_utils/test__copy.py index eb150b25..31184f5a 100644 --- a/tests/unit/plugins/module_utils/test_copy.py +++ b/tests/unit/plugins/module_utils/test__copy.py @@ -8,7 +8,7 @@ from __future__ import absolute_import, division, print_function __metaclass__ = type import pytest -from ansible_collections.community.docker.plugins.module_utils.copy import ( +from ansible_collections.community.docker.plugins.module_utils._copy import ( _stream_generator_to_fileobj, ) diff --git a/tests/unit/plugins/module_utils/test_image_archive.py b/tests/unit/plugins/module_utils/test__image_archive.py similarity index 96% rename from tests/unit/plugins/module_utils/test_image_archive.py rename to tests/unit/plugins/module_utils/test__image_archive.py index 7c161037..dc1dcd78 100644 --- a/tests/unit/plugins/module_utils/test_image_archive.py +++ b/tests/unit/plugins/module_utils/test__image_archive.py @@ -10,7 +10,7 @@ __metaclass__ = type import tarfile import pytest -from ansible_collections.community.docker.plugins.module_utils.image_archive import ( +from ansible_collections.community.docker.plugins.module_utils._image_archive import ( ImageArchiveInvalidException, api_image_id, archived_image_manifest, diff --git a/tests/unit/plugins/module_utils/test_util.py b/tests/unit/plugins/module_utils/test__util.py similarity index 99% rename from tests/unit/plugins/module_utils/test_util.py rename to tests/unit/plugins/module_utils/test__util.py index ff3231c2..dcac124f 100644 --- a/tests/unit/plugins/module_utils/test_util.py +++ b/tests/unit/plugins/module_utils/test__util.py @@ -8,7 +8,7 @@ from __future__ import absolute_import, division, print_function __metaclass__ = type import pytest -from ansible_collections.community.docker.plugins.module_utils.util import ( +from ansible_collections.community.docker.plugins.module_utils._util import ( compare_dict_allow_more_present, compare_generic, convert_duration_to_nanosecond, diff --git a/tests/unit/plugins/modules/test_docker_image.py b/tests/unit/plugins/modules/test_docker_image.py index b82188c6..e7820d10 100644 --- a/tests/unit/plugins/modules/test_docker_image.py +++ b/tests/unit/plugins/modules/test_docker_image.py @@ -8,7 +8,7 @@ from __future__ import absolute_import, division, print_function __metaclass__ = type import pytest -from ansible_collections.community.docker.plugins.module_utils.image_archive import ( +from ansible_collections.community.docker.plugins.module_utils._image_archive import ( api_image_id, ) from ansible_collections.community.docker.plugins.modules.docker_image import ( diff --git a/tests/unit/plugins/plugin_utils/test_unsafe.py b/tests/unit/plugins/plugin_utils/test__unsafe.py similarity index 98% rename from tests/unit/plugins/plugin_utils/test_unsafe.py rename to tests/unit/plugins/plugin_utils/test__unsafe.py index b79022ed..116b5bff 100644 --- a/tests/unit/plugins/plugin_utils/test_unsafe.py +++ b/tests/unit/plugins/plugin_utils/test__unsafe.py @@ -6,7 +6,7 @@ from __future__ import annotations import pytest -from ansible_collections.community.docker.plugins.plugin_utils.unsafe import ( +from ansible_collections.community.docker.plugins.plugin_utils._unsafe import ( make_unsafe, ) from ansible_collections.community.internal_test_tools.tests.unit.utils.trust import (