Dean Troyer 725e2543ef Object API commands using our REST API layer
* Add object-store API to ClientManager
* Add object-store client
* Add Object API library in openstackclient.object.v1.lib
* Add Object API {container,object} list commands
* Add library tests
* Add command tests

This should complete the Object v1 container and object list commands

Change-Id: Ib1770d45efa8871959826b85faafa1e0bcef0a03
2013-08-28 22:16:34 -05:00

98 lines
2.8 KiB
Python

# Copyright 2010-2012 OpenStack Foundation
# Copyright 2013 Nebula 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.
#
"""Object v1 API library"""
def list_objects(
api,
url,
container,
marker=None,
limit=None,
end_marker=None,
delimiter=None,
prefix=None,
path=None,
full_listing=False,
):
"""Get objects in a container
:param api: a restapi object
:param url: endpoint
:param container: container name to get a listing for
:param marker: marker query
:param limit: limit query
:param end_marker: marker query
:param delimiter: string to delimit the queries on
:param prefix: prefix query
:param path: path query (equivalent: "delimiter=/" and "prefix=path/")
:param full_listing: if True, return a full listing, else returns a max
of 10000 listings
:returns: a tuple of (response headers, a list of objects) The response
headers will be a dict and all header names will be lowercase.
"""
if full_listing:
data = listing = list_objects(
api,
url,
container,
marker,
limit,
end_marker,
delimiter,
prefix,
path,
)
while listing:
if delimiter:
marker = listing[-1].get('name', listing[-1].get('subdir'))
else:
marker = listing[-1]['name']
listing = list_objects(
api,
url,
container,
marker,
limit,
end_marker,
delimiter,
prefix,
path,
)
if listing:
data.extend(listing)
return data
object_url = url
query = "format=json"
if marker:
query += '&marker=%s' % marker
if limit:
query += '&limit=%d' % limit
if end_marker:
query += '&end_marker=%s' % end_marker
if delimiter:
query += '&delimiter=%s' % delimiter
if prefix:
query += '&prefix=%s' % prefix
if path:
query += '&path=%s' % path
url = "%s/%s?%s" % (object_url, container, query)
response = api.request('GET', url)
return response.json()