openstack/oslo.messaging
Code Issues Proposed changes

Deprecate parameter aliases

Browse Source 
oslo.messaging deprecated transport aliases[1] since 5.2.0+
that is the minimal version supported for stable/newton.
This commit deprecates aliases kwargs of TransportURL() and
get_transport(), then we can remove the parameter aliases
in the future version.

Related-Bug: #1424728

[1]I314cefa5fb1803fa7e21e3e34300e5ced31bba89

Change-Id: I0c96979dacd9eb05b4215c687b5e34e7b3475ddb
This commit is contained in:
ChangBo Guo(gcb) 2017-03-20 13:52:19 +08:00
parent 2ee6a2a480
commit 5a7dcadc94
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
oslo_messaging/transport.py
View File

@ -29,6 +29,7 @@ __all__ = [
import logging import logging
from debtcollector import removals
from oslo_config import cfg from oslo_config import cfg
import six import six
from six.moves.urllib import parse from six.moves.urllib import parse
@ -145,6 +146,8 @@ class DriverLoadFailure(exceptions.MessagingException):
self.ex = ex self.ex = ex
@removals.removed_kwarg('aliases',
'Parameter aliases is deprecated for removal.')
def get_transport(conf, url=None, allowed_remote_exmods=None, aliases=None): def get_transport(conf, url=None, allowed_remote_exmods=None, aliases=None):
"""A factory method for Transport objects. """A factory method for Transport objects.
@ -172,7 +175,7 @@ def get_transport(conf, url=None, allowed_remote_exmods=None, aliases=None):
transport will deserialize remote exceptions transport will deserialize remote exceptions
from from
:type allowed_remote_exmods: list :type allowed_remote_exmods: list
:param aliases: A map of transport alias to transport name :param aliases: DEPRECATED: A map of transport alias to transport name
:type aliases: dict :type aliases: dict
""" """
allowed_remote_exmods = allowed_remote_exmods or [] allowed_remote_exmods = allowed_remote_exmods or []
@ -252,6 +255,8 @@ class TransportURL(object):
:type query: dict :type query: dict
""" """
@removals.removed_kwarg('aliases',
'Parameter aliases is deprecated for removal.')
def __init__(self, conf, transport=None, virtual_host=None, hosts=None, def __init__(self, conf, transport=None, virtual_host=None, hosts=None,
aliases=None, query=None): aliases=None, query=None):
self.conf = conf self.conf = conf
@ -282,7 +287,7 @@ class TransportURL(object):
final_transport = self.aliases.get(transport, transport) final_transport = self.aliases.get(transport, transport)
if not self._deprecation_logged and final_transport != transport: if not self._deprecation_logged and final_transport != transport:
# NOTE(sileht): The first step is deprecate this one cycle. # NOTE(sileht): The first step is deprecate this one cycle.
# To ensure deployer have updated they configuration during Octavia # To ensure deployer have updated they configuration during Ocata
# Then in P we will deprecate aliases kwargs of TransportURL() and # Then in P we will deprecate aliases kwargs of TransportURL() and
# get_transport() for consuming application # get_transport() for consuming application
LOG.warning('legacy "rpc_backend" is deprecated, ' LOG.warning('legacy "rpc_backend" is deprecated, '