ansible-core 2.18.7rc1__py3-none-any.whl → 2.19.0__py3-none-any.whl

ansible/module_utils/datatag.py

@@ -0,0 +1,49 @@
+"""Public API for data tagging."""
+from __future__ import annotations as _annotations
+
+import typing as _t
+
+from ._internal import _datatag, _deprecator, _traceback, _messages
+from ._internal._datatag import _tags
+
+_T = _t.TypeVar('_T')
+
+
+deprecator_from_collection_name = _deprecator.deprecator_from_collection_name
+
+
+def deprecate_value(
+    value: _T,
+    msg: str,
+    *,
+    version: str | None = None,
+    date: str | None = None,
+    collection_name: str | None = None,
+    deprecator: _messages.PluginInfo | None = None,
+    help_text: str | None = None,
+) -> _T:
+    """
+    Return `value` tagged with the given deprecation details.
+    The types `None` and `bool` cannot be deprecated and are returned unmodified.
+    Raises a `TypeError` if `value` is not a supported type.
+    Most callers do not need to provide `collection_name` or `deprecator` -- but provide only one if needed.
+    Specify `version` or `date`, but not both.
+    If `date` is provided, it should be in the form `YYYY-MM-DD`.
+    """
+    _skip_stackwalk = True
+
+    deprecated = _tags.Deprecated(
+        msg=msg,
+        help_text=help_text,
+        date=date,
+        version=version,
+        deprecator=_deprecator.get_best_deprecator(deprecator=deprecator, collection_name=collection_name),
+        formatted_traceback=_traceback.maybe_capture_traceback(msg, _traceback.TracebackEvent.DEPRECATED_VALUE),
+    )
+
+    return deprecated.tag(value)
+
+
+def native_type_name(value: object | type, /) -> str:
+    """Return the type name of `value`, substituting the native Python type name for internal tagged types."""
+    return _datatag.AnsibleTagHelper.base_type(value).__name__

ansible/module_utils/distro/__init__.py

@@ -16,9 +16,9 @@
 # along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
 
 
-'''
+"""
 Compat distro library.
-'''
+"""
 from __future__ import annotations
 
 # The following makes it easier for us to script updates of the bundled code

ansible/module_utils/facts/ansible_collector.py

@@ -30,8 +30,7 @@ from __future__ import annotations
 
 import fnmatch
 import sys
-
-import ansible.module_utils.compat.typing as t
+import typing as t
 
 from ansible.module_utils.facts import timeout
 from ansible.module_utils.facts import collector
@@ -39,13 +38,13 @@ from ansible.module_utils.common.collections import is_string
 
 
 class AnsibleFactCollector(collector.BaseFactCollector):
-    '''A FactCollector that returns results under 'ansible_facts' top level key.
+    """A FactCollector that returns results under 'ansible_facts' top level key.
 
        If a namespace if provided, facts will be collected under that namespace.
        For ex, a ansible.module_utils.facts.namespace.PrefixFactNamespace(prefix='ansible_')
 
        Has a 'from_gather_subset() constructor that populates collectors based on a
-       gather_subset specifier.'''
+       gather_subset specifier."""
 
     def __init__(self, collectors=None, namespace=None, filter_spec=None):
 
@@ -102,7 +101,7 @@ class AnsibleFactCollector(collector.BaseFactCollector):
 
 
 class CollectorMetaDataCollector(collector.BaseFactCollector):
-    '''Collector that provides a facts with the gather_subset metadata.'''
+    """Collector that provides a facts with the gather_subset metadata."""
 
     name = 'gather_subset'
     _fact_ids = set()  # type: t.Set[str]

ansible/module_utils/facts/collector.py

@@ -31,20 +31,19 @@ from __future__ import annotations
 from collections import defaultdict
 
 import platform
-
-import ansible.module_utils.compat.typing as t
+import typing as t
 
 from ansible.module_utils.facts import timeout
 
 
 class CycleFoundInFactDeps(Exception):
-    '''Indicates there is a cycle in fact collector deps
+    """Indicates there is a cycle in fact collector deps
 
     If collector-B requires collector-A, and collector-A requires
     collector-B, that is a cycle. In that case, there is no ordering
     that will satisfy B before A and A and before B. That will cause this
     error to be raised.
-    '''
+    """
     pass
 
 
@@ -64,9 +63,9 @@ class BaseFactCollector:
     required_facts = set()  # type: t.Set[str]
 
     def __init__(self, collectors=None, namespace=None):
-        '''Base class for things that collect facts.
+        """Base class for things that collect facts.
 
-        'collectors' is an optional list of other FactCollectors for composing.'''
+        'collectors' is an optional list of other FactCollectors for composing."""
         self.collectors = collectors or []
 
         # self.namespace is a object with a 'transform' method that transforms
@@ -88,7 +87,7 @@ class BaseFactCollector:
         return key_name
 
     def _transform_dict_keys(self, fact_dict):
-        '''update a dicts keys to use new names as transformed by self._transform_name'''
+        """update a dicts keys to use new names as transformed by self._transform_name"""
 
         if fact_dict is None:
             return {}
@@ -107,7 +106,7 @@ class BaseFactCollector:
         return facts_dict
 
     def collect(self, module=None, collected_facts=None):
-        '''do the fact collection
+        """do the fact collection
 
         'collected_facts' is a object (a dict, likely) that holds all previously
           facts. This is intended to be used if a FactCollector needs to reference
@@ -115,7 +114,7 @@ class BaseFactCollector:
 
           Returns a dict of facts.
 
-          '''
+          """
         facts_dict = {}
         return facts_dict
 
@@ -125,12 +124,12 @@ def get_collector_names(valid_subsets=None,
                         gather_subset=None,
                         aliases_map=None,
                         platform_info=None):
-    '''return a set of FactCollector names based on gather_subset spec.
+    """return a set of FactCollector names based on gather_subset spec.
 
     gather_subset is a spec describing which facts to gather.
     valid_subsets is a frozenset of potential matches for gather_subset ('all', 'network') etc
     minimal_gather_subsets is a frozenset of matches to always use, even for gather_subset='!all'
-    '''
+    """
 
     # Retrieve module parameters
     gather_subset = gather_subset or ['all']
@@ -267,11 +266,11 @@ def _get_requires_by_collector_name(collector_name, all_fact_subsets):
 
 
 def find_unresolved_requires(collector_names, all_fact_subsets):
-    '''Find any collector names that have unresolved requires
+    """Find any collector names that have unresolved requires
 
     Returns a list of collector names that correspond to collector
     classes whose .requires_facts() are not in collector_names.
-    '''
+    """
     unresolved = set()
 
     for collector_name in collector_names:
@@ -351,7 +350,7 @@ def collector_classes_from_gather_subset(all_collector_classes=None,
                                          gather_subset=None,
                                          gather_timeout=None,
                                          platform_info=None):
-    '''return a list of collector classes that match the args'''
+    """return a list of collector classes that match the args"""
 
     # use gather_name etc to get the list of collectors
 

ansible/module_utils/facts/compat.py

@@ -34,19 +34,19 @@ from ansible.module_utils.facts import ansible_collector
 
 
 def get_all_facts(module):
-    '''compat api for ansible 2.2/2.3 module_utils.facts.get_all_facts method
+    """compat api for ansible 2.2/2.3 module_utils.facts.get_all_facts method
 
     Expects module to be an instance of AnsibleModule, with a 'gather_subset' param.
 
     returns a dict mapping the bare fact name ('default_ipv4' with no 'ansible_' namespace) to
-    the fact value.'''
+    the fact value."""
 
     gather_subset = module.params['gather_subset']
     return ansible_facts(module, gather_subset=gather_subset)
 
 
 def ansible_facts(module, gather_subset=None):
-    '''Compat api for ansible 2.0/2.2/2.3 module_utils.facts.ansible_facts method
+    """Compat api for ansible 2.0/2.2/2.3 module_utils.facts.ansible_facts method
 
     2.3/2.3 expects a gather_subset arg.
     2.0/2.1 does not except a gather_subset arg
@@ -57,7 +57,7 @@ def ansible_facts(module, gather_subset=None):
 
     returns a dict mapping the bare fact name ('default_ipv4' with no 'ansible_' namespace) to
     the fact value.
-    '''
+    """
 
     gather_subset = gather_subset or module.params.get('gather_subset', ['all'])
     gather_timeout = module.params.get('gather_timeout', 10)

ansible/module_utils/facts/default_collectors.py

@@ -27,7 +27,7 @@
 #
 from __future__ import annotations
 
-import ansible.module_utils.compat.typing as t
+import typing as t
 
 from ansible.module_utils.facts.collector import BaseFactCollector
 

ansible/module_utils/facts/hardware/aix.py

@@ -45,6 +45,7 @@ class AIXHardware(Hardware):
         vgs_facts = self.get_vgs_facts()
         mount_facts = self.get_mount_facts()
         devices_facts = self.get_device_facts()
+        uptime_facts = self.get_uptime_facts()
 
         hardware_facts.update(cpu_facts)
         hardware_facts.update(memory_facts)
@@ -52,6 +53,7 @@ class AIXHardware(Hardware):
         hardware_facts.update(vgs_facts)
         hardware_facts.update(mount_facts)
         hardware_facts.update(devices_facts)
+        hardware_facts.update(uptime_facts)
 
         return hardware_facts
 
@@ -123,6 +125,38 @@ class AIXHardware(Hardware):
 
         return memory_facts
 
+    def get_uptime_facts(self):
+        uptime_facts = {}
+        # On AIX, there are no options to get the uptime directly in seconds.
+        # Your options are to parse the output of "who", "uptime", or "ps".
+        # Only "ps" always provides a field with seconds.
+        ps_bin = self.module.get_bin_path("ps")
+        if ps_bin is None:
+            return uptime_facts
+
+        ps_cmd = [ps_bin, "-p", "1", "-o", "etime="]
+
+        rc, out, err = self.module.run_command(ps_cmd)
+        if rc != 0:
+            return uptime_facts
+
+        # Parse out
+        if out:
+            lines = out.splitlines()
+            data = lines[0].replace(':', '-').split('-')
+            try:
+                days = int(data[0])
+                hours = int(data[1])
+                minutes = int(data[2])
+                seconds = int(data[3])
+            except (IndexError, ValueError):
+                return uptime_facts
+            # Calculate uptime in seconds
+            uptime_seconds = (days * 86400) + (hours * 3600) + (minutes * 60) + seconds
+            uptime_facts['uptime_seconds'] = int(uptime_seconds)
+
+        return uptime_facts
+
     def get_dmi_facts(self):
         dmi_facts = {}
 

ansible/module_utils/facts/hardware/base.py

@@ -28,7 +28,7 @@
 
 from __future__ import annotations
 
-import ansible.module_utils.compat.typing as t
+import typing as t
 
 from ansible.module_utils.facts.collector import BaseFactCollector
 
@@ -49,7 +49,7 @@ class HardwareCollector(BaseFactCollector):
     _fact_ids = set(['processor',
                      'processor_cores',
                      'processor_count',
-                     # TODO: mounts isnt exactly hardware
+                     # TODO: mounts isn't exactly hardware
                      'mounts',
                      'devices'])  # type: t.Set[str]
     _fact_class = Hardware

ansible/module_utils/facts/hardware/darwin.py

@@ -93,9 +93,7 @@ class DarwinHardware(Hardware):
         }
 
         total_used = 0
-        page_size = 4096
-        if 'hw.pagesize' in self.sysctl:
-            page_size = int(self.sysctl['hw.pagesize'])
+        page_size = int(self.sysctl.get('hw.pagesize', 4096))
 
         vm_stat_command = self.module.get_bin_path('vm_stat')
         if vm_stat_command is None:

ansible/module_utils/facts/hardware/freebsd.py

@@ -224,9 +224,9 @@ class FreeBSDHardware(Hardware):
         return device_facts
 
     def get_dmi_facts(self):
-        ''' learn dmi facts from system
+        """ learn dmi facts from system
 
-        Use dmidecode executable if available'''
+        Use dmidecode executable if available"""
 
         dmi_facts = {}
 

ansible/module_utils/facts/hardware/linux.py

@@ -182,7 +182,7 @@ class LinuxHardware(Hardware):
                         xen = True
                     # Only interested in the first line
                     break
-        except IOError:
+        except OSError:
             pass
 
         if not os.access("/proc/cpuinfo", os.R_OK):
@@ -311,10 +311,10 @@ class LinuxHardware(Hardware):
         return cpu_facts
 
     def get_dmi_facts(self):
-        ''' learn dmi facts from system
+        """ learn dmi facts from system
 
         Try /sys first for dmi related facts.
-        If that is not available, fall back to dmidecode executable '''
+        If that is not available, fall back to dmidecode executable """
 
         dmi_facts = {}
 
@@ -423,13 +423,13 @@ class LinuxHardware(Hardware):
             'NA'
         )
         sysinfo_re = re.compile(
-            r'''
+            r"""
                 ^
                     (?:Manufacturer:\s+(?P<system_vendor>.+))|
                     (?:Type:\s+(?P<product_name>.+))|
                     (?:Sequence\ Code:\s+0+(?P<product_serial>.+))
                 $
-            ''',
+            """,
             re.VERBOSE | re.MULTILINE
         )
         data = get_file_content('/proc/sysinfo')

ansible/module_utils/facts/namespace.py

@@ -33,7 +33,7 @@ class FactNamespace:
         self.namespace_name = namespace_name
 
     def transform(self, name):
-        '''Take a text name, and transforms it as needed (add a namespace prefix, etc)'''
+        """Take a text name, and transforms it as needed (add a namespace prefix, etc)"""
         return name
 
     def _underscore(self, name):

ansible/module_utils/facts/network/base.py

@@ -15,7 +15,7 @@
 
 from __future__ import annotations
 
-import ansible.module_utils.compat.typing as t
+import typing as t
 
 from ansible.module_utils.facts.collector import BaseFactCollector
 

ansible/module_utils/facts/network/fc_wwn.py

@@ -19,8 +19,7 @@ from __future__ import annotations
 
 import sys
 import glob
-
-import ansible.module_utils.compat.typing as t
+import typing as t
 
 from ansible.module_utils.facts.utils import get_file_lines
 from ansible.module_utils.facts.collector import BaseFactCollector

ansible/module_utils/facts/network/iscsi.py

@@ -18,8 +18,7 @@
 from __future__ import annotations
 
 import sys
-
-import ansible.module_utils.compat.typing as t
+import typing as t
 
 from ansible.module_utils.facts.utils import get_file_content
 from ansible.module_utils.facts.network.base import NetworkCollector

ansible/module_utils/facts/network/nvme.py

@@ -18,8 +18,7 @@
 from __future__ import annotations
 
 import sys
-
-import ansible.module_utils.compat.typing as t
+import typing as t
 
 from ansible.module_utils.facts.utils import get_file_content
 from ansible.module_utils.facts.network.base import NetworkCollector

ansible/module_utils/facts/other/facter.py

@@ -4,8 +4,7 @@
 from __future__ import annotations
 
 import json
-
-import ansible.module_utils.compat.typing as t
+import typing as t
 
 from ansible.module_utils.facts.namespace import PrefixFactNamespace
 from ansible.module_utils.facts.collector import BaseFactCollector
@@ -62,7 +61,7 @@ class FacterFactCollector(BaseFactCollector):
         return out
 
     def collect(self, module=None, collected_facts=None):
-        # Note that this mirrors previous facter behavior, where there isnt
+        # Note that this mirrors previous facter behavior, where there isn't
         # a 'ansible_facter' key in the main fact dict, but instead, 'facter_whatever'
         # items are added to the main dict.
         facter_dict = {}

ansible/module_utils/facts/other/ohai.py

@@ -16,8 +16,7 @@
 from __future__ import annotations
 
 import json
-
-import ansible.module_utils.compat.typing as t
+import typing as t
 
 from ansible.module_utils.facts.namespace import PrefixFactNamespace
 
@@ -25,7 +24,7 @@ from ansible.module_utils.facts.collector import BaseFactCollector
 
 
 class OhaiFactCollector(BaseFactCollector):
-    '''This is a subclass of Facts for including information gathered from Ohai.'''
+    """This is a subclass of Facts for including information gathered from Ohai."""
     name = 'ohai'
     _fact_ids = set()  # type: t.Set[str]
 

ansible/module_utils/facts/sysctl.py

@@ -17,8 +17,6 @@ from __future__ import annotations
 
 import re
 
-from ansible.module_utils.common.text.converters import to_text
-
 
 def get_sysctl(module, prefixes):
 
@@ -31,8 +29,8 @@ def get_sysctl(module, prefixes):
 
         try:
             rc, out, err = module.run_command(cmd)
-        except (IOError, OSError) as e:
-            module.warn('Unable to read sysctl: %s' % to_text(e))
+        except OSError as ex:
+            module.error_as_warning('Unable to read sysctl.', exception=ex)
             rc = 1
 
         if rc == 0:
@@ -54,8 +52,8 @@ def get_sysctl(module, prefixes):
 
                 try:
                     (key, value) = re.split(r'\s?=\s?|: ', line, maxsplit=1)
-                except Exception as e:
-                    module.warn('Unable to split sysctl line (%s): %s' % (to_text(line), to_text(e)))
+                except Exception as ex:
+                    module.error_as_warning(f'Unable to split sysctl line {line!r}.', exception=ex)
 
             if key:
                 sysctl[key] = value.strip()

ansible/module_utils/facts/system/apparmor.py

@@ -18,8 +18,7 @@
 from __future__ import annotations
 
 import os
-
-import ansible.module_utils.compat.typing as t
+import typing as t
 
 from ansible.module_utils.facts.collector import BaseFactCollector
 

ansible/module_utils/facts/system/caps.py

@@ -17,7 +17,7 @@
 
 from __future__ import annotations
 
-import ansible.module_utils.compat.typing as t
+import typing as t
 
 from ansible.module_utils.facts.collector import BaseFactCollector
 
@@ -38,8 +38,8 @@ class SystemCapabilitiesFactCollector(BaseFactCollector):
                 # NOTE: -> get_caps_data()/parse_caps_data() for easier mocking -akl
                 try:
                     rc, out, err = module.run_command([capsh_path, "--print"], errors='surrogate_then_replace', handle_exceptions=False)
-                except (IOError, OSError) as e:
-                    module.warn('Could not query system capabilities: %s' % str(e))
+                except OSError as ex:
+                    module.error_as_warning('Could not query system capabilities.', exception=ex)
 
             if rc == 0:
                 enforced_caps = []

ansible/module_utils/facts/system/chroot.py

@@ -3,8 +3,7 @@
 from __future__ import annotations
 
 import os
-
-import ansible.module_utils.compat.typing as t
+import typing as t
 
 from ansible.module_utils.facts.collector import BaseFactCollector
 

ansible/module_utils/facts/system/cmdline.py

@@ -16,8 +16,7 @@
 from __future__ import annotations
 
 import shlex
-
-import ansible.module_utils.compat.typing as t
+import typing as t
 
 from ansible.module_utils.facts.utils import get_file_content
 

ansible/module_utils/facts/system/date_time.py

@@ -19,10 +19,9 @@ from __future__ import annotations
 
 import datetime
 import time
+import typing as t
 
-import ansible.module_utils.compat.typing as t
 from ansible.module_utils.facts.collector import BaseFactCollector
-from ansible.module_utils.compat.datetime import utcfromtimestamp
 
 
 class DateTimeFactCollector(BaseFactCollector):
@@ -36,7 +35,10 @@ class DateTimeFactCollector(BaseFactCollector):
         # Store the timestamp once, then get local and UTC versions from that
         epoch_ts = time.time()
         now = datetime.datetime.fromtimestamp(epoch_ts)
-        utcnow = utcfromtimestamp(epoch_ts).replace(tzinfo=None)
+        utcnow = datetime.datetime.fromtimestamp(
+            epoch_ts,
+            tz=datetime.timezone.utc,
+        )
 
         date_time_facts['year'] = now.strftime('%Y')
         date_time_facts['month'] = now.strftime('%m')