e97a755046
In auditing our proxy method names heading into the 1.0 release, where we'll need to be more careful about backwards compatibility, some names in the cluster proxy use structures that are different than we're using both around the other services and also within cluster itself. We've converged on several naming formats for add/remove, attach/detach, and several other grammar styles when naming operations that are done on a certain resource. This change introduces a deprecation decorator using the `deprecation` library, which was recently added to global-requirements. This is also the first change of several in the auditing process, just going alphabetical order through the services. The plan with these is that they're marked for deprecation in the next release (0.9.14), both here in the code and in the documentation via the deprecation library's ability to modify the docstring, which then shows up in our built documentation. In the meantime, we should help any users we know of—in this case we have cluster developers on this project—in updating calling code to use the newer format before 1.0 happens. The following deprecations were made: * cluster_add_nodes -> add_nodes_to_cluster * cluster_del_nodes -> remove_nodes_from_cluster * cluster_replace_nodes -> replace_nodes_in_cluster * cluster_scale_out -> scale_out_cluster * cluster_scale_in -> scale_in_cluster * cluster_attach_policy -> attach_policy_to_cluster * cluster_detach_policy -> detach_policy_from_cluster * cluster_update_policy -> update_cluster_policy * cluster_operation -> perform_operation_on_cluster * node_operation -> perform_operation_on_node Partial-Bug: 1657498 Change-Id: I3df0494f9ec0097aee7d47e05fb42094439bc4a4
99 lines
4.0 KiB
Python
99 lines
4.0 KiB
Python
# 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 functools
|
|
import logging
|
|
|
|
import deprecation
|
|
|
|
from openstack import version
|
|
|
|
|
|
def deprecated(deprecated_in=None, removed_in=None,
|
|
details=""):
|
|
"""Mark a method as deprecated
|
|
|
|
:param deprecated_in: The version string where this method is deprecated.
|
|
Generally this is the next version to be released.
|
|
:param removed_in: The version where this method will be removed
|
|
from the code base. Generally this is the next
|
|
major version. This argument is helpful for the
|
|
tests when using ``deprecation.fail_if_not_removed``.
|
|
:param str details: Helpful details to callers and the documentation.
|
|
This will usually be a recommendation for alternate
|
|
code to use.
|
|
"""
|
|
# As all deprecations within this library have the same current_version,
|
|
# return a partial function with the library version always set.
|
|
partial = functools.partial(deprecation.deprecated,
|
|
current_version=version.__version__)
|
|
|
|
return partial(deprecated_in=deprecated_in, removed_in=removed_in,
|
|
details=details)
|
|
|
|
|
|
def enable_logging(debug=False, path=None, stream=None):
|
|
"""Enable logging to a file at path and/or a console stream.
|
|
|
|
This function is available for debugging purposes. If you wish to
|
|
log this package's message in your application, the standard library
|
|
``logging`` package will receive these messages in any handlers you
|
|
create.
|
|
|
|
:param bool debug: Set this to ``True`` to receive debug messages,
|
|
which includes HTTP requests and responses,
|
|
or ``False`` for warning messages.
|
|
:param str path: If a *path* is specified, logging output will
|
|
written to that file in addition to sys.stderr.
|
|
The path is passed to logging.FileHandler,
|
|
which will append messages the file (and create
|
|
it if needed).
|
|
:param stream: One of ``None `` or ``sys.stdout`` or ``sys.stderr``.
|
|
If it is ``None``, nothing is logged to a stream.
|
|
If it isn't ``None``, console output is logged
|
|
to this stream.
|
|
|
|
:rtype: None
|
|
"""
|
|
if path is None and stream is None:
|
|
raise ValueError("path and/or stream must be set")
|
|
|
|
logger = logging.getLogger('openstack')
|
|
ksalog = logging.getLogger('keystoneauth')
|
|
formatter = logging.Formatter(
|
|
'%(asctime)s %(levelname)s: %(name)s %(message)s')
|
|
|
|
if stream is not None:
|
|
console = logging.StreamHandler(stream)
|
|
console.setFormatter(formatter)
|
|
logger.addHandler(console)
|
|
ksalog.addHandler(console)
|
|
|
|
if path is not None:
|
|
file_handler = logging.FileHandler(path)
|
|
file_handler.setFormatter(formatter)
|
|
logger.addHandler(file_handler)
|
|
ksalog.addHandler(file_handler)
|
|
|
|
logger.setLevel(logging.DEBUG if debug else logging.WARNING)
|
|
ksalog.setLevel(logging.DEBUG if debug else logging.WARNING)
|
|
|
|
|
|
def urljoin(*args):
|
|
"""A custom version of urljoin that simply joins strings into a path.
|
|
|
|
The real urljoin takes into account web semantics like when joining a url
|
|
like /path this should be joined to http://host/path as it is an anchored
|
|
link. We generally won't care about that in client.
|
|
"""
|
|
return '/'.join(str(a or '').strip('/') for a in args)
|