Make all doc fragments, module utils, and plugin utils private (#11896)

* Make all doc fragments private.

* Make all plugin utils private.

* Make all module utils private.

* Reformat.

* Changelog fragment.

* Update configs and ignores.

* Adjust unit test names.

.github/BOTMETA.yml

@@ -128,21 +128,21 @@ files:
     maintainers: $team_ansible_core
   $doc_fragments/:
     labels: docs_fragments
-  $doc_fragments/django.py:
+  $doc_fragments/_django.py:
     maintainers: russoz
-  $doc_fragments/hpe3par.py:
+  $doc_fragments/_hpe3par.py:
     labels: hpe3par
     maintainers: farhan7500 gautamphegde
-  $doc_fragments/hwc.py:
+  $doc_fragments/_hwc.py:
     labels: hwc
     maintainers: $team_huawei
   $doc_fragments/_icinga2_api.py:
     maintainers: cfiehe
-  $doc_fragments/nomad.py:
+  $doc_fragments/_nomad.py:
     maintainers: chris93111 apecnascimento
-  $doc_fragments/pipx.py:
+  $doc_fragments/_pipx.py:
     maintainers: russoz
-  $doc_fragments/xenserver.py:
+  $doc_fragments/_xenserver.py:
     labels: xenserver
     maintainers: bvitnik
   $filters/accumulate.py:
@@ -339,42 +339,42 @@ files:
     maintainers: delineaKrehl tylerezimmerman
   $module_utils/:
     labels: module_utils
-  $module_utils/android_sdkmanager.py:
+  $module_utils/_android_sdkmanager.py:
     maintainers: shamilovstas
-  $module_utils/btrfs.py:
+  $module_utils/_btrfs.py:
     maintainers: gnfzdz
-  $module_utils/cmd_runner_fmt.py:
+  $module_utils/_cmd_runner_fmt.py:
     maintainers: russoz
-  $module_utils/cmd_runner.py:
+  $module_utils/_cmd_runner.py:
     maintainers: russoz
-  $module_utils/deps.py:
+  $module_utils/_deps.py:
     maintainers: russoz
-  $module_utils/django.py:
+  $module_utils/_django.py:
     maintainers: russoz
-  $module_utils/gconftool2.py:
+  $module_utils/_gconftool2.py:
     labels: gconftool2
     maintainers: russoz
-  $module_utils/gio_mime.py:
+  $module_utils/_gio_mime.py:
     maintainers: russoz
-  $module_utils/gitlab.py:
+  $module_utils/_gitlab.py:
     keywords: gitlab source_control
     labels: gitlab
     maintainers: $team_gitlab
     notify: jlozadad
-  $module_utils/hwc_utils.py:
+  $module_utils/_hwc_utils.py:
     keywords: cloud huawei hwc
     labels: huawei hwc_utils networking
     maintainers: $team_huawei
   $module_utils/_icinga2.py:
     maintainers: cfiehe
-  $module_utils/identity/keycloak/keycloak.py:
+  $module_utils/_identity/keycloak/keycloak.py:
     maintainers: $team_keycloak
-  $module_utils/identity/keycloak/keycloak_clientsecret.py:
+  $module_utils/_identity/keycloak/keycloak_clientsecret.py:
     maintainers: $team_keycloak fynncfchen johncant
-  $module_utils/ipa.py:
+  $module_utils/_ipa.py:
     labels: ipa
     maintainers: $team_ipa
-  $module_utils/jenkins.py:
+  $module_utils/_jenkins.py:
     labels: jenkins
     maintainers: russoz
   $module_utils/_crypt.py:
@@ -384,63 +384,63 @@ files:
   $module_utils/_lvm.py:
     labels: lvm
     maintainers: russoz
-  $module_utils/manageiq.py:
+  $module_utils/_manageiq.py:
     labels: manageiq
     maintainers: $team_manageiq
-  $module_utils/memset.py:
+  $module_utils/_memset.py:
     labels: cloud memset
-  $module_utils/mh/:
+  $module_utils/_mh/:
     labels: module_helper
     maintainers: russoz
-  $module_utils/module_helper.py:
+  $module_utils/_module_helper.py:
     labels: module_helper
     maintainers: russoz
-  $module_utils/net_tools/pritunl/:
+  $module_utils/_net_tools/pritunl/:
     maintainers: Lowess
-  $module_utils/pacemaker.py:
+  $module_utils/_pacemaker.py:
     maintainers: munchtoast
-  $module_utils/pipx.py:
+  $module_utils/_pipx.py:
     labels: pipx
     maintainers: russoz
-  $module_utils/pkg_req.py:
+  $module_utils/_pkg_req.py:
     maintainers: russoz
-  $module_utils/python_runner.py:
+  $module_utils/_python_runner.py:
     maintainers: russoz
-  $module_utils/puppet.py:
+  $module_utils/_puppet.py:
     labels: puppet
     maintainers: russoz
-  $module_utils/redfish_utils.py:
+  $module_utils/_redfish_utils.py:
     labels: redfish_utils
     maintainers: $team_redfish
-  $module_utils/remote_management/lxca/common.py:
+  $module_utils/_remote_management/lxca/common.py:
     maintainers: navalkp prabhosa
-  $module_utils/scaleway.py:
+  $module_utils/_scaleway.py:
     labels: cloud scaleway
     maintainers: $team_scaleway
-  $module_utils/snap.py:
+  $module_utils/_snap.py:
     labels: snap
     maintainers: russoz
-  $module_utils/ssh.py:
+  $module_utils/_ssh.py:
     maintainers: russoz
-  $module_utils/systemd.py:
+  $module_utils/_systemd.py:
     maintainers: NomakCooper
-  $module_utils/storage/hpe3par/hpe3par.py:
+  $module_utils/_storage/hpe3par/hpe3par.py:
     maintainers: farhan7500 gautamphegde
-  $module_utils/utm_utils.py:
+  $module_utils/_utm_utils.py:
     labels: utm_utils
     maintainers: $team_e_spirit
-  $module_utils/vardict.py:
+  $module_utils/_vardict.py:
     labels: vardict
     maintainers: russoz
-  $module_utils/wdc_redfish_utils.py:
+  $module_utils/_wdc_redfish_utils.py:
     labels: wdc_redfish_utils
     maintainers: $team_wdc
-  $module_utils/xdg_mime.py:
+  $module_utils/_xdg_mime.py:
     maintainers: mhalano
-  $module_utils/xenserver.py:
+  $module_utils/_xenserver.py:
     labels: xenserver
     maintainers: bvitnik
-  $module_utils/xfconf.py:
+  $module_utils/_xfconf.py:
     labels: xfconf
     maintainers: russoz
   $modules/aerospike_migrations.py:
@@ -1493,11 +1493,11 @@ files:
   $modules/zypper_repository_info.py:
     labels: zypper
     maintainers: $team_suse TobiasZeuch181
-  $plugin_utils/ansible_type.py:
+  $plugin_utils/_ansible_type.py:
     maintainers: vbotka
-  $plugin_utils/keys_filter.py:
+  $plugin_utils/_keys_filter.py:
     maintainers: vbotka
-  $plugin_utils/unsafe.py:
+  $plugin_utils/_unsafe.py:
     maintainers: felixfontein
   $plugin_utils/_tags.py:
     maintainers: felixfontein

antsibull-nox.toml

@@ -98,7 +98,7 @@ exclusions = [
     "consul_acl_bootstrap",
     "consul_kv",
 ]
-doc_fragment = "community.general.consul.actiongroup_consul"
+doc_fragment = "community.general._consul.actiongroup_consul"
 
 [[sessions.extra_checks.action_groups_config]]
 name = "keycloak"
@@ -106,12 +106,12 @@ pattern = "^keycloak_.*$"
 exclusions = [
     "keycloak_realm_info",
 ]
-doc_fragment = "community.general.keycloak.actiongroup_keycloak"
+doc_fragment = "community.general._keycloak.actiongroup_keycloak"
 
 [[sessions.extra_checks.action_groups_config]]
 name = "scaleway"
 pattern = "^scaleway_.*$"
-doc_fragment = "community.general.scaleway.actiongroup_scaleway"
+doc_fragment = "community.general._scaleway.actiongroup_scaleway"
 
 [sessions.build_import_check]
 run_galaxy_importer = true

changelogs/fragments/11896-private.yml

@@ -0,0 +1,5 @@
+breaking_changes:
+  - "Since community.general 13.0.0, all module utils, plugin utils, and doc fragments contained in this collection are private to the collection.
+     This means that if another collection wants to use these, there is no longer any guarantee that there are no breaking changes, even in bugfix releases.
+     This has no practical impact on any other use of the collection, that is, everyone using modules or plugins from the collections will not notice any
+     difference (https://github.com/ansible-collections/community.general/issues/11312, https://github.com/ansible-collections/community.general/pull/11896)."

docs/docsite/rst/guide_cmdrunner.rst

@@ -13,7 +13,7 @@ Command Runner guide
 Introduction
 ^^^^^^^^^^^^
 
-The ``ansible_collections.community.general.plugins.module_utils.cmd_runner`` module util provides the
+The ``ansible_collections.community.general.plugins.module_utils._cmd_runner`` module util provides the
 ``CmdRunner`` class to help execute external commands. The class is a wrapper around
 the standard ``AnsibleModule.run_command()`` method, handling command arguments, localization setting,
 output processing output, check mode, and other features.
@@ -38,7 +38,7 @@ version of the actual code in :ansplugin:`community.general.ansible_galaxy_insta
 
 .. code-block:: python
 
-    from ansible_collections.community.general.plugins.module_utils.cmd_runner import CmdRunner, cmd_runner_fmt
+    from ansible_collections.community.general.plugins.module_utils._cmd_runner import CmdRunner, cmd_runner_fmt
 
     runner = CmdRunner(
         module,
@@ -151,7 +151,7 @@ that class:
 
 .. code-block:: python
 
-    from ansible_collections.community.general.plugins.module_utils.cmd_runner import CmdRunner, cmd_runner_fmt
+    from ansible_collections.community.general.plugins.module_utils._cmd_runner import CmdRunner, cmd_runner_fmt
 
 The same example shows how to make use of some of them in the instantiation of the ``CmdRunner`` object.
 A description of each one of the convenience methods available and examples of how to use them is found below.
@@ -354,7 +354,7 @@ Some additional features are available as decorators:
 - ``cmd_runner_fmt.unpack args()``
     This decorator unpacks the incoming ``value`` as a list of elements.
 
-    For example, in ``ansible_collections.community.general.plugins.module_utils.puppet``, it is used as:
+    For example, in ``ansible_collections.community.general.plugins.module_utils._puppet``, it is used as:
 
     .. code-block:: python
 
@@ -492,8 +492,8 @@ Python scripts. It features two extra and  mutually exclusive parameters ``pytho
 
 .. code-block:: python
 
-    from ansible_collections.community.general.plugins.module_utils.python_runner import PythonRunner
-    from ansible_collections.community.general.plugins.module_utils.cmd_runner import cmd_runner_fmt
+    from ansible_collections.community.general.plugins.module_utils._python_runner import PythonRunner
+    from ansible_collections.community.general.plugins.module_utils._cmd_runner import cmd_runner_fmt
 
     runner = PythonRunner(
         module,

docs/docsite/rst/guide_deps.rst

@@ -12,7 +12,7 @@
 Using ``deps``
 ^^^^^^^^^^^^^^
 
-The ``ansible_collections.community.general.plugins.module_utils.deps`` module util simplifies
+The ``ansible_collections.community.general.plugins.module_utils._deps`` module util simplifies
 the importing of code as described in :ref:`Importing and using shared code <shared_code>`.
 Please notice that ``deps`` is meant to be used specifically with Ansible modules, and not other types of plugins.
 
@@ -20,7 +20,7 @@ The same example from the Developer Guide would become:
 
 .. code-block:: python
 
-    from ansible_collections.community.general.plugins.module_utils import deps
+    from ansible_collections.community.general.plugins.module_utils import _deps as deps
 
 
     with deps.declare("foo"):

docs/docsite/rst/guide_modulehelper.rst

@@ -27,7 +27,7 @@ But bear in mind that it does not showcase all of MH's features:
 
 .. code-block:: python
 
-    from ansible_collections.community.general.plugins.module_utils.module_helper import ModuleHelper
+    from ansible_collections.community.general.plugins.module_utils._module_helper import ModuleHelper
 
 
     class MyTest(ModuleHelper):
@@ -72,7 +72,7 @@ section above, but there are more elements that will take part in it.
 
 .. code-block:: python
 
-    from ansible_collections.community.general.plugins.module_utils.module_helper import ModuleHelper
+    from ansible_collections.community.general.plugins.module_utils._module_helper import ModuleHelper
 
 
     class MyTest(ModuleHelper):
@@ -354,7 +354,7 @@ However, you can set output variables specifically for that exception, if you so
 
 .. code-block:: python
 
-    from ansible_collections.community.general.plugins.module_utils.module_helper import ModuleHelperException
+    from ansible_collections.community.general.plugins.module_utils._module_helper import ModuleHelperException
 
     def __init_module__(self):
         if not complex_validation():
@@ -385,7 +385,7 @@ By using ``StateModuleHelper`` you can make your code like the excerpt from the
 
 .. code-block:: python
 
-    from ansible_collections.community.general.plugins.module_utils.module_helper import StateModuleHelper
+    from ansible_collections.community.general.plugins.module_utils._module_helper import StateModuleHelper
 
     class GConftool(StateModuleHelper):
         ...
@@ -501,7 +501,7 @@ The value of ``changed`` in the module output will be set to ``True``:
 
 .. code-block:: python
 
-    from ansible_collections.community.general.plugins.module_utils.module_helper import cause_changes
+    from ansible_collections.community.general.plugins.module_utils._module_helper import cause_changes
 
     # adapted excerpt from the community.general.jira module
     class JIRA(StateModuleHelper):
@@ -528,7 +528,7 @@ The return value in that case is ``None``.
 
 .. code-block:: python
 
-    from ansible_collections.community.general.plugins.module_utils.module_helper import check_mode_skip
+    from ansible_collections.community.general.plugins.module_utils._module_helper import check_mode_skip
 
     # adapted excerpt from the community.general.locale_gen module
     class LocaleGen(StateModuleHelper):

docs/docsite/rst/guide_vardict.rst

@@ -11,7 +11,7 @@ VarDict Guide
 Introduction
 ^^^^^^^^^^^^
 
-The ``ansible_collections.community.general.plugins.module_utils.vardict`` module util provides the
+The ``ansible_collections.community.general.plugins.module_utils._vardict`` module util provides the
 ``VarDict`` class to help manage the module variables. That class is a container for module variables,
 especially the ones for which the module must keep track of state changes, and the ones that should
 be published as return values.
@@ -26,7 +26,7 @@ The simplest way of using ``VarDict`` is:
 
 .. code-block:: python
 
-    from ansible_collections.community.general.plugins.module_utils.vardict import VarDict
+    from ansible_collections.community.general.plugins.module_utils._vardict import VarDict
 
 Then in ``main()``, or any other function called from there:
 

plugins/callback/counter_enabled.py

@@ -17,7 +17,7 @@ description:
   - You can see how many tasks has the playbook to run, and which one is actually running.
   - You can see how many hosts may run a task, and which of them is actually running.
 extends_documentation_fragment:
-  - default_callback
+  - ansible.builtin.default_callback
 requirements:
   - set as stdout callback in C(ansible.cfg) (C(stdout_callback = counter_enabled))
 """

plugins/callback/dense.py

@@ -10,7 +10,7 @@ name: dense
 type: stdout
 short_description: Minimal stdout output
 extends_documentation_fragment:
-  - default_callback
+  - ansible.builtin.default_callback
 description:
   - When in verbose mode it acts the same as the default callback.
 author:

plugins/callback/diy.py

@@ -13,7 +13,7 @@ description:
   - Callback plugin that allows you to supply your own custom callback templates to be output.
 author: Trevor Highfill (@theque5t)
 extends_documentation_fragment:
-  - default_callback
+  - ansible.builtin.default_callback
 notes:
   - Uses the P(ansible.builtin.default#callback) callback plugin output when a custom callback V(message(msg\)) is not provided.
   - Makes the callback event data available using the C(ansible_callback_diy) dictionary, which can be used in the templating

plugins/callback/loganalytics.py

@@ -69,7 +69,7 @@ from ansible.module_utils.urls import open_url
 from ansible.parsing.ajson import AnsibleJSONEncoder
 from ansible.plugins.callback import CallbackBase
 
-from ansible_collections.community.general.plugins.module_utils.datetime import (
+from ansible_collections.community.general.plugins.module_utils._datetime import (
     now,
 )
 

plugins/callback/logstash.py

@@ -111,7 +111,7 @@ except ImportError:
 
 from ansible.plugins.callback import CallbackBase
 
-from ansible_collections.community.general.plugins.module_utils.datetime import (
+from ansible_collections.community.general.plugins.module_utils._datetime import (
     now,
 )
 

plugins/callback/splunk.py

@@ -94,7 +94,7 @@ from ansible.module_utils.urls import open_url
 from ansible.parsing.ajson import AnsibleJSONEncoder
 from ansible.plugins.callback import CallbackBase
 
-from ansible_collections.community.general.plugins.module_utils.datetime import (
+from ansible_collections.community.general.plugins.module_utils._datetime import (
     now,
 )
 

plugins/callback/sumologic.py

@@ -51,7 +51,7 @@ from ansible.module_utils.urls import open_url
 from ansible.parsing.ajson import AnsibleJSONEncoder
 from ansible.plugins.callback import CallbackBase
 
-from ansible_collections.community.general.plugins.module_utils.datetime import (
+from ansible_collections.community.general.plugins.module_utils._datetime import (
     now,
 )
 

plugins/callback/unixy.py

@@ -14,7 +14,7 @@ short_description: Condensed Ansible output
 description:
   - Consolidated Ansible output in the style of LINUX/UNIX startup logs.
 extends_documentation_fragment:
-  - default_callback
+  - ansible.builtin.default_callback
 requirements:
   - set as stdout in configuration
 """

plugins/connection/wsl.py

@@ -342,7 +342,7 @@ from ansible.utils.display import Display
 from ansible.utils.path import makedirs_safe
 
 from ansible_collections.community.general.plugins.module_utils._filelock import FileLock, LockTimeout
-from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
+from ansible_collections.community.general.plugins.module_utils._version import LooseVersion
 
 PARAMIKO_IMPORT_ERR: str | None
 try:

plugins/doc_fragments/_alicloud.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 doc fragment 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
 
 

plugins/doc_fragments/_attributes.py

@@ -2,6 +2,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 doc fragment 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
 
 

plugins/doc_fragments/_auth_basic.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 doc fragment 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
 
 

plugins/doc_fragments/_bitbucket.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 doc fragment 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
 
 

plugins/doc_fragments/_consul.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 doc fragment 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
 
 

plugins/doc_fragments/_django.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 doc fragment 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
 
 

plugins/doc_fragments/_emc.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 doc fragment 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
 
 

plugins/doc_fragments/_gitlab.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 doc fragment 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
 
 

plugins/doc_fragments/_hpe3par.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 doc fragment 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
 
 

plugins/doc_fragments/_hwc.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 doc fragment 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
 
 

plugins/doc_fragments/_ibm_storage.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 doc fragment 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
 
 

plugins/doc_fragments/_influxdb.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 doc fragment 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
 
 

plugins/doc_fragments/_ipa.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 doc fragment 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
 
 

plugins/doc_fragments/_keycloak.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 doc fragment 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
 
 

plugins/doc_fragments/_ldap.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 doc fragment 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
 
 

plugins/doc_fragments/_lxca_common.py

@@ -2,6 +2,9 @@
 # Simplified BSD License (see LICENSES/BSD-2-Clause.txt or https://opensource.org/licenses/BSD-2-Clause)
 # SPDX-License-Identifier: BSD-2-Clause
 
+# Note that this doc fragment 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
 
 

plugins/doc_fragments/_manageiq.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 doc fragment 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
 
 

plugins/doc_fragments/_nomad.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 doc fragment 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
 
 

plugins/doc_fragments/_onepassword.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 doc fragment 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
 
 

plugins/doc_fragments/_oneview.py

@@ -1,8 +1,10 @@
-#
 # Copyright (c) 2016-2017, Hewlett Packard Enterprise Development LP
 # 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 doc fragment 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
 
 

plugins/doc_fragments/_online.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 doc fragment 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
 
 

plugins/doc_fragments/_opennebula.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 doc fragment 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
 
 

plugins/doc_fragments/_openswitch.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 doc fragment 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
 
 

plugins/doc_fragments/_pipx.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 doc fragment 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
 
 

plugins/doc_fragments/_pritunl.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 doc fragment 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
 
 

plugins/doc_fragments/_redfish.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 doc fragment 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
 
 

plugins/doc_fragments/_redis.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 doc fragment 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
 
 

plugins/doc_fragments/_rundeck.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 doc fragment 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
 
 

plugins/doc_fragments/_scaleway.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 doc fragment 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
 
 

plugins/doc_fragments/_scaleway_waitable_resource.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 doc fragment 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
 
 

plugins/doc_fragments/_utm.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 doc fragment 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
 
 

plugins/doc_fragments/_vexata.py

@@ -1,8 +1,10 @@
-#
 # Copyright (c) 2019, Sandeep Kasargod <sandeep@vexata.com>
 # 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 doc fragment 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
 
 

plugins/doc_fragments/_xenserver.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 doc fragment 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
 
 

plugins/filter/from_csv.py

@@ -79,7 +79,7 @@ _value:
 
 from ansible.errors import AnsibleFilterError
 
-from ansible_collections.community.general.plugins.module_utils.csv import (
+from ansible_collections.community.general.plugins.module_utils._csv import (
     CSVError,
     CustomDialectFailureError,
     DialectNotAvailableError,

plugins/filter/keep_keys.py

@@ -99,7 +99,7 @@ _value:
   elements: dictionary
 """
 
-from ansible_collections.community.general.plugins.plugin_utils.keys_filter import (
+from ansible_collections.community.general.plugins.plugin_utils._keys_filter import (
     _keys_filter_params,
     _keys_filter_target_str,
 )

plugins/filter/remove_keys.py

@@ -99,7 +99,7 @@ _value:
   elements: dictionary
 """
 
-from ansible_collections.community.general.plugins.plugin_utils.keys_filter import (
+from ansible_collections.community.general.plugins.plugin_utils._keys_filter import (
     _keys_filter_params,
     _keys_filter_target_str,
 )

plugins/filter/replace_keys.py

@@ -129,7 +129,7 @@ _value:
   elements: dictionary
 """
 
-from ansible_collections.community.general.plugins.plugin_utils.keys_filter import (
+from ansible_collections.community.general.plugins.plugin_utils._keys_filter import (
     _keys_filter_params,
     _keys_filter_target_dict,
 )

plugins/filter/reveal_ansible_type.py

@@ -129,7 +129,7 @@ _value:
   type: str
 """
 
-from ansible_collections.community.general.plugins.plugin_utils.ansible_type import _ansible_type
+from ansible_collections.community.general.plugins.plugin_utils._ansible_type import _ansible_type
 
 
 def reveal_ansible_type(data, alias=None):

plugins/filter/version_sort.py

@@ -33,7 +33,7 @@ _value:
   elements: string
 """
 
-from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
+from ansible_collections.community.general.plugins.module_utils._version import LooseVersion
 
 
 def version_sort(value, reverse=False):

plugins/inventory/cobbler.py

@@ -135,7 +135,7 @@ import socket
 from ansible.errors import AnsibleError
 from ansible.plugins.inventory import BaseInventoryPlugin, Cacheable, to_safe_group_name
 
-from ansible_collections.community.general.plugins.plugin_utils.unsafe import make_unsafe
+from ansible_collections.community.general.plugins.plugin_utils._unsafe import make_unsafe
 
 # xmlrpc
 try:

plugins/inventory/gitlab_runners.py

@@ -82,7 +82,7 @@ keyed_groups:
 from ansible.errors import AnsibleError, AnsibleParserError
 from ansible.plugins.inventory import BaseInventoryPlugin, Constructable
 
-from ansible_collections.community.general.plugins.plugin_utils.unsafe import make_unsafe
+from ansible_collections.community.general.plugins.plugin_utils._unsafe import make_unsafe
 
 try:
     import gitlab

plugins/inventory/icinga2.py

@@ -100,7 +100,7 @@ from ansible.errors import AnsibleParserError
 from ansible.module_utils.urls import open_url
 from ansible.plugins.inventory import BaseInventoryPlugin, Constructable
 
-from ansible_collections.community.general.plugins.plugin_utils.unsafe import make_unsafe
+from ansible_collections.community.general.plugins.plugin_utils._unsafe import make_unsafe
 
 
 class InventoryModule(BaseInventoryPlugin, Constructable):

plugins/inventory/linode.py

@@ -127,7 +127,7 @@ compose:
 from ansible.errors import AnsibleError
 from ansible.plugins.inventory import BaseInventoryPlugin, Cacheable, Constructable
 
-from ansible_collections.community.general.plugins.plugin_utils.unsafe import make_unsafe
+from ansible_collections.community.general.plugins.plugin_utils._unsafe import make_unsafe
 
 try:
     from linode_api4 import LinodeClient

plugins/inventory/lxd.py

@@ -177,8 +177,8 @@ from ansible.module_utils.common.dict_transformations import dict_merge
 from ansible.module_utils.common.text.converters import to_native, to_text
 from ansible.plugins.inventory import BaseInventoryPlugin
 
-from ansible_collections.community.general.plugins.module_utils.lxd import LXDClient, LXDClientException
-from ansible_collections.community.general.plugins.plugin_utils.unsafe import make_unsafe
+from ansible_collections.community.general.plugins.module_utils._lxd import LXDClient, LXDClientException
+from ansible_collections.community.general.plugins.plugin_utils._unsafe import make_unsafe
 
 IPADDRESS_IMPORT_ERROR: ImportError | None
 try:

plugins/inventory/nmap.py

@@ -133,7 +133,7 @@ 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_collections.community.general.plugins.plugin_utils.unsafe import make_unsafe
+from ansible_collections.community.general.plugins.plugin_utils._unsafe import make_unsafe
 
 
 class InventoryModule(BaseInventoryPlugin, Constructable, Cacheable):

plugins/inventory/online.py

@@ -69,7 +69,7 @@ from ansible.module_utils.common.text.converters import to_text
 from ansible.module_utils.urls import open_url
 from ansible.plugins.inventory import BaseInventoryPlugin
 
-from ansible_collections.community.general.plugins.plugin_utils.unsafe import make_unsafe
+from ansible_collections.community.general.plugins.plugin_utils._unsafe import make_unsafe
 
 
 class InventoryModule(BaseInventoryPlugin):

plugins/inventory/opennebula.py

@@ -95,7 +95,7 @@ from collections import namedtuple
 from ansible.errors import AnsibleError
 from ansible.plugins.inventory import BaseInventoryPlugin, Constructable
 
-from ansible_collections.community.general.plugins.plugin_utils.unsafe import make_unsafe
+from ansible_collections.community.general.plugins.plugin_utils._unsafe import make_unsafe
 
 
 class InventoryModule(BaseInventoryPlugin, Constructable):

plugins/inventory/scaleway.py

@@ -135,8 +135,11 @@ from ansible.module_utils.common.text.converters import to_text
 from ansible.module_utils.urls import open_url
 from ansible.plugins.inventory import BaseInventoryPlugin, Constructable
 
-from ansible_collections.community.general.plugins.module_utils.scaleway import SCALEWAY_LOCATION, parse_pagination_link
-from ansible_collections.community.general.plugins.plugin_utils.unsafe import make_unsafe
+from ansible_collections.community.general.plugins.module_utils._scaleway import (
+    SCALEWAY_LOCATION,
+    parse_pagination_link,
+)
+from ansible_collections.community.general.plugins.plugin_utils._unsafe import make_unsafe
 
 
 def _fetch_information(token, url):

plugins/inventory/virtualbox.py

@@ -80,7 +80,7 @@ from ansible.module_utils.common.process import get_bin_path
 from ansible.module_utils.common.text.converters import to_bytes, to_text
 from ansible.plugins.inventory import BaseInventoryPlugin, Cacheable, Constructable
 
-from ansible_collections.community.general.plugins.plugin_utils.unsafe import make_unsafe
+from ansible_collections.community.general.plugins.plugin_utils._unsafe import make_unsafe
 
 
 class InventoryModule(BaseInventoryPlugin, Constructable, Cacheable):

plugins/inventory/xen_orchestra.py

@@ -101,8 +101,8 @@ from time import sleep
 from ansible.errors import AnsibleError
 from ansible.plugins.inventory import BaseInventoryPlugin, Cacheable, Constructable
 
-from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
-from ansible_collections.community.general.plugins.plugin_utils.unsafe import make_unsafe
+from ansible_collections.community.general.plugins.module_utils._version import LooseVersion
+from ansible_collections.community.general.plugins.plugin_utils._unsafe import make_unsafe
 
 # 3rd party imports
 try:

plugins/lookup/bitwarden_secrets_manager.py

@@ -74,7 +74,7 @@ from ansible.module_utils.common.text.converters import to_text
 from ansible.parsing.ajson import AnsibleJSONDecoder
 from ansible.plugins.lookup import LookupBase
 
-from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
+from ansible_collections.community.general.plugins.module_utils._version import LooseVersion
 
 
 class BitwardenSecretsManagerException(AnsibleLookupError):

plugins/lookup/onepassword.py

@@ -34,8 +34,8 @@ options:
   service_account_token:
     version_added: 7.1.0
 extends_documentation_fragment:
-  - community.general.onepassword
-  - community.general.onepassword.lookup
+  - community.general._onepassword
+  - community.general._onepassword.lookup
 """
 
 EXAMPLES = r"""
@@ -84,7 +84,7 @@ from ansible.module_utils.common.process import get_bin_path
 from ansible.module_utils.common.text.converters import to_bytes, to_text
 from ansible.plugins.lookup import LookupBase
 
-from ansible_collections.community.general.plugins.module_utils.onepassword import OnePasswordConfig
+from ansible_collections.community.general.plugins.module_utils._onepassword import OnePasswordConfig
 
 
 def _lower_if_possible(value):

plugins/lookup/onepassword_doc.py

@@ -25,8 +25,8 @@ options:
     elements: string
 
 extends_documentation_fragment:
-  - community.general.onepassword
-  - community.general.onepassword.lookup
+  - community.general._onepassword
+  - community.general._onepassword.lookup
 """
 
 EXAMPLES = r"""

plugins/lookup/onepassword_raw.py

@@ -30,8 +30,8 @@ options:
   service_account_token:
     version_added: 7.1.0
 extends_documentation_fragment:
-  - community.general.onepassword
-  - community.general.onepassword.lookup
+  - community.general._onepassword
+  - community.general._onepassword.lookup
 """
 
 EXAMPLES = r"""

plugins/lookup/onepassword_ssh_key.py

@@ -30,8 +30,8 @@ options:
     type: bool
 
 extends_documentation_fragment:
-  - community.general.onepassword
-  - community.general.onepassword.lookup
+  - community.general._onepassword
+  - community.general._onepassword.lookup
 """
 
 EXAMPLES = r"""

plugins/module_utils/_alicloud_ecs.py

@@ -9,6 +9,9 @@
 # Simplified BSD License (see LICENSES/BSD-2-Clause.txt or https://opensource.org/licenses/BSD-2-Clause)
 # SPDX-License-Identifier: BSD-2-Clause
 
+# 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

plugins/module_utils/_android_sdkmanager.py

@@ -2,12 +2,15 @@
 # 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
 import typing as t
 
-from ansible_collections.community.general.plugins.module_utils.cmd_runner import CmdRunner, cmd_runner_fmt
+from ansible_collections.community.general.plugins.module_utils._cmd_runner import CmdRunner, cmd_runner_fmt
 
 if t.TYPE_CHECKING:
     from ansible.module_utils.basic import AnsibleModule

plugins/module_utils/_btrfs.py

@@ -2,6 +2,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
 
 import os

plugins/module_utils/_cmd_runner.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
@@ -10,14 +13,14 @@ import typing as t
 from ansible.module_utils.common.collections import is_sequence
 from ansible.module_utils.common.locale import get_best_parsable_locale
 
-from ansible_collections.community.general.plugins.module_utils import cmd_runner_fmt
+from ansible_collections.community.general.plugins.module_utils import _cmd_runner_fmt as cmd_runner_fmt
 
 if t.TYPE_CHECKING:
     from collections.abc import Callable, Mapping, Sequence
 
     from ansible.module_utils.basic import AnsibleModule
 
-    from ansible_collections.community.general.plugins.module_utils.cmd_runner_fmt import ArgFormatType
+    from ansible_collections.community.general.plugins.module_utils._cmd_runner_fmt import ArgFormatType
 
     ArgFormatter = t.Union[ArgFormatType, cmd_runner_fmt._ArgFormat]  # noqa: UP007
 

plugins/module_utils/_cmd_runner_fmt.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 typing as t

plugins/module_utils/_consul.py

@@ -2,6 +2,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
 
 import copy

plugins/module_utils/_crypt.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
 
 __all__ = ["CryptContext", "has_crypt_context"]

plugins/module_utils/_csv.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 csv

plugins/module_utils/_datetime.py

@@ -3,6 +3,9 @@
 # Simplified BSD License (see LICENSES/BSD-2-Clause.txt or https://opensource.org/licenses/BSD-2-Clause)
 # SPDX-License-Identifier: BSD-2-Clause
 
+# 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 datetime as _datetime

plugins/module_utils/_deps.py

@@ -3,6 +3,9 @@
 # Simplified BSD License (see LICENSES/BSD-2-Clause.txt or https://opensource.org/licenses/BSD-2-Clause)
 # SPDX-License-Identifier: BSD-2-Clause
 
+# 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

plugins/module_utils/_django.py

@@ -2,20 +2,23 @@
 # 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 typing as t
 
 from ansible.module_utils.common.dict_transformations import dict_merge
 
-from ansible_collections.community.general.plugins.module_utils import cmd_runner_fmt
-from ansible_collections.community.general.plugins.module_utils.module_helper import ModuleHelper
-from ansible_collections.community.general.plugins.module_utils.python_runner import PythonRunner
+from ansible_collections.community.general.plugins.module_utils import _cmd_runner_fmt as cmd_runner_fmt
+from ansible_collections.community.general.plugins.module_utils._module_helper import ModuleHelper
+from ansible_collections.community.general.plugins.module_utils._python_runner import PythonRunner
 
 if t.TYPE_CHECKING:
     from ansible.module_utils.basic import AnsibleModule
 
-    from ansible_collections.community.general.plugins.module_utils.cmd_runner import ArgFormatter
+    from ansible_collections.community.general.plugins.module_utils._cmd_runner import ArgFormatter
 
 
 django_std_args = dict(

plugins/module_utils/_filelock.py

@@ -2,6 +2,9 @@
 # Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
 # SPDX-License-Identifier: BSD-2-Clause
 
+# 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!
+
 # NOTE:
 # This has been vendored from ansible.module_utils.common.file. This code has been removed from there for ansible-core 2.16.
 

plugins/module_utils/_gandi_livedns_api.py

@@ -2,6 +2,9 @@
 # Simplified BSD License (see LICENSES/BSD-2-Clause.txt or https://opensource.org/licenses/BSD-2-Clause)
 # SPDX-License-Identifier: BSD-2-Clause
 
+# 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

plugins/module_utils/_gconftool2.py

@@ -2,11 +2,14 @@
 # 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 typing as t
 
-from ansible_collections.community.general.plugins.module_utils.cmd_runner import CmdRunner, cmd_runner_fmt
+from ansible_collections.community.general.plugins.module_utils._cmd_runner import CmdRunner, cmd_runner_fmt
 
 if t.TYPE_CHECKING:
     from ansible.module_utils.basic import AnsibleModule

plugins/module_utils/_gio_mime.py

@@ -2,11 +2,14 @@
 # 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 typing as t
 
-from ansible_collections.community.general.plugins.module_utils.cmd_runner import CmdRunner, cmd_runner_fmt
+from ansible_collections.community.general.plugins.module_utils._cmd_runner import CmdRunner, cmd_runner_fmt
 
 if t.TYPE_CHECKING:
     from ansible.module_utils.basic import AnsibleModule

plugins/module_utils/_gitlab.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 traceback
@@ -11,7 +14,7 @@ from urllib.parse import urljoin
 
 from ansible.module_utils.basic import missing_required_lib
 
-from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
+from ansible_collections.community.general.plugins.module_utils._version import LooseVersion
 
 if t.TYPE_CHECKING:
     from ansible.module_utils.basic import AnsibleModule

plugins/module_utils/_heroku.py

@@ -2,6 +2,9 @@
 # Simplified BSD License (see LICENSES/BSD-2-Clause.txt or https://opensource.org/licenses/BSD-2-Clause)
 # SPDX-License-Identifier: BSD-2-Clause
 
+# 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

plugins/module_utils/_homebrew.py

@@ -2,6 +2,9 @@
 # Simplified BSD License (see LICENSES/BSD-2-Clause.txt or https://opensource.org/licenses/BSD-2-Clause)
 # SPDX-License-Identifier: BSD-2-Clause
 
+# 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

plugins/module_utils/_hwc_utils.py

@@ -2,6 +2,9 @@
 # Simplified BSD License (see LICENSES/BSD-2-Clause.txt or https://opensource.org/licenses/BSD-2-Clause)
 # SPDX-License-Identifier: BSD-2-Clause
 
+# 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

plugins/module_utils/_ibm_sa_utils.py

@@ -4,6 +4,9 @@
 # Simplified BSD License (see LICENSES/BSD-2-Clause.txt or https://opensource.org/licenses/BSD-2-Clause)
 # SPDX-License-Identifier: BSD-2-Clause
 
+# 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

plugins/module_utils/_identity/keycloak/keycloak.py

@@ -2,6 +2,9 @@
 # BSD 2-Clause license (see LICENSES/BSD-2-Clause.txt)
 # SPDX-License-Identifier: BSD-2-Clause
 
+# 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 copy

plugins/module_utils/_identity/keycloak/keycloak_clientsecret.py

@@ -3,13 +3,16 @@
 # 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
 
 import typing as t
 
 from ansible.module_utils.basic import AnsibleModule
 
-from ansible_collections.community.general.plugins.module_utils.identity.keycloak.keycloak import (
+from ansible_collections.community.general.plugins.module_utils._identity.keycloak.keycloak import (
     KeycloakAPI,
     keycloak_argument_spec,
 )

plugins/module_utils/_ilo_redfish_utils.py

@@ -2,12 +2,15 @@
 # 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 time
 import typing as t
 
-from ansible_collections.community.general.plugins.module_utils.redfish_utils import RedfishUtils
+from ansible_collections.community.general.plugins.module_utils._redfish_utils import RedfishUtils
 
 
 class iLORedfishUtils(RedfishUtils):

plugins/module_utils/_influxdb.py

@@ -2,6 +2,9 @@
 # Simplified BSD License (see LICENSES/BSD-2-Clause.txt or https://opensource.org/licenses/BSD-2-Clause)
 # SPDX-License-Identifier: BSD-2-Clause
 
+# 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
@@ -9,7 +12,7 @@ import typing as t
 
 from ansible.module_utils.basic import missing_required_lib
 
-from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
+from ansible_collections.community.general.plugins.module_utils._version import LooseVersion
 
 if t.TYPE_CHECKING:
     from ansible.module_utils.basic import AnsibleModule

plugins/module_utils/_ipa.py

@@ -9,6 +9,9 @@
 # Simplified BSD License (see LICENSES/BSD-2-Clause.txt or https://opensource.org/licenses/BSD-2-Clause)
 # SPDX-License-Identifier: BSD-2-Clause
 
+# 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

plugins/module_utils/_jenkins.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 os

plugins/module_utils/_ldap.py

@@ -5,6 +5,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

plugins/module_utils/_linode.py

@@ -9,6 +9,9 @@
 # Simplified BSD License (see LICENSES/BSD-2-Clause.txt or https://opensource.org/licenses/BSD-2-Clause)
 # SPDX-License-Identifier: BSD-2-Clause
 
+# 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.ansible_release import __version__ as ansible_version