Remove deprecated localcontext

Change-Id: Ib109ced5ee6a706853b0f54be6756cfaf63e2164
This commit is contained in:
Mehdi Abaakouk 2016-05-17 09:36:33 +02:00
parent 7b45bbdb7e
commit 5dd059aa3c
4 changed files with 1 additions and 97 deletions

View File

@ -14,7 +14,6 @@
# under the License.
from .exceptions import *
from .localcontext import *
from .notify import *
from .rpc import *
from .serializer import *

View File

@ -1,85 +0,0 @@
# Copyright 2013 Red Hat, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
__all__ = [
'get_local_context',
'set_local_context',
'clear_local_context',
'_set_local_context',
'_clear_local_context',
]
from functools import wraps
import threading
import uuid
import warnings
def _deprecated(as_of=None, in_favor_of=None):
def __inner(func):
@wraps(func)
def __wrapper(*args, **kwargs):
replaced_by = (' Please use %s instead.'
% in_favor_of) if in_favor_of else ''
warnings.warn('%s has been deprecated in %s and will be '
'removed in the next release.%s' %
(func.__name__, as_of, replaced_by))
return func(*args, **kwargs)
return __wrapper
return __inner
_VERSION = '1.8.0'
_KEY = '_%s_%s' % (__name__.replace('.', '_'), uuid.uuid4().hex)
_STORE = threading.local()
@_deprecated(as_of=_VERSION, in_favor_of='oslo_context.context.get_current')
def get_local_context(ctxt):
"""Retrieve the RPC endpoint request context for the current thread.
This method allows any code running in the context of a dispatched RPC
endpoint method to retrieve the context for this request.
This is commonly used for logging so that, for example, you can include the
request ID, user and tenant in every message logged from a RPC endpoint
method.
:returns: the context for the request dispatched in the current thread
"""
return getattr(_STORE, _KEY, None)
@_deprecated(as_of=_VERSION)
def set_local_context(ctxt):
_set_local_context(ctxt)
def _set_local_context(ctxt):
"""Set the request context for the current thread.
:param ctxt: a deserialized request context
:type ctxt: dict
"""
setattr(_STORE, _KEY, ctxt)
@_deprecated(as_of=_VERSION)
def clear_local_context():
_clear_local_context()
def _clear_local_context():
"""Clear the request context for the current thread."""
delattr(_STORE, _KEY)

View File

@ -21,7 +21,6 @@ import six
from oslo_messaging._i18n import _LW
from oslo_messaging import dispatcher
from oslo_messaging import localcontext
from oslo_messaging import serializer as msg_serializer
@ -77,8 +76,6 @@ class NotificationDispatcher(dispatcher.DispatcherBase):
return NotificationResult.HANDLED
def _exec_callback(self, callback, message):
localcontext._set_local_context(message["ctxt"])
try:
return callback(message["ctxt"],
message["publisher_id"],
@ -88,8 +85,6 @@ class NotificationDispatcher(dispatcher.DispatcherBase):
except Exception:
LOG.exception("Callback raised an exception.")
return NotificationResult.REQUEUE
finally:
localcontext._clear_local_context()
def _extract_user_message(self, incoming):
ctxt = self.serializer.deserialize_context(incoming.ctxt)

View File

@ -31,7 +31,6 @@ import six
from oslo_messaging import _utils as utils
from oslo_messaging import dispatcher
from oslo_messaging import localcontext
from oslo_messaging import serializer as msg_serializer
from oslo_messaging import server as msg_server
from oslo_messaging import target as msg_target
@ -148,11 +147,7 @@ class RPCDispatcher(dispatcher.DispatcherBase):
continue
if hasattr(endpoint, method):
localcontext._set_local_context(ctxt)
try:
return self._do_dispatch(endpoint, method, ctxt, args)
finally:
localcontext._clear_local_context()
return self._do_dispatch(endpoint, method, ctxt, args)
found_compatible = True