0f5d3ec0e5
Having the SDK configure the root logger is problematic as it not only enables logging in the SDK but it also enables logging in the users app and logging in other libs unrelated to the SDK as an unintented side-effect. We should only log for the openstack module. We also want to be more selective about what stream to log to so we provide the option to log to stdout or stderr. Change-Id: I82ef867e182ebe4f29e21380268a3691e3b83494
67 lines
2.6 KiB
Python
67 lines
2.6 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 logging
|
|
|
|
|
|
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')
|
|
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)
|
|
|
|
if path is not None:
|
|
file_handler = logging.FileHandler(path)
|
|
file_handler.setFormatter(formatter)
|
|
logger.addHandler(file_handler)
|
|
|
|
logger.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)
|