openstack/ironic
Code Issues Proposed changes

Clarify deprecation of "async" parameter

Browse Source 
For vendor passthru decorators, the "async" parameter is deprecated.
This clarifies the messaging we emit (via logs and release notes), and
adds a TODO so we don't forget to delete the "async" parameter in
Stein cycle.

This is a follow up to Change-Id: I6299aafd30faae9a93df2cb901c1505df47e6b45.

Change-Id: I63ddf453584f4e7e8d2fa778ec50b8debcb86bf4
Task: 9289
Story: 1751306
This commit is contained in:
Ruby Loo 2018-04-06 10:02:05 -04:00
parent f5605d13e6
commit 3e92382d2e
2 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
ironic/drivers/base.py
View File

@ -655,11 +655,15 @@ def _passthru(http_methods, method=None, async=None, async_call=None,
for a synchronous passthru method. If False, for a synchronous passthru method. If False,
don't lock the node. Defaults to True. don't lock the node. Defaults to True.
""" """
# TODO(rloo): In Stein cycle, remove support for 'async' parameter.
# The default value for 'async_call' should then be changed
# to True.
if async_call is None: if async_call is None:
if async is not None: if async is not None:
LOG.warning( LOG.warning(
'async parameter is deprecated, please use async_call instead.' 'The "async" parameter is deprecated, please use "async_call" '
'deprecated parameter will be removed in the next cycle.' 'instead. The "async" parameter will be removed in the Stein '
'cycle.'
) )
async_call = async async_call = async
else: else:
@ -667,8 +671,9 @@ def _passthru(http_methods, method=None, async=None, async_call=None,
else: else:
if async is not None: if async is not None:
raise TypeError( raise TypeError(
"async_call and async parameters couldn't be used together, " "'async_call' and 'async' parameters cannot be used together. "
"use async_call instead of async" "Use 'async_call' instead of 'async' since 'async' is "
"deprecated and will be removed in the Stein cycle."
) )
def handle_passthru(func): def handle_passthru(func):

9
releasenotes/notes/async-deprecate-b3d81d7968ea47e5.yaml
View File

@ -1,4 +1,9 @@
--- ---
other: other:
async parameter of passthru and driver_passthru decorators is deprecated For out-of-tree drivers that have `vendor passthru methods
and will be removed in next cycle. async_call should be used instead. <https://docs.openstack.org/ironic/latest/contributor/vendor-passthru.html>`_.
The ``async`` parameter of the ``passthru`` and ``driver_passthru``
decorators is deprecated and will be removed in the Stein cycle.
Please use its replacement instead, the ``async_call`` parameter.
For more information, see `bug 1751306
<https://storyboard.openstack.org/#!/story/1751306>`_.