d1a0c1f405
Client libraries shouldn't depend on specific configuration libraries, since that will make it difficult for other applications to adopt the library. This patch replaces all oslo.config usages with dictionaries. The client will use those as options holders and all parameters are considered optional. Notice that `options` was preferred instead of `**options` since this dictionary is considered a 'config object' and not a set of optional parameters. This will make it easier for applications using marconiclient to hold a single, mutable instance of options to pass around. Partially-Implements blueprint python-marconiclient-v1 Change-Id: Ib41f2957689545f05dab19338842fd9a953f2f76
62 lines
1.9 KiB
Python
62 lines
1.9 KiB
Python
# Copyright (c) 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.
|
|
|
|
import uuid
|
|
|
|
from marconiclient.queues.v1 import queues
|
|
from marconiclient import transport
|
|
|
|
|
|
class Client(object):
|
|
"""Client base class
|
|
|
|
:param url: Marconi's instance base url.
|
|
:type url: `six.text_type`
|
|
:param version: API Version pointing to.
|
|
:type version: `int`
|
|
:param options: Extra options:
|
|
- client_uuid: Custom client uuid. A new one
|
|
will be generated, if not passed.
|
|
- auth_opts: Authentication options:
|
|
- backend
|
|
- options
|
|
:type options: `dict`
|
|
"""
|
|
|
|
def __init__(self, url=None, version=1, conf=None):
|
|
self.conf = conf or {}
|
|
|
|
self.api_url = url
|
|
self.api_version = version
|
|
self.auth_opts = self.conf.get('auth_opts', {})
|
|
self.client_uuid = self.conf.get('client_uuid',
|
|
uuid.uuid4().hex)
|
|
|
|
def transport(self):
|
|
"""Gets a transport based the api url and version."""
|
|
return transport.get_transport_for(self.url,
|
|
self.api_version)
|
|
|
|
def queue(self, ref, **kwargs):
|
|
"""Returns a queue instance
|
|
|
|
:param ref: Queue's reference id.
|
|
:type ref: `six.text_type`
|
|
|
|
:returns: A queue instance
|
|
:rtype: `queues.Queue`
|
|
"""
|
|
return queues.Queue(self, ref, **kwargs)
|