9dfd6b4a45
Updates Nova's deprecated warn function so that we only log messages about deprecated config options once. The motivation for this change is to cut down the log file noise when deprecated config code gets called more than once. Change-Id: If8919817330dc9461a0472fea982d43c78a86f66
56 lines
1.6 KiB
Python
56 lines
1.6 KiB
Python
# vim: tabstop=4 shiftwidth=4 softtabstop=4
|
|
|
|
# Copyright (c) 2012 IBM
|
|
#
|
|
# 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.
|
|
|
|
import warnings
|
|
|
|
from nova import exception
|
|
from nova import flags
|
|
from nova.openstack.common import cfg
|
|
from nova.openstack.common import log as logging
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
deprecate_opts = [
|
|
cfg.BoolOpt('fatal_deprecations',
|
|
default=False,
|
|
help='make deprecations fatal')
|
|
]
|
|
FLAGS = flags.FLAGS
|
|
FLAGS.register_opts(deprecate_opts)
|
|
|
|
|
|
def _showwarning(message, category, filename, lineno, file=None, line=None):
|
|
"""
|
|
Redirect warnings into logging.
|
|
"""
|
|
LOG.warn(str(message))
|
|
|
|
|
|
# Install our warnings handler
|
|
warnings.showwarning = _showwarning
|
|
|
|
|
|
def warn(msg=""):
|
|
"""
|
|
Warn of a deprecated config option that an operator has specified.
|
|
This should be added in the code where we've made a change in how
|
|
we use some operator changeable parameter to indicate that it will
|
|
go away in a future version of OpenStack.
|
|
"""
|
|
warnings.warn(_("Deprecated Config: %s") % msg)
|
|
if FLAGS.fatal_deprecations:
|
|
raise exception.DeprecatedConfig(msg=msg)
|