Merge pull request #28348 from jfindlay/alias

salt.utils.alias informs user they are using a renamed function

salt/modules/aptpkg.py

@@ -298,7 +298,7 @@ def latest_version(*names, **kwargs):
     return ret
 
 # available_version is being deprecated
-available_version = latest_version
+available_version = salt.utils.alias_function(latest_version, 'available_version')
 
 
 def version(*names, **kwargs):

salt/modules/brew.py

@@ -164,7 +164,7 @@ def latest_version(*names, **kwargs):
         return ret
 
 # available_version is being deprecated
-available_version = latest_version
+available_version = salt.utils.alias_function(latest_version, 'available_version')
 
 
 def remove(name=None, pkgs=None, **kwargs):

salt/modules/cron.py

@@ -316,7 +316,7 @@ def list_tab(user):
     return ret
 
 # For consistency's sake
-ls = list_tab  # pylint: disable=C0103
+ls = salt.utils.alias_function(list_tab, 'ls')
 
 
 def set_special(user, special, cmd):
@@ -526,7 +526,7 @@ def rm_job(user,
         return comdat['stderr']
     return ret
 
-rm = rm_job  # pylint: disable=C0103
+rm = salt.utils.alias_function(rm_job, 'rm')
 
 
 def set_env(user, name, value=None):

salt/modules/dockerng.py

@@ -3013,7 +3013,7 @@ def copy_from(name, source, dest, overwrite=False, makedirs=False):
 
 
 # Docker cp gets a file from the container, alias this to copy_from
-cp = copy_from
+cp = salt.utils.alias_function(copy_from, 'cp')
 
 
 @_ensure_exists
@@ -4297,7 +4297,7 @@ def pause(name):
                             .format(name))}
     return _change_state(name, 'pause', 'paused')
 
-freeze = pause
+freeze = salt.utils.alias_function(pause, 'freeze')
 
 
 @_ensure_exists
@@ -4492,7 +4492,7 @@ def unpause(name):
                             .format(name))}
     return _change_state(name, 'unpause', 'running')
 
-unfreeze = unpause
+unfreeze = salt.utils.alias_function(unpause, 'unfreeze')
 
 
 def wait(name):

salt/modules/ebuild.py

@@ -237,7 +237,7 @@ def latest_version(*names, **kwargs):
     return ret
 
 # available_version is being deprecated
-available_version = latest_version
+available_version = salt.utils.alias_function(latest_version, 'available_version')
 
 
 def _get_upgradable(backtrack=3):

salt/modules/file.py

@@ -4700,7 +4700,7 @@ def list_backups(path, limit=None):
         [files[x] for x in sorted(files, reverse=True)[:limit]]
     )))
 
-list_backup = list_backups
+list_backup = salt.utils.alias_function(list_backups, 'list_backup')
 
 
 def list_backups_dir(path, limit=None):
@@ -4872,7 +4872,7 @@ def delete_backup(path, backup_id):
 
     return ret
 
-remove_backup = delete_backup
+remove_backup = salt.utils.alias_function(delete_backup, 'remove_backup')
 
 
 def grep(path,

salt/modules/freebsdpkg.py

@@ -190,7 +190,7 @@ def latest_version(*names, **kwargs):
     return '' if len(names) == 1 else dict((x, '') for x in names)
 
 # available_version is being deprecated
-available_version = latest_version
+available_version = salt.utils.alias_function(latest_version, 'available_version')
 
 
 def version(*names, **kwargs):
@@ -455,9 +455,9 @@ def remove(name=None, pkgs=None, **kwargs):
     return salt.utils.compare_dicts(old, new)
 
 # Support pkg.delete to remove packages to more closely match pkg_delete
-delete = remove
+delete = salt.utils.alias_function(remove, 'delete')
 # No equivalent to purge packages, use remove instead
-purge = remove
+purge = salt.utils.alias_function(remove, 'purge')
 
 
 def _rehash():

salt/modules/git.py

@@ -959,7 +959,7 @@ def config_get_regexp(key,
         ret.setdefault(param, []).append(value)
     return ret
 
-config_get_regex = config_get_regexp
+config_get_regex = salt.utils.alias_function(config_get_regexp, 'config_get_regex')
 
 
 def config_set(key,

salt/modules/img.py

@@ -7,6 +7,9 @@ Virtual machine image management tools
 from __future__ import absolute_import
 import logging
 
+# Import salt libs
+import salt.utils
+
 # Import 3rd-party libs
 import salt.ext.six as six
 
@@ -36,7 +39,7 @@ def mount_image(location):
     return ''
 
 # compatibility for api change
-mnt_image = mount_image
+mnt_image = salt.utils.alias_function(mount_image, 'mnt_image')
 
 
 def umount_image(mnt):

salt/modules/incron.py

@@ -211,7 +211,7 @@ def list_tab(user):
     return ret
 
 # For consistency's sake
-ls = list_tab  # pylint: disable=C0103
+ls = salt.utils.alias_function(list_tab, 'ls')
 
 
 def set_job(user, path, mask, cmd):
@@ -315,4 +315,4 @@ def rm_job(user,
 
     return ret
 
-rm = rm_job  # pylint: disable=C0103
+rm = salt.utils.alias_function(rm_job, 'rm')

salt/modules/lxc.py

@@ -2612,7 +2612,7 @@ def destroy(name, stop=False, path=None):
     return _change_state('lxc-destroy', name, None, path=path)
 
 # Compatibility between LXC and nspawn
-remove = destroy
+remove = salt.utils.alias_function(destroy, 'remove')
 
 
 def exists(name, path=None):
@@ -2955,7 +2955,7 @@ def set_password(name, users, password, encrypted=True, path=None):
         )
     return True
 
-set_pass = set_password
+set_pass = salt.utils.alias_function(set_password, 'set_pass')
 
 
 def update_lxc_conf(name, lxc_conf, lxc_conf_unset, path=None):
@@ -4272,7 +4272,7 @@ def copy_to(name, source, dest, overwrite=False, makedirs=False, path=None):
         overwrite=overwrite,
         makedirs=makedirs)
 
-cp = copy_to
+cp = salt.utils.alias_function(copy_to, 'cp')
 
 
 def read_conf(conf_file, out_format='simple'):

salt/modules/macports.py

@@ -189,7 +189,7 @@ def latest_version(*names, **kwargs):
     return ret
 
 # available_version is being deprecated
-available_version = latest_version
+available_version = salt.utils.alias_function(latest_version, 'available_version')
 
 
 def remove(name=None, pkgs=None, **kwargs):

salt/modules/memcached.py

@@ -12,6 +12,7 @@ from __future__ import absolute_import
 import logging
 
 # Import salt libs
+import salt.utils
 from salt.exceptions import CommandExecutionError, SaltInvocationError
 from salt.ext.six import integer_types
 
@@ -234,7 +235,7 @@ def increment(key, delta=1, host=DEFAULT_HOST, port=DEFAULT_PORT):
     except ValueError:
         raise SaltInvocationError('Delta value must be an integer')
 
-incr = increment
+incr = salt.utils.alias_function(increment, 'incr')
 
 
 def decrement(key, delta=1, host=DEFAULT_HOST, port=DEFAULT_PORT):
@@ -265,4 +266,4 @@ def decrement(key, delta=1, host=DEFAULT_HOST, port=DEFAULT_PORT):
     except ValueError:
         raise SaltInvocationError('Delta value must be an integer')
 
-decr = decrement
+decr = salt.utils.alias_function(decrement, 'decr')

salt/modules/network.py

@@ -728,7 +728,7 @@ def hw_addr(iface):
     return salt.utils.network.hw_addr(iface)
 
 # Alias hwaddr to preserve backward compat
-hwaddr = hw_addr
+hwaddr = salt.utils.alias_function(hw_addr, 'hwaddr')
 
 
 def interface(iface):
@@ -853,7 +853,7 @@ def ip_addrs(interface=None, include_loopback=False, cidr=None):
     else:
         return addrs
 
-ipaddrs = ip_addrs
+ipaddrs = salt.utils.alias_function(ip_addrs, 'ipaddrs')
 
 
 def ip_addrs6(interface=None, include_loopback=False, cidr=None):
@@ -877,7 +877,7 @@ def ip_addrs6(interface=None, include_loopback=False, cidr=None):
     else:
         return addrs
 
-ipaddrs6 = ip_addrs6
+ipaddrs6 = salt.utils.alias_function(ip_addrs6, 'ipaddrs6')
 
 
 def get_hostname():

salt/modules/nspawn.py

@@ -862,7 +862,7 @@ def list_running():
 
 # 'machinectl list' shows only running containers, so allow this to work as an
 # alias to nspawn.list_running
-list_ = list_running
+list_ = salt.utils.alias_function(list_running, 'list_')
 
 
 def list_stopped():
@@ -1236,7 +1236,7 @@ def remove(name, stop=False):
 
 
 # Compatibility between LXC and nspawn
-destroy = remove
+destroy = salt.utils.alias_function(remove, 'destroy')
 
 
 @_ensure_exists
@@ -1292,7 +1292,7 @@ def copy_to(name, source, dest, overwrite=False, makedirs=False):
         overwrite=overwrite,
         makedirs=makedirs)
 
-cp = copy_to
+cp = salt.utils.alias_function(copy_to, 'cp')
 
 
 # Everything below requres systemd >= 219
@@ -1455,4 +1455,4 @@ def pull_dkr(url, name, index):
     '''
     return _pull_image('dkr', url, name, index=index)
 
-pull_docker = pull_dkr
+pull_docker = salt.utils.alias_function(pull_dkr, 'pull_docker')

salt/modules/openbsdpkg.py

@@ -116,7 +116,7 @@ def latest_version(*names, **kwargs):
     return ret
 
 # available_version is being deprecated
-available_version = latest_version
+available_version = salt.utils.alias_function(latest_version, 'available_version')
 
 
 def version(*names, **kwargs):

salt/modules/pacman.py

@@ -96,7 +96,7 @@ def latest_version(*names, **kwargs):
     return ret
 
 # available_version is being deprecated
-available_version = latest_version
+available_version = salt.utils.alias_function(latest_version, 'available_version')
 
 
 def upgrade_available(name):

salt/modules/pagerduty.py

@@ -121,7 +121,7 @@ def list_windows(profile=None, api_key=None):
 
 
 # The long version, added for consistency
-list_maintenance_windows = list_windows
+list_maintenance_windows = salt.utils.alias_function(list_windows, 'list_maintenance_windows')
 
 
 def list_policies(profile=None, api_key=None):
@@ -143,7 +143,7 @@ def list_policies(profile=None, api_key=None):
 
 
 # The long version, added for consistency
-list_escalation_policies = list_policies
+list_escalation_policies = salt.utils.alias_function(list_policies, 'list_escalation_policies')
 
 
 def create_event(service_key=None, description=None, details=None,

salt/modules/pillar.py

@@ -114,7 +114,7 @@ def items(*args, **kwargs):
     return pillar.compile_pillar()
 
 # Allow pillar.data to also be used to return pillar data
-data = items
+data = salt.utils.alias_function(items, 'data')
 
 
 def _obfuscate_inner(var):

salt/modules/pkgin.py

@@ -178,7 +178,7 @@ def latest_version(*names, **kwargs):
 
 
 # available_version is being deprecated
-available_version = latest_version
+available_version = salt.utils.alias_function(latest_version, 'available_version')
 
 
 def version(*names, **kwargs):

salt/modules/pkgng.py

@@ -193,7 +193,7 @@ def version(*names, **kwargs):
     ])
 
 # Support pkg.info get version info, since this is the CLI usage
-info = version
+info = salt.utils.alias_function(version, 'info')
 
 
 def refresh_db(jail=None, chroot=None, force=False):
@@ -237,7 +237,7 @@ def refresh_db(jail=None, chroot=None, force=False):
 
 
 # Support pkg.update to refresh the db, since this is the CLI usage
-update = refresh_db
+update = salt.utils.alias_function(refresh_db, 'update')
 
 
 def latest_version(*names, **kwargs):
@@ -303,7 +303,7 @@ def latest_version(*names, **kwargs):
 
 
 # available_version is being deprecated
-available_version = latest_version
+available_version = salt.utils.alias_function(latest_version, 'available_version')
 
 
 def list_pkgs(versions_as_list=False,
@@ -957,9 +957,9 @@ def remove(name=None,
     return salt.utils.compare_dicts(old, new)
 
 # Support pkg.delete to remove packages, since this is the CLI usage
-delete = remove
+delete = salt.utils.alias_function(remove, 'delete')
 # No equivalent to purge packages, use remove instead
-purge = remove
+purge = salt.utils.alias_function(remove, 'purge')
 
 
 def upgrade(*names, **kwargs):

salt/modules/pkgutil.py

@@ -226,7 +226,7 @@ def latest_version(*names, **kwargs):
     return ret
 
 # available_version is being deprecated
-available_version = latest_version
+available_version = salt.utils.alias_function(latest_version, 'available_version')
 
 
 def install(name=None, refresh=False, version=None, pkgs=None, **kwargs):

salt/modules/saltutil.py

@@ -427,7 +427,7 @@ def sync_output(saltenv=None, refresh=True):
         refresh_modules()
     return ret
 
-sync_outputters = sync_output
+sync_outputters = salt.utils.alias_function(sync_output, 'sync_outputters')
 
 
 def sync_utils(saltenv=None, refresh=True):
@@ -553,7 +553,7 @@ def refresh_pillar():
         ret = False  # Effectively a no-op, since we can't really return without an event system
     return ret
 
-pillar_refresh = refresh_pillar
+pillar_refresh = salt.utils.alias_function(refresh_pillar, 'pillar_refresh')
 
 
 def refresh_modules(async=True):

salt/modules/solarisips.py

@@ -259,7 +259,7 @@ def latest_version(name, **kwargs):
     return ''
 
 # available_version is being deprecated
-available_version = latest_version
+available_version = salt.utils.alias_function(latest_version, 'available_version')
 
 
 def get_fmri(name, **kwargs):

salt/modules/solarispkg.py

@@ -150,7 +150,7 @@ def latest_version(*names, **kwargs):
     return ret
 
 # available_version is being deprecated
-available_version = latest_version
+available_version = salt.utils.alias_function(latest_version, 'available_version')
 
 
 def upgrade_available(name):

salt/modules/test.py

@@ -190,7 +190,7 @@ def versions_report():
     return '\n'.join(salt.version.versions_report())
 
 
-versions = versions_report
+versions = salt.utils.alias_function(versions_report, 'versions')
 
 
 def conf_test():

salt/modules/win_network.py

@@ -226,7 +226,7 @@ def hw_addr(iface):
     return salt.utils.network.hw_addr(iface)
 
 # Alias hwaddr to preserve backward compat
-hwaddr = hw_addr
+hwaddr = salt.utils.alias_function(hw_addr, 'hwaddr')
 
 
 def subnets():
@@ -270,7 +270,7 @@ def ip_addrs(interface=None, include_loopback=False):
     return salt.utils.network.ip_addrs(interface=interface,
                                        include_loopback=include_loopback)
 
-ipaddrs = ip_addrs
+ipaddrs = salt.utils.alias_function(ip_addrs, 'ipaddrs')
 
 
 def ip_addrs6(interface=None, include_loopback=False):
@@ -288,4 +288,4 @@ def ip_addrs6(interface=None, include_loopback=False):
     return salt.utils.network.ip_addrs6(interface=interface,
                                         include_loopback=include_loopback)
 
-ipaddrs6 = ip_addrs6
+ipaddrs6 = salt.utils.alias_function(ip_addrs6, 'ipaddrs6')

salt/modules/win_pkg.py

@@ -116,7 +116,7 @@ def latest_version(*names, **kwargs):
     return ret
 
 # available_version is being deprecated
-available_version = latest_version
+available_version = salt.utils.alias_function(latest_version, 'available_version')
 
 
 def upgrade_available(name):

salt/modules/win_system.py

@@ -381,7 +381,7 @@ def set_computer_desc(desc=None):
     return {'Computer Description': get_computer_desc()}
 
 
-set_computer_description = set_computer_desc
+set_computer_description = salt.utils.alias_function(set_computer_desc, 'set_computer_description')
 
 
 def get_system_info():
@@ -414,7 +414,7 @@ def get_computer_desc():
     return desc if desc else False
 
 
-get_computer_description = get_computer_desc
+get_computer_description = salt.utils.alias_function(get_computer_desc, 'get_computer_description')
 
 
 def join_domain(

salt/modules/yumpkg.py

@@ -448,7 +448,7 @@ def latest_version(*names, **kwargs):
     return ret
 
 # available_version is being deprecated
-available_version = latest_version
+available_version = salt.utils.alias_function(latest_version, 'available_version')
 
 
 def upgrade_available(name):
@@ -1744,7 +1744,7 @@ def group_install(name,
 
     return install(pkgs=pkgs, **kwargs)
 
-groupinstall = group_install
+groupinstall = salt.utils.alias_function(group_install, 'groupinstall')
 
 
 def list_repos(basedir=None):

salt/modules/zypper.py

@@ -92,7 +92,7 @@ def list_upgrades(refresh=True):
     return ret
 
 # Provide a list_updates function for those used to using zypper list-updates
-list_updates = list_upgrades
+list_updates = salt.utils.alias_function(list_upgrades, 'list_updates')
 
 
 def info_installed(*names):
@@ -224,7 +224,7 @@ def latest_version(*names, **kwargs):
 
 
 # available_version is being deprecated
-available_version = latest_version
+available_version = salt.utils.alias_function(latest_version, 'available_version')
 
 
 def upgrade_available(name):

salt/runners/pagerduty.py

@@ -120,7 +120,7 @@ def list_windows(profile=None, api_key=None):
 
 
 # The long version, added for consistency
-list_maintenance_windows = list_windows
+list_maintenance_windows = salt.utils.alias_function(list_windows, 'list_maintenance_windows')
 
 
 def list_policies(profile=None, api_key=None):
@@ -142,7 +142,7 @@ def list_policies(profile=None, api_key=None):
 
 
 # The long version, added for consistency
-list_escalation_policies = list_policies
+list_escalation_policies = salt.utils.alias_function(list_policies, 'list_escalation_policies')
 
 
 def create_event(service_key=None, description=None, details=None,

salt/runners/state.py

@@ -11,6 +11,7 @@ import sys
 
 # Import salt libs
 import salt.syspaths
+import salt.utils
 import salt.utils.event
 from salt.exceptions import SaltInvocationError
 
@@ -60,8 +61,8 @@ def orchestrate(mods, saltenv='base', test=None, exclude=None, pillar=None):
     return ret
 
 # Aliases for orchestrate runner
-orch = orchestrate  # pylint: disable=invalid-name
-sls = orchestrate  # pylint: disable=invalid-name
+orch = salt.utils.alias_function(orchestrate, 'orch')
+sls = salt.utils.alias_function(orchestrate, 'sls')
 
 
 def orchestrate_single(fun, name, test=None, queue=False, pillar=None, **kwargs):

salt/states/cmd.py

@@ -217,6 +217,7 @@ except ImportError:
     pass
 
 # Import salt libs
+import salt.utils
 from salt.exceptions import CommandExecutionError, SaltRenderError
 from salt.ext.six import string_types
 
@@ -494,7 +495,7 @@ def wait(name,
 
 
 # Alias "cmd.watch" to "cmd.wait", as this is a common misconfiguration
-watch = wait
+watch = salt.utils.alias_function(wait, 'watch')
 
 
 def wait_script(name,

salt/states/event.py

@@ -2,6 +2,10 @@
 '''
 Send events through Salt's event system during state runs
 '''
+from __future__ import absolute_import
+
+# import salt libs
+import salt.utils
 
 
 def send(name,
@@ -86,5 +90,5 @@ def wait(name, sfun=None):
     return {'name': name, 'changes': {}, 'result': True, 'comment': ''}
 
 
-mod_watch = send
-fire_master = send
+mod_watch = salt.utils.alias_function(send, 'mod_watch')
+fire_master = salt.utils.alias_function(send, 'fire_master')

salt/states/module.py

@@ -127,7 +127,7 @@ def wait(name, **kwargs):
             'comment': ''}
 
 # Alias module.watch to module.wait
-watch = wait
+watch = salt.utils.alias_function(wait, 'watch')
 
 
 def run(name, **kwargs):
@@ -269,4 +269,4 @@ def run(name, **kwargs):
             ret['result'] = False
     return ret
 
-mod_watch = run  # pylint: disable=C0103
+mod_watch = salt.utils.alias_function(run, 'mod_watch')

salt/states/rabbitmq_cluster.py

@@ -74,4 +74,4 @@ def joined(name, host, user='rabbit', ram_node=None, runas='root'):
 
 
 # Alias join to preserve backward compat
-join = joined
+join = salt.utils.alias_function(joined, 'join')

salt/states/virtualenv_mod.py

@@ -231,4 +231,4 @@ def managed(name,
                 'old': old if old else ''}
     return ret
 
-manage = managed  # pylint: disable=C0103
+manage = salt.utils.alias_function(managed, 'manage')

salt/states/win_system.py

@@ -77,7 +77,7 @@ def computer_desc(name):
                           '{0!r}'.format(name))
     return ret
 
-computer_description = computer_desc
+computer_description = salt.utils.alias_function(computer_desc, 'computer_description')
 
 
 def computer_name(name):

salt/utils/__init__.py

@@ -2001,7 +2001,7 @@ def get_hash(path, form='md5', chunk_size=65536):
 
 def namespaced_function(function, global_dict, defaults=None):
     '''
-    Redefine(clone) a function under a different globals() namespace scope
+    Redefine (clone) a function under a different globals() namespace scope
     '''
     if defaults is None:
         defaults = function.__defaults__
@@ -2016,6 +2016,32 @@ def namespaced_function(function, global_dict, defaults=None):
     return new_namespaced_function
 
 
+def alias_function(fun, name, doc=None):
+    '''
+    Copy a function
+    '''
+    alias_fun = types.FunctionType(fun.__code__,
+                                   fun.__globals__,
+                                   name,
+                                   fun.__defaults__,
+                                   fun.__closure__)
+    alias_fun.__dict__.update(fun.__dict__)
+
+    if doc and isinstance(doc, six.string_types):
+        alias_fun.__doc__ = doc
+    else:
+        if six.PY3:
+            orig_name = fun.__name__
+        else:
+            orig_name = fun.func_name  # pylint: disable=incompatible-py3-code
+
+        alias_msg = ('\nThis function is an alias of '
+                     '``{0}``.\n'.format(orig_name))
+        alias_fun.__doc__ = alias_msg + fun.__doc__
+
+    return alias_fun
+
+
 def _win_console_event_handler(event):
     if event == 5:
         # Do nothing on CTRL_LOGOFF_EVENT