From f3cee56bca6a320b82e431858027769ea98c6a60 Mon Sep 17 00:00:00 2001 From: jo Date: Mon, 5 Jan 2026 21:01:23 +0100 Subject: [PATCH] chore: add note about private modules --- plugins/module_utils/_base.py | 4 ++-- plugins/module_utils/_client.py | 3 +++ plugins/module_utils/_deprecation.py | 3 +++ plugins/module_utils/_experimental.py | 3 +++ plugins/module_utils/_floating_ip.py | 3 +++ plugins/module_utils/_ipaddress.py | 3 +++ plugins/module_utils/_primary_ip.py | 3 +++ plugins/module_utils/_ssh.py | 3 +++ plugins/module_utils/_storage_box.py | 3 +++ plugins/module_utils/_storage_box_snapshot.py | 3 +++ plugins/module_utils/_storage_box_subaccount.py | 3 +++ plugins/module_utils/_vendor/__init__.py | 2 ++ plugins/module_utils/_version.py | 3 +++ 13 files changed, 37 insertions(+), 2 deletions(-) diff --git a/plugins/module_utils/_base.py b/plugins/module_utils/_base.py index 70d1cb0..1d40e05 100644 --- a/plugins/module_utils/_base.py +++ b/plugins/module_utils/_base.py @@ -1,7 +1,7 @@ # Copyright: (c) 2019, Hetzner Cloud GmbH -# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/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 diff --git a/plugins/module_utils/_client.py b/plugins/module_utils/_client.py index b9f931f..4b93511 100644 --- a/plugins/module_utils/_client.py +++ b/plugins/module_utils/_client.py @@ -1,5 +1,8 @@ # Copyright: (c) 2023, Hetzner Cloud GmbH +# 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 contextlib import contextmanager diff --git a/plugins/module_utils/_deprecation.py b/plugins/module_utils/_deprecation.py index 5dc461a..e3a42a3 100644 --- a/plugins/module_utils/_deprecation.py +++ b/plugins/module_utils/_deprecation.py @@ -1,3 +1,6 @@ +# 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 warnings diff --git a/plugins/module_utils/_experimental.py b/plugins/module_utils/_experimental.py index a0ea1a9..43b3d92 100644 --- a/plugins/module_utils/_experimental.py +++ b/plugins/module_utils/_experimental.py @@ -1,5 +1,8 @@ # Copyright: (c) 2025, Hetzner Cloud GmbH +# 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 ._base import AnsibleModule diff --git a/plugins/module_utils/_floating_ip.py b/plugins/module_utils/_floating_ip.py index 281d915..db23da4 100644 --- a/plugins/module_utils/_floating_ip.py +++ b/plugins/module_utils/_floating_ip.py @@ -1,3 +1,6 @@ +# 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 ._vendor.hcloud.floating_ips import ( diff --git a/plugins/module_utils/_ipaddress.py b/plugins/module_utils/_ipaddress.py index 30c3bd6..9722667 100644 --- a/plugins/module_utils/_ipaddress.py +++ b/plugins/module_utils/_ipaddress.py @@ -1,3 +1,6 @@ +# 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 ipaddress import ip_interface diff --git a/plugins/module_utils/_primary_ip.py b/plugins/module_utils/_primary_ip.py index 1713920..9f75748 100644 --- a/plugins/module_utils/_primary_ip.py +++ b/plugins/module_utils/_primary_ip.py @@ -1,3 +1,6 @@ +# 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 ._vendor.hcloud.primary_ips import ( diff --git a/plugins/module_utils/_ssh.py b/plugins/module_utils/_ssh.py index c52d1eb..6297407 100644 --- a/plugins/module_utils/_ssh.py +++ b/plugins/module_utils/_ssh.py @@ -1,3 +1,6 @@ +# 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 base64 import b64decode diff --git a/plugins/module_utils/_storage_box.py b/plugins/module_utils/_storage_box.py index eaed4e8..d7874c4 100644 --- a/plugins/module_utils/_storage_box.py +++ b/plugins/module_utils/_storage_box.py @@ -1,3 +1,6 @@ +# 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 ._client import client_resource_not_found diff --git a/plugins/module_utils/_storage_box_snapshot.py b/plugins/module_utils/_storage_box_snapshot.py index a76c136..225404b 100644 --- a/plugins/module_utils/_storage_box_snapshot.py +++ b/plugins/module_utils/_storage_box_snapshot.py @@ -1,3 +1,6 @@ +# 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 ._vendor.hcloud.storage_boxes import ( diff --git a/plugins/module_utils/_storage_box_subaccount.py b/plugins/module_utils/_storage_box_subaccount.py index 0d1cfcb..cec0d3f 100644 --- a/plugins/module_utils/_storage_box_subaccount.py +++ b/plugins/module_utils/_storage_box_subaccount.py @@ -1,3 +1,6 @@ +# 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 ._vendor.hcloud.storage_boxes import ( diff --git a/plugins/module_utils/_vendor/__init__.py b/plugins/module_utils/_vendor/__init__.py index e69de29..824c33b 100644 --- a/plugins/module_utils/_vendor/__init__.py +++ b/plugins/module_utils/_vendor/__init__.py @@ -0,0 +1,2 @@ +# 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! diff --git a/plugins/module_utils/_version.py b/plugins/module_utils/_version.py index 3612671..69e8216 100644 --- a/plugins/module_utils/_version.py +++ b/plugins/module_utils/_version.py @@ -1,3 +1,6 @@ +# 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 version = "6.4.0" # x-release-please-version