feat: Add version to deprecated function (#3491)

* Add the ability to pass a version to the deprecated function to print that it will be removed after that version. Signed-off-by: Ryan Blakley <[email protected]>
RedHatInsights · Aug 9, 2022 · 05459e0 · 05459e0
1 parent 77f0196
commit 05459e0
Show file tree

Hide file tree

Showing 31 changed files with 78 additions and 43 deletions.
diff --git a/insights/combiners/hostname.py b/insights/combiners/hostname.py
@@ -82,7 +82,7 @@ def hostname(hf, hd, hs, sid):
     Raises:
         Exception: If no hostname can be found in any of the source parsers.
     """
-    deprecated(hostname, "Use the `Hostname` class instead.")
+    deprecated(hostname, "Use the `Hostname` class instead.", "3.0.300")
     return Hostname(hf, hd, hs, sid)
 
 

diff --git a/insights/combiners/modinfo.py b/insights/combiners/modinfo.py
@@ -67,7 +67,8 @@ class ModInfo(dict):
     def __init__(self, mi_all, mi_each):
         deprecated(
             ModInfo,
-            'Please use the :class:`insights.parsers.modinfo.KernelModulesInfo` instead.'
+            "Please use the :class:`insights.parsers.modinfo.KernelModulesInfo` instead.",
+            "3.1.25"
         )
         self.retpoline_y = set()
         self.retpoline_n = set()

diff --git a/insights/combiners/package_provides_httpd.py b/insights/combiners/package_provides_httpd.py
@@ -47,7 +47,8 @@ class PackageProvidesHttpdAll(LegacyItemAccess):
     def __init__(self, package_provides_httpd):
         deprecated(
             PackageProvidesHttpdAll,
-            'Please use the :class:`insights.parsers.package_provides.PackageProvidesCommand` instead.'
+            "Please use the :class:`insights.parsers.package_provides.PackageProvidesCommand` instead.",
+            "3.0.300"
         )
         self.data = {}
         for pkg in package_provides_httpd:

diff --git a/insights/combiners/package_provides_java.py b/insights/combiners/package_provides_java.py
@@ -53,7 +53,8 @@ class PackageProvidesJavaAll(LegacyItemAccess):
     def __init__(self, package_provides_java):
         deprecated(
             PackageProvidesJavaAll,
-            'Please use the :class:`insights.parsers.package_provides.PackageProvidesCommand` instead.'
+            "Please use the :class:`insights.parsers.package_provides.PackageProvidesCommand` instead.",
+            "3.0.300"
         )
         self.data = {}
         for pkg in package_provides_java:

diff --git a/insights/combiners/redhat_release.py b/insights/combiners/redhat_release.py
@@ -65,7 +65,7 @@ def redhat_release(rh_release, un):
 
     """
 
-    deprecated(redhat_release, "Use the `RedHatRelease` class instead.")
+    deprecated(redhat_release, "Use the `RedHatRelease` class instead.", "3.0.300")
 
     if un and un.release_tuple[0] != -1:
         return Release(*un.release_tuple)

diff --git a/insights/combiners/uptime.py b/insights/combiners/uptime.py
@@ -44,7 +44,7 @@ def uptime(ut):
     Raises:
         SkipComponent: If no data is available or if ``loadavg`` is not available.
     """
-    deprecated(uptime, "Use the `Uptime` parser instead.")
+    deprecated(uptime, "Use the `Uptime` parser instead.", "3.0.300")
 
     if ut.loadavg:
         return Uptime(ut.currtime, ut.updays, ut.uphhmm,

diff --git a/insights/core/__init__.py b/insights/core/__init__.py
@@ -1796,6 +1796,6 @@ class AttributeDict(dict):
     """
 
     def __init__(self, *args, **kwargs):
-        deprecated(AttributeDict, "Please set attributes explicitly.")
+        deprecated(AttributeDict, "Please set attributes explicitly.", "3.0.300")
         super(AttributeDict, self).__init__(*args, **kwargs)
         self.__dict__ = self
diff --git a/insights/parsers/aws_instance_type.py b/insights/parsers/aws_instance_type.py
@@ -44,7 +44,7 @@ class AWSInstanceType(CommandParser):
     """
 
     def __init__(self, *args, **kwargs):
-        deprecated(AWSInstanceType, "Use AWSInstanceIdDoc in insights.insights.aws_instance_id instead.")
+        deprecated(AWSInstanceType, "Use AWSInstanceIdDoc in insights.insights.aws_instance_id instead.", "3.0.300")
         super(AWSInstanceType, self).__init__(*args, **kwargs)
 
     def parse_content(self, content):

diff --git a/insights/parsers/corosync.py b/insights/parsers/corosync.py
@@ -56,7 +56,7 @@ class CoroSyncConfig(SysconfigOptions):
         ''
     """
     def __init__(self, *args, **kwargs):
-        deprecated(CoroSyncConfig, "Import CorosyncSysconfig from insights.parsers.sysconfig instead")
+        deprecated(CoroSyncConfig, "Import CorosyncSysconfig from insights.parsers.sysconfig instead.", "3.0.300")
         super(CoroSyncConfig, self).__init__(*args, **kwargs)
 
     @property

diff --git a/insights/parsers/dirsrv_sysconfig.py b/insights/parsers/dirsrv_sysconfig.py
@@ -42,7 +42,7 @@ class DirsrvSysconfig(SysconfigOptions):
     Parse the `dirsrv` service's start-up configuration.
     """
     def __init__(self, *args, **kwargs):
-        deprecated(DirsrvSysconfig, "Import DirsrvSysconfig from insights.parsers.sysconfig instead")
+        deprecated(DirsrvSysconfig, "Import DirsrvSysconfig from insights.parsers.sysconfig instead.", "3.0.300")
         super(DirsrvSysconfig, self).__init__(*args, **kwargs)
 
     set_properties = True
diff --git a/insights/parsers/docker_storage_setup.py b/insights/parsers/docker_storage_setup.py
@@ -44,5 +44,9 @@ class DockerStorageSetup(SysconfigOptions):
     A parser for accessing /etc/sysconfig/docker-storage-setup.
     """
     def __init__(self, *args, **kwargs):
-        deprecated(DockerStorageSetup, "Import DockerStorageSetupSysconfig from insights.parsers.sysconfig instead")
+        deprecated(
+            DockerStorageSetup,
+            "Import DockerStorageSetupSysconfig from insights.parsers.sysconfig instead.",
+            "3.0.300"
+        )
         super(DockerStorageSetup, self).__init__(*args, **kwargs)
diff --git a/insights/parsers/etc_udev_rules.py b/insights/parsers/etc_udev_rules.py
@@ -49,5 +49,5 @@ class UdevRules40Redhat(LogFileOutput):
         True
     """
     def __init__(self, *args, **kwargs):
-        deprecated(UdevRules40Redhat, "Import UdevRules40Redhat from insights.parsers.udev_rules instread.")
+        deprecated(UdevRules40Redhat, "Import UdevRules40Redhat from insights.parsers.udev_rules instread.", "3.0.300")
         super(UdevRules40Redhat, self).__init__(*args, **kwargs)
diff --git a/insights/parsers/foreman_tasks_config.py b/insights/parsers/foreman_tasks_config.py
@@ -57,7 +57,11 @@ class ForemanTasksConfig(Parser, LegacyItemAccess):
         False
     """
     def __init__(self, *args, **kwargs):
-        deprecated(ForemanTasksConfig, "Import ForemanTasksSysconfig from insights.parsers.sysconfig instead")
+        deprecated(
+            ForemanTasksConfig,
+            "Import ForemanTasksSysconfig from insights.parsers.sysconfig instead",
+            "3.0.300"
+        )
         super(ForemanTasksConfig, self).__init__(*args, **kwargs)
 
     def parse_content(self, content):

diff --git a/insights/parsers/ipcs_sem.py b/insights/parsers/ipcs_sem.py
@@ -55,7 +55,7 @@ class IpcsS(CommandParser):
         {'owner': 'postgres', 'perms': '600', 'nsems': '1', 'key': '0x00000000'}
     """
     def __init__(self, *args, **kwargs):
-        deprecated(IpcsS, "Import IpcsS from insights.parsers.ipcs instead")
+        deprecated(IpcsS, "Import IpcsS from insights.parsers.ipcs instead.", "3.0.300")
         super(IpcsS, self).__init__(*args, **kwargs)
 
     def parse_content(self, content):
@@ -132,7 +132,7 @@ class IpcsSI(CommandParser):
 
     """
     def __init__(self, *args, **kwargs):
-        deprecated(IpcsSI, "Import IpcsSI from insights.parsers.ipcs instead")
+        deprecated(IpcsSI, "Import IpcsSI from insights.parsers.ipcs instead.", "3.0.300")
         super(IpcsSI, self).__init__(*args, **kwargs)
 
     def parse_content(self, content):

diff --git a/insights/parsers/ksmstate.py b/insights/parsers/ksmstate.py
@@ -22,7 +22,7 @@ def is_running(context):
     Check if Kernel Samepage Merging is enabled. 'True' if KSM is
     on (i.e. ``/sys/kernel/mm/ksm/run`` is '1') or 'False' if not.
     """
-    deprecated(is_running, "Use the `KSMState` class instead.")
+    deprecated(is_running, "Use the `KSMState` class instead.", "3.0.300")
     ksminfo = {}
     ksminfo['running'] = (context.content[0].split()[0] == '1')
     return ksminfo

diff --git a/insights/parsers/lsvmbus.py b/insights/parsers/lsvmbus.py
@@ -66,7 +66,7 @@ class LsvmBus(CommandParser):
 
     """
     def __init__(self, *args, **kwargs):
-        deprecated(LsvmBus, "Use the SysVmBusDeviceInfo combiner instead")
+        deprecated(LsvmBus, "Use the SysVmBusDeviceInfo combiner instead.", "3.0.300")
         super(LsvmBus, self).__init__(*args, **kwargs)
 
     def parse_content(self, content):

diff --git a/insights/parsers/modinfo.py b/insights/parsers/modinfo.py
@@ -323,7 +323,8 @@ class ModInfoAll(KernelModulesInfo):
     def __init__(self, *args, **kwargs):
         deprecated(
             ModInfoAll,
-            'Please use the :class:`insights.combiners.modinfo.ModulesInfo` instead.'
+            "Please use the :class:`insights.combiners.modinfo.ModulesInfo` instead.",
+            "3.0.300"
         )
         super(ModInfoAll, self).__init__(*args, **kwargs)
 
@@ -383,7 +384,8 @@ class ModInfoEach(CommandParser, ModInfo):
     def __init__(self, *args, **kwargs):
         deprecated(
             ModInfoEach,
-            'Please use the :class:`insights.combiners.modinfo.ModulesInfo` instead.'
+            "Please use the :class:`insights.combiners.modinfo.ModulesInfo` instead.",
+            "3.0.300"
         )
         super(ModInfoEach, self).__init__(*args, **kwargs)
 
@@ -451,7 +453,8 @@ class ModInfoI40e(ModInfoEach):
     def __init__(self, *args, **kwargs):
         deprecated(
             ModInfoI40e,
-            'Please use the :class:`insights.combiners.modinfo.ModulesInfo` instead.'
+            "Please use the :class:`insights.combiners.modinfo.ModulesInfo` instead.",
+            "3.0.300"
         )
         super(ModInfoI40e, self).__init__(*args, **kwargs)
 
@@ -498,7 +501,8 @@ class ModInfoVmxnet3(ModInfoEach):
     def __init__(self, *args, **kwargs):
         deprecated(
             ModInfoVmxnet3,
-            'Please use the :class:`insights.combiners.modinfo.ModulesInfo` instead.'
+            "Please use the :class:`insights.combiners.modinfo.ModulesInfo` instead.",
+            "3.0.300"
         )
         super(ModInfoVmxnet3, self).__init__(*args, **kwargs)
 
@@ -546,7 +550,8 @@ class ModInfoIgb(ModInfoEach):
     def __init__(self, *args, **kwargs):
         deprecated(
             ModInfoIgb,
-            'Please use the :class:`insights.combiners.modinfo.ModulesInfo` instead.'
+            "Please use the :class:`insights.combiners.modinfo.ModulesInfo` instead.",
+            "3.0.300"
         )
         super(ModInfoIgb, self).__init__(*args, **kwargs)
 
@@ -594,7 +599,8 @@ class ModInfoIxgbe(ModInfoEach):
     def __init__(self, *args, **kwargs):
         deprecated(
             ModInfoIxgbe,
-            'Please use the :class:`insights.combiners.modinfo.ModulesInfo` instead.'
+            "Please use the :class:`insights.combiners.modinfo.ModulesInfo` instead.",
+            "3.0.300"
         )
         super(ModInfoIxgbe, self).__init__(*args, **kwargs)
 
@@ -634,6 +640,7 @@ class ModInfoVeth(ModInfoEach):
     def __init__(self, *args, **kwargs):
         deprecated(
             ModInfoVeth,
-            'Please use the :class:`insights.combiners.modinfo.ModulesInfo` instead.'
+            "Please use the :class:`insights.combiners.modinfo.ModulesInfo` instead.",
+            "3.0.300"
         )
         super(ModInfoVeth, self).__init__(*args, **kwargs)
diff --git a/insights/parsers/multipath_v4_ll.py b/insights/parsers/multipath_v4_ll.py
@@ -282,5 +282,5 @@ def get_multipath_v4_ll(context):
     .. warning::
         Deprecated parser, please use :class:`MultipathDevices` instead.
     """
-    deprecated(get_multipath_v4_ll, "Use the `MultipathDevices` class instead.")
+    deprecated(get_multipath_v4_ll, "Use the `MultipathDevices` class instead.", "3.0.300")
     return MultipathDevices(context).devices
diff --git a/insights/parsers/netconsole.py b/insights/parsers/netconsole.py
@@ -41,5 +41,5 @@ class NetConsole(SysconfigOptions, LegacyItemAccess):
     ``SysconfigOptions`` shared parser class.
     '''
     def __init__(self, *args, **kwargs):
-        deprecated(NetConsole, "Import NetconsoleSysconfig from insights.parsers.sysconfig instead")
+        deprecated(NetConsole, "Import NetconsoleSysconfig from insights.parsers.sysconfig instead.", "3.0.300")
         super(NetConsole, self).__init__(*args, **kwargs)
diff --git a/insights/parsers/nfs_exports.py b/insights/parsers/nfs_exports.py
@@ -160,7 +160,8 @@ def reconstitute(path, d):
         """
         deprecated(
             NFSExportsBase.reconstitute,
-            'Please use the `raw_lines` dictionary property of the parser instance'
+            "Please use the `raw_lines` dictionary property of the parser instance.",
+            "3.0.300"
         )
         return "  ".join([path] + ["%s(%s)" % (host, ",".join(options))
                          for host, options in d.items()])

diff --git a/insights/parsers/nginx_conf.py b/insights/parsers/nginx_conf.py
@@ -133,7 +133,7 @@ class NginxConf(Parser, LegacyItemAccess):
         '127.0.0.1:1025'
     """
     def __init__(self, *args, **kwargs):
-        deprecated(NginxConf, "Import NginxConfTree from insights.combiners.nginx_conf instead")
+        deprecated(NginxConf, "Import NginxConfTree from insights.combiners.nginx_conf instead.", "3.0.300")
         super(NginxConf, self).__init__(*args, **kwargs)
 
     def parse_content(self, content):

diff --git a/insights/parsers/package_provides_httpd.py b/insights/parsers/package_provides_httpd.py
@@ -48,7 +48,8 @@ class PackageProvidesHttpd(CommandParser):
     def parse_content(self, content):
         deprecated(
             PackageProvidesHttpd,
-            'Please use the :class:`insights.parsers.package_provides.PackageProvidesCommand` instead.'
+            "Please use the :class:`insights.parsers.package_provides.PackageProvidesCommand` instead.",
+            "3.0.300"
         )
         if len(content) == 0:
             raise SkipException("Error: ", 'there is not httpd application running')

diff --git a/insights/parsers/package_provides_java.py b/insights/parsers/package_provides_java.py
@@ -71,7 +71,8 @@ class PackageProvidesJava(CommandParser):
     def parse_content(self, content):
         deprecated(
             PackageProvidesJava,
-            'Please use the :class:`insights.parsers.package_provides.PackageProvidesCommand` instead.'
+            "Please use the :class:`insights.parsers.package_provides.PackageProvidesCommand` instead.",
+            "3.0.300"
         )
         if len(content) == 0:
             raise ParseException("Error: ", 'there is not java application running')

diff --git a/insights/parsers/pluginconf_d.py b/insights/parsers/pluginconf_d.py
@@ -44,7 +44,7 @@ class PluginConfD(LegacyItemAccess, Parser):
         #gpgcheck = 0
     """
     def parse_content(self, content):
-        deprecated(PluginConfD, "Deprecated. Use 'PluginConfDIni' instead.")
+        deprecated(PluginConfD, "Deprecated. Use 'PluginConfDIni' instead.", "3.0.300")
         plugin_dict = {}
         section_dict = {}
         key = None

diff --git a/insights/parsers/puppetserver_config.py b/insights/parsers/puppetserver_config.py
@@ -55,7 +55,11 @@ class PuppetserverConfig(Parser, LegacyItemAccess):
         False
     """
     def __init__(self, *args, **kwargs):
-        deprecated(PuppetserverConfig, "Import PuppetserverSysconfig from insights.parsers.sysconfig instead")
+        deprecated(
+            PuppetserverConfig,
+            "Import PuppetserverSysconfig from insights.parsers.sysconfig instead.",
+            "3.0.300"
+        )
         super(PuppetserverConfig, self).__init__(*args, **kwargs)
 
     def parse_content(self, content):

diff --git a/insights/parsers/satellite_postgresql_query.py b/insights/parsers/satellite_postgresql_query.py
@@ -235,7 +235,11 @@ class SatelliteKatelloEmptyURLRepositories(SatellitePostgreSQLQuery):
     columns = ['id', 'name']
 
     def __init__(self, *args, **kwargs):
-        deprecated(SatelliteKatelloEmptyURLRepositories, 'Please use the SatelliteQualifiedKatelloRepos parser in the current module.')
+        deprecated(
+            SatelliteKatelloEmptyURLRepositories,
+            "Please use the SatelliteQualifiedKatelloRepos parser in the current module.",
+            "3.1.25"
+        )
         super(SatelliteKatelloEmptyURLRepositories, self).__init__(*args, **kwargs)
 
 

diff --git a/insights/parsers/systemctl_show.py b/insights/parsers/systemctl_show.py
@@ -200,7 +200,7 @@ class SystemctlShow(CommandParser, dict):
     In CMD's output, empty properties are suppressed by default.
     """
     def __init__(self, *args, **kwargs):
-        deprecated(SystemctlShow, "Deprecated. Use 'SystemctlShowServiceAll' instead.")
+        deprecated(SystemctlShow, "Deprecated. Use 'SystemctlShowServiceAll' instead.", "3.0.300")
         super(SystemctlShow, self).__init__(*args, **kwargs)
 
     def parse_content(self, content):

diff --git a/insights/parsers/systemd/config.py b/insights/parsers/systemd/config.py
@@ -244,7 +244,7 @@ class MultiOrderedDict(dict):
     """
 
     def __init__(self, *args, **kwargs):
-        deprecated(MultiOrderedDict, "This class is deprecated")
+        deprecated(MultiOrderedDict, "This class is deprecated.", "3.0.300")
         super(MultiOrderedDict, self).__init__(*args, **kwargs)
 
     def __setitem__(self, key, value):

diff --git a/insights/parsers/up2date.py b/insights/parsers/up2date.py
@@ -22,7 +22,7 @@ class Up2Date(LegacyItemAccess, Parser):
         serverURL=https://rhnproxy.glb.tech.markit.partners/XMLRPC
     """
     def __init__(self, *args, **kwargs):
-        deprecated(Up2Date, "Import Up2DateSysconfig from insights.parsers.sysconfig instead")
+        deprecated(Up2Date, "Import Up2DateSysconfig from insights.parsers.sysconfig instead.", "3.0.300")
         super(Up2Date, self).__init__(*args, **kwargs)
 
     def parse_content(self, content):

diff --git a/insights/parsers/yum_list_installed.py b/insights/parsers/yum_list_installed.py
@@ -20,7 +20,7 @@ class YumInstalledRpm(InstalledRpm):
     with an additional ``.repo`` attribute.
     """
     def __init__(self, data):
-        deprecated(YumInstalledRpm, "Import YumListRpm from insights.parsers.yum_list instead")
+        deprecated(YumInstalledRpm, "Import YumListRpm from insights.parsers.yum_list instead.", "3.0.300")
         self.repo = None
         """str: yum / dnf repository name, if available."""
 
@@ -38,7 +38,7 @@ class YumListInstalled(CommandParser, RpmList):
     """
 
     def __init__(self, context):
-        deprecated(YumListInstalled, "Import YumListBase from insights.parsers.yum_list instead")
+        deprecated(YumListInstalled, "Import YumListBase from insights.parsers.yum_list instead.", "3.0.300")
         self.expired_cache = False
         """bool: Indicates if the yum repo cache is expired."""
 

diff --git a/insights/util/__init__.py b/insights/util/__init__.py
@@ -143,7 +143,7 @@ def check_log_level(*args, **kwargs):
     return _f
 
 
-def deprecated(func, solution):
+def deprecated(func, solution, version=None):
     """
     Mark a parser or combiner as deprecated, and give a message of how to fix
     this.  This will emit a warning in the logs when the function is used.
@@ -156,8 +156,9 @@ def deprecated(func, solution):
             function that replaces the thing being deprecated.  For example,
             "use the `fnord()` function" or "use the `search()` method with
             the parameter `name='(value)'`".
+        version (str): The last version of insights-core that the function
+            will be available before it is removed.
     """
-
     def get_name_line(src):
         for line in src:
             if "@" not in line:
@@ -166,9 +167,14 @@ def get_name_line(src):
     path = inspect.getsourcefile(func)
     src, line_no = inspect.getsourcelines(func)
     name = get_name_line(src) or "Unknown"
-    the_msg = "<{c}> at {p}:{l} is deprecated: {s}".format(
-        c=name, p=path, l=line_no, s=solution
-    )
+    if version:
+        the_msg = "<{c}> at {p}:{l} is deprecated: {s} This function will be removed after version: {v}.".format(
+            c=name, p=path, l=line_no, s=solution, v=version
+        )
+    else:
+        the_msg = "<{c}> at {p}:{l} is deprecated: {s}".format(
+            c=name, p=path, l=line_no, s=solution
+        )
 
     warnings.warn(the_msg, DeprecationWarning)