From 73e4296a389893c750f7c70a477ec828e4360197 Mon Sep 17 00:00:00 2001
From: Paulo Ewerton <pauloewerton@lsd.ufcg.edu.br>
Date: Tue, 29 Mar 2016 19:10:42 +0000
Subject: [PATCH 001/316] Adding keystoneauth sessions support

This patch allows authentication in swiftclient with a keystonauth
session.

Co-Authored-By: Tim Burke <tim@swiftstack.com>

Change-Id: Ia3fd947ff619c11ff0ce474897533dcf7b49d9b3
Closes-Bug: 1518938
---
 doc/source/client-api.rst      | 22 ++++++++++++++++++
 swiftclient/client.py          | 35 ++++++++++++++++++++--------
 tests/unit/test_swiftclient.py | 42 ++++++++++++++++++++++++++++++++++
 3 files changed, 89 insertions(+), 10 deletions(-)

diff --git a/doc/source/client-api.rst b/doc/source/client-api.rst
index 5677f70d..13b3056a 100644
--- a/doc/source/client-api.rst
+++ b/doc/source/client-api.rst
@@ -18,6 +18,28 @@ version are detailed below, but are
 just a subset of those that can be used to successfully authenticate. These
 are the most common and recommended combinations.
 
+Keystone Session
+~~~~~~~~~~~~~~~~
+
+.. code-block:: python
+
+    from keystoneauth1 import session
+    from keystoneauth1 import v3
+
+    # Create a password auth plugin
+    auth = v3.Password(auth_url='http://127.0.0.1:5000/v3/',
+                       username='tester',
+                       password='testing',
+                       user_domain_name='Default',
+                       project_name='Default',
+                       project_domain_name='Default')
+
+    # Create session
+    session = session.Session(auth=auth)
+
+    # Create swiftclient Connection
+    swift_conn = Connection(session=session)
+
 Keystone v3
 ~~~~~~~~~~~
 
diff --git a/swiftclient/client.py b/swiftclient/client.py
index 744a876b..8370764d 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -609,6 +609,7 @@ def get_auth(auth_url, user, key, **kwargs):
     use of this network path causes no bandwidth charges but requires the
     client to be running on Rackspace's ServiceNet network.
     """
+    session = kwargs.get('session', None)
     auth_version = kwargs.get('auth_version', '1')
     os_options = kwargs.get('os_options', {})
 
@@ -617,7 +618,14 @@ def get_auth(auth_url, user, key, **kwargs):
     cert = kwargs.get('cert')
     cert_key = kwargs.get('cert_key')
     timeout = kwargs.get('timeout', None)
-    if auth_version in AUTH_VERSIONS_V1:
+
+    if session:
+        service_type = os_options.get('service_type', 'object-store')
+        interface = os_options.get('endpoint_type', 'public')
+        storage_url = session.get_endpoint(service_type=service_type,
+                                           interface=interface)
+        token = session.get_token()
+    elif auth_version in AUTH_VERSIONS_V1:
         storage_url, token = get_auth_1_0(auth_url,
                                           user,
                                           key,
@@ -654,8 +662,8 @@ def get_auth(auth_url, user, key, **kwargs):
                                                timeout=timeout,
                                                auth_version=auth_version)
     else:
-        raise ClientException('Unknown auth_version %s specified.'
-                              % auth_version)
+        raise ClientException('Unknown auth_version %s specified and no '
+                              'session found.' % auth_version)
 
     # Override storage url, if necessary
     if os_options.get('object_storage_url'):
@@ -1414,7 +1422,7 @@ def __init__(self, authurl=None, user=None, key=None, retries=5,
                  os_options=None, auth_version="1", cacert=None,
                  insecure=False, cert=None, cert_key=None,
                  ssl_compression=True, retry_on_ratelimit=False,
-                 timeout=None):
+                 timeout=None, session=None):
         """
         :param authurl: authentication URL
         :param user: user name to authenticate as
@@ -1449,7 +1457,9 @@ def __init__(self, authurl=None, user=None, key=None, retries=5,
                                    this parameter to True will cause a retry
                                    after a backoff.
         :param timeout: The connect timeout for the HTTP connection.
+        :param session: A keystoneauth session object.
         """
+        self.session = session
         self.authurl = authurl
         self.user = user
         self.key = key
@@ -1493,7 +1503,7 @@ def close(self):
 
     def get_auth(self):
         self.url, self.token = get_auth(self.authurl, self.user, self.key,
-                                        snet=self.snet,
+                                        session=self.session, snet=self.snet,
                                         auth_version=self.auth_version,
                                         os_options=self.os_options,
                                         cacert=self.cacert,
@@ -1512,8 +1522,8 @@ def get_service_auth(self):
                                                          None)
         service_user = opts.get('service_username', None)
         service_key = opts.get('service_key', None)
-        return get_auth(self.authurl, service_user,
-                        service_key,
+        return get_auth(self.authurl, service_user, service_key,
+                        session=self.session,
                         snet=self.snet,
                         auth_version=self.auth_version,
                         os_options=service_options,
@@ -1577,10 +1587,15 @@ def _retry(self, reset_func, func, *args, **kwargs):
                     logger.exception(err)
                     raise
                 if err.http_status == 401:
+                    if self.session:
+                        should_retry = self.session.invalidate()
+                    else:
+                        # Without a proper session, just check for auth creds
+                        should_retry = all((self.authurl, self.user, self.key))
+
                     self.url = self.token = self.service_token = None
-                    if retried_auth or not all((self.authurl,
-                                                self.user,
-                                                self.key)):
+
+                    if retried_auth or not should_retry:
                         logger.exception(err)
                         raise
                     retried_auth = True
diff --git a/tests/unit/test_swiftclient.py b/tests/unit/test_swiftclient.py
index cbb95dbe..07ae5021 100644
--- a/tests/unit/test_swiftclient.py
+++ b/tests/unit/test_swiftclient.py
@@ -561,6 +561,15 @@ def test_get_keystone_client_2_0(self):
         self.assertTrue(url.startswith("http"))
         self.assertTrue(token)
 
+    def test_auth_with_session(self):
+        mock_session = mock.MagicMock()
+        mock_session.get_endpoint.return_value = 'http://storagehost/v1/acct'
+        mock_session.get_token.return_value = 'token'
+        url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf',
+                                session=mock_session)
+        self.assertEqual(url, 'http://storagehost/v1/acct')
+        self.assertTrue(token)
+
 
 class TestGetAccount(MockHttpTest):
 
@@ -1868,6 +1877,39 @@ def test_reauth_os_preauth(self):
             ('HEAD', '/v1/AUTH_test', '', {'x-auth-token': 'token'}),
         ])
 
+    def test_session_no_invalidate(self):
+        mock_session = mock.MagicMock()
+        mock_session.get_endpoint.return_value = 'http://storagehost/v1/acct'
+        mock_session.get_token.return_value = 'expired'
+        mock_session.invalidate.return_value = False
+        conn = c.Connection(session=mock_session)
+        fake_conn = self.fake_http_connection(401)
+        with mock.patch.multiple('swiftclient.client',
+                                 http_connection=fake_conn,
+                                 sleep=mock.DEFAULT):
+            self.assertRaises(c.ClientException, conn.head_account)
+        self.assertEqual(mock_session.get_token.mock_calls, [mock.call()])
+        self.assertEqual(mock_session.invalidate.mock_calls, [mock.call()])
+
+    def test_session_can_invalidate(self):
+        mock_session = mock.MagicMock()
+        mock_session.get_endpoint.return_value = 'http://storagehost/v1/acct'
+        mock_session.get_token.side_effect = ['expired', 'token']
+        mock_session.invalidate.return_value = True
+        conn = c.Connection(session=mock_session)
+        fake_conn = self.fake_http_connection(401, 200)
+        with mock.patch.multiple('swiftclient.client',
+                                 http_connection=fake_conn,
+                                 sleep=mock.DEFAULT):
+            conn.head_account()
+        self.assertRequests([
+            ('HEAD', '/v1/acct', '', {'x-auth-token': 'expired'}),
+            ('HEAD', '/v1/acct', '', {'x-auth-token': 'token'}),
+        ])
+        self.assertEqual(mock_session.get_token.mock_calls, [
+            mock.call(), mock.call()])
+        self.assertEqual(mock_session.invalidate.mock_calls, [mock.call()])
+
     def test_preauth_token_with_no_storage_url_requires_auth(self):
         conn = c.Connection(
             'http://auth.example.com', 'user', 'password',

From a62b7ee06c1a300c73d9a01b2c9bc05028f1fabd Mon Sep 17 00:00:00 2001
From: Julien Danjou <julien@danjou.info>
Date: Tue, 7 Jun 2016 15:49:32 +0200
Subject: [PATCH 002/316] client: renew token on 401 even if retries is 0

Gnocchi uses a client with retries=0 to maximize throughtput and not retry N
times on e.g. 404 when checking existence of an object. However, this as the
side effect of never renewing the token since there' no retry on 401 either.

This patches change the behavior so that 401 errors are always retried,
whatever the retries value is.

Closes-Bug: #1589926
Change-Id: Ie06adf4cf17ea4592b5bbd7bbde9828e5e134e3e
---
 swiftclient/client.py          |  8 ++--
 tests/unit/test_swiftclient.py | 78 ++++++++++++++++++++++++++++++++++
 2 files changed, 82 insertions(+), 4 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index 744a876b..f556afd9 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -1544,7 +1544,7 @@ def _retry(self, reset_func, func, *args, **kwargs):
         backoff = self.starting_backoff
         caller_response_dict = kwargs.pop('response_dict', None)
         self.attempts = kwargs.pop('attempts', 0)
-        while self.attempts <= self.retries:
+        while self.attempts <= self.retries or retried_auth:
             self.attempts += 1
             try:
                 if not self.url or not self.token:
@@ -1573,9 +1573,6 @@ def _retry(self, reset_func, func, *args, **kwargs):
                 self.http_conn = None
             except ClientException as err:
                 self._add_response_dict(caller_response_dict, kwargs)
-                if self.attempts > self.retries or err.http_status is None:
-                    logger.exception(err)
-                    raise
                 if err.http_status == 401:
                     self.url = self.token = self.service_token = None
                     if retried_auth or not all((self.authurl,
@@ -1584,6 +1581,9 @@ def _retry(self, reset_func, func, *args, **kwargs):
                         logger.exception(err)
                         raise
                     retried_auth = True
+                elif self.attempts > self.retries or err.http_status is None:
+                    logger.exception(err)
+                    raise
                 elif err.http_status == 408:
                     self.http_conn = None
                 elif 500 <= err.http_status <= 599:
diff --git a/tests/unit/test_swiftclient.py b/tests/unit/test_swiftclient.py
index cbb95dbe..4a39458b 100644
--- a/tests/unit/test_swiftclient.py
+++ b/tests/unit/test_swiftclient.py
@@ -2556,6 +2556,84 @@ def swap_sleep(*args):
         self.assertEqual('service_project_name',
                          auth_kwargs['os_options']['tenant_name'])
 
+    def test_service_token_reauth_retries_0(self):
+        get_auth_call_list = []
+
+        def get_auth(url, user, key, **kwargs):
+            # The real get_auth function will always return the os_option
+            # dict's object_storage_url which will be overridden by the
+            # preauthurl parameter to Connection if it is provided.
+            args = {'url': url, 'user': user, 'key': key, 'kwargs': kwargs}
+            get_auth_call_list.append(args)
+            return_dict = {'asdf': 'new', 'service_username': 'newserv'}
+            storage_url = kwargs['os_options'].get('object_storage_url')
+            return storage_url, return_dict[user]
+
+        def swap_sleep(*args):
+            self.swap_sleep_called = True
+            c.get_auth = get_auth
+
+        with mock.patch('swiftclient.client.http_connection',
+                        self.fake_http_connection(401, 200)):
+            with mock.patch('swiftclient.client.sleep', swap_sleep):
+                self.swap_sleep_called = False
+
+                conn = c.Connection('http://www.test.com', 'asdf', 'asdf',
+                                    preauthurl='http://www.old.com',
+                                    preauthtoken='old',
+                                    os_options=self.os_options,
+                                    retries=0)
+
+                self.assertEqual(conn.attempts, 0)
+                self.assertEqual(conn.url, 'http://www.old.com')
+                self.assertEqual(conn.token, 'old')
+
+                conn.head_account()
+
+        self.assertTrue(self.swap_sleep_called)
+        self.assertEqual(conn.attempts, 2)
+        # The original 'preauth' storage URL *must* be preserved
+        self.assertEqual(conn.url, 'http://www.old.com')
+        self.assertEqual(conn.token, 'new')
+        self.assertEqual(conn.service_token, 'newserv')
+
+        # Check get_auth was called with expected args
+        auth_args = get_auth_call_list[0]
+        auth_kwargs = get_auth_call_list[0]['kwargs']
+        self.assertEqual('asdf', auth_args['user'])
+        self.assertEqual('asdf', auth_args['key'])
+        self.assertEqual('service_key',
+                         auth_kwargs['os_options']['service_key'])
+        self.assertEqual('service_username',
+                         auth_kwargs['os_options']['service_username'])
+        self.assertEqual('service_project_name',
+                         auth_kwargs['os_options']['service_project_name'])
+
+        auth_args = get_auth_call_list[1]
+        auth_kwargs = get_auth_call_list[1]['kwargs']
+        self.assertEqual('service_username', auth_args['user'])
+        self.assertEqual('service_key', auth_args['key'])
+        self.assertEqual('service_project_name',
+                         auth_kwargs['os_options']['tenant_name'])
+
+        # Ensure this is not an endless loop - it fails after the second 401
+        with mock.patch('swiftclient.client.http_connection',
+                        self.fake_http_connection(401, 401, 401, 401)):
+            with mock.patch('swiftclient.client.sleep', swap_sleep):
+                self.swap_sleep_called = False
+
+                conn = c.Connection('http://www.test.com', 'asdf', 'asdf',
+                                    preauthurl='http://www.old.com',
+                                    preauthtoken='old',
+                                    os_options=self.os_options,
+                                    retries=0)
+
+                self.assertEqual(conn.attempts, 0)
+                self.assertRaises(c.ClientException, conn.head_account)
+                self.assertEqual(conn.attempts, 2)
+                unused_responses = list(self.fake_connect.code_iter)
+                self.assertEqual(unused_responses, [401, 401])
+
     def test_service_token_get_account(self):
         with mock.patch('swiftclient.client.http_connection',
                         self.fake_http_connection(200)):

From dca4ea5fd6e1a4eb15eeea9879913f64f2851446 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Wed, 29 Jun 2016 11:07:41 -0700
Subject: [PATCH 003/316] Fix unicode issues in tempurl command

Previously, we weren't encoding paths and keys as UTF-8, which would
trigger a UnicodeEncodeError on py27.

Change-Id: I2fad428369406c2ae32343a5e943ffb2cd1ca6ef
---
 swiftclient/utils.py     |  45 ++++++++-----
 tests/unit/test_utils.py | 142 ++++++++++++++++++++++++++++++---------
 2 files changed, 137 insertions(+), 50 deletions(-)

diff --git a/swiftclient/utils.py b/swiftclient/utils.py
index 0abaed6f..10687bf4 100644
--- a/swiftclient/utils.py
+++ b/swiftclient/utils.py
@@ -78,15 +78,20 @@ def generate_temp_url(path, seconds, key, method, absolute=False):
     :raises: TypeError if seconds is not an integer
     :return: the path portion of a temporary URL
     """
-    if seconds < 0:
-        raise ValueError('seconds must be a positive integer')
     try:
-        if not absolute:
-            expiration = int(time.time() + seconds)
-        else:
-            expiration = int(seconds)
-    except TypeError:
+        seconds = int(seconds)
+    except ValueError:
         raise TypeError('seconds must be an integer')
+    if seconds < 0:
+        raise ValueError('seconds must be a positive integer')
+
+    if isinstance(path, six.binary_type):
+        try:
+            path_for_body = path.decode('utf-8')
+        except UnicodeDecodeError:
+            raise ValueError('path must be representable as UTF-8')
+    else:
+        path_for_body = path
 
     standard_methods = ['GET', 'PUT', 'HEAD', 'POST', 'DELETE']
     if method.upper() not in standard_methods:
@@ -94,18 +99,24 @@ def generate_temp_url(path, seconds, key, method, absolute=False):
         logger.warning('Non default HTTP method %s for tempurl specified, '
                        'possibly an error', method.upper())
 
-    hmac_body = '\n'.join([method.upper(), str(expiration), path])
+    if not absolute:
+        expiration = int(time.time() + seconds)
+    else:
+        expiration = seconds
+    hmac_body = u'\n'.join([method.upper(), str(expiration), path_for_body])
 
     # Encode to UTF-8 for py3 compatibility
-    sig = hmac.new(key.encode(),
-                   hmac_body.encode(),
-                   hashlib.sha1).hexdigest()
-
-    return ('{path}?temp_url_sig='
-            '{sig}&temp_url_expires={exp}'.format(
-                path=path,
-                sig=sig,
-                exp=expiration))
+    if not isinstance(key, six.binary_type):
+        key = key.encode('utf-8')
+    sig = hmac.new(key, hmac_body.encode('utf-8'), hashlib.sha1).hexdigest()
+
+    temp_url = u'{path}?temp_url_sig={sig}&temp_url_expires={exp}'.format(
+        path=path_for_body, sig=sig, exp=expiration)
+    # Have return type match path from caller
+    if isinstance(path, six.binary_type):
+        return temp_url.encode('utf-8')
+    else:
+        return temp_url
 
 
 def parse_api_response(headers, body):
diff --git a/tests/unit/test_utils.py b/tests/unit/test_utils.py
index aae466c7..0f210a3c 100644
--- a/tests/unit/test_utils.py
+++ b/tests/unit/test_utils.py
@@ -17,7 +17,7 @@
 import mock
 import six
 import tempfile
-from hashlib import md5
+from hashlib import md5, sha1
 
 from swiftclient import utils as u
 
@@ -120,48 +120,124 @@ def test_overflow(self):
 
 
 class TestTempURL(unittest.TestCase):
-
-    def setUp(self):
-        super(TestTempURL, self).setUp()
-        self.url = '/v1/AUTH_account/c/o'
-        self.seconds = 3600
-        self.key = 'correcthorsebatterystaple'
-        self.method = 'GET'
-
-    @mock.patch('hmac.HMAC.hexdigest', return_value='temp_url_signature')
+    url = '/v1/AUTH_account/c/o'
+    seconds = 3600
+    key = 'correcthorsebatterystaple'
+    method = 'GET'
+    expected_url = url + ('?temp_url_sig=temp_url_signature'
+                          '&temp_url_expires=1400003600')
+    expected_body = '\n'.join([
+        method,
+        '1400003600',
+        url,
+    ]).encode('utf-8')
+
+    @mock.patch('hmac.HMAC')
     @mock.patch('time.time', return_value=1400000000)
     def test_generate_temp_url(self, time_mock, hmac_mock):
-        expected_url = (
-            '/v1/AUTH_account/c/o?'
-            'temp_url_sig=temp_url_signature&'
-            'temp_url_expires=1400003600')
-        url = u.generate_temp_url(self.url, self.seconds, self.key,
-                                  self.method)
-        self.assertEqual(url, expected_url)
+        hmac_mock().hexdigest.return_value = 'temp_url_signature'
+        url = u.generate_temp_url(self.url, self.seconds,
+                                  self.key, self.method)
+        key = self.key
+        if not isinstance(key, six.binary_type):
+            key = key.encode('utf-8')
+        self.assertEqual(url, self.expected_url)
+        self.assertEqual(hmac_mock.mock_calls, [
+            mock.call(),
+            mock.call(key, self.expected_body, sha1),
+            mock.call().hexdigest(),
+        ])
+        self.assertIsInstance(url, type(self.url))
+
+    def test_generate_temp_url_invalid_path(self):
+        with self.assertRaises(ValueError) as exc_manager:
+            u.generate_temp_url(b'/v1/a/c/\xff', self.seconds, self.key,
+                                self.method)
+        self.assertEqual(exc_manager.exception.args[0],
+                         'path must be representable as UTF-8')
 
     @mock.patch('hmac.HMAC.hexdigest', return_value="temp_url_signature")
     def test_generate_absolute_expiry_temp_url(self, hmac_mock):
-        expected_url = ('/v1/AUTH_account/c/o?'
-                        'temp_url_sig=temp_url_signature&'
-                        'temp_url_expires=2146636800')
+        if isinstance(self.expected_url, six.binary_type):
+            expected_url = self.expected_url.replace(
+                b'1400003600', b'2146636800')
+        else:
+            expected_url = self.expected_url.replace(
+                u'1400003600', u'2146636800')
         url = u.generate_temp_url(self.url, 2146636800, self.key, self.method,
                                   absolute=True)
         self.assertEqual(url, expected_url)
 
     def test_generate_temp_url_bad_seconds(self):
-        self.assertRaises(TypeError,
-                          u.generate_temp_url,
-                          self.url,
-                          'not_an_int',
-                          self.key,
-                          self.method)
-
-        self.assertRaises(ValueError,
-                          u.generate_temp_url,
-                          self.url,
-                          -1,
-                          self.key,
-                          self.method)
+        with self.assertRaises(TypeError) as exc_manager:
+            u.generate_temp_url(self.url, 'not_an_int', self.key, self.method)
+        self.assertEqual(exc_manager.exception.args[0],
+                         'seconds must be an integer')
+
+        with self.assertRaises(ValueError) as exc_manager:
+            u.generate_temp_url(self.url, -1, self.key, self.method)
+        self.assertEqual(exc_manager.exception.args[0],
+                         'seconds must be a positive integer')
+
+
+class TestTempURLUnicodePathAndKey(TestTempURL):
+    url = u'/v1/\u00e4/c/\u00f3'
+    key = u'k\u00e9y'
+    expected_url = (u'%s?temp_url_sig=temp_url_signature'
+                    u'&temp_url_expires=1400003600') % url
+    expected_body = u'\n'.join([
+        u'GET',
+        u'1400003600',
+        url,
+    ]).encode('utf-8')
+
+
+class TestTempURLUnicodePathBytesKey(TestTempURL):
+    url = u'/v1/\u00e4/c/\u00f3'
+    key = u'k\u00e9y'.encode('utf-8')
+    expected_url = (u'%s?temp_url_sig=temp_url_signature'
+                    u'&temp_url_expires=1400003600') % url
+    expected_body = '\n'.join([
+        u'GET',
+        u'1400003600',
+        url,
+    ]).encode('utf-8')
+
+
+class TestTempURLBytesPathUnicodeKey(TestTempURL):
+    url = u'/v1/\u00e4/c/\u00f3'.encode('utf-8')
+    key = u'k\u00e9y'
+    expected_url = url + (b'?temp_url_sig=temp_url_signature'
+                          b'&temp_url_expires=1400003600')
+    expected_body = b'\n'.join([
+        b'GET',
+        b'1400003600',
+        url,
+    ])
+
+
+class TestTempURLBytesPathAndKey(TestTempURL):
+    url = u'/v1/\u00e4/c/\u00f3'.encode('utf-8')
+    key = u'k\u00e9y'.encode('utf-8')
+    expected_url = url + (b'?temp_url_sig=temp_url_signature'
+                          b'&temp_url_expires=1400003600')
+    expected_body = b'\n'.join([
+        b'GET',
+        b'1400003600',
+        url,
+    ])
+
+
+class TestTempURLBytesPathAndNonUtf8Key(TestTempURL):
+    url = u'/v1/\u00e4/c/\u00f3'.encode('utf-8')
+    key = b'k\xffy'
+    expected_url = url + (b'?temp_url_sig=temp_url_signature'
+                          b'&temp_url_expires=1400003600')
+    expected_body = b'\n'.join([
+        b'GET',
+        b'1400003600',
+        url,
+    ])
 
 
 class TestReadableToIterable(unittest.TestCase):

From d460db84edb11cd57ed12b092a21224e870a4228 Mon Sep 17 00:00:00 2001
From: zheng yin <yin.zheng@easystack.cn>
Date: Mon, 25 Jul 2016 11:58:28 +0800
Subject: [PATCH 004/316] Modify assert

For example: self.assertEqual(a,None) is equal to self.assertIsNone(a)

Change-Id: I063145d034979cf3d36645a00a30cc27defac7c4
---
 tests/unit/test_service.py | 50 +++++++++++++++++++-------------------
 1 file changed, 25 insertions(+), 25 deletions(-)

diff --git a/tests/unit/test_service.py b/tests/unit/test_service.py
index 75f8961a..2e7acf95 100644
--- a/tests/unit/test_service.py
+++ b/tests/unit/test_service.py
@@ -59,7 +59,7 @@ def test_create(self):
         spo = self.spo('obj_name')
 
         self.assertEqual(spo.object_name, 'obj_name')
-        self.assertEqual(spo.options, None)
+        self.assertIsNone(spo.options)
 
     def test_create_with_invalid_name(self):
         # empty strings are not allowed as names
@@ -81,10 +81,10 @@ def test_create(self):
 
         self.assertEqual(sr._path, 'path')
         self.assertEqual(sr._body, 'body')
-        self.assertEqual(sr._content_length, None)
-        self.assertEqual(sr._expected_etag, None)
+        self.assertIsNone(sr._content_length)
+        self.assertIsNone(sr._expected_etag)
 
-        self.assertNotEqual(sr._actual_md5, None)
+        self.assertIsNotNone(sr._actual_md5)
         self.assertIs(type(sr._actual_md5), self.md5_type)
 
     def test_create_with_large_object_headers(self):
@@ -92,25 +92,25 @@ def test_create_with_large_object_headers(self):
         sr = self.sr('path', 'body', {'x-object-manifest': 'test'})
         self.assertEqual(sr._path, 'path')
         self.assertEqual(sr._body, 'body')
-        self.assertEqual(sr._content_length, None)
-        self.assertEqual(sr._expected_etag, None)
-        self.assertEqual(sr._actual_md5, None)
+        self.assertIsNone(sr._content_length)
+        self.assertIsNone(sr._expected_etag)
+        self.assertIsNone(sr._actual_md5)
 
         sr = self.sr('path', 'body', {'x-static-large-object': 'test'})
         self.assertEqual(sr._path, 'path')
         self.assertEqual(sr._body, 'body')
-        self.assertEqual(sr._content_length, None)
-        self.assertEqual(sr._expected_etag, None)
-        self.assertEqual(sr._actual_md5, None)
+        self.assertIsNone(sr._content_length)
+        self.assertIsNone(sr._expected_etag)
+        self.assertIsNone(sr._actual_md5)
 
     def test_create_with_ignore_checksum(self):
         # md5 should not be initialized if checksum is False
         sr = self.sr('path', 'body', {}, False)
         self.assertEqual(sr._path, 'path')
         self.assertEqual(sr._body, 'body')
-        self.assertEqual(sr._content_length, None)
-        self.assertEqual(sr._expected_etag, None)
-        self.assertEqual(sr._actual_md5, None)
+        self.assertIsNone(sr._content_length)
+        self.assertIsNone(sr._expected_etag)
+        self.assertIsNone(sr._actual_md5)
 
     def test_create_with_content_length(self):
         sr = self.sr('path', 'body', {'content-length': 5})
@@ -118,9 +118,9 @@ def test_create_with_content_length(self):
         self.assertEqual(sr._path, 'path')
         self.assertEqual(sr._body, 'body')
         self.assertEqual(sr._content_length, 5)
-        self.assertEqual(sr._expected_etag, None)
+        self.assertIsNone(sr._expected_etag)
 
-        self.assertNotEqual(sr._actual_md5, None)
+        self.assertIsNotNone(sr._actual_md5)
         self.assertIs(type(sr._actual_md5), self.md5_type)
 
         # Check Contentlength raises error if it isn't an integer
@@ -401,10 +401,10 @@ def test_empty_swifterror_creation(self):
         se = SwiftError(5)
 
         self.assertEqual(se.value, 5)
-        self.assertEqual(se.container, None)
-        self.assertEqual(se.obj, None)
-        self.assertEqual(se.segment, None)
-        self.assertEqual(se.exception, None)
+        self.assertIsNone(se.container)
+        self.assertIsNone(se.obj)
+        self.assertIsNone(se.segment)
+        self.assertIsNone(se.exception)
 
         self.assertEqual(str(se), '5')
 
@@ -526,12 +526,12 @@ def test_create_with_string(self):
         suo = self.suo('source')
         self.assertEqual(suo.source, 'source')
         self.assertEqual(suo.object_name, 'source')
-        self.assertEqual(suo.options, None)
+        self.assertIsNone(suo.options)
 
         suo = self.suo('source', 'obj_name')
         self.assertEqual(suo.source, 'source')
         self.assertEqual(suo.object_name, 'obj_name')
-        self.assertEqual(suo.options, None)
+        self.assertIsNone(suo.options)
 
         suo = self.suo('source', 'obj_name', {'opt': '123'})
         self.assertEqual(suo.source, 'source')
@@ -550,7 +550,7 @@ def test_create_with_file(self):
             suo = self.suo(mock_file, 'obj_name')
             self.assertEqual(suo.source, mock_file)
             self.assertEqual(suo.object_name, 'obj_name')
-            self.assertEqual(suo.options, None)
+            self.assertIsNone(suo.options)
 
             suo = self.suo(mock_file, 'obj_name', {'opt': '123'})
             self.assertEqual(suo.source, mock_file)
@@ -559,9 +559,9 @@ def test_create_with_file(self):
 
     def test_create_with_no_source(self):
         suo = self.suo(None, 'obj_name')
-        self.assertEqual(suo.source, None)
+        self.assertIsNone(suo.source)
         self.assertEqual(suo.object_name, 'obj_name')
-        self.assertEqual(suo.options, None)
+        self.assertIsNone(suo.options)
 
         # Check error is raised if source is None without an object name
         self.assertRaises(SwiftError, self.suo, None)
@@ -1868,7 +1868,7 @@ def test_download_with_objects_empty(self, mock_down_obj,
         mock_down_cont.assert_not_called()
 
         next(service.download('c', options=self.opts), None)
-        self.assertEqual(True, mock_down_cont.called)
+        self.assertTrue(mock_down_cont.called)
 
     def test_download_with_output_dir(self):
         with mock.patch('swiftclient.service.Connection') as mock_conn:

From 335570e511e5c3a748969d921714a8b9e287e1ac Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Thu, 4 Feb 2016 10:25:15 -0800
Subject: [PATCH 005/316] Add --json option to `swift capabilities` / `swift
 info`

This lets us do things like:

    $ swift info --json | jq '[.swift.policies[].name]'
    [
      "Standard-Replica",
      "EC"
    ]

Also, escape more dashes in the man page, so they won't be
misinterpreted as hyphens.

Change-Id: Ic7690bdbcfc55f55e5dde9bc11bb0644085973ce
---
 doc/manpages/swift.1     | 34 +++++++++++++++++++++-------------
 swiftclient/shell.py     | 25 ++++++++++++++++++-------
 tests/unit/test_shell.py | 16 ++++++++++++++++
 3 files changed, 55 insertions(+), 20 deletions(-)

diff --git a/doc/manpages/swift.1 b/doc/manpages/swift.1
index beefb818..efcb8e47 100644
--- a/doc/manpages/swift.1
+++ b/doc/manpages/swift.1
@@ -61,8 +61,8 @@ of container or objects being listed. With the \-t or \-\-total option they only
 .RS 4
 Uploads to the given container the files and directories specified by the
 remaining args. The \-c or \-\-changed is an option that will only upload files
-that have changed since the last upload. The \-\-object-name <object\-name> is
-an option that will upload file and name object to <object-name> or upload dir
+that have changed since the last upload. The \-\-object\-name <object\-name> is
+an option that will upload file and name object to <object\-name> or upload dir
 and use <object\-name> as object prefix. The \-S <size> or \-\-segment\-size <size>
 and \-\-leave\-segments and others are options as well (see swift upload \-\-help for more).
 .RE
@@ -86,7 +86,7 @@ container, or a list of objects depending on the args given. For a single
 object download, you may use the \-o [\-\-output] <filename> option to
 redirect the output to a specific file or if "-" then just redirect to stdout or
 with \-\-no-download actually not to write anything to disk.
-The \-\-ignore-checksum is an option that turn off checksum validation.
+The \-\-ignore-checksum is an option that turns off checksum validation.
 You can specify optional headers with the repeatable cURL-like option
 \-H [\-\-header]. For more details and options see swift download \-\-help.
 .RE
@@ -100,23 +100,31 @@ will be deleted as well, unless you specify the \-\-leave\-segments option.
 For more details and options see swift delete \-\-help.
 .RE
 
-\fBcapabilities\fR [\fIproxy-url\fR]
+\fBcapabilities\fR [\fIcommand-options\fR] [\fIproxy-url\fR]
 .RS 4
-Displays cluster capabilities. The output includes the list of the activated
-Swift middlewares as well as relevant options for each one. Additionally the
-command displays relevant options for the Swift core. If the proxy-url option
-is not provided the storage-url retrieved after authentication is used as
-proxy-url.
+Displays cluster capabilities. If the proxy-url option is not provided the
+storage-url retrieved after authentication is used as proxy-url.
+
+By default, the output includes the list of the activated Swift middlewares as
+well as relevant options for each one. Additionally the command displays
+relevant options for the Swift core.
+
+The \-\-json option will print a json representation of the cluster
+capabilities. This is typically more suitable for consumption by other
+programs, such as jq.
+
+\fBExample\fR: capabilities https://swift.example.com
+         capabilities \-\-json
 .RE
 
 \fBtempurl\fR [\fIcommand-option\fR] \fImethod\fR \fIseconds\fR \fIpath\fR \fIkey\fR
 .RS 4
 Generates a temporary URL allowing unauthenticated access to the Swift object
 at the given path, using the given HTTP method, for the given number of
-seconds, using the given TempURL key. If optional --absolute argument is
+seconds, using the given TempURL key. If optional \-\-absolute argument is
 provided, seconds is instead interpreted as a Unix timestamp at which the URL
-should expire. \fBExample\fR: tempurl GET $(date -d "Jan 1 2016" +%s)
-/v1/AUTH_foo/bar_container/quux.md my_secret_tempurl_key --absolute
+should expire. \fBExample\fR: tempurl GET $(date \-d "Jan 1 2016" +%s)
+/v1/AUTH_foo/bar_container/quux.md my_secret_tempurl_key \-\-absolute
 .RE
 
 \fBauth\fR
@@ -140,7 +148,7 @@ For examples see swift auth \-\-help.
 .IP "--os-help              Show all OpenStack authentication options"
 .PD
 .RS 4
-For more options see swift \-\-help and swift \-\-os-help.
+For more options see swift \-\-help and swift \-\-os\-help.
 .RE
 
 
diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index ef165d8d..cc34b7f6 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -17,6 +17,7 @@
 from __future__ import print_function, unicode_literals
 
 import argparse
+import json
 import logging
 import signal
 import socket
@@ -248,7 +249,7 @@ def st_delete(parser, args, output_manager):
   -H, --header <header:value>
                         Adds a customized request header to the query, like
                         "Range" or "If-Match". This option may be repeated.
-                        Example --header "content-type:text/plain"
+                        Example: --header "content-type:text/plain"
   --skip-identical      Skip downloading files that are identical on both
                         sides.
   --ignore-checksum     Turn off checksum validation for downloads.
@@ -789,7 +790,7 @@ def st_post(parser, args, output_manager):
                         Default is 10.
   -H, --header <header:value>
                         Adds a customized request header. This option may be
-                        repeated. Example -H "content-type:text/plain"
+                        repeated. Example: -H "content-type:text/plain"
                          -H "Content-Length: 4000".
   --use-slo             When used in conjunction with --segment-size it will
                         create a Static Large Object instead of the default
@@ -840,7 +841,7 @@ def st_upload(parser, args, output_manager):
     parser.add_argument(
         '-H', '--header', action='append', dest='header',
         default=[], help='Set request headers with the syntax header:value. '
-        ' This option may be repeated. Example -H "content-type:text/plain" '
+        ' This option may be repeated. Example: -H "content-type:text/plain" '
         '-H "Content-Length: 4000"')
     parser.add_argument(
         '--use-slo', action='store_true', default=False,
@@ -995,13 +996,16 @@ def st_upload(parser, args, output_manager):
             output_manager.error(e.value)
 
 
-st_capabilities_options = "[<proxy_url>]"
+st_capabilities_options = "[--json] [<proxy_url>]"
 st_info_options = st_capabilities_options
 st_capabilities_help = '''
 Retrieve capability of the proxy.
 
 Optional positional arguments:
   <proxy_url>           Proxy URL of the cluster to retrieve capabilities.
+
+Optional arguments:
+  --json                Print the cluster capabilities in JSON format.
 '''.strip('\n')
 st_info_help = st_capabilities_help
 
@@ -1017,6 +1021,8 @@ def _print_compo_cap(name, capabilities):
                                          key=lambda x: x[0]):
                     output_manager.print_msg("  %s: %s" % (key, value))
 
+    parser.add_argument('--json', action='store_true',
+                        help='print capability information in json')
     (options, args) = parse_args(parser, args)
     if args and len(args) > 2:
         output_manager.error('Usage: %s capabilities %s\n%s',
@@ -1034,9 +1040,14 @@ def _print_compo_cap(name, capabilities):
                 capabilities_result = swift.capabilities()
                 capabilities = capabilities_result['capabilities']
 
-            _print_compo_cap('Core', {'swift': capabilities['swift']})
-            del capabilities['swift']
-            _print_compo_cap('Additional middleware', capabilities)
+            if options['json']:
+                output_manager.print_msg(
+                    json.dumps(capabilities, sort_keys=True, indent=2))
+            else:
+                capabilities = dict(capabilities)
+                _print_compo_cap('Core', {'swift': capabilities['swift']})
+                del capabilities['swift']
+                _print_compo_cap('Additional middleware', capabilities)
         except SwiftError as e:
             output_manager.error(e.value)
 
diff --git a/tests/unit/test_shell.py b/tests/unit/test_shell.py
index 59f0d5f7..b786c777 100644
--- a/tests/unit/test_shell.py
+++ b/tests/unit/test_shell.py
@@ -16,6 +16,7 @@
 from genericpath import getmtime
 
 import hashlib
+import json
 import logging
 import mock
 import os
@@ -1285,6 +1286,21 @@ def test_capabilities(self, connection):
         swiftclient.shell.main(argv)
         connection.return_value.get_capabilities.assert_called_with(None)
 
+    @mock.patch('swiftclient.service.Connection')
+    def test_capabilities_json(self, connection):
+        capabilities = {
+            'slo': {'min_segment_size': 1000000},
+            'some': [{'arbitrary': 'nested'}, {'crazy': 'structure'}],
+            'swift': {'version': '2.5.0'}}
+
+        connection.return_value.get_capabilities.return_value = capabilities
+        argv = ["", "capabilities", "--json"]
+        with CaptureOutput(suppress_systemexit=True) as output:
+            swiftclient.shell.main(argv)
+        expected = json.dumps(capabilities, sort_keys=True, indent=2) + '\n'
+        self.assertEqual(expected, output.out)
+        connection.return_value.get_capabilities.assert_called_with(None)
+
     def test_human_readable_upload_segment_size(self):
         def _check_expected(x, expected):
             actual = x.call_args_list[-1][1]["options"]["segment_size"]

From ed4ee7927369cdd5056a3347edad674c3e9ee160 Mon Sep 17 00:00:00 2001
From: John Dickinson <me@not.mn>
Date: Thu, 11 Aug 2016 15:15:06 -0700
Subject: [PATCH 006/316] reenable sidebar links

uses new method from https://review.openstack.org/#/c/340509/

Change-Id: I4d19b71b632546fc2e5d5dac2b0d8d43152dabed
---
 doc/source/conf.py | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/doc/source/conf.py b/doc/source/conf.py
index 0b3e7e1a..5af77b2d 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -111,6 +111,8 @@
 # documentation.
 # html_theme_options = {}
 
+html_theme_options = {'show_other_versions': True}
+
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = []
 

From b1539d9c0feaaf26783e7cab3962219e036994ba Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Fri, 12 Aug 2016 21:14:25 +0200
Subject: [PATCH 007/316] Move other-requirements.txt to bindep.txt

The default filename for documenting binary dependencies has been
changed from "other-requirements.txt" to "bindep.txt" with the release
of bindep 2.1.0. While the previous name is still supported, it will
be deprecated.

Move the file around to follow this change.

Note that this change is self-testing, the OpenStack CI infrastructure
will use a "bindep.txt" file to setup nodes for testing.

For more information about bindep, see also:
http://docs.openstack.org/infra/manual/drivers.html#package-requirements
http://docs.openstack.org/infra/bindep/

As well as this announcement:
http://lists.openstack.org/pipermail/openstack-dev/2016-August/101590.html

Change-Id: I384cdb39c1f65218bb5c6f76afc381c1799b623e
---
 other-requirements.txt => bindep.txt | 0
 1 file changed, 0 insertions(+), 0 deletions(-)
 rename other-requirements.txt => bindep.txt (100%)

diff --git a/other-requirements.txt b/bindep.txt
similarity index 100%
rename from other-requirements.txt
rename to bindep.txt

From 8fbe118cea8804fe29529a27f3937af412b47fb7 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Wed, 17 Aug 2016 16:01:23 -0700
Subject: [PATCH 008/316] Strip leading/trailing whitespace from headers

New versions of requests will raise an InvalidHeader error otherwise.

Change-Id: Idf3bcd8ac359bdda9a847bf99a78988943374134
Closes-Bug: #1614280
Closes-Bug: #1613814
---
 swiftclient/service.py     | 2 +-
 tests/unit/test_service.py | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/swiftclient/service.py b/swiftclient/service.py
index 6ccba552..3820ace9 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -280,7 +280,7 @@ def split_headers(options, prefix=''):
     for item in options:
         split_item = item.split(':', 1)
         if len(split_item) == 2:
-            headers[(prefix + split_item[0]).title()] = split_item[1]
+            headers[(prefix + split_item[0]).title()] = split_item[1].strip()
         else:
             raise SwiftError(
                 "Metadata parameter %s must contain a ':'.\n%s"
diff --git a/tests/unit/test_service.py b/tests/unit/test_service.py
index 2e7acf95..989699f7 100644
--- a/tests/unit/test_service.py
+++ b/tests/unit/test_service.py
@@ -496,7 +496,7 @@ def test_process_options_new_style_args(self):
         self.assertEqual(opt_c['key'], 'key')
 
     def test_split_headers(self):
-        mock_headers = ['color:blue', 'size:large']
+        mock_headers = ['color:blue', 'SIZE: large']
         expected = {'Color': 'blue', 'Size': 'large'}
 
         actual = swiftclient.service.split_headers(mock_headers)

From 4a2465fb12ff7287b62b6941fb8ae43e100adc25 Mon Sep 17 00:00:00 2001
From: Marek Kaleta <Marek.Kaleta@firma.seznam.cz>
Date: Mon, 15 Feb 2016 12:14:17 +0100
Subject: [PATCH 009/316] Add copy object method

Implement copy object method in swiftclient Connection, Service and CLI.

Although COPY functionality can be accomplished with 'X-Copy-From'
header in PUT request, using copy is more convenient especially when
using copy for updating object metadata non-destructively.

Closes-Bug: 1474939
Change-Id: I1338ac411f418f4adb3d06753d044a484a7f32a4
---
 doc/manpages/swift.1                 |  13 ++
 doc/source/cli.rst                   |  14 ++
 doc/source/service-api.rst           |  82 +++++++++-
 examples/copy.py                     |  30 ++++
 swiftclient/client.py                |  71 +++++++++
 swiftclient/service.py               | 225 ++++++++++++++++++++++++++-
 swiftclient/shell.py                 | 102 +++++++++++-
 tests/functional/test_swiftclient.py |  40 +++++
 tests/unit/test_service.py           | 106 +++++++++++++
 tests/unit/test_shell.py             | 133 ++++++++++++++++
 tests/unit/test_swiftclient.py       | 104 +++++++++++++
 11 files changed, 914 insertions(+), 6 deletions(-)
 create mode 100644 examples/copy.py

diff --git a/doc/manpages/swift.1 b/doc/manpages/swift.1
index b9f99c4d..7c2ee896 100644
--- a/doc/manpages/swift.1
+++ b/doc/manpages/swift.1
@@ -79,6 +79,19 @@ For more details and options see swift post \-\-help.
 \fBExample\fR: post \-m Color:Blue \-m Size:Large
 .RE
 
+\fBcopy\fR [\fIcommand-options\fR] \fIcontainer\fR \fIobject\fR
+.RS 4
+Copies an object to a new destination or adds user metadata to the object (current
+user metadata will be preserved, in contrast with the post command) depending
+on the args given. The \-\-destination option sets the destination in the form
+/container/object. If not set, the object will be copied onto itself which is useful
+for adding metadata. The \-M or \-\-fresh\-metadata option copies the object without
+the existing user metadata. The \-m or \-\-meta option is always allowed and is used
+to define the user metadata items to set in the form Name:Value (this option
+can be repeated).
+For more details and options see swift copy \-\-help.
+.RE
+
 \fBdownload\fR [\fIcommand-options\fR] [\fIcontainer\fR] [\fIobject\fR] [\fIobject\fR] [...]
 .RS 4
 Downloads everything in the account (with \-\-all), or everything in a
diff --git a/doc/source/cli.rst b/doc/source/cli.rst
index 12de02ff..76630be9 100644
--- a/doc/source/cli.rst
+++ b/doc/source/cli.rst
@@ -199,6 +199,20 @@ Delete
        of manifest objects will be deleted as well, unless you specify the
        ``--leave-segments`` option.
 
+Copy
+----
+
+    ``copy [command-options] container object``
+
+       Copies an object to a new destination or adds user metadata to an object. Depending
+       on the options supplied, you can preserve existing metadata in contrast to the post
+       command. The ``--destination`` option sets the copy target destination in the form
+       ``/container/object``. If not set, the object will be copied onto itself which is useful
+       for adding metadata. You can use the ``-M`` or ``--fresh-metadata`` option to copy
+       an object without existing user meta data, and the ``-m`` or ``--meta`` option
+       to define user meta data items to set in the form ``Name:Value``. You can repeat
+       this option. For example: ``copy -m Color:Blue -m Size:Large``.
+
 Capabilities
 ------------
 
diff --git a/doc/source/service-api.rst b/doc/source/service-api.rst
index 50dd80e8..aeb3daac 100644
--- a/doc/source/service-api.rst
+++ b/doc/source/service-api.rst
@@ -217,6 +217,17 @@ Options
         are downloaded in lexically-sorted order. Setting this option to ``True``
         gives the same shuffling behaviour as the CLI.
 
+    ``destination``: ``None``
+        When copying objects, this specifies the destination where the object
+        will be copied to.  The default of None means copy will be the same as
+        source.
+
+    ``fresh_metadata``: ``None``
+        When copying objects, this specifies that the object metadata on the
+        source will *not* be applied to the destination object - the
+        destination object will have a new fresh set of metadata that includes
+        *only* the metadata specified in the meta option if any at all.
+
 Other available options can be found in ``swiftclient/service.py`` in the
 source code for ``python-swiftclient``. Each ``SwiftService`` method also allows
 for an optional dictionary to override those specified at init time, and the
@@ -735,13 +746,76 @@ Example
 
 The code below demonstrates the use of ``delete`` to remove a given list of
 objects from a specified container. As the objects are deleted the transaction
-id of the relevant request is printed along with the object name and number
-of attempts required. By printing the transaction id, the printed operations
+ID of the relevant request is printed along with the object name and number
+of attempts required. By printing the transaction ID, the printed operations
 can be easily linked to events in the swift server logs:
 
 .. literalinclude:: ../../examples/delete.py
    :language: python
 
+Copy
+~~~~
+
+Copy can be called to copy an object or update the metadata on the given items.
+
+Each element of the object list may be a plain string of the object name, or a
+``SwiftCopyObject`` that allows finer control over the options applied to each
+of the individual copy operations (destination, fresh_metadata, options).
+
+Destination should be in format /container/object; if not set, the object will be
+copied onto itself. Fresh_metadata sets mode of operation on metadata. If not set,
+current object user metadata will be copied/preserved; if set, all current user
+metadata will be removed.
+
+Returns an iterator over the results generated for each object copy (and may
+also include the results of creating destination containers).
+
+When a string is given for the object name, destination and fresh metadata will
+default to None and None, which result in adding metadata to existing objects.
+
+Successful copy results are dictionaries as described below:
+
+.. code-block:: python
+
+   {
+       'action': 'copy_object',
+       'success': True,
+       'container': <container>,
+       'object': <object>,
+       'destination': <destination>,
+       'headers': {},
+       'fresh_metadata': <boolean>,
+       'response_dict': <HTTP response details>
+   }
+
+Any failure in a copy operation will return a failure dictionary as described
+below:
+
+.. code-block:: python
+
+   {
+       'action': 'copy_object',
+       'success': False,
+       'container': <container>,
+       'object': <object>,
+       'destination': <destination>,
+       'headers': {},
+       'fresh_metadata': <boolean>,
+       'response_dict': <HTTP response details>,
+       'error': <error>,
+       'traceback': <traceback>,
+       'error_timestamp': <timestamp>
+   }
+
+Example
+-------
+
+The code below demonstrates the use of ``copy`` to add new user metadata for
+objects a and b, and to copy object c to d (with added metadata).
+
+.. literalinclude:: ../../examples/copy.py
+   :language: python
+
 Capabilities
 ~~~~~~~~~~~~
 
@@ -764,7 +838,7 @@ returned with the contents described below:
     }
 
 The contents of the capabilities dictionary contain the core swift capabilities
-under the key ``swift``, all other keys show the configuration options for
+under the key ``swift``; all other keys show the configuration options for
 additional middlewares deployed in the proxy pipeline. An example capabilities
 dictionary is given below:
 
@@ -819,7 +893,7 @@ Example
 ^^^^^^^
 
 The code below demonstrates the use of ``capabilities`` to determine if the
-Swift cluster supports static large objects, and if so,  the maximum number of
+Swift cluster supports static large objects, and if so, the maximum number of
 segments that can be described in a single manifest file, along with the
 size restrictions on those objects:
 
diff --git a/examples/copy.py b/examples/copy.py
new file mode 100644
index 00000000..e928db4e
--- /dev/null
+++ b/examples/copy.py
@@ -0,0 +1,30 @@
+import logging
+
+from swiftclient.service import SwiftService, SwiftCopyObject, SwiftError
+
+logging.basicConfig(level=logging.ERROR)
+logging.getLogger("requests").setLevel(logging.CRITICAL)
+logging.getLogger("swiftclient").setLevel(logging.CRITICAL)
+logger = logging.getLogger(__name__)
+
+with SwiftService() as swift:
+    try:
+        obj = SwiftCopyObject("c", {"Destination": "/cont/d"})
+        for i in swift.copy(
+                "cont", ["a", "b", obj],
+                {"meta": ["foo:bar"], "Destination": "/cc"}):
+            if i["success"]:
+                if i["action"] == "copy_object":
+                    print(
+                        "object %s copied from /%s/%s" %
+                        (i["destination"], i["container"], i["object"])
+                    )
+                if i["action"] == "create_container":
+                    print(
+                        "container %s created" % i["container"]
+                    )
+            else:
+                if "error" in i and isinstance(i["error"], Exception):
+                    raise i["error"]
+    except SwiftError as e:
+        logger.error(e.value)
diff --git a/swiftclient/client.py b/swiftclient/client.py
index 744a876b..5b3fa725 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -1319,6 +1319,70 @@ def post_object(url, token, container, name, headers, http_conn=None,
         raise ClientException.from_response(resp, 'Object POST failed', body)
 
 
+def copy_object(url, token, container, name, destination=None,
+                headers=None, fresh_metadata=None, http_conn=None,
+                response_dict=None, service_token=None):
+    """
+    Copy object
+
+    :param url: storage URL
+    :param token: auth token; if None, no token will be sent
+    :param container: container name that the source object is in
+    :param name: source object name
+    :param destination: The container and object name of the destination object
+                        in the form of /container/object; if None, the copy
+                        will use the source as the destination.
+    :param headers: additional headers to include in the request
+    :param fresh_metadata: Enables object creation that omits existing user
+                           metadata, default None
+    :param http_conn: HTTP connection object (If None, it will create the
+                      conn object)
+    :param response_dict: an optional dictionary into which to place
+                     the response - status, reason and headers
+    :param service_token: service auth token
+    :raises ClientException: HTTP COPY request failed
+    """
+    if http_conn:
+        parsed, conn = http_conn
+    else:
+        parsed, conn = http_connection(url)
+
+    path = parsed.path
+    container = quote(container)
+    name = quote(name)
+    path = '%s/%s/%s' % (path.rstrip('/'), container, name)
+
+    headers = dict(headers) if headers else {}
+
+    if destination is not None:
+        headers['Destination'] = quote(destination)
+    elif container and name:
+        headers['Destination'] = '/%s/%s' % (container, name)
+
+    if token is not None:
+        headers['X-Auth-Token'] = token
+    if service_token is not None:
+        headers['X-Service-Token'] = service_token
+
+    if fresh_metadata is not None:
+        # remove potential fresh metadata headers
+        for fresh_hdr in [hdr for hdr in headers.keys()
+                          if hdr.lower() == 'x-fresh-metadata']:
+            headers.pop(fresh_hdr)
+        headers['X-Fresh-Metadata'] = 'true' if fresh_metadata else 'false'
+
+    conn.request('COPY', path, '', headers)
+    resp = conn.getresponse()
+    body = resp.read()
+    http_log(('%s%s' % (url.replace(parsed.path, ''), path), 'COPY',),
+             {'headers': headers}, resp, body)
+
+    store_response(resp, response_dict)
+
+    if resp.status < 200 or resp.status >= 300:
+        raise ClientException.from_response(resp, 'Object COPY failed', body)
+
+
 def delete_object(url, token=None, container=None, name=None, http_conn=None,
                   headers=None, proxy=None, query_string=None,
                   response_dict=None, service_token=None):
@@ -1711,6 +1775,13 @@ def post_object(self, container, obj, headers, response_dict=None):
         return self._retry(None, post_object, container, obj, headers,
                            response_dict=response_dict)
 
+    def copy_object(self, container, obj, destination=None, headers=None,
+                    fresh_metadata=None, response_dict=None):
+        """Wrapper for :func:`copy_object`"""
+        return self._retry(None, copy_object, container, obj, destination,
+                           headers, fresh_metadata,
+                           response_dict=response_dict)
+
     def delete_object(self, container, obj, query_string=None,
                       response_dict=None):
         """Wrapper for :func:`delete_object`"""
diff --git a/swiftclient/service.py b/swiftclient/service.py
index 12d3f210..a813d163 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -200,7 +200,9 @@ def _build_default_global_options():
     'human': False,
     'dir_marker': False,
     'checksum': True,
-    'shuffle': False
+    'shuffle': False,
+    'destination': None,
+    'fresh_metadata': False,
 }
 
 POLICY = 'X-Storage-Policy'
@@ -330,6 +332,42 @@ def __init__(self, object_name, options=None):
             self.options = options
 
 
+class SwiftCopyObject(object):
+    """
+    Class for specifying an object copy,
+    allowing the destination/headers/metadata/fresh_metadata to be specified
+    separately for each individual object.
+    destination and fresh_metadata should be set in options
+    """
+    def __init__(self, object_name, options=None):
+        if not isinstance(object_name, string_types) or not object_name:
+            raise SwiftError(
+                "Object names must be specified as non-empty strings"
+            )
+
+        self.object_name = object_name
+        self.options = options
+
+        if self.options is None:
+            self.destination = None
+            self.fresh_metadata = False
+        else:
+            self.destination = self.options.get('destination')
+            self.fresh_metadata = self.options.get('fresh_metadata', False)
+
+        if self.destination is not None:
+            destination_components = self.destination.split('/')
+            if destination_components[0] or len(destination_components) < 2:
+                raise SwiftError("destination must be in format /cont[/obj]")
+            if not destination_components[-1]:
+                raise SwiftError("destination must not end in a slash")
+            if len(destination_components) == 2:
+                # only container set in destination
+                self.destination = "{0}/{1}".format(
+                    self.destination, object_name
+                )
+
+
 class _SwiftReader(object):
     """
     Class for downloading objects from swift and raising appropriate
@@ -2389,6 +2427,191 @@ def _bulkdelete(conn, container, objects, options):
 
         return res
 
+    # Copy related methods
+    #
+    def copy(self, container, objects, options=None):
+        """
+        Copy operations on a list of objects in a container. Destination
+        containers will be created.
+
+        :param container: The container from which to copy the objects.
+        :param objects: A list of object names (strings) or SwiftCopyObject
+                        instances containing an object name and an
+                        options dict (can be None) to override the options for
+                        that individual copy operation::
+
+                            [
+                                'object_name',
+                                SwiftCopyObject(
+                                    'object_name',
+                                     options={
+                                        'destination': '/container/object',
+                                        'fresh_metadata': False,
+                                        ...
+                                        }),
+                                ...
+                            ]
+
+                        The options dict is described below.
+        :param options: A dictionary containing options to override the global
+                        options specified during the service object creation.
+                        These options are applied to all copy operations
+                        performed by this call, unless overridden on a per
+                        object basis.
+                        The options "destination" and "fresh_metadata" do
+                        not need to be set, in this case objects will be
+                        copied onto themselves and metadata will not be
+                        refreshed.
+                        The option "destination" can also be specified in the
+                        format '/container', in which case objects without an
+                        explicit destination will be copied to the destination
+                        /container/original_object_name. Combinations of
+                        multiple objects and a destination in the format
+                        '/container/object' is invalid. Possible options are
+                        given below::
+
+                            {
+                                'meta': [],
+                                'header': [],
+                                'destination': '/container/object',
+                                'fresh_metadata': False,
+                            }
+
+        :returns: A generator returning the results of copying the given list
+                  of objects.
+
+        :raises: SwiftError
+        """
+        if options is not None:
+            options = dict(self._options, **options)
+        else:
+            options = self._options
+
+        # Try to create the container, just in case it doesn't exist. If this
+        # fails, it might just be because the user doesn't have container PUT
+        # permissions, so we'll ignore any error. If there's really a problem,
+        # it'll surface on the first object COPY.
+        containers = set(
+            next(p for p in obj.destination.split("/") if p)
+            for obj in objects
+            if isinstance(obj, SwiftCopyObject) and obj.destination
+        )
+        if options.get('destination'):
+            destination_split = options['destination'].split('/')
+            if destination_split[0]:
+                raise SwiftError("destination must be in format /cont[/obj]")
+            _str_objs = [
+                o for o in objects if not isinstance(o, SwiftCopyObject)
+            ]
+            if len(destination_split) > 2 and len(_str_objs) > 1:
+                # TODO (clayg): could be useful to copy multiple objects into
+                # a destination like "/container/common/prefix/for/objects/"
+                # where the trailing "/" indicates the destination option is a
+                # prefix!
+                raise SwiftError("Combination of multiple objects and "
+                                 "destination including object is invalid")
+            if destination_split[-1] == '':
+                # N.B. this protects the above case
+                raise SwiftError("destination can not end in a slash")
+            containers.add(destination_split[1])
+
+        policy_header = {}
+        _header = split_headers(options["header"])
+        if POLICY in _header:
+            policy_header[POLICY] = _header[POLICY]
+        create_containers = [
+            self.thread_manager.container_pool.submit(
+                self._create_container_job, cont, headers=policy_header)
+            for cont in containers
+        ]
+
+        # wait for container creation jobs to complete before any COPY
+        for r in interruptable_as_completed(create_containers):
+            res = r.result()
+            yield res
+
+        copy_futures = []
+        copy_objects = self._make_copy_objects(objects, options)
+        for copy_object in copy_objects:
+            obj = copy_object.object_name
+            obj_options = copy_object.options
+            destination = copy_object.destination
+            fresh_metadata = copy_object.fresh_metadata
+            headers = split_headers(
+                options['meta'], 'X-Object-Meta-')
+            # add header options to the headers object for the request.
+            headers.update(
+                split_headers(options['header'], ''))
+            if obj_options is not None:
+                if 'meta' in obj_options:
+                    headers.update(
+                        split_headers(
+                            obj_options['meta'], 'X-Object-Meta-'
+                        )
+                    )
+                if 'header' in obj_options:
+                    headers.update(
+                        split_headers(obj_options['header'], '')
+                    )
+
+            copy = self.thread_manager.object_uu_pool.submit(
+                self._copy_object_job, container, obj, destination,
+                headers, fresh_metadata
+            )
+            copy_futures.append(copy)
+
+        for r in interruptable_as_completed(copy_futures):
+            res = r.result()
+            yield res
+
+    @staticmethod
+    def _make_copy_objects(objects, options):
+        copy_objects = []
+
+        for o in objects:
+            if isinstance(o, string_types):
+                obj = SwiftCopyObject(o, options)
+                copy_objects.append(obj)
+            elif isinstance(o, SwiftCopyObject):
+                copy_objects.append(o)
+            else:
+                raise SwiftError(
+                    "The copy operation takes only strings or "
+                    "SwiftCopyObjects as input",
+                    obj=o)
+
+        return copy_objects
+
+    @staticmethod
+    def _copy_object_job(conn, container, obj, destination, headers,
+                         fresh_metadata):
+        response_dict = {}
+        res = {
+            'success': True,
+            'action': 'copy_object',
+            'container': container,
+            'object': obj,
+            'destination': destination,
+            'headers': headers,
+            'fresh_metadata': fresh_metadata,
+            'response_dict': response_dict
+        }
+        try:
+            conn.copy_object(
+                container, obj, destination=destination, headers=headers,
+                fresh_metadata=fresh_metadata, response_dict=response_dict)
+        except Exception as err:
+            traceback, err_time = report_traceback()
+            logger.exception(err)
+            res.update({
+                'success': False,
+                'error': err,
+                'traceback': traceback,
+                'error_timestamp': err_time
+            })
+
+        return res
+
     # Capabilities related methods
     #
     def capabilities(self, url=None, refresh_cache=False):
diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 5eafe0b6..8da0e7ba 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -46,7 +46,7 @@
     from pipes import quote as sh_quote
 
 BASENAME = 'swift'
-commands = ('delete', 'download', 'list', 'post', 'stat', 'upload',
+commands = ('delete', 'download', 'list', 'post', 'copy', 'stat', 'upload',
             'capabilities', 'info', 'tempurl', 'auth')
 
 
@@ -746,6 +746,105 @@ def st_post(parser, args, output_manager):
             output_manager.error(e.value)
 
 
+st_copy_options = '''[--destination </container/object>] [--fresh-metadata]
+                  [--meta <name:value>] [--header <header>] container object
+'''
+
+st_copy_help = '''
+Copies object to new destination, optionally updates objects metadata.
+If destination is not set, will update metadata of object
+
+Positional arguments:
+  container             Name of container to copy from.
+  object                Name of object to copy. Specify multiple times
+                        for multiple objects
+
+Optional arguments:
+  -d, --destination </container[/object]>
+                        The container and name of the destination object. Name
+                        of destination object can be ommited, then will be
+                        same as name of source object. Supplying multiple
+                        objects and destination with object name is invalid.
+  -M, --fresh-metadata  Copy the object without any existing metadata,
+                        If not set, metadata will be preserved or appended
+  -m, --meta <name:value>
+                        Sets a meta data item. This option may be repeated.
+                        Example: -m Color:Blue -m Size:Large
+  -H, --header <header:value>
+                        Adds a customized request header.
+                        This option may be repeated. Example
+                        -H "content-type:text/plain" -H "Content-Length: 4000"
+'''.strip('\n')
+
+
+def st_copy(parser, args, output_manager):
+    parser.add_argument(
+        '-d', '--destination', help='The container and name of the '
+        'destination object')
+    parser.add_argument(
+        '-M', '--fresh-metadata', action='store_true',
+        help='Copy the object without any existing metadata', default=False)
+    parser.add_argument(
+        '-m', '--meta', action='append', dest='meta', default=[],
+        help='Sets a meta data item. This option may be repeated. '
+        'Example: -m Color:Blue -m Size:Large')
+    parser.add_argument(
+        '-H', '--header', action='append', dest='header',
+        default=[], help='Adds a customized request header. '
+        'This option may be repeated. '
+        'Example: -H "content-type:text/plain" '
+        '-H "Content-Length: 4000"')
+    (options, args) = parse_args(parser, args)
+    args = args[1:]
+
+    with SwiftService(options=options) as swift:
+        try:
+            if len(args) >= 2:
+                container = args[0]
+                if '/' in container:
+                    output_manager.error(
+                        'WARNING: / in container name; you might have '
+                        "meant '%s' instead of '%s'." %
+                        (args[0].replace('/', ' ', 1), args[0]))
+                    return
+                objects = [arg for arg in args[1:]]
+
+                for r in swift.copy(
+                        container=container, objects=objects,
+                        options=options):
+                    if r['success']:
+                        if options['verbose']:
+                            if r['action'] == 'copy_object':
+                                output_manager.print_msg(
+                                    '%s/%s copied to %s' % (
+                                        r['container'],
+                                        r['object'],
+                                        r['destination'] or '<self>'))
+                            if r['action'] == 'create_container':
+                                output_manager.print_msg(
+                                    'created container %s' % r['container']
+                                )
+                    else:
+                        error = r['error']
+                        if 'action' in r and r['action'] == 'create_container':
+                            # it is not an error to be unable to create the
+                            # container so print a warning and carry on
+                            output_manager.warning(
+                                'Warning: failed to create container '
+                                "'%s': %s", container, error
+                            )
+                        else:
+                            output_manager.error("%s" % error)
+            else:
+                output_manager.error(
+                    'Usage: %s copy %s\n%s', BASENAME,
+                    st_copy_options, st_copy_help)
+                return
+
+        except SwiftError as e:
+            output_manager.error(e.value)
+
+
 st_upload_options = '''[--changed] [--skip-identical] [--segment-size <size>]
                     [--segment-container <container>] [--leave-segments]
                     [--object-threads <thread>] [--segment-threads <threads>]
@@ -1268,6 +1367,7 @@ def main(arguments=None):
                          for a container.
     post                 Updates meta information for the account, container,
                          or object; creates containers if not present.
+    copy                 Copies object, optionally adds meta
     stat                 Displays information for the account, container,
                          or object.
     upload               Uploads files or directories to the given container.
diff --git a/tests/functional/test_swiftclient.py b/tests/functional/test_swiftclient.py
index 7a77c071..6e19abdb 100644
--- a/tests/functional/test_swiftclient.py
+++ b/tests/functional/test_swiftclient.py
@@ -405,6 +405,46 @@ def test_post_object(self):
         headers = self.conn.head_object(self.containername, self.objectname)
         self.assertEqual('Something', headers.get('x-object-meta-color'))
 
+    def test_copy_object(self):
+        self.conn.put_object(
+            self.containername, self.objectname, self.test_data)
+        self.conn.copy_object(self.containername,
+                              self.objectname,
+                              headers={'x-object-meta-color': 'Something'})
+
+        headers = self.conn.head_object(self.containername, self.objectname)
+        self.assertEqual('Something', headers.get('x-object-meta-color'))
+
+        self.conn.copy_object(self.containername,
+                              self.objectname,
+                              headers={'x-object-meta-taste': 'Second'})
+
+        headers = self.conn.head_object(self.containername, self.objectname)
+        self.assertEqual('Something', headers.get('x-object-meta-color'))
+        self.assertEqual('Second', headers.get('x-object-meta-taste'))
+
+        destination = "/%s/%s" % (self.containername, self.objectname_2)
+        self.conn.copy_object(self.containername,
+                              self.objectname,
+                              destination,
+                              headers={'x-object-meta-taste': 'Second'})
+        headers, data = self.conn.get_object(self.containername,
+                                             self.objectname_2)
+        self.assertEqual(self.test_data, data)
+        self.assertEqual('Something', headers.get('x-object-meta-color'))
+        self.assertEqual('Second', headers.get('x-object-meta-taste'))
+
+        destination = "/%s/%s" % (self.containername, self.objectname_2)
+        self.conn.copy_object(self.containername,
+                              self.objectname,
+                              destination,
+                              headers={'x-object-meta-color': 'Else'},
+                              fresh_metadata=True)
+
+        headers = self.conn.head_object(self.containername, self.objectname_2)
+        self.assertEqual('Else', headers.get('x-object-meta-color'))
+        self.assertIsNone(headers.get('x-object-meta-taste'))
+
     def test_get_capabilities(self):
         resp = self.conn.get_capabilities()
         self.assertTrue(resp.get('swift'))
diff --git a/tests/unit/test_service.py b/tests/unit/test_service.py
index cce8c7a9..5b04c44a 100644
--- a/tests/unit/test_service.py
+++ b/tests/unit/test_service.py
@@ -69,6 +69,42 @@ def test_create_with_invalid_name(self):
         self.assertRaises(SwiftError, self.spo, 1)
 
 
+class TestSwiftCopyObject(unittest.TestCase):
+
+    def setUp(self):
+        super(TestSwiftCopyObject, self).setUp()
+        self.sco = swiftclient.service.SwiftCopyObject
+
+    def test_create(self):
+        sco = self.sco('obj_name')
+
+        self.assertEqual(sco.object_name, 'obj_name')
+        self.assertIsNone(sco.destination)
+        self.assertFalse(sco.fresh_metadata)
+
+        sco = self.sco('obj_name',
+                       {'destination': '/dest', 'fresh_metadata': True})
+
+        self.assertEqual(sco.object_name, 'obj_name')
+        self.assertEqual(sco.destination, '/dest/obj_name')
+        self.assertTrue(sco.fresh_metadata)
+
+        sco = self.sco('obj_name',
+                       {'destination': '/dest/new_obj/a',
+                        'fresh_metadata': False})
+
+        self.assertEqual(sco.object_name, 'obj_name')
+        self.assertEqual(sco.destination, '/dest/new_obj/a')
+        self.assertFalse(sco.fresh_metadata)
+
+    def test_create_with_invalid_name(self):
+        # empty strings are not allowed as names
+        self.assertRaises(SwiftError, self.sco, '')
+
+        # names cannot be anything but strings
+        self.assertRaises(SwiftError, self.sco, 1)
+
+
 class TestSwiftReader(unittest.TestCase):
 
     def setUp(self):
@@ -2344,3 +2380,73 @@ def test_object_post(self, res_iter, thread_manager):
 
         res_iter.assert_called_with(
             [tm_instance.object_uu_pool.submit()] * len(calls))
+
+
+class TestServiceCopy(_TestServiceBase):
+
+    def setUp(self):
+        super(TestServiceCopy, self).setUp()
+        self.opts = swiftclient.service._default_local_options.copy()
+
+    @mock.patch('swiftclient.service.MultiThreadingManager')
+    @mock.patch('swiftclient.service.interruptable_as_completed')
+    def test_object_copy(self, inter_compl, thread_manager):
+        """
+        Check copy method translates strings and objects to _copy_object_job
+        calls correctly
+        """
+        tm_instance = Mock()
+        thread_manager.return_value = tm_instance
+
+        self.opts.update({'meta': ["meta1:test1"], "header": ["hdr1:test1"]})
+        sco = swiftclient.service.SwiftCopyObject(
+            "test_sco",
+            options={'meta': ["meta1:test2"], "header": ["hdr1:test2"],
+                     'destination': "/cont_new/test_sco"})
+
+        res = SwiftService().copy('test_c', ['test_o', sco], self.opts)
+        res = list(res)
+
+        calls = [
+            mock.call(
+                SwiftService._create_container_job, 'cont_new', headers={}),
+        ]
+        tm_instance.container_pool.submit.assert_has_calls(calls,
+                                                           any_order=True)
+        self.assertEqual(
+            tm_instance.container_pool.submit.call_count, len(calls))
+
+        calls = [
+            mock.call(
+                SwiftService._copy_object_job, 'test_c', 'test_o',
+                None,
+                {
+                    "X-Object-Meta-Meta1": "test1",
+                    "Hdr1": "test1"},
+                False),
+            mock.call(
+                SwiftService._copy_object_job, 'test_c', 'test_sco',
+                '/cont_new/test_sco',
+                {
+                    "X-Object-Meta-Meta1": "test2",
+                    "Hdr1": "test2"},
+                False),
+        ]
+        tm_instance.object_uu_pool.submit.assert_has_calls(calls)
+        self.assertEqual(
+            tm_instance.object_uu_pool.submit.call_count, len(calls))
+
+        inter_compl.assert_called_with(
+            [tm_instance.object_uu_pool.submit()] * len(calls))
+
+    def test_object_copy_fail_dest(self):
+        """
+        Destination in incorrect format and destination with object
+        used when multiple objects are copied raises SwiftError
+        """
+        with self.assertRaises(SwiftError):
+            list(SwiftService().copy('test_c', ['test_o'],
+                                     {'destination': 'cont'}))
+        with self.assertRaises(SwiftError):
+            list(SwiftService().copy('test_c', ['test_o', 'test_o2'],
+                                     {'destination': '/cont/obj'}))
diff --git a/tests/unit/test_shell.py b/tests/unit/test_shell.py
index d82def62..407076b3 100644
--- a/tests/unit/test_shell.py
+++ b/tests/unit/test_shell.py
@@ -1244,6 +1244,139 @@ def test_post_object_too_many_args(self):
             self.assertTrue(output.err != '')
             self.assertTrue(output.err.startswith('Usage'))
 
+    @mock.patch('swiftclient.service.Connection')
+    def test_copy_object_no_destination(self, connection):
+        argv = ["", "copy", "container", "object",
+                "--meta", "Color:Blue",
+                "--header", "content-type:text/plain"
+                ]
+        with CaptureOutput() as output:
+            swiftclient.shell.main(argv)
+            connection.return_value.copy_object.assert_called_with(
+                'container', 'object', destination=None, fresh_metadata=False,
+                headers={
+                    'Content-Type': 'text/plain',
+                    'X-Object-Meta-Color': 'Blue'}, response_dict={})
+        self.assertEqual(output.out, 'container/object copied to <self>\n')
+
+    @mock.patch('swiftclient.service.Connection')
+    def test_copy_object(self, connection):
+        argv = ["", "copy", "container", "object",
+                "--meta", "Color:Blue",
+                "--header", "content-type:text/plain",
+                "--destination", "/c/o"
+                ]
+        with CaptureOutput() as output:
+            swiftclient.shell.main(argv)
+            connection.return_value.copy_object.assert_called_with(
+                'container', 'object', destination="/c/o",
+                fresh_metadata=False,
+                headers={
+                    'Content-Type': 'text/plain',
+                    'X-Object-Meta-Color': 'Blue'}, response_dict={})
+        self.assertEqual(
+            output.out,
+            'created container c\ncontainer/object copied to /c/o\n'
+        )
+
+    @mock.patch('swiftclient.service.Connection')
+    def test_copy_object_fresh_metadata(self, connection):
+        argv = ["", "copy", "container", "object",
+                "--meta", "Color:Blue", "--fresh-metadata",
+                "--header", "content-type:text/plain",
+                "--destination", "/c/o"
+                ]
+        swiftclient.shell.main(argv)
+        connection.return_value.copy_object.assert_called_with(
+            'container', 'object', destination="/c/o", fresh_metadata=True,
+            headers={
+                'Content-Type': 'text/plain',
+                'X-Object-Meta-Color': 'Blue'}, response_dict={})
+
+    @mock.patch('swiftclient.service.Connection')
+    def test_copy_two_objects(self, connection):
+        argv = ["", "copy", "container", "object", "object2",
+                "--meta", "Color:Blue"]
+        connection.return_value.copy_object.return_value = None
+        swiftclient.shell.main(argv)
+        calls = [
+            mock.call(
+                'container', 'object', destination=None,
+                fresh_metadata=False, headers={'X-Object-Meta-Color': 'Blue'},
+                response_dict={}),
+            mock.call(
+                'container', 'object2', destination=None,
+                fresh_metadata=False, headers={'X-Object-Meta-Color': 'Blue'},
+                response_dict={})
+        ]
+        for call in calls:
+            self.assertIn(call, connection.return_value.copy_object.mock_calls)
+        self.assertEqual(len(connection.return_value.copy_object.mock_calls),
+                         len(calls))
+
+    @mock.patch('swiftclient.service.Connection')
+    def test_copy_two_objects_destination(self, connection):
+        argv = ["", "copy", "container", "object", "object2",
+                "--meta", "Color:Blue", "--destination", "/c"]
+        swiftclient.shell.main(argv)
+        calls = [
+            mock.call(
+                'container', 'object', destination="/c/object",
+                fresh_metadata=False, headers={'X-Object-Meta-Color': 'Blue'},
+                response_dict={}),
+            mock.call(
+                'container', 'object2', destination="/c/object2",
+                fresh_metadata=False, headers={'X-Object-Meta-Color': 'Blue'},
+                response_dict={})
+        ]
+        connection.return_value.copy_object.assert_has_calls(calls)
+
+    @mock.patch('swiftclient.service.Connection')
+    def test_copy_two_objects_bad_destination(self, connection):
+        argv = ["", "copy", "container", "object", "object2",
+                "--meta", "Color:Blue", "--destination", "/c/o"]
+
+        with CaptureOutput() as output:
+            with self.assertRaises(SystemExit):
+                swiftclient.shell.main(argv)
+
+            self.assertEqual(
+                output.err,
+                'Combination of multiple objects and destination '
+                'including object is invalid\n')
+
+    @mock.patch('swiftclient.service.Connection')
+    def test_copy_object_bad_auth(self, connection):
+        argv = ["", "copy", "container", "object"]
+        connection.return_value.copy_object.side_effect = \
+            swiftclient.ClientException("bad auth")
+
+        with CaptureOutput() as output:
+            with self.assertRaises(SystemExit):
+                swiftclient.shell.main(argv)
+
+            self.assertEqual(output.err, 'bad auth\n')
+
+    def test_copy_object_not_enough_args(self):
+        argv = ["", "copy", "container"]
+
+        with CaptureOutput() as output:
+            with self.assertRaises(SystemExit):
+                swiftclient.shell.main(argv)
+
+            self.assertTrue(output.err != '')
+            self.assertTrue(output.err.startswith('Usage'))
+
+    def test_copy_bad_container(self):
+        argv = ["", "copy", "cont/ainer", "object"]
+
+        with CaptureOutput() as output:
+            with self.assertRaises(SystemExit):
+                swiftclient.shell.main(argv)
+
+            self.assertTrue(output.err != '')
+            self.assertTrue(output.err.startswith('WARN'))
+
     @mock.patch('swiftclient.shell.generate_temp_url', return_value='')
     def test_temp_url(self, temp_url):
         argv = ["", "tempurl", "GET", "60", "/v1/AUTH_account/c/o",
diff --git a/tests/unit/test_swiftclient.py b/tests/unit/test_swiftclient.py
index cbb95dbe..cc6a4aca 100644
--- a/tests/unit/test_swiftclient.py
+++ b/tests/unit/test_swiftclient.py
@@ -1398,6 +1398,109 @@ def test_server_error(self):
         ])
 
 
+class TestCopyObject(MockHttpTest):
+
+    def test_server_error(self):
+        c.http_connection = self.fake_http_connection(500)
+        self.assertRaises(
+            c.ClientException, c.copy_object,
+            'http://www.test.com/v1/AUTH', 'asdf', 'asdf', 'asdf')
+
+    def test_ok(self):
+        c.http_connection = self.fake_http_connection(200)
+        c.copy_object(
+            'http://www.test.com/v1/AUTH', 'token', 'container', 'obj',
+            destination='/container2/obj')
+        self.assertRequests([
+            ('COPY', 'http://www.test.com/v1/AUTH/container/obj', '', {
+                'X-Auth-Token': 'token',
+                'Destination': '/container2/obj',
+            }),
+        ])
+
+    def test_service_token(self):
+        c.http_connection = self.fake_http_connection(200)
+        c.copy_object('http://www.test.com/v1/AUTH', None, 'container',
+                      'obj', destination='/container2/obj',
+                      service_token="TOKEN")
+        self.assertRequests([
+            ('COPY', 'http://www.test.com/v1/AUTH/container/obj', '', {
+                'X-Service-Token': 'TOKEN',
+                'Destination': '/container2/obj',
+
+            }),
+        ])
+
+    def test_headers(self):
+        c.http_connection = self.fake_http_connection(200)
+        c.copy_object(
+            'http://www.test.com/v1/AUTH', 'token', 'container', 'obj',
+            destination='/container2/obj',
+            headers={'some-hdr': 'a', 'other-hdr': 'b'})
+        self.assertRequests([
+            ('COPY', 'http://www.test.com/v1/AUTH/container/obj', '', {
+                'X-Auth-Token': 'token',
+                'Destination': '/container2/obj',
+                'some-hdr': 'a',
+                'other-hdr': 'b',
+            }),
+        ])
+
+    def test_fresh_metadata_default(self):
+        c.http_connection = self.fake_http_connection(200)
+        c.copy_object(
+            'http://www.test.com/v1/AUTH', 'token', 'container', 'obj',
+            '/container2/obj', {'x-fresh-metadata': 'hdr-value'})
+        self.assertRequests([
+            ('COPY', 'http://www.test.com/v1/AUTH/container/obj', '', {
+                'X-Auth-Token': 'token',
+                'Destination': '/container2/obj',
+                'X-Fresh-Metadata': 'hdr-value',
+            }),
+        ])
+
+    def test_fresh_metadata_true(self):
+        c.http_connection = self.fake_http_connection(200)
+        c.copy_object(
+            'http://www.test.com/v1/AUTH', 'token', 'container', 'obj',
+            destination='/container2/obj',
+            headers={'x-fresh-metadata': 'hdr-value'},
+            fresh_metadata=True)
+        self.assertRequests([
+            ('COPY', 'http://www.test.com/v1/AUTH/container/obj', '', {
+                'X-Auth-Token': 'token',
+                'Destination': '/container2/obj',
+                'X-Fresh-Metadata': 'true',
+            }),
+        ])
+
+    def test_fresh_metadata_false(self):
+        c.http_connection = self.fake_http_connection(200)
+        c.copy_object(
+            'http://www.test.com/v1/AUTH', 'token', 'container', 'obj',
+            destination='/container2/obj',
+            headers={'x-fresh-metadata': 'hdr-value'},
+            fresh_metadata=False)
+        self.assertRequests([
+            ('COPY', 'http://www.test.com/v1/AUTH/container/obj', '', {
+                'x-auth-token': 'token',
+                'Destination': '/container2/obj',
+                'X-Fresh-Metadata': 'false',
+            }),
+        ])
+
+    def test_no_destination(self):
+        c.http_connection = self.fake_http_connection(200)
+        c.copy_object(
+            'http://www.test.com/v1/AUTH', 'token', 'container', 'obj')
+        self.assertRequests([
+            ('COPY', 'http://www.test.com/v1/AUTH/container/obj', '', {
+                'x-auth-token': 'token',
+                'Destination': '/container/obj',
+            }),
+        ])
+
+
 class TestDeleteObject(MockHttpTest):
 
     def test_ok(self):
@@ -2246,6 +2349,7 @@ class TestResponseDict(MockHttpTest):
              ('delete_container', 'c'),
              ('post_object', 'c', 'o', {}),
              ('put_object', 'c', 'o', 'body'),
+             ('copy_object', 'c', 'o'),
              ('delete_object', 'c', 'o')]
 
     def fake_get_auth(*args, **kwargs):

From 304da900daccce76d9f54ecd661211674daca591 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Wed, 24 Aug 2016 17:27:52 -0700
Subject: [PATCH 010/316] Make functests py3-compatible

Change-Id: I2b3bf17e874cf049eccab4c85ceac7da10d258ef
---
 tests/functional/test_swiftclient.py | 35 ++++++++++++++++------------
 1 file changed, 20 insertions(+), 15 deletions(-)

diff --git a/tests/functional/test_swiftclient.py b/tests/functional/test_swiftclient.py
index 6e19abdb..a31d4af4 100644
--- a/tests/functional/test_swiftclient.py
+++ b/tests/functional/test_swiftclient.py
@@ -110,15 +110,20 @@ def tearDown(self):
                 pass
 
     def _check_account_headers(self, headers):
-        self.assertTrue(headers.get('content-length'))
-        self.assertTrue(headers.get('x-account-object-count'))
-        self.assertTrue(headers.get('x-timestamp'))
-        self.assertTrue(headers.get('x-trans-id'))
-        self.assertTrue(headers.get('date'))
-        self.assertTrue(headers.get('x-account-bytes-used'))
-        self.assertTrue(headers.get('x-account-container-count'))
-        self.assertTrue(headers.get('content-type'))
-        self.assertTrue(headers.get('accept-ranges'))
+        headers_to_check = [
+            'content-length',
+            'x-account-object-count',
+            'x-timestamp',
+            'x-trans-id',
+            'date',
+            'x-account-bytes-used',
+            'x-account-container-count',
+            'content-type',
+            'accept-ranges',
+        ]
+        for h in headers_to_check:
+            self.assertIn(h, headers)
+            self.assertTrue(headers[h])
 
     def test_stat_account(self):
         headers = self.conn.head_account()
@@ -322,16 +327,16 @@ def test_put_object_using_generator(self):
         # verify that put using a generator yielding empty strings does not
         # cause connection to be closed
         def data():
-            yield "should"
-            yield ""
-            yield " tolerate"
-            yield ""
-            yield " empty chunks"
+            yield b"should"
+            yield b""
+            yield b" tolerate"
+            yield b""
+            yield b" empty chunks"
 
         self.conn.put_object(
             self.containername, self.objectname, data())
         hdrs, body = self.conn.get_object(self.containername, self.objectname)
-        self.assertEqual("should tolerate empty chunks", body)
+        self.assertEqual(b"should tolerate empty chunks", body)
 
     def test_download_object_retry_chunked(self):
         resp_chunk_size = 2

From fd675b2c5a9453efac1fadadb17f40ef5fb908d2 Mon Sep 17 00:00:00 2001
From: Jamie Lennox <jamielennox@gmail.com>
Date: Wed, 24 Aug 2016 23:10:59 +1000
Subject: [PATCH 011/316] Use mock patch to handle get_auth_keystone

Setting c.get_auth_keystone = fake_get_auth_keystone is setting a new
method on the module. This information is not reset between test runs
and therefore has the potential to corrupt other tests.

Use mock patch so that the mock is reset after the test is complete.

Change-Id: Ifb9ba72634cf477c72dda080b5aed8f8e3a7ac89
---
 tests/unit/test_swiftclient.py | 277 +++++++++++++++++----------------
 1 file changed, 144 insertions(+), 133 deletions(-)

diff --git a/tests/unit/test_swiftclient.py b/tests/unit/test_swiftclient.py
index 4e4c9f47..6775acf6 100644
--- a/tests/unit/test_swiftclient.py
+++ b/tests/unit/test_swiftclient.py
@@ -335,79 +335,84 @@ def test_auth_v2_timeout(self):
     def test_auth_v2_with_tenant_name(self):
         os_options = {'tenant_name': 'asdf'}
         req_args = {'auth_version': '2.0'}
-        c.get_auth_keystone = fake_get_auth_keystone(os_options,
-                                                     required_kwargs=req_args)
-        url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf',
-                                os_options=os_options,
-                                auth_version="2.0")
+        ks = fake_get_auth_keystone(os_options, required_kwargs=req_args)
+        with mock.patch('swiftclient.client.get_auth_keystone', ks):
+            url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf',
+                                    os_options=os_options,
+                                    auth_version="2.0")
         self.assertTrue(url.startswith("http"))
         self.assertTrue(token)
 
     def test_auth_v2_with_tenant_id(self):
         os_options = {'tenant_id': 'asdf'}
         req_args = {'auth_version': '2.0'}
-        c.get_auth_keystone = fake_get_auth_keystone(os_options,
-                                                     required_kwargs=req_args)
-        url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf',
-                                os_options=os_options,
-                                auth_version="2.0")
+        ks = fake_get_auth_keystone(os_options, required_kwargs=req_args)
+        with mock.patch('swiftclient.client.get_auth_keystone', ks):
+            url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf',
+                                    os_options=os_options,
+                                    auth_version="2.0")
         self.assertTrue(url.startswith("http"))
         self.assertTrue(token)
 
     def test_auth_v2_with_project_name(self):
         os_options = {'project_name': 'asdf'}
         req_args = {'auth_version': '2.0'}
-        c.get_auth_keystone = fake_get_auth_keystone(os_options,
-                                                     required_kwargs=req_args)
-        url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf',
-                                os_options=os_options,
-                                auth_version="2.0")
+        ks = fake_get_auth_keystone(os_options, required_kwargs=req_args)
+        with mock.patch('swiftclient.client.get_auth_keystone', ks):
+            url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf',
+                                    os_options=os_options,
+                                    auth_version="2.0")
         self.assertTrue(url.startswith("http"))
         self.assertTrue(token)
 
     def test_auth_v2_with_project_id(self):
         os_options = {'project_id': 'asdf'}
         req_args = {'auth_version': '2.0'}
-        c.get_auth_keystone = fake_get_auth_keystone(os_options,
-                                                     required_kwargs=req_args)
-        url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf',
-                                os_options=os_options,
-                                auth_version="2.0")
+
+        ks = fake_get_auth_keystone(os_options, required_kwargs=req_args)
+        with mock.patch('swiftclient.client.get_auth_keystone', ks):
+            url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf',
+                                    os_options=os_options,
+                                    auth_version="2.0")
         self.assertTrue(url.startswith("http"))
         self.assertTrue(token)
 
     def test_auth_v2_no_tenant_name_or_tenant_id(self):
-        c.get_auth_keystone = fake_get_auth_keystone({})
-        self.assertRaises(c.ClientException, c.get_auth,
-                          'http://www.tests.com', 'asdf', 'asdf',
-                          os_options={},
-                          auth_version='2.0')
+        with mock.patch('swiftclient.client.get_auth_keystone',
+                        fake_get_auth_keystone({})):
+            self.assertRaises(c.ClientException, c.get_auth,
+                              'http://www.tests.com', 'asdf', 'asdf',
+                              os_options={},
+                              auth_version='2.0')
 
     def test_auth_v2_with_tenant_name_none_and_tenant_id_none(self):
         os_options = {'tenant_name': None,
                       'tenant_id': None}
-        c.get_auth_keystone = fake_get_auth_keystone(os_options)
-        self.assertRaises(c.ClientException, c.get_auth,
-                          'http://www.tests.com', 'asdf', 'asdf',
-                          os_options=os_options,
-                          auth_version='2.0')
+        with mock.patch('swiftclient.client.get_auth_keystone',
+                        fake_get_auth_keystone(os_options)):
+            self.assertRaises(c.ClientException, c.get_auth,
+                              'http://www.tests.com', 'asdf', 'asdf',
+                              os_options=os_options,
+                              auth_version='2.0')
 
     def test_auth_v2_with_tenant_user_in_user(self):
         tenant_option = {'tenant_name': 'foo'}
-        c.get_auth_keystone = fake_get_auth_keystone(tenant_option)
-        url, token = c.get_auth('http://www.test.com', 'foo:bar', 'asdf',
-                                os_options={},
-                                auth_version="2.0")
+        with mock.patch('swiftclient.client.get_auth_keystone',
+                        fake_get_auth_keystone(tenant_option)):
+            url, token = c.get_auth('http://www.test.com', 'foo:bar', 'asdf',
+                                    os_options={},
+                                    auth_version="2.0")
         self.assertTrue(url.startswith("http"))
         self.assertTrue(token)
 
     def test_auth_v2_tenant_name_no_os_options(self):
         tenant_option = {'tenant_name': 'asdf'}
-        c.get_auth_keystone = fake_get_auth_keystone(tenant_option)
-        url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf',
-                                tenant_name='asdf',
-                                os_options={},
-                                auth_version="2.0")
+        with mock.patch('swiftclient.client.get_auth_keystone',
+                        fake_get_auth_keystone(tenant_option)):
+            url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf',
+                                    tenant_name='asdf',
+                                    os_options={},
+                                    auth_version="2.0")
         self.assertTrue(url.startswith("http"))
         self.assertTrue(token)
 
@@ -415,138 +420,141 @@ def test_auth_v2_with_os_options(self):
         os_options = {'service_type': 'object-store',
                       'endpoint_type': 'internalURL',
                       'tenant_name': 'asdf'}
-        c.get_auth_keystone = fake_get_auth_keystone(os_options)
-        url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf',
-                                os_options=os_options,
-                                auth_version="2.0")
+        with mock.patch('swiftclient.client.get_auth_keystone',
+                        fake_get_auth_keystone(os_options)):
+            url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf',
+                                    os_options=os_options,
+                                    auth_version="2.0")
         self.assertTrue(url.startswith("http"))
         self.assertTrue(token)
 
     def test_auth_v2_with_tenant_user_in_user_no_os_options(self):
         tenant_option = {'tenant_name': 'foo'}
-        c.get_auth_keystone = fake_get_auth_keystone(tenant_option)
-        url, token = c.get_auth('http://www.test.com', 'foo:bar', 'asdf',
-                                auth_version="2.0")
+        with mock.patch('swiftclient.client.get_auth_keystone',
+                        fake_get_auth_keystone(tenant_option)):
+            url, token = c.get_auth('http://www.test.com', 'foo:bar', 'asdf',
+                                    auth_version="2.0")
         self.assertTrue(url.startswith("http"))
         self.assertTrue(token)
 
     def test_auth_v2_with_os_region_name(self):
         os_options = {'region_name': 'good-region',
                       'tenant_name': 'asdf'}
-        c.get_auth_keystone = fake_get_auth_keystone(os_options)
-        url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf',
-                                os_options=os_options,
-                                auth_version="2.0")
+        with mock.patch('swiftclient.client.get_auth_keystone',
+                        fake_get_auth_keystone(os_options)):
+            url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf',
+                                    os_options=os_options,
+                                    auth_version="2.0")
         self.assertTrue(url.startswith("http"))
         self.assertTrue(token)
 
     def test_auth_v2_no_endpoint(self):
         os_options = {'region_name': 'unknown_region',
                       'tenant_name': 'asdf'}
-        c.get_auth_keystone = fake_get_auth_keystone(
-            os_options, c.ClientException)
-        self.assertRaises(c.ClientException, c.get_auth,
-                          'http://www.tests.com', 'asdf', 'asdf',
-                          os_options=os_options, auth_version='2.0')
+        with mock.patch('swiftclient.client.get_auth_keystone',
+                        fake_get_auth_keystone(os_options, c.ClientException)):
+            self.assertRaises(c.ClientException, c.get_auth,
+                              'http://www.tests.com', 'asdf', 'asdf',
+                              os_options=os_options, auth_version='2.0')
 
     def test_auth_v2_ks_exception(self):
-        c.get_auth_keystone = fake_get_auth_keystone(
-            {}, c.ClientException)
-        self.assertRaises(c.ClientException, c.get_auth,
-                          'http://www.tests.com', 'asdf', 'asdf',
-                          os_options={},
-                          auth_version='2.0')
+        with mock.patch('swiftclient.client.get_auth_keystone',
+                        fake_get_auth_keystone({}, c.ClientException)):
+            self.assertRaises(c.ClientException, c.get_auth,
+                              'http://www.tests.com', 'asdf', 'asdf',
+                              os_options={},
+                              auth_version='2.0')
 
     def test_auth_v2_cacert(self):
         os_options = {'tenant_name': 'foo'}
-        c.get_auth_keystone = fake_get_auth_keystone(
-            os_options, None)
-
         auth_url_secure = 'https://www.tests.com'
         auth_url_insecure = 'https://www.tests.com/self-signed-certificate'
 
-        url, token = c.get_auth(auth_url_secure, 'asdf', 'asdf',
-                                os_options=os_options, auth_version='2.0',
-                                insecure=False)
-        self.assertTrue(url.startswith("http"))
-        self.assertTrue(token)
-
-        url, token = c.get_auth(auth_url_insecure, 'asdf', 'asdf',
-                                os_options=os_options, auth_version='2.0',
-                                cacert='ca.pem', insecure=False)
-        self.assertTrue(url.startswith("http"))
-        self.assertTrue(token)
-
-        self.assertRaises(c.ClientException, c.get_auth,
-                          auth_url_insecure, 'asdf', 'asdf',
-                          os_options=os_options, auth_version='2.0')
-        self.assertRaises(c.ClientException, c.get_auth,
-                          auth_url_insecure, 'asdf', 'asdf',
-                          os_options=os_options, auth_version='2.0',
-                          insecure=False)
+        with mock.patch('swiftclient.client.get_auth_keystone',
+                        fake_get_auth_keystone(os_options, None)):
+            url, token = c.get_auth(auth_url_secure, 'asdf', 'asdf',
+                                    os_options=os_options, auth_version='2.0',
+                                    insecure=False)
+            self.assertTrue(url.startswith("http"))
+            self.assertTrue(token)
+
+            url, token = c.get_auth(auth_url_insecure, 'asdf', 'asdf',
+                                    os_options=os_options, auth_version='2.0',
+                                    cacert='ca.pem', insecure=False)
+            self.assertTrue(url.startswith("http"))
+            self.assertTrue(token)
+
+            self.assertRaises(c.ClientException, c.get_auth,
+                              auth_url_insecure, 'asdf', 'asdf',
+                              os_options=os_options, auth_version='2.0')
+            self.assertRaises(c.ClientException, c.get_auth,
+                              auth_url_insecure, 'asdf', 'asdf',
+                              os_options=os_options, auth_version='2.0',
+                              insecure=False)
 
     def test_auth_v2_insecure(self):
         os_options = {'tenant_name': 'foo'}
-        c.get_auth_keystone = fake_get_auth_keystone(
-            os_options, None)
-
         auth_url_secure = 'https://www.tests.com'
         auth_url_insecure = 'https://www.tests.com/invalid-certificate'
 
-        url, token = c.get_auth(auth_url_secure, 'asdf', 'asdf',
-                                os_options=os_options, auth_version='2.0')
-        self.assertTrue(url.startswith("http"))
-        self.assertTrue(token)
-
-        url, token = c.get_auth(auth_url_insecure, 'asdf', 'asdf',
-                                os_options=os_options, auth_version='2.0',
-                                insecure=True)
-        self.assertTrue(url.startswith("http"))
-        self.assertTrue(token)
-
-        self.assertRaises(c.ClientException, c.get_auth,
-                          auth_url_insecure, 'asdf', 'asdf',
-                          os_options=os_options, auth_version='2.0')
-        self.assertRaises(c.ClientException, c.get_auth,
-                          auth_url_insecure, 'asdf', 'asdf',
-                          os_options=os_options, auth_version='2.0',
-                          insecure=False)
+        with mock.patch('swiftclient.client.get_auth_keystone',
+                        fake_get_auth_keystone(os_options, None)):
+            url, token = c.get_auth(auth_url_secure, 'asdf', 'asdf',
+                                    os_options=os_options, auth_version='2.0')
+            self.assertTrue(url.startswith("http"))
+            self.assertTrue(token)
+
+            url, token = c.get_auth(auth_url_insecure, 'asdf', 'asdf',
+                                    os_options=os_options, auth_version='2.0',
+                                    insecure=True)
+            self.assertTrue(url.startswith("http"))
+            self.assertTrue(token)
+
+            self.assertRaises(c.ClientException, c.get_auth,
+                              auth_url_insecure, 'asdf', 'asdf',
+                              os_options=os_options, auth_version='2.0')
+            self.assertRaises(c.ClientException, c.get_auth,
+                              auth_url_insecure, 'asdf', 'asdf',
+                              os_options=os_options, auth_version='2.0',
+                              insecure=False)
 
     def test_auth_v2_cert(self):
         os_options = {'tenant_name': 'foo'}
-        c.get_auth_keystone = fake_get_auth_keystone(os_options, None)
-
         auth_url_no_sslauth = 'https://www.tests.com'
         auth_url_sslauth = 'https://www.tests.com/client-certificate'
 
-        url, token = c.get_auth(auth_url_no_sslauth, 'asdf', 'asdf',
-                                os_options=os_options, auth_version='2.0')
-        self.assertTrue(url.startswith("http"))
-        self.assertTrue(token)
-
-        url, token = c.get_auth(auth_url_sslauth, 'asdf', 'asdf',
-                                os_options=os_options, auth_version='2.0',
-                                cert='minnie', cert_key='mickey')
-        self.assertTrue(url.startswith("http"))
-        self.assertTrue(token)
-
-        self.assertRaises(c.ClientException, c.get_auth,
-                          auth_url_sslauth, 'asdf', 'asdf',
-                          os_options=os_options, auth_version='2.0')
-        self.assertRaises(c.ClientException, c.get_auth,
-                          auth_url_sslauth, 'asdf', 'asdf',
-                          os_options=os_options, auth_version='2.0',
-                          cert='minnie')
+        with mock.patch('swiftclient.client.get_auth_keystone',
+                        fake_get_auth_keystone(os_options, None)):
+            url, token = c.get_auth(auth_url_no_sslauth, 'asdf', 'asdf',
+                                    os_options=os_options, auth_version='2.0')
+            self.assertTrue(url.startswith("http"))
+            self.assertTrue(token)
+
+            url, token = c.get_auth(auth_url_sslauth, 'asdf', 'asdf',
+                                    os_options=os_options, auth_version='2.0',
+                                    cert='minnie', cert_key='mickey')
+            self.assertTrue(url.startswith("http"))
+            self.assertTrue(token)
+
+            self.assertRaises(c.ClientException, c.get_auth,
+                              auth_url_sslauth, 'asdf', 'asdf',
+                              os_options=os_options, auth_version='2.0')
+            self.assertRaises(c.ClientException, c.get_auth,
+                              auth_url_sslauth, 'asdf', 'asdf',
+                              os_options=os_options, auth_version='2.0',
+                              cert='minnie')
 
     def test_auth_v3_with_tenant_name(self):
         # check the correct auth version is passed to get_auth_keystone
         os_options = {'tenant_name': 'asdf'}
         req_args = {'auth_version': '3'}
-        c.get_auth_keystone = fake_get_auth_keystone(os_options,
-                                                     required_kwargs=req_args)
-        url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf',
-                                os_options=os_options,
-                                auth_version="3")
+
+        ks = fake_get_auth_keystone(os_options, required_kwargs=req_args)
+        with mock.patch('swiftclient.client.get_auth_keystone', ks):
+            url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf',
+                                    os_options=os_options,
+                                    auth_version="3")
+
         self.assertTrue(url.startswith("http"))
         self.assertTrue(token)
 
@@ -554,10 +562,13 @@ def test_get_keystone_client_2_0(self):
         # check the correct auth version is passed to get_auth_keystone
         os_options = {'tenant_name': 'asdf'}
         req_args = {'auth_version': '2.0'}
-        c.get_auth_keystone = fake_get_auth_keystone(os_options,
-                                                     required_kwargs=req_args)
-        url, token = c.get_keystoneclient_2_0('http://www.test.com', 'asdf',
-                                              'asdf', os_options=os_options)
+
+        ks = fake_get_auth_keystone(os_options, required_kwargs=req_args)
+        with mock.patch('swiftclient.client.get_auth_keystone', ks):
+            url, token = c.get_keystoneclient_2_0('http://www.test.com',
+                                                  'asdf', 'asdf',
+                                                  os_options=os_options)
+
         self.assertTrue(url.startswith("http"))
         self.assertTrue(token)
 

From daed43a44ae77a58ae52033d95f23a0bdb4d6c49 Mon Sep 17 00:00:00 2001
From: Joel Wright <joel.wright@sohonet.com>
Date: Sat, 4 Jun 2016 11:23:02 +0100
Subject: [PATCH 012/316] Fix examples and missing code-block

This patch fixes a missing code-block section in the
capabilities section of service-api.rst, and fixes
the import of walk in the upload.py examples to support
both python2 and python3.

Change-Id: I572769f971f84e0029f2948e42c130e73517f434
---
 doc/source/service-api.rst | 2 ++
 examples/upload.py         | 3 ++-
 2 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/doc/source/service-api.rst b/doc/source/service-api.rst
index 50dd80e8..4da68a37 100644
--- a/doc/source/service-api.rst
+++ b/doc/source/service-api.rst
@@ -756,6 +756,8 @@ the method docstring.
 For each successful call to list capabilities, a result dictionary will be
 returned with the contents described below:
 
+.. code-block:: python
+
     {
         'action': 'capabilities',
         'timestamp': <time of the call>,
diff --git a/examples/upload.py b/examples/upload.py
index 1b1e3490..0715b19a 100644
--- a/examples/upload.py
+++ b/examples/upload.py
@@ -1,6 +1,7 @@
 import logging
 
-from os.path import join, walk
+from os import walk
+from os.path import join
 from swiftclient.multithreading import OutputManager
 from swiftclient.service import SwiftError, SwiftService, SwiftUploadObject
 from sys import argv

From ab60e08e2e34ac4a87bc6c1701c6ace69bb392cf Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Thu, 25 Aug 2016 10:51:29 -0700
Subject: [PATCH 013/316] Convert numeric and boolean header values to strings

Recently, requests got a bit more picky about what types of data it will
accept as header values [1]. The reasons for this are generally sound;
str()ing arbitrary objects just before pushing them out a socket may not
do what the developer wanted/expected.

However, there are a few standard types that developers may be sending
that we should convert for them as a convenience. Now, we'll convert all
int, float, and bool values to strings before sending them on to
requests.

Change-Id: I6c2f451009cb03cb78812f54e4ed8566076de821
Closes-Bug: 1614932
---
 swiftclient/client.py                |  7 +++++++
 tests/functional/test_swiftclient.py | 11 ++++++++++-
 tests/unit/test_swiftclient.py       |  7 ++++---
 3 files changed, 21 insertions(+), 4 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index 602489df..7515f7c7 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -211,6 +211,13 @@ def quote(value, safe='/'):
 
 
 def encode_utf8(value):
+    if type(value) in six.integer_types + (float, bool):
+        # As of requests 2.11.0, headers must be byte- or unicode-strings.
+        # Convert some known-good types as a convenience for developers.
+        # Note that we *don't* convert subclasses, as they may have overriddden
+        # __str__ or __repr__.
+        # See https://github.com/kennethreitz/requests/pull/3366 for more info
+        value = str(value)
     if isinstance(value, six.text_type):
         value = value.encode('utf8')
     return value
diff --git a/tests/functional/test_swiftclient.py b/tests/functional/test_swiftclient.py
index 6e19abdb..0e6a3463 100644
--- a/tests/functional/test_swiftclient.py
+++ b/tests/functional/test_swiftclient.py
@@ -400,10 +400,19 @@ def test_post_container(self):
     def test_post_object(self):
         self.conn.post_object(self.containername,
                               self.objectname,
-                              {'x-object-meta-color': 'Something'})
+                              {'x-object-meta-color': 'Something',
+                               'x-object-meta-uni': b'\xd8\xaa'.decode('utf8'),
+                               'x-object-meta-int': 123,
+                               'x-object-meta-float': 45.67,
+                               'x-object-meta-bool': False})
 
         headers = self.conn.head_object(self.containername, self.objectname)
         self.assertEqual('Something', headers.get('x-object-meta-color'))
+        self.assertEqual(b'\xd8\xaa'.decode('utf-8'),
+                         headers.get('x-object-meta-uni'))
+        self.assertEqual('123', headers.get('x-object-meta-int'))
+        self.assertEqual('45.67', headers.get('x-object-meta-float'))
+        self.assertEqual('False', headers.get('x-object-meta-bool'))
 
     def test_copy_object(self):
         self.conn.put_object(
diff --git a/tests/unit/test_swiftclient.py b/tests/unit/test_swiftclient.py
index 4e4c9f47..09d8e769 100644
--- a/tests/unit/test_swiftclient.py
+++ b/tests/unit/test_swiftclient.py
@@ -185,9 +185,9 @@ def test_http_connection(self):
 
     def test_encode_meta_headers(self):
         headers = {'abc': '123',
-                   u'x-container-meta-\u0394': '123',
-                   u'x-account-meta-\u0394': '123',
-                   u'x-object-meta-\u0394': '123'}
+                   u'x-container-meta-\u0394': 123,
+                   u'x-account-meta-\u0394': 12.3,
+                   u'x-object-meta-\u0394': True}
 
         r = swiftclient.encode_meta_headers(headers)
 
@@ -199,6 +199,7 @@ def test_encode_meta_headers(self):
         for k, v in r.items():
             self.assertIs(type(k), binary_type)
             self.assertIs(type(v), binary_type)
+            self.assertIn(v, (b'123', b'12.3', b'True'))
 
     def test_set_user_agent_default(self):
         _junk, conn = c.http_connection('http://www.example.com')

From 96f0031e642081fabfcda19f2fbc66b86e97339e Mon Sep 17 00:00:00 2001
From: Clay Gerrard <clay.gerrard@gmail.com>
Date: Thu, 26 May 2016 11:17:13 -0700
Subject: [PATCH 014/316] boolean logic cleanup in
 service.Swift[Copy|Post]Object

Change-Id: I07e74536502ec2479b22a825f684703d65924563
---
 swiftclient/service.py | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)

diff --git a/swiftclient/service.py b/swiftclient/service.py
index 0c162620..f204895a 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -323,13 +323,12 @@ class SwiftPostObject(object):
     specified separately for each individual object.
     """
     def __init__(self, object_name, options=None):
-        if not isinstance(object_name, string_types) or not object_name:
+        if not (isinstance(object_name, string_types) and object_name):
             raise SwiftError(
                 "Object names must be specified as non-empty strings"
             )
-        else:
-            self.object_name = object_name
-            self.options = options
+        self.object_name = object_name
+        self.options = options
 
 
 class SwiftCopyObject(object):
@@ -340,7 +339,7 @@ class SwiftCopyObject(object):
     destination and fresh_metadata should be set in options
     """
     def __init__(self, object_name, options=None):
-        if not isinstance(object_name, string_types) or not object_name:
+        if not (isinstance(object_name, string_types) and object_name):
             raise SwiftError(
                 "Object names must be specified as non-empty strings"
             )

From 7cd7df410a8d01dd5c973f8d8273e09aca9b1e2e Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 26 Aug 2016 13:50:31 -0700
Subject: [PATCH 015/316] Change Examples from headings to topics

Previously, they appeared in the table of contents, which seemed unnecessary.

Additionally, de-dent the bullet list for stat since it looked weird.

Change-Id: Ief5d480beb4a7daa2fd87c27019601332f087602
---
 doc/source/service-api.rst | 114 +++++++++++++++++--------------------
 1 file changed, 53 insertions(+), 61 deletions(-)

diff --git a/doc/source/service-api.rst b/doc/source/service-api.rst
index 02b12d0b..66dd527f 100644
--- a/doc/source/service-api.rst
+++ b/doc/source/service-api.rst
@@ -312,11 +312,11 @@ method docstring.
 
 Valid calls for this method are as follows:
 
- * ``stat([options])``: Returns stats for the configured account.
- * ``stat(<container>, [options])``: Returns stats for the given container.
- * ``stat(<container>, <object_list>, [options])``: Returns stats for each
-   of the given objects in the the given container (through the returned
-   iterator).
+* ``stat([options])``: Returns stats for the configured account.
+* ``stat(<container>, [options])``: Returns stats for the given container.
+* ``stat(<container>, <object_list>, [options])``: Returns stats for each
+  of the given objects in the the given container (through the returned
+  iterator).
 
 Results from stat are dictionaries indicating the success or failure of each
 operation. In the case of a successful stat against an account or container,
@@ -371,15 +371,14 @@ operation was not successful, and will include the keys below:
         'error_timestamp': <timestamp>
     }
 
-Example
-^^^^^^^
+.. topic:: Example
 
-The code below demonstrates the use of ``stat`` to retrieve the headers for a
-given list of objects in a container using 20 threads. The code creates a
-mapping from object name to headers which is then pretty printed to the log.
+   The code below demonstrates the use of ``stat`` to retrieve the headers for
+   a given list of objects in a container using 20 threads. The code creates a
+   mapping from object name to headers which is then pretty printed to the log.
 
-.. literalinclude:: ../../examples/stat.py
-   :language: python
+   .. literalinclude:: ../../examples/stat.py
+      :language: python
 
 List
 ~~~~
@@ -438,14 +437,13 @@ dictionary as described below:
         'error_timestamp': <timestamp>
     }
 
-Example
-^^^^^^^
+.. topic:: Example
 
-The code below demonstrates the use of ``list`` to list all items in a
-container that are over 10MiB in size:
+   The code below demonstrates the use of ``list`` to list all items in a
+   container that are over 10MiB in size:
 
-.. literalinclude:: ../../examples/list.py
-   :language: python
+   .. literalinclude:: ../../examples/list.py
+      :language: python
 
 Post
 ~~~~
@@ -484,14 +482,13 @@ described below:
     that each time user metadata is updated, the complete set of desired
     key-value pairs must be specified.
 
-Example
-^^^^^^^
+.. topic:: Example
 
-The code below demonstrates the use of ``post`` to set an archive folder in a
-given container to expire after a 24 hour delay:
+   The code below demonstrates the use of ``post`` to set an archive folder in
+   a given container to expire after a 24 hour delay:
 
-.. literalinclude:: ../../examples/post.py
-   :language: python
+   .. literalinclude:: ../../examples/post.py
+      :language: python
 
 Download
 ~~~~~~~~
@@ -552,14 +549,13 @@ below:
         'response_dict': <HTTP response details>
     }
 
-Example
-^^^^^^^
+.. topic:: Example
 
-The code below demonstrates the use of ``download`` to download all PNG images
-from a dated archive folder in a given container:
+   The code below demonstrates the use of ``download`` to download all PNG
+   images from a dated archive folder in a given container:
 
-.. literalinclude:: ../../examples/download.py
-   :language: python
+   .. literalinclude:: ../../examples/download.py
+      :language: python
 
 Upload
 ~~~~~~
@@ -646,16 +642,15 @@ below:
         'attempts': <attempt count>
     }
 
-Example
-^^^^^^^
+.. topic:: Example
 
-The code below demonstrates the use of ``upload`` to upload all files and
-folders in a given directory, and rename each object by replacing the root
-directory name with 'my-<d>-objects', where <d> is the name of the uploaded
-directory:
+   The code below demonstrates the use of ``upload`` to upload all files and
+   folders in a given directory, and rename each object by replacing the root
+   directory name with 'my-<d>-objects', where <d> is the name of the uploaded
+   directory:
 
-.. literalinclude:: ../../examples/upload.py
-   :language: python
+   .. literalinclude:: ../../examples/upload.py
+      :language: python
 
 Delete
 ~~~~~~
@@ -744,17 +739,16 @@ below:
         'response_dict': <HTTP response details>
     }
 
-Example
-^^^^^^^
+.. topic:: Example
 
-The code below demonstrates the use of ``delete`` to remove a given list of
-objects from a specified container. As the objects are deleted the transaction
-ID of the relevant request is printed along with the object name and number
-of attempts required. By printing the transaction ID, the printed operations
-can be easily linked to events in the swift server logs:
+   The code below demonstrates the use of ``delete`` to remove a given list of
+   objects from a specified container. As the objects are deleted the
+   transaction ID of the relevant request is printed along with the object name
+   and number of attempts required. By printing the transaction ID, the printed
+   operations can be easily linked to events in the swift server logs:
 
-.. literalinclude:: ../../examples/delete.py
-   :language: python
+   .. literalinclude:: ../../examples/delete.py
+      :language: python
 
 Copy
 ~~~~
@@ -810,14 +804,13 @@ below:
        'error_timestamp': <timestamp>
    }
 
-Example
--------
+.. topic:: Example
 
-The code below demonstrates the use of ``copy`` to add new user metadata for
-objects a and b, and to copy object c to d (with added metadata).
+   The code below demonstrates the use of ``copy`` to add new user metadata for
+   objects a and b, and to copy object c to d (with added metadata).
 
-.. literalinclude:: ../../examples/copy.py
-   :language: python
+   .. literalinclude:: ../../examples/copy.py
+      :language: python
 
 Capabilities
 ~~~~~~~~~~~~
@@ -894,13 +887,12 @@ dictionary is given below:
         }
     }
 
-Example
-^^^^^^^
+.. topic:: Example
 
-The code below demonstrates the use of ``capabilities`` to determine if the
-Swift cluster supports static large objects, and if so, the maximum number of
-segments that can be described in a single manifest file, along with the
-size restrictions on those objects:
+   The code below demonstrates the use of ``capabilities`` to determine if the
+   Swift cluster supports static large objects, and if so, the maximum number
+   of segments that can be described in a single manifest file, along with the
+   size restrictions on those objects:
 
-.. literalinclude:: ../../examples/capabilities.py
-   :language: python
+   .. literalinclude:: ../../examples/capabilities.py
+      :language: python

From 8753c4dea32cedd9cdbb80b3b442cbea899c348f Mon Sep 17 00:00:00 2001
From: zheng yin <yin.zheng@easystack.cn>
Date: Thu, 25 Aug 2016 11:58:27 +0800
Subject: [PATCH 016/316] Add swift tempurl and swift auth command docstring

Swift has commands including 'swift tempurl' and 'swift auth',
but it has no 'swift tempurl' and 'swift auth' in doc/source/cli.rst.
Therefore, I add them and their examples.

Change-Id: I9a935b648556e2718727d25ac553c860ebbadd82
---
 doc/source/cli.rst | 43 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)

diff --git a/doc/source/cli.rst b/doc/source/cli.rst
index 9bb229d0..87020c90 100644
--- a/doc/source/cli.rst
+++ b/doc/source/cli.rst
@@ -225,6 +225,28 @@ Capabilities
        the ``proxy-url`` option is not provided, the storage URL retrieved after
        authentication is used as ``proxy-url``.
 
+Tempurl
+-------
+
+    ``tempurl [method] [seconds] [path] [key]``
+
+       Generates a temporary URL for a Swift object. ``method`` option sets an HTTP method to
+       allow for this temporary URL that is usually 'GET' or 'PUT'. ``seconds`` option sets
+       the amount of time in seconds the temporary URL will be valid for; or, if ``--absolute``
+       is passed, the Unix timestamp when the temporary URL will expire. ``path`` option sets
+       the full path to the Swift object. Example: ``/v1/AUTH_account/c/o``. ``key`` option is
+       the secret temporary URL key set on the Swift cluster. To set a key, run
+       ``swift post -m "Temp-URL-Key: <your secret key>"``.
+
+Auth
+----
+
+    ``auth``
+
+       Display authentication variables in shell friendly format. Command to run to export storage
+       url and auth token into ``OS_STORAGE_URL`` and ``OS_AUTH_TOKEN``: ``swift auth``.
+       Command to append to a runcom file (e.g. ``~/.bashrc``, ``/etc/profile``) for automatic
+       authentication: ``swift auth -v -U test:tester -K testing``.
 
 Examples
 ~~~~~~~~
@@ -272,6 +294,15 @@ List the contents of a container:
 
     testSwift.txt
 
+Display auth related authentication variables in shell friendly format:
+
+.. code-block:: bash
+
+    > swift auth
+
+    export OS_STORAGE_URL=http://127.0.0.1:8080/v1/AUTH_bf5e63572f7a420a83fcf0aa8c72c2c7
+    export OS_AUTH_TOKEN=c597015ae19943a18438b52ef3762e79
+
 Download an object from a container:
 
 .. code-block:: bash
@@ -347,3 +378,15 @@ For more information on large objects, see the documentation `here
     myvideo.mp4/slo/1460229233.679546/9341553868/1073741824/00000006
     myvideo.mp4/slo/1460229233.679546/9341553868/1073741824/00000007
     myvideo.mp4/slo/1460229233.679546/9341553868/1073741824/00000008
+
+Firstly, the key should be set, then generate a temporary URL for a Swift object:
+
+.. code-block:: bash
+
+    > swift post -m "Temp-URL-Key:b3968d0207b54ece87cccc06515a89d4"
+
+    > swift tempurl GET 6000 /v1/AUTH_bf5e63572f7a420a83fcf0aa8c72c2c7\
+      /firstcontainer/clean.sh b3968d0207b54ece87cccc06515a89d4
+
+    /v1/AUTH_/firstcontainer/clean.sh?temp_url_sig=\
+    9218fc288cc09e5edd857b6a3d43cf2122b906dc&temp_url_expires=1472203614

From f728027bed59d08a6491ae9c14d2f5968f8d6fa3 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Thu, 21 May 2015 22:44:36 -0700
Subject: [PATCH 017/316] Accept gzip-encoded API responses

Previously, we would accept gzip-encoded responses, but only because we
were letting requests decode *all* responses (even object data). This
restores the previous capability, but with tighter controls about which
requests will accept gzipped responses and where the decoding happens.

Change-Id: I4fd8b97207b9ab01b1bcf825cc16efd8ad46344a
Related-Bug: 1282861
Related-Bug: 1338464
---
 swiftclient/client.py          |  8 +++++---
 swiftclient/utils.py           |  5 +++++
 tests/unit/test_swiftclient.py | 21 ++++++++++++++++---
 tests/unit/test_utils.py       | 37 ++++++++++++++++++++++++++++++++++
 4 files changed, 65 insertions(+), 6 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index 988c7d9c..64885cf4 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -732,7 +732,7 @@ def get_account(url, token, marker=None, limit=None, prefix=None,
     if end_marker:
         qs += '&end_marker=%s' % quote(end_marker)
     full_path = '%s?%s' % (parsed.path, qs)
-    headers = {'X-Auth-Token': token}
+    headers = {'X-Auth-Token': token, 'Accept-Encoding': 'gzip'}
     if service_token:
         headers['X-Service-Token'] = service_token
     method = 'GET'
@@ -859,6 +859,7 @@ def get_container(url, token, container, marker=None, limit=None,
     else:
         headers = {}
     headers['X-Auth-Token'] = token
+    headers['Accept-Encoding'] = 'gzip'
     if full_listing:
         rv = get_container(url, token, container, marker, limit, prefix,
                            delimiter, end_marker, path, http_conn,
@@ -1457,10 +1458,11 @@ def get_capabilities(http_conn):
     :raises ClientException: HTTP Capabilities GET failed
     """
     parsed, conn = http_conn
-    conn.request('GET', parsed.path, '')
+    headers = {'Accept-Encoding': 'gzip'}
+    conn.request('GET', parsed.path, '', headers)
     resp = conn.getresponse()
     body = resp.read()
-    http_log((parsed.geturl(), 'GET',), {'headers': {}}, resp, body)
+    http_log((parsed.geturl(), 'GET',), {'headers': headers}, resp, body)
     if resp.status < 200 or resp.status >= 300:
         raise ClientException.from_response(
             resp, 'Capabilities GET failed', body)
diff --git a/swiftclient/utils.py b/swiftclient/utils.py
index 10687bf4..d3942839 100644
--- a/swiftclient/utils.py
+++ b/swiftclient/utils.py
@@ -13,6 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 """Miscellaneous utility functions for use with Swift."""
+import gzip
 import hashlib
 import hmac
 import json
@@ -120,6 +121,10 @@ def generate_temp_url(path, seconds, key, method, absolute=False):
 
 
 def parse_api_response(headers, body):
+    if headers.get('content-encoding') == 'gzip':
+        with gzip.GzipFile(fileobj=six.BytesIO(body), mode='r') as gz:
+            body = gz.read()
+
     charset = 'utf-8'
     # Swift *should* be speaking UTF-8, but check content-type just in case
     content_type = headers.get('content-type', '')
diff --git a/tests/unit/test_swiftclient.py b/tests/unit/test_swiftclient.py
index 00954479..da43510e 100644
--- a/tests/unit/test_swiftclient.py
+++ b/tests/unit/test_swiftclient.py
@@ -581,6 +581,7 @@ def test_no_content(self):
         self.assertEqual(value, [])
         self.assertRequests([
             ('GET', '/v1/acct?format=json', '', {
+                'accept-encoding': 'gzip',
                 'x-auth-token': 'asdf'}),
         ])
 
@@ -591,6 +592,7 @@ def test_param_marker(self):
         c.get_account('http://www.test.com/v1/acct', 'asdf', marker='marker')
         self.assertRequests([
             ('GET', '/v1/acct?format=json&marker=marker', '', {
+                'accept-encoding': 'gzip',
                 'x-auth-token': 'asdf'}),
         ])
 
@@ -601,6 +603,7 @@ def test_param_limit(self):
         c.get_account('http://www.test.com/v1/acct', 'asdf', limit=10)
         self.assertRequests([
             ('GET', '/v1/acct?format=json&limit=10', '', {
+                'accept-encoding': 'gzip',
                 'x-auth-token': 'asdf'}),
         ])
 
@@ -611,6 +614,7 @@ def test_param_prefix(self):
         c.get_account('http://www.test.com/v1/acct', 'asdf', prefix='asdf/')
         self.assertRequests([
             ('GET', '/v1/acct?format=json&prefix=asdf/', '', {
+                'accept-encoding': 'gzip',
                 'x-auth-token': 'asdf'}),
         ])
 
@@ -622,6 +626,7 @@ def test_param_end_marker(self):
                       end_marker='end_marker')
         self.assertRequests([
             ('GET', '/v1/acct?format=json&end_marker=end_marker', '', {
+                'accept-encoding': 'gzip',
                 'x-auth-token': 'asdf'}),
         ])
 
@@ -700,6 +705,7 @@ def test_no_content(self):
         self.assertEqual(value, [])
         self.assertRequests([
             ('GET', '/v1/acct/container?format=json', '', {
+                'accept-encoding': 'gzip',
                 'x-auth-token': 'token'}),
         ])
 
@@ -711,6 +717,7 @@ def test_param_marker(self):
                         marker='marker')
         self.assertRequests([
             ('GET', '/v1/acct/container?format=json&marker=marker', '', {
+                'accept-encoding': 'gzip',
                 'x-auth-token': 'token'}),
         ])
 
@@ -722,6 +729,7 @@ def test_param_limit(self):
                         limit=10)
         self.assertRequests([
             ('GET', '/v1/acct/container?format=json&limit=10', '', {
+                'accept-encoding': 'gzip',
                 'x-auth-token': 'token'}),
         ])
 
@@ -733,6 +741,7 @@ def test_param_prefix(self):
                         prefix='asdf/')
         self.assertRequests([
             ('GET', '/v1/acct/container?format=json&prefix=asdf/', '', {
+                'accept-encoding': 'gzip',
                 'x-auth-token': 'token'}),
         ])
 
@@ -744,6 +753,7 @@ def test_param_delimiter(self):
                         delimiter='/')
         self.assertRequests([
             ('GET', '/v1/acct/container?format=json&delimiter=/', '', {
+                'accept-encoding': 'gzip',
                 'x-auth-token': 'token'}),
         ])
 
@@ -755,7 +765,7 @@ def test_param_end_marker(self):
                         end_marker='end_marker')
         self.assertRequests([
             ('GET', '/v1/acct/container?format=json&end_marker=end_marker',
-             '', {'x-auth-token': 'token'}),
+             '', {'x-auth-token': 'token', 'accept-encoding': 'gzip'}),
         ])
 
     def test_param_path(self):
@@ -766,6 +776,7 @@ def test_param_path(self):
                         path='asdf')
         self.assertRequests([
             ('GET', '/v1/acct/container?format=json&path=asdf', '', {
+                'accept-encoding': 'gzip',
                 'x-auth-token': 'token'}),
         ])
 
@@ -780,6 +791,7 @@ def test_request_headers(self):
             ('GET', '/container?format=json', '', {
                 'x-auth-token': 'TOKEN',
                 'x-client-key': 'client key',
+                'accept-encoding': 'gzip',
             }),
         ])
 
@@ -790,6 +802,7 @@ def test_query_string(self):
                         query_string="hello=20")
         self.assertRequests([
             ('GET', '/asdf?format=json&hello=20', '', {
+                'accept-encoding': 'gzip',
                 'x-auth-token': 'asdf'}),
         ])
 
@@ -1583,7 +1596,7 @@ def test_ok(self):
         http_conn = conn('http://www.test.com/info')
         info = c.get_capabilities(http_conn)
         self.assertRequests([
-            ('GET', '/info', '', {}),
+            ('GET', '/info', '', {'Accept-Encoding': 'gzip'}),
         ])
         self.assertEqual(info, {})
         self.assertTrue(http_conn[1].resp.has_been_read)
@@ -1619,7 +1632,8 @@ def test_conn_get_capabilities_with_auth(self):
             ('GET', '/auth/v1.0', '', {
                 'x-auth-user': 'user',
                 'x-auth-key': 'key'}),
-            ('GET', 'http://storage.example.com/info', '', {}),
+            ('GET', 'http://storage.example.com/info', '', {
+                'accept-encoding': 'gzip'}),
         ])
 
     def test_conn_get_capabilities_with_os_auth(self):
@@ -2341,6 +2355,7 @@ def test_get_container(self):
             ('GET', '/v1/a/c1?format=json&limit=5&prefix=p', '', {
                 'x-auth-token': 'token',
                 'X-Favourite-Pet': 'Aardvark',
+                'accept-encoding': 'gzip',
             }),
         ])
         self.assertEqual(conn.attempts, 1)
diff --git a/tests/unit/test_utils.py b/tests/unit/test_utils.py
index 0f210a3c..f0de79ce 100644
--- a/tests/unit/test_utils.py
+++ b/tests/unit/test_utils.py
@@ -13,6 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import gzip
 import unittest
 import mock
 import six
@@ -394,3 +395,39 @@ def test_n_groups(self):
 
         result = list(u.n_groups(range(100), 12))
         self.assertEqual([9] * 11 + [1], list(map(len, result)))
+
+
+class TestApiResponeParser(unittest.TestCase):
+
+    def test_utf8_default(self):
+        result = u.parse_api_response(
+            {}, u'{"test": "\u2603"}'.encode('utf8'))
+        self.assertEqual({'test': u'\u2603'}, result)
+
+        result = u.parse_api_response(
+            {}, u'{"test": "\\u2603"}'.encode('utf8'))
+        self.assertEqual({'test': u'\u2603'}, result)
+
+    def test_bad_json(self):
+        self.assertRaises(ValueError, u.parse_api_response,
+                          {}, b'{"foo": "bar}')
+
+    def test_bad_utf8(self):
+        self.assertRaises(UnicodeDecodeError, u.parse_api_response,
+                          {}, b'{"foo": "b\xffr"}')
+
+    def test_latin_1(self):
+        result = u.parse_api_response(
+            {'content-type': 'application/json; charset=iso8859-1'},
+            b'{"t\xe9st": "\xff"}')
+        self.assertEqual({u't\xe9st': u'\xff'}, result)
+
+    def test_gzipped_utf8(self):
+        buf = six.BytesIO()
+        gz = gzip.GzipFile(fileobj=buf, mode='w')
+        gz.write(u'{"test": "\u2603"}'.encode('utf8'))
+        gz.close()
+        result = u.parse_api_response(
+            {'content-encoding': 'gzip'},
+            buf.getvalue())
+        self.assertEqual({'test': u'\u2603'}, result)

From cbd71a8b5a7339f3ed297ae410a4836b2d56634a Mon Sep 17 00:00:00 2001
From: John Dickinson <me@not.mn>
Date: Sun, 28 Aug 2016 14:05:41 -0700
Subject: [PATCH 018/316] authors/changelog updates for 3.1.0 release

Change-Id: I75ba58d194ea99b17c862cefcd9943e38e3f1ff0
---
 .mailmap                                      |  2 +
 AUTHORS                                       | 17 ++++++-
 ChangeLog                                     | 49 +++++++++++++++++++
 .../notes/310-notes-03040158a8683dd8.yaml     | 38 ++++++++++++++
 4 files changed, 105 insertions(+), 1 deletion(-)
 create mode 100644 releasenotes/notes/310-notes-03040158a8683dd8.yaml

diff --git a/.mailmap b/.mailmap
index 840a8ac8..859a978f 100644
--- a/.mailmap
+++ b/.mailmap
@@ -89,3 +89,5 @@ Doug Hellmann <doug@doughellmann.com> <doug.hellmann@dreamhost.com>
 Ondrej Novy <ondrej.novy@firma.seznam.cz>
 James Nzomo <james@tdt.rocks> <kazikubwa@gmail.com>
 Alessandro Pilotti <ap@pilotti.it> <apilotti@cloudbasesolutions.com>
+Marek Kaleta <marek.kaleta@firma.seznam.cz> <Marek.Kaleta@firma.seznam.cz>
+Andreas Jaeger <aj@suse.de> <aj@suse.com>
diff --git a/AUTHORS b/AUTHORS
index e7215de4..f8b79c38 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -1,9 +1,12 @@
+Paul Belanger (pabelanger@redhat.com)
 Christian Berendt (berendt@b1-systems.de)
 Luis de Bethencourt (luis@debethencourt.com)
+Hu Bing (hubingsh@cn.ibm.com)
 Darrell Bishop (darrell@swiftstack.com)
 Fabien Boucher (fabien.boucher@enovance.com)
 Chmouel Boudjnah (chmouel@enovance.com)
 Clark Boylan (clark.boylan@gmail.com)
+Cedric Brandily (zzelle@gmail.com)
 Chris Buccella (chris.buccella@antallagon.com)
 Tim Burke (tim.burke@gmail.com)
 Clint Byrum (clint@fewbar.com)
@@ -12,13 +15,13 @@ Sergio Cazzolato (sergio.j.cazzolato@intel.com)
 Mahati Chamarthy (mahati.chamarthy@gmail.com)
 Chaozhe.Chen (chaozhe.chen@easystack.cn)
 Ray Chen (oldsharp@163.com)
-Li Cheng (shcli@cn.ibm.com)
 Taurus Cheung (Taurus.Cheung@harmonicinc.com)
 Alistair Coles (alistair.coles@hpe.com)
 Ian Cordasco (ian.cordasco@rackspace.com)
 Nick Craig-Wood (nick@craig-wood.com)
 Thiago da Silva (thiago@redhat.com)
 Sean Dague (sean@dague.net)
+Julien Danjou (julien@danjou.info)
 Zack M. Davis (zdavis@swiftstack.com)
 John Dickinson (me@not.mn)
 EdLeafe (ed@leafe.com)
@@ -32,7 +35,9 @@ Anne Gentle (anne@openstack.org)
 Clay Gerrard (clay.gerrard@gmail.com)
 David Goetz (david.goetz@rackspace.com)
 Thomas Goirand (thomas@goirand.fr)
+Sergey Gotliv (sgotliv@redhat.com)
 Davide Guerri (davide.guerri@hp.com)
+Shashirekha Gundur (shashirekha.j.gundur@intel.com)
 Romain Hardouin (romain_hardouin@yahoo.fr)
 Steven Hardy (shardy@redhat.com)
 Doug Hellmann (doug@doughellmann.com)
@@ -44,12 +49,15 @@ Andreas Jaeger (aj@suse.de)
 Jude Job (judeopenstack@gmail.com)
 Vasyl Khomenko (vasiliyk@yahoo-inc.com)
 Leah Klearman (lklrmn@gmail.com)
+Marek Kaleta (marek.kaleta@firma.seznam.cz)
 Jaivish Kothari (jaivish.kothari@nectechnologies.in)
 Jakub Krajcovic (jakub.krajcovic@gmail.com)
 David Kranz (david.kranz@qrclab.com)
 Sushil Kumar (sushil.kumar2@globallogic.com)
 Greg Lange (greglange@gmail.com)
 Alexis Lee (lxsli@hpe.com)
+Jamie Lennox (jamielennox@gmail.com)
+Cheng Li (shcli@cn.ibm.com)
 Tong Li (litong01@us.ibm.com)
 Peter Lisak (peter.lisak@firma.seznam.cz)
 Feng Liu (mefengliu23@gmail.com)
@@ -71,6 +79,7 @@ Dirk Mueller (dirk@dmllr.de)
 Zhenguo Niu (zhenguo@unitedstack.com)
 Ondrej Novy (ondrej.novy@firma.seznam.cz)
 James Nzomo (james@tdt.rocks)
+Nguyen Hung Phuong (phuongnh@vn.fujitsu.com)
 Alessandro Pilotti (ap@pilotti.it)
 Stanislaw Pitucha (stanislaw.pitucha@hpe.com)
 Dan Prince (dprince@redhat.com)
@@ -87,18 +96,22 @@ Jeremy Stanley (fungi@yuggoth.org)
 Victor Stinner (victor.stinner@enovance.com)
 Jiří Suchomel (jsuchome@suse.cz)
 YUZAWA Takahiko (yuzawataka@intellilink.co.jp)
+Nandini Tata (nandini.tata.15@gmail.com)
 Monty Taylor (mordred@inaugust.com)
 TheSriram (sriram@klusterkloud.com)
 Tihomir Trifonov (t.trifonov@gmail.com)
 Dean Troyer (dtroyer@gmail.com)
+Kota Tsuyuzaki (tsuyuzaki.kota@lab.ntt.co.jp)
 Stanislav Vitkovskiy (stas.vitkovsky@gmail.com)
 Daniel Wakefield (daniel.wakefield@hp.com)
 Shane Wang (shane.wang@intel.com)
 Mark Washenberger (mark.washenberger@rackspace.com)
+Andrew Welleck (awellec@us.ibm.com)
 Wu Wenxiang (wu.wenxiang@99cloud.net)
 Mike Widman (mwidman@endurancewindpower.com)
 Joel Wright (joel.wright@sohonet.com)
 You Yamagata (bi.yamagata@gmail.com)
+zheng yin (yin.zheng@easystack.cn)
 Qiu Yu (qiuyu@ebaysf.com)
 YangLei (yanglyy@cn.ibm.com)
 Pete Zaitcev (zaitcev@kotori.zaitcev.us)
@@ -112,3 +125,5 @@ zhang-jinnan (ben.os@99cloud.net)
 hgangwx (hgangwx@cn.ibm.com)
 shu-mutou (shu-mutou@rf.jp.nec.com)
 SaiKiran (saikiranveeravarapu@gmail.com)
+venkatamahesh (venkatamaheshkotha@gmail.com)
+yuyafei (yu.yafei@zte.com.cn)
diff --git a/ChangeLog b/ChangeLog
index f5e0a60c..7697bdb1 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,52 @@
+3.1.0
+-----
+
+* Added a copy object method.
+
+* Arbitrary query strings can now be passed into container functions.
+
+* Client certificate and key can now be specified via CLI
+  options (--os-cert/--os-key) or environment variables ($OS_CERT/$OS_KEY).
+
+* A new CLI option `--ignore-checksum` can be specified to turn off
+  checksum validation. In the SDK, the new `checksum=True` parameter can
+  be used for the same purpose.
+
+* Added --json option to `swift capabilities` / `swift info`
+
+* Default to v3 auth if we find a (user|project)-domain-(name|id) option.
+
+* Added a Python version constraint of >= Py27.
+
+* `client.py` will now retry on a 401 (auth error) even if `retries` is
+  set to zero.
+
+* Fixed `swift download` when `marker` was specified.
+
+* Object segments uploaded via swiftclient are now given the content type
+  "application/swiftclient-segment".
+
+* "Directory marker" objects are now given a "application/directory"
+  content type to match both Swift's `staticweb` feature and other
+  ecosystem tools.
+
+* Strip leading/trailing whitespace from headers (otherwise, new versions
+  of the requests library will raise an InvalidHeader error). Additionally,
+  header values with standard types (integer, float, or bool) are coerced
+  to strings before being sent to a socket.
+
+* Non-python dependencies are now specified in bindep.txt. Currently this
+  only lists a single dependency for testing (PyPy), but if future
+  dependencies are added, they will be included in this file.
+
+* Client exceptions now include response headers. One benefit is that
+  this allows clients to see transaction IDs without needing to turn on
+  debug logging.
+
+* Client connections now accept gzip-encoded responses.
+
+* Various other minor bug fixes and improvements.
+
 3.0.0
 -----
 
diff --git a/releasenotes/notes/310-notes-03040158a8683dd8.yaml b/releasenotes/notes/310-notes-03040158a8683dd8.yaml
new file mode 100644
index 00000000..792b6f56
--- /dev/null
+++ b/releasenotes/notes/310-notes-03040158a8683dd8.yaml
@@ -0,0 +1,38 @@
+---
+features:
+ - Added a copy object method.
+ - Arbitrary query strings can now be passed into container functions.
+ - >
+   Client certificate and key can now be specified via CLI
+   options (--os-cert/--os-key) or environment variables ($OS_CERT/$OS_KEY).
+ - >
+   A new CLI option `--ignore-checksum` can be specified to turn off
+   checksum validation. In the SDK, the new `checksum=True` parameter can
+   be used for the same purpose.
+ - Added --json option to `swift capabilities` / `swift info`
+ - Default to v3 auth if we find a (user|project)-domain-(name|id) option.
+ - Added a Python version constraint of >= Py27.
+ - >
+   `client.py` will now retry on a 401 (auth error) even if `retries` is
+   set to zero.
+ - Fixed `swift download` when `marker` was specified.
+ - Object segments uploaded via swiftclient are now given the content type
+   "application/swiftclient-segment".
+ - >
+   "Directory marker" objects are now given a "application/directory"
+   content type to match both Swift's `staticweb` feature and other
+   ecosystem tools.
+ - >
+   Strip leading/trailing whitespace from headers (otherwise, new versions
+   of the requests library will raise an InvalidHeader error). Additionally,
+   header values with standard types (integer, float, or bool) are coerced
+   to strings before being sent to a socket.
+ - >
+   Non-python dependencies are now specified in bindep.txt. Currently this
+   only lists a single dependency for testing (PyPy), but if future
+   dependencies are added, they will be included in this file.
+ - Client exceptions now include response headers. One benefit is that
+   this allows clients to see transaction IDs without needing to turn on
+   debug logging.
+ - Client connections now accept gzip-encoded responses.
+ - Various other minor bug fixes and improvements.

From 209677e6a8afeba048cca62b0383661052f7db2b Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 26 Aug 2016 18:19:19 -0700
Subject: [PATCH 019/316] Fix intermittent test failure

The mock needs to be initialized before calling main, or we get a race
to create it between all the uu_threads

Change-Id: If7649da13ed9276d7f0e005e999770e09c022a3f
---
 tests/unit/test_shell.py | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/tests/unit/test_shell.py b/tests/unit/test_shell.py
index c0fcc410..6c4ebed9 100644
--- a/tests/unit/test_shell.py
+++ b/tests/unit/test_shell.py
@@ -1328,8 +1328,8 @@ def test_copy_two_objects(self, connection):
                 fresh_metadata=False, headers={'X-Object-Meta-Color': 'Blue'},
                 response_dict={})
         ]
-        for call in calls:
-            self.assertIn(call, connection.return_value.copy_object.mock_calls)
+        connection.return_value.copy_object.assert_has_calls(
+            calls, any_order=True)
         self.assertEqual(len(connection.return_value.copy_object.mock_calls),
                          len(calls))
 
@@ -1337,6 +1337,7 @@ def test_copy_two_objects(self, connection):
     def test_copy_two_objects_destination(self, connection):
         argv = ["", "copy", "container", "object", "object2",
                 "--meta", "Color:Blue", "--destination", "/c"]
+        connection.return_value.copy_object.return_value = None
         swiftclient.shell.main(argv)
         calls = [
             mock.call(
@@ -1348,7 +1349,10 @@ def test_copy_two_objects_destination(self, connection):
                 fresh_metadata=False, headers={'X-Object-Meta-Color': 'Blue'},
                 response_dict={})
         ]
-        connection.return_value.copy_object.assert_has_calls(calls)
+        connection.return_value.copy_object.assert_has_calls(
+            calls, any_order=True)
+        self.assertEqual(len(connection.return_value.copy_object.mock_calls),
+                         len(calls))
 
     @mock.patch('swiftclient.service.Connection')
     def test_copy_two_objects_bad_destination(self, connection):

From 89ff29e788479334c218801beb0538b4a6bddf23 Mon Sep 17 00:00:00 2001
From: Christian Schwede <cschwede@redhat.com>
Date: Thu, 18 Aug 2016 09:44:03 +0000
Subject: [PATCH 020/316] Make options arguments truely optional

Currently the options help, info and debug must exist in the options
dictionary; however it might be that this is not the case if a method is
imported externally. This patch fixes this.

Also support using a storage URL or path as an argument for tempurl, and
adding a test to verify correct output in both cases.

Related-Bug: 1607519
Related-Bug: 1607523
Closes-Bug: 1607521
Change-Id: I0fb2ce125fe12d660e4deb778265016bdd5ff31b
---
 swiftclient/shell.py     | 26 +++++++++++++++++---------
 tests/unit/test_shell.py | 16 ++++++++++++++++
 2 files changed, 33 insertions(+), 9 deletions(-)

diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index be1888d4..e1a5a8d1 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -25,7 +25,7 @@
 from os import environ, walk, _exit as os_exit
 from os.path import isfile, isdir, join
 from six import text_type, PY2
-from six.moves.urllib.parse import unquote
+from six.moves.urllib.parse import unquote, urlparse
 from sys import argv as sys_argv, exit, stderr
 from time import gmtime, strftime
 
@@ -1207,8 +1207,9 @@ def st_auth(parser, args, thread_manager):
   <seconds>             The amount of time in seconds the temporary URL will be
                         valid for; or, if --absolute is passed, the Unix
                         timestamp when the temporary URL will expire.
-  <path>                The full path to the Swift object. Example:
-                        /v1/AUTH_account/c/o.
+  <path>                The full path or storage URL to the Swift object.
+                        Example: /v1/AUTH_account/c/o
+                        or: http://saio:8080/v1/AUTH_account/c/o
   <key>                 The secret temporary URL key set on the Swift cluster.
                         To set a key, run \'swift post -m
                         "Temp-URL-Key:b3968d0207b54ece87cccc06515a89d4"\'
@@ -1235,6 +1236,9 @@ def st_tempurl(parser, args, thread_manager):
                              st_tempurl_options, st_tempurl_help)
         return
     method, seconds, path, key = args[:4]
+
+    parsed = urlparse(path)
+
     try:
         seconds = int(seconds)
     except ValueError:
@@ -1244,8 +1248,12 @@ def st_tempurl(parser, args, thread_manager):
         thread_manager.print_msg('WARNING: Non default HTTP method %s for '
                                  'tempurl specified, possibly an error' %
                                  method.upper())
-    url = generate_temp_url(path, seconds, key, method,
-                            absolute=options['absolute_expiry'])
+    path = generate_temp_url(parsed.path, seconds, key, method,
+                             absolute=options['absolute_expiry'])
+    if parsed.scheme and parsed.netloc:
+        url = "%s://%s%s" % (parsed.scheme, parsed.netloc, path)
+    else:
+        url = path
     thread_manager.print_msg(url)
 
 
@@ -1285,16 +1293,16 @@ def _get_default_metavar_for_positional(self, action):
 def parse_args(parser, args, enforce_requires=True):
     options, args = parser.parse_known_args(args or ['-h'])
     options = vars(options)
-    if enforce_requires and (options['debug'] or options['info']):
+    if enforce_requires and (options.get('debug') or options.get('info')):
         logging.getLogger("swiftclient")
-        if options['debug']:
+        if options.get('debug'):
             logging.basicConfig(level=logging.DEBUG)
             logging.getLogger('iso8601').setLevel(logging.WARNING)
             client_logger_settings['redact_sensitive_headers'] = False
-        elif options['info']:
+        elif options.get('info'):
             logging.basicConfig(level=logging.INFO)
 
-    if args and options['help']:
+    if args and options.get('help'):
         _help = globals().get('st_%s_help' % args[0],
                               "no help for %s" % args[0])
         print(_help)
diff --git a/tests/unit/test_shell.py b/tests/unit/test_shell.py
index c0fcc410..40881c24 100644
--- a/tests/unit/test_shell.py
+++ b/tests/unit/test_shell.py
@@ -1412,6 +1412,22 @@ def test_absolute_expiry_temp_url(self, temp_url):
         temp_url.assert_called_with(
             '/v1/AUTH_account/c/o', 60, 'secret_key', 'GET', absolute=True)
 
+    def test_temp_url_output(self):
+        argv = ["", "tempurl", "GET", "60", "/v1/a/c/o",
+                "secret_key", "--absolute"]
+        with CaptureOutput(suppress_systemexit=True) as output:
+            swiftclient.shell.main(argv)
+        sig = "63bc77a473a1c2ce956548cacf916f292eb9eac3"
+        expected = "/v1/a/c/o?temp_url_sig=%s&temp_url_expires=60\n" % sig
+        self.assertEqual(expected, output.out)
+
+        argv = ["", "tempurl", "GET", "60", "http://saio:8080/v1/a/c/o",
+                "secret_key", "--absolute"]
+        with CaptureOutput(suppress_systemexit=True) as output:
+            swiftclient.shell.main(argv)
+        expected = "http://saio:8080%s" % expected
+        self.assertEqual(expected, output.out)
+
     @mock.patch('swiftclient.service.Connection')
     def test_capabilities(self, connection):
         argv = ["", "capabilities"]

From aa88677018986f8f49208f64d660219ac6f7e8e6 Mon Sep 17 00:00:00 2001
From: Nandini Tata <nandini.tata@intel.com>
Date: Tue, 6 Sep 2016 15:48:09 +0000
Subject: [PATCH 021/316] Fixed inconsistent positional arguments naming

When printing the help menu for Swift commands, it is confusing to see
both positional arguments and options not distinguished. The
positional arguments are supposed to be enclosed in angular braces <>,
options in square braces [] and optional positional arguments in [<>].

Change-Id: Ie84a90eb0278dd2cdf5775948572bb140f8d2c4b
---
 swiftclient/shell.py | 37 +++++++++++++++++++------------------
 1 file changed, 19 insertions(+), 18 deletions(-)

diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index be1888d4..0b96d2d2 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -209,18 +209,18 @@ def st_delete(parser, args, output_manager):
                       [--container-threads <threads>] [--no-download]
                       [--skip-identical] [--remove-prefix]
                       [--header <header:value>] [--no-shuffle]
-                      <container> <object>
+                      [<container>] [<object>]
 '''
 
 st_download_help = '''
 Download objects from containers.
 
 Positional arguments:
-  <container>           Name of container to download from. To download a
-                        whole account, omit this and specify --all.
-  <object>              Name of object to download. Specify multiple times
-                        for multiple objects. Omit this to download all
-                        objects from the container.
+  [<container>]           Name of container to download from. To download a
+                          whole account, omit this and specify --all.
+  [<object>]              Name of object to download. Specify multiple times
+                          for multiple objects. Omit this to download all
+                          objects from the container.
 
 Optional arguments:
   -a, --all             Indicates that you really want to download
@@ -445,14 +445,14 @@ def st_download(parser, args, output_manager):
 
 
 st_list_options = '''[--long] [--lh] [--totals] [--prefix <prefix>]
-                  [--delimiter <delimiter>] [container]
+                  [--delimiter <delimiter>] [<container>]
 '''
 
 st_list_help = '''
 Lists the containers for the account or the objects for a container.
 
 Positional arguments:
-  [container]           Name of container to list object in.
+  [<container>]           Name of container to list object in.
 
 Optional arguments:
   -l, --long            Long listing format, similar to ls -l.
@@ -581,15 +581,15 @@ def _print_stats(options, stats, human):
 
 
 st_stat_options = '''[--lh]
-                  [container] [object]
+                  [<container>] [<object>]
 '''
 
 st_stat_help = '''
 Displays information for the account, container, or object.
 
 Positional arguments:
-  [container]           Name of container to stat from.
-  [object]              Name of object to stat.
+  [<container>]           Name of container to stat from.
+  [<object>]              Name of object to stat.
 
 Optional arguments:
   --lh                  Report sizes in human readable format similar to
@@ -655,7 +655,7 @@ def st_stat(parser, args, output_manager):
 st_post_options = '''[--read-acl <acl>] [--write-acl <acl>] [--sync-to]
                   [--sync-key <sync-key>] [--meta <name:value>]
                   [--header <header>]
-                  [container] [object]
+                  [<container>] [<object>]
 '''
 
 st_post_help = '''
@@ -663,8 +663,8 @@ def st_stat(parser, args, output_manager):
 If the container is not found, it will be created automatically.
 
 Positional arguments:
-  [container]           Name of container to post to.
-  [object]              Name of object to post.
+  [<container>]           Name of container to post to.
+  [<object>]              Name of object to post.
 
 Optional arguments:
   -r, --read-acl <acl>  Read ACL for containers. Quick summary of ACL syntax:
@@ -752,7 +752,8 @@ def st_post(parser, args, output_manager):
 
 
 st_copy_options = '''[--destination </container/object>] [--fresh-metadata]
-                  [--meta <name:value>] [--header <header>] container object
+                  [--meta <name:value>] [--header <header>] <container>
+                  <object> [<object>] [...]
 '''
 
 st_copy_help = '''
@@ -760,9 +761,9 @@ def st_post(parser, args, output_manager):
 If destination is not set, will update metadata of object
 
 Positional arguments:
-  container             Name of container to copy from.
-  object                Name of object to copy. Specify multiple times
-                        for multiple objects
+  <container>             Name of container to copy from.
+  <object>                Name of object to copy. Specify multiple times
+                          for multiple objects
 
 Optional arguments:
   -d, --destination </container[/object]>

From cb0cdca7aa8ccb880f0cbacaf4b0e891cb3e91d9 Mon Sep 17 00:00:00 2001
From: Alistair Coles <alistair.coles@hpe.com>
Date: Thu, 8 Sep 2016 11:09:25 +0100
Subject: [PATCH 022/316] Make object option dependent on container in usage
 strings

In usage messages, it only makes sense to have an
object option if the container option has been specified.
Fixes the parentheses to indicate this.

Change-Id: I550ba99879ea6ce5489617a94cec36b66be270c8
Related-Change: Ie84a90eb0278dd2cdf5775948572bb140f8d2c4b
---
 swiftclient/shell.py | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 0b96d2d2..c8e43d1f 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -58,7 +58,7 @@ def immediate_exit(signum, frame):
 st_delete_options = '''[--all] [--leave-segments]
                     [--object-threads <threads>]
                     [--container-threads <threads>]
-                    [<container>] [<object>] [...]
+                    [<container> [<object>] [...]]
 '''
 
 st_delete_help = '''
@@ -209,7 +209,7 @@ def st_delete(parser, args, output_manager):
                       [--container-threads <threads>] [--no-download]
                       [--skip-identical] [--remove-prefix]
                       [--header <header:value>] [--no-shuffle]
-                      [<container>] [<object>]
+                      [<container> [<object>] [...]]
 '''
 
 st_download_help = '''
@@ -581,7 +581,7 @@ def _print_stats(options, stats, human):
 
 
 st_stat_options = '''[--lh]
-                  [<container>] [<object>]
+                  [<container> [<object>]]
 '''
 
 st_stat_help = '''
@@ -655,7 +655,7 @@ def st_stat(parser, args, output_manager):
 st_post_options = '''[--read-acl <acl>] [--write-acl <acl>] [--sync-to]
                   [--sync-key <sync-key>] [--meta <name:value>]
                   [--header <header>]
-                  [<container>] [<object>]
+                  [<container> [<object>]]
 '''
 
 st_post_help = '''

From 5eb0f3debc320340965460c04a1d6ca4f9c423a3 Mon Sep 17 00:00:00 2001
From: Ji-Wei <ji.wei3@zte.com.cn>
Date: Fri, 9 Sep 2016 17:30:17 +0800
Subject: [PATCH 023/316] Fix order of arguments in assertIs

Some tests used incorrect order assertIs(observed, expected).
The correct order expected by testtools is

assertIs(expected, observed, message='')
Assert that expected is observed.
Parameters:
  expected The expected value.
  observed The observed value.
  message An optional message describing the error.
https://docs.python.org/2/library/unittest.html

Change-Id: I5f406336b7804c13ca042dd0c6b30645a711c5f2
---
 tests/unit/test_utils.py | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/tests/unit/test_utils.py b/tests/unit/test_utils.py
index f0de79ce..949c3e17 100644
--- a/tests/unit/test_utils.py
+++ b/tests/unit/test_utils.py
@@ -32,10 +32,10 @@ def test_TRUE_VALUES(self):
     @mock.patch.object(u, 'TRUE_VALUES', 'hello world'.split())
     def test_config_true_value(self):
         for val in 'hello world HELLO WORLD'.split():
-            self.assertIs(u.config_true_value(val), True)
-        self.assertIs(u.config_true_value(True), True)
-        self.assertIs(u.config_true_value('foo'), False)
-        self.assertIs(u.config_true_value(False), False)
+            self.assertIs(True, u.config_true_value(val))
+        self.assertIs(True, u.config_true_value(True))
+        self.assertIs(False, u.config_true_value('foo'))
+        self.assertIs(False, u.config_true_value(False))
 
 
 class TestPrtBytes(unittest.TestCase):
@@ -265,11 +265,11 @@ def test_md5_creation(self):
         # Check creation with a real and noop md5 class
         data = u.ReadableToIterable(None, None, md5=True)
         self.assertEqual(md5().hexdigest(), data.get_md5sum())
-        self.assertIs(type(data.md5sum), type(md5()))
+        self.assertIs(type(md5()), type(data.md5sum))
 
         data = u.ReadableToIterable(None, None, md5=False)
         self.assertEqual('', data.get_md5sum())
-        self.assertIs(type(data.md5sum), u.NoopMD5)
+        self.assertIs(u.NoopMD5, type(data.md5sum))
 
     def test_unicode(self):
         # Check no errors are raised if unicode data is feed in.

From 4c955751d340a8f71a2eebdb3c58d90b36874a66 Mon Sep 17 00:00:00 2001
From: Alistair Coles <alistair.coles@hpe.com>
Date: Thu, 8 Sep 2016 14:15:40 +0100
Subject: [PATCH 024/316] Make tempurl command check for valid object path

If the supplied path is not of the form /v1/a/c/o then
swift tempurl subcommand will now return an error message.

Also removes redundant check for seconds parameter being an int
from shell.py because the same check is made when calling
utils.generate_temp_url.

Drive-by fix for missing param definition for generate_temp_url.

Change-Id: I41f4389948b01fadaa5fc4939ea12e0ed2167345
Related-Change: I0fb2ce125fe12d660e4deb778265016bdd5ff31b
---
 swiftclient/shell.py     | 14 +++++++-------
 swiftclient/utils.py     | 16 +++++++++++++---
 tests/unit/test_shell.py | 16 ++++++++++++++--
 tests/unit/test_utils.py | 26 ++++++++++++++++++++++++++
 4 files changed, 60 insertions(+), 12 deletions(-)

diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index e1a5a8d1..4e3ed0af 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -1239,17 +1239,17 @@ def st_tempurl(parser, args, thread_manager):
 
     parsed = urlparse(path)
 
-    try:
-        seconds = int(seconds)
-    except ValueError:
-        thread_manager.error('Seconds must be an integer')
-        return
     if method.upper() not in ['GET', 'PUT', 'HEAD', 'POST', 'DELETE']:
         thread_manager.print_msg('WARNING: Non default HTTP method %s for '
                                  'tempurl specified, possibly an error' %
                                  method.upper())
-    path = generate_temp_url(parsed.path, seconds, key, method,
-                             absolute=options['absolute_expiry'])
+    try:
+        path = generate_temp_url(parsed.path, seconds, key, method,
+                                 absolute=options['absolute_expiry'])
+    except ValueError as err:
+        thread_manager.error(err)
+        return
+
     if parsed.scheme and parsed.netloc:
         url = "%s://%s%s" % (parsed.scheme, parsed.netloc, path)
     else:
diff --git a/swiftclient/utils.py b/swiftclient/utils.py
index d3942839..2e727ad5 100644
--- a/swiftclient/utils.py
+++ b/swiftclient/utils.py
@@ -68,14 +68,20 @@ def generate_temp_url(path, seconds, key, method, absolute=False):
 
     :param path: The full path to the Swift object. Example:
         /v1/AUTH_account/c/o.
-    :param seconds: The amount of time in seconds the temporary URL will
-        be valid for.
+    :param seconds: If absolute is False then this specifies the amount of time
+        in seconds for which the temporary URL will be valid. If absolute is
+        True then this specifies an absolute time at which the temporary URL
+        will expire.
     :param key: The secret temporary URL key set on the Swift
         cluster. To set a key, run 'swift post -m
         "Temp-URL-Key: <substitute tempurl key here>"'
     :param method: A HTTP method, typically either GET or PUT, to allow
         for this temporary URL.
-    :raises: ValueError if seconds is not a positive integer
+    :param absolute: if True then the seconds parameter is interpreted as an
+        absolute Unix time, otherwise seconds is interpreted as a relative time
+        offset from current time.
+    :raises: ValueError if seconds is not a positive integer or path is not to
+        an object.
     :raises: TypeError if seconds is not an integer
     :return: the path portion of a temporary URL
     """
@@ -94,6 +100,10 @@ def generate_temp_url(path, seconds, key, method, absolute=False):
     else:
         path_for_body = path
 
+    parts = path_for_body.split('/', 4)
+    if len(parts) != 5 or parts[0] or not all(parts[1:]):
+        raise ValueError('path must be full path to an object e.g. /v1/a/c/o')
+
     standard_methods = ['GET', 'PUT', 'HEAD', 'POST', 'DELETE']
     if method.upper() not in standard_methods:
         logger = logging.getLogger("swiftclient")
diff --git a/tests/unit/test_shell.py b/tests/unit/test_shell.py
index 40881c24..3f077dc6 100644
--- a/tests/unit/test_shell.py
+++ b/tests/unit/test_shell.py
@@ -1402,7 +1402,7 @@ def test_temp_url(self, temp_url):
                 "secret_key"]
         swiftclient.shell.main(argv)
         temp_url.assert_called_with(
-            '/v1/AUTH_account/c/o', 60, 'secret_key', 'GET', absolute=False)
+            '/v1/AUTH_account/c/o', "60", 'secret_key', 'GET', absolute=False)
 
     @mock.patch('swiftclient.shell.generate_temp_url', return_value='')
     def test_absolute_expiry_temp_url(self, temp_url):
@@ -1410,7 +1410,7 @@ def test_absolute_expiry_temp_url(self, temp_url):
                 "secret_key", "--absolute"]
         swiftclient.shell.main(argv)
         temp_url.assert_called_with(
-            '/v1/AUTH_account/c/o', 60, 'secret_key', 'GET', absolute=True)
+            '/v1/AUTH_account/c/o', "60", 'secret_key', 'GET', absolute=True)
 
     def test_temp_url_output(self):
         argv = ["", "tempurl", "GET", "60", "/v1/a/c/o",
@@ -1428,6 +1428,18 @@ def test_temp_url_output(self):
         expected = "http://saio:8080%s" % expected
         self.assertEqual(expected, output.out)
 
+    def test_temp_url_error_output(self):
+        expected = 'path must be full path to an object e.g. /v1/a/c/o\n'
+        for bad_path in ('/v1/a/c', 'v1/a/c/o', '/v1/a/c/', '/v1/a//o',
+                         'http://saio/v1/a/c', 'http://v1/a/c/o'):
+            argv = ["", "tempurl", "GET", "60", bad_path,
+                    "secret_key", "--absolute"]
+            with CaptureOutput(suppress_systemexit=True) as output:
+                swiftclient.shell.main(argv)
+            self.assertEqual(expected, output.err,
+                             'Expected %r but got %r for path %r' %
+                             (expected, output.err, bad_path))
+
     @mock.patch('swiftclient.service.Connection')
     def test_capabilities(self, connection):
         argv = ["", "capabilities"]
diff --git a/tests/unit/test_utils.py b/tests/unit/test_utils.py
index f0de79ce..e820aff1 100644
--- a/tests/unit/test_utils.py
+++ b/tests/unit/test_utils.py
@@ -180,6 +180,32 @@ def test_generate_temp_url_bad_seconds(self):
         self.assertEqual(exc_manager.exception.args[0],
                          'seconds must be a positive integer')
 
+    def test_generate_temp_url_bad_path(self):
+        with self.assertRaises(ValueError) as exc_manager:
+            u.generate_temp_url('/v1/a/c', 60, self.key, self.method)
+        self.assertEqual(exc_manager.exception.args[0],
+                         'path must be full path to an object e.g. /v1/a/c/o')
+
+        with self.assertRaises(ValueError) as exc_manager:
+            u.generate_temp_url('v1/a/c/o', 60, self.key, self.method)
+        self.assertEqual(exc_manager.exception.args[0],
+                         'path must be full path to an object e.g. /v1/a/c/o')
+
+        with self.assertRaises(ValueError) as exc_manager:
+            u.generate_temp_url('blah/v1/a/c/o', 60, self.key, self.method)
+        self.assertEqual(exc_manager.exception.args[0],
+                         'path must be full path to an object e.g. /v1/a/c/o')
+
+        with self.assertRaises(ValueError) as exc_manager:
+            u.generate_temp_url('/v1//c/o', 60, self.key, self.method)
+        self.assertEqual(exc_manager.exception.args[0],
+                         'path must be full path to an object e.g. /v1/a/c/o')
+
+        with self.assertRaises(ValueError) as exc_manager:
+            u.generate_temp_url('/v1/a/c/', 60, self.key, self.method)
+        self.assertEqual(exc_manager.exception.args[0],
+                         'path must be full path to an object e.g. /v1/a/c/o')
+
 
 class TestTempURLUnicodePathAndKey(TestTempURL):
     url = u'/v1/\u00e4/c/\u00f3'

From e41158d79e4bcb280ec94365226f9423f72d7b66 Mon Sep 17 00:00:00 2001
From: Alistair Coles <alistair.coles@hpe.com>
Date: Fri, 9 Sep 2016 11:06:06 +0100
Subject: [PATCH 025/316] Make tempurl subcommand insist on whole number
 seconds

Previously the tempurl subcommand would dump a traceback
due to a TypeError if the seconds option was not an int
value. With this patch it will now return the same
error message as if the seconds option were negative or not
a number.

Also changes the error message to state that the seconds
option should be a "whole number" rather than a "positive
integer", since 0 is a valid value.

Change-Id: Ie940d470f2be8006aa8eb7fe242f092457aeae21
Closes-Bug: #1621817
---
 swiftclient/utils.py     | 12 +++++++-----
 tests/unit/test_utils.py | 21 ++++++++++++++++++---
 2 files changed, 25 insertions(+), 8 deletions(-)

diff --git a/swiftclient/utils.py b/swiftclient/utils.py
index 2e727ad5..0d1104e7 100644
--- a/swiftclient/utils.py
+++ b/swiftclient/utils.py
@@ -80,17 +80,19 @@ def generate_temp_url(path, seconds, key, method, absolute=False):
     :param absolute: if True then the seconds parameter is interpreted as an
         absolute Unix time, otherwise seconds is interpreted as a relative time
         offset from current time.
-    :raises: ValueError if seconds is not a positive integer or path is not to
+    :raises: ValueError if seconds is not a whole number or path is not to
         an object.
-    :raises: TypeError if seconds is not an integer
     :return: the path portion of a temporary URL
     """
     try:
+        seconds = float(seconds)
+        if not seconds.is_integer():
+            raise ValueError()
         seconds = int(seconds)
+        if seconds < 0:
+            raise ValueError()
     except ValueError:
-        raise TypeError('seconds must be an integer')
-    if seconds < 0:
-        raise ValueError('seconds must be a positive integer')
+        raise ValueError('seconds must be a whole number')
 
     if isinstance(path, six.binary_type):
         try:
diff --git a/tests/unit/test_utils.py b/tests/unit/test_utils.py
index e820aff1..67c39e07 100644
--- a/tests/unit/test_utils.py
+++ b/tests/unit/test_utils.py
@@ -170,15 +170,30 @@ def test_generate_absolute_expiry_temp_url(self, hmac_mock):
         self.assertEqual(url, expected_url)
 
     def test_generate_temp_url_bad_seconds(self):
-        with self.assertRaises(TypeError) as exc_manager:
+        with self.assertRaises(ValueError) as exc_manager:
             u.generate_temp_url(self.url, 'not_an_int', self.key, self.method)
         self.assertEqual(exc_manager.exception.args[0],
-                         'seconds must be an integer')
+                         'seconds must be a whole number')
 
         with self.assertRaises(ValueError) as exc_manager:
             u.generate_temp_url(self.url, -1, self.key, self.method)
         self.assertEqual(exc_manager.exception.args[0],
-                         'seconds must be a positive integer')
+                         'seconds must be a whole number')
+
+        with self.assertRaises(ValueError) as exc_manager:
+            u.generate_temp_url(self.url, 1.1, self.key, self.method)
+        self.assertEqual(exc_manager.exception.args[0],
+                         'seconds must be a whole number')
+
+        with self.assertRaises(ValueError) as exc_manager:
+            u.generate_temp_url(self.url, '-1', self.key, self.method)
+        self.assertEqual(exc_manager.exception.args[0],
+                         'seconds must be a whole number')
+
+        with self.assertRaises(ValueError) as exc_manager:
+            u.generate_temp_url(self.url, '1.1', self.key, self.method)
+        self.assertEqual(exc_manager.exception.args[0],
+                         'seconds must be a whole number')
 
     def test_generate_temp_url_bad_path(self):
         with self.assertRaises(ValueError) as exc_manager:

From 371f0e3482a6fbf963f6c1d987d48aed19dc8c3e Mon Sep 17 00:00:00 2001
From: Mohit Motiani <mohit.motiani@intel.com>
Date: Thu, 2 Jun 2016 17:51:20 +0000
Subject: [PATCH 026/316] Update help text around container ACL syntax

The patch add the information about the syntax of provding read and
write access to the users within a project.

The current status is:
account:* does not work with tempauth
account does not work with keystoneauth

Furthermore, the concept of "account" is fuzzy. It could be a
"project", but even that doesn't distinguish between a project
id and a project name.

Change-Id: I4462230fe05aa4a742e825f5b6312deb93bc1170
Closes-Bug: #1587677
---
 swiftclient/shell.py | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 5eafe0b6..3e8de7d3 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -663,10 +663,12 @@ def st_stat(parser, args, output_manager):
 
 Optional arguments:
   -r, --read-acl <acl>  Read ACL for containers. Quick summary of ACL syntax:
-                        .r:*, .r:-.example.com, .r:www.example.com, account1,
-                        account2:user2
+                        .r:*, .r:-.example.com, .r:www.example.com,
+                        account1 (v1.0 identity API only),
+                        account1:*, account2:user2 (v2.0+ identity API).
   -w, --write-acl <acl> Write ACL for containers. Quick summary of ACL syntax:
-                        account1 account2:user2
+                        account1 (v1.0 identity API only),
+                        account1:*, account2:user2 (v2.0+ identity API).
   -t, --sync-to <sync-to>
                         Sync To for containers, for multi-cluster replication.
   -k, --sync-key <sync-key>

From a9f21662dfcc8504c536d629d5721771ecc62d23 Mon Sep 17 00:00:00 2001
From: zheng yin <yin.zheng@easystack.cn>
Date: Wed, 21 Sep 2016 15:48:35 +0800
Subject: [PATCH 027/316] remove swiftclient/openstack/common/* in the
 .coveragerc

There is no swiftclient/openstack/common/* in python-swiftclient.
Therefore, I remove "omit=swiftclient/openstack/common/*"
in the .coveragerc.

Change-Id: Ibf4e4e499cb5538fcd8b1680285294c8a09ad401
---
 .coveragerc | 1 -
 1 file changed, 1 deletion(-)

diff --git a/.coveragerc b/.coveragerc
index 2f4084ac..b65e6bf5 100644
--- a/.coveragerc
+++ b/.coveragerc
@@ -1,7 +1,6 @@
 [run]
 branch = True
 source = swiftclient
-omit = swiftclient/openstack/common/*
 
 [report]
 ignore_errors = True

From 46937f8620ddaae42187f221c34b5e1a3b66468b Mon Sep 17 00:00:00 2001
From: John Dickinson <me@not.mn>
Date: Fri, 23 Sep 2016 13:01:07 -0700
Subject: [PATCH 028/316] add pypy to the bindep "test" profile

According to the bindep docs
(http://docs.openstack.org/infra/bindep/readme.html#profiles),
we can specify profiles for each entry listed.

Also added a bindep env to tox.ini.

Change-Id: Ifb59d3ef2934c3d72ba84b337c38bb7eb14774bb
---
 bindep.txt | 4 ++--
 tox.ini    | 9 +++++++++
 2 files changed, 11 insertions(+), 2 deletions(-)

diff --git a/bindep.txt b/bindep.txt
index c587dda2..efc54415 100644
--- a/bindep.txt
+++ b/bindep.txt
@@ -1,5 +1,5 @@
 # This is a cross-platform list tracking distribution packages needed by tests;
 # see http://docs.openstack.org/infra/bindep/ for additional information.
 
-pypy
-pypy-dev
+pypy [test]
+pypy-dev [test]
diff --git a/tox.ini b/tox.ini
index 26cfb112..84806cce 100644
--- a/tox.ini
+++ b/tox.ini
@@ -56,3 +56,12 @@ commands=
 ignore = H101,H301,H306,H401,H403,H404,H405
 show-source = True
 exclude = .venv,.tox,dist,doc,*egg
+
+[testenv:bindep]
+# Do not install any requirements. We want this to be fast and work even if
+# system dependencies are missing, since it's used to tell you what system
+# dependencies are missing! This also means that bindep must be installed
+# separately, outside of the requirements files.
+usedevelop = False
+deps = bindep
+commands = bindep test

From f1b935288376c01379d85cd3081856bd7e061239 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ond=C5=99ej=20Nov=C3=BD?= <ondrej.novy@firma.seznam.cz>
Date: Sat, 3 Sep 2016 11:47:58 +0200
Subject: [PATCH 029/316] Require newer version of oslosphinx

This newer version contains show_other_versions option, which is used in
conf.py

Change-Id: Iad82206cbed81d13e80e62b7faaca9dcc736ea15
---
 test-requirements.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/test-requirements.txt b/test-requirements.txt
index 0a813987..0ce9cece 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -2,6 +2,6 @@ hacking>=0.10.0,<0.11
 
 coverage>=3.6
 mock>=1.2
-oslosphinx
+oslosphinx>=4.7.0  # Apache-2.0
 sphinx>=1.1.2,<1.2
 testrepository>=0.0.18

From ab7a8b2453d4eda10d5790c73d132fe350548107 Mon Sep 17 00:00:00 2001
From: Anh Tran <anhtt@vn.fujitsu.com>
Date: Tue, 27 Sep 2016 16:08:44 +0700
Subject: [PATCH 030/316] TrivialFix: Removed redundant 'the'

Change-Id: I3b3c0e7e4d5c8a1934378e2083a64bb686754f18
---
 doc/source/service-api.rst | 2 +-
 swiftclient/client.py      | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/doc/source/service-api.rst b/doc/source/service-api.rst
index 66dd527f..8efd43a0 100644
--- a/doc/source/service-api.rst
+++ b/doc/source/service-api.rst
@@ -315,7 +315,7 @@ Valid calls for this method are as follows:
 * ``stat([options])``: Returns stats for the configured account.
 * ``stat(<container>, [options])``: Returns stats for the given container.
 * ``stat(<container>, <object_list>, [options])``: Returns stats for each
-  of the given objects in the the given container (through the returned
+  of the given objects in the given container (through the returned
   iterator).
 
 Results from stat are dictionaries indicating the success or failure of each
diff --git a/swiftclient/client.py b/swiftclient/client.py
index ee5a838d..dc9a09ec 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -607,8 +607,8 @@ def get_auth(auth_url, user, key, **kwargs):
     :returns: a tuple, (storage_url, token)
 
     N.B. if the optional os_options parameter includes a non-empty
-    'object_storage_url' key it will override the the default storage url
-    returned by the auth service.
+    'object_storage_url' key it will override the default storage url returned
+    by the auth service.
 
     The snet parameter is used for Rackspace's ServiceNet internal network
     implementation. In this function, it simply adds *snet-* to the beginning

From b3921b26e8659ec08476b070e4547e6eddc46781 Mon Sep 17 00:00:00 2001
From: Claudiu Belu <cbelu@cloudbasesolutions.com>
Date: Tue, 27 Sep 2016 06:46:32 -0700
Subject: [PATCH 031/316] Installs futures only for python 2.7 and 2.6

The futures library is native to python 3 and it doesn't
have to be installed from pypi.

If the futures library is installed, it can cause issues when used.

Changes the futures' library requirement to match the one in
global requirements. [1]

[1] https://github.com/openstack/requirements/blob/master/global-requirements.txt

Change-Id: I8f13d63a303b71f7bdd8c3e67c15d0a0df5ea7a9
Closes-Bug: #1628107
---
 requirements.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/requirements.txt b/requirements.txt
index 88b3df2c..6d31e09b 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,3 +1,3 @@
-futures>=2.1.3
+futures>=3.0;python_version=='2.7' or python_version=='2.6' # BSD
 requests>=1.1
 six>=1.5.2

From bb3160a42c72e9e2b8b1046ffbb2933a4397ff5d Mon Sep 17 00:00:00 2001
From: Anh Tran <anhtt@vn.fujitsu.com>
Date: Wed, 28 Sep 2016 11:25:56 +0700
Subject: [PATCH 032/316] Remove redundant space in docstring

TrivialFix

Change-Id: I7012fb7bbbedfba30b8e0450a449787e9076f4ef
---
 swiftclient/client.py | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index dc9a09ec..70d0675c 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -416,11 +416,11 @@ def __init__(self, url, proxy=None, cacert=None, insecure=False,
             self.requests_args['timeout'] = timeout
 
     def _request(self, *arg, **kwarg):
-        """ Final wrapper before requests call, to be patched in tests """
+        """Final wrapper before requests call, to be patched in tests"""
         return self.request_session.request(*arg, **kwarg)
 
     def request(self, method, full_path, data=None, headers=None, files=None):
-        """ Encode url and header, then call requests.request """
+        """Encode url and header, then call requests.request"""
         if headers is None:
             headers = {}
         else:
@@ -447,7 +447,7 @@ def putrequest(self, full_path, data=None, headers=None, files=None):
         return self.request('PUT', full_path, data, headers, files)
 
     def getresponse(self):
-        """ Adapt requests response to httplib interface """
+        """Adapt requests response to httplib interface"""
         self.resp.status = self.resp.status_code
         old_getheader = self.resp.raw.getheader
 
@@ -476,7 +476,7 @@ def releasing_read(*args, **kwargs):
 
 
 def http_connection(*arg, **kwarg):
-    """ :returns: tuple of (parsed url, connection object) """
+    """:returns: tuple of (parsed url, connection object)"""
     conn = HTTPConnection(*arg, **kwarg)
     return conn.parsed_url, conn
 

From 9be94f3baebf2412df4c70e2cc2949314e651f8d Mon Sep 17 00:00:00 2001
From: Yushiro FURUKAWA <y.furukawa_2@jp.fujitsu.com>
Date: Thu, 29 Sep 2016 20:19:55 +0900
Subject: [PATCH 033/316] Fix 'url' to 'URL'

TrivialFix

Change-Id: I6f35b0c48eda7d6021c2f6a13c084170ebf552d2
---
 doc/source/cli.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/source/cli.rst b/doc/source/cli.rst
index 87020c90..ad91ca99 100644
--- a/doc/source/cli.rst
+++ b/doc/source/cli.rst
@@ -244,7 +244,7 @@ Auth
     ``auth``
 
        Display authentication variables in shell friendly format. Command to run to export storage
-       url and auth token into ``OS_STORAGE_URL`` and ``OS_AUTH_TOKEN``: ``swift auth``.
+       URL and auth token into ``OS_STORAGE_URL`` and ``OS_AUTH_TOKEN``: ``swift auth``.
        Command to append to a runcom file (e.g. ``~/.bashrc``, ``/etc/profile``) for automatic
        authentication: ``swift auth -v -U test:tester -K testing``.
 

From a71c0d5a30452b7ddcd1bb4fa5dc9dc36028fb0c Mon Sep 17 00:00:00 2001
From: Anh Tran <anhtt@vn.fujitsu.com>
Date: Mon, 3 Oct 2016 09:35:59 +0700
Subject: [PATCH 034/316] Replace assertTrue(a in b) with assertIn(a, b)

Change-Id: I9726c9c051eea9264200ab27b3e556c68d5c927f
---
 tests/unit/test_shell.py | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/tests/unit/test_shell.py b/tests/unit/test_shell.py
index 33e297dd..718615d6 100644
--- a/tests/unit/test_shell.py
+++ b/tests/unit/test_shell.py
@@ -2138,7 +2138,7 @@ def _test_options_passed_to_keystone(self, cmd, opts, os_opts,
                              'Expected %s for key %s, found %s'
                              % (expected, key, actual_args[key]))
         for flag in flags:
-            self.assertTrue(flag in actual_args)
+            self.assertIn(flag, actual_args)
             self.assertTrue(actual_args[flag])
 
         check_attr = True
@@ -2647,7 +2647,7 @@ def test_segment_upload_with_write_only_access(self):
         self.assert_request(('PUT', segment_path_0))
         self.assert_request(('PUT', segment_path_1))
         self.assert_request(('PUT', self.obj_path))
-        self.assertTrue(self.obj[1:] in out.out)
+        self.assertIn(self.obj[1:], out.out)
         expected_err = "Warning: failed to create container '%s': 403 Fake" \
                        % self.cont
         self.assertEqual(expected_err, out.err.strip())
@@ -2693,7 +2693,7 @@ def test_segment_upload_with_write_only_access_segments_container(self):
         self.assert_request(('PUT', segment_path_0))
         self.assert_request(('PUT', segment_path_1))
         self.assert_request(('PUT', self.obj_path))
-        self.assertTrue(self.obj[1:] in out.out)
+        self.assertIn(self.obj[1:], out.out)
         expected_err = ("Warning: failed to create container '%s': 403 Fake\n"
                         "Warning: failed to create container '%s': 403 Fake"
                         ) % (self.cont, self.cont + '_segments')
@@ -2719,7 +2719,7 @@ def test_upload_with_no_access(self):
                              ('PUT', self.obj_path)])
         expected_err = 'Object PUT failed: http://1.2.3.4%s 403 Fake' \
                        % self.obj_path
-        self.assertTrue(expected_err in out.err)
+        self.assertIn(expected_err, out.err)
         self.assertEqual('', out)
 
     @mock.patch.object(swiftclient.service.SwiftService, '_should_bulk_delete',

From b6cf56deb9eba388c787d365e7f5b4aca67c57e1 Mon Sep 17 00:00:00 2001
From: Pallavi <pallavi.s@nectechnologies.in>
Date: Wed, 14 Sep 2016 10:27:02 +0530
Subject: [PATCH 035/316] Use ConfigParser instead of SafeConfigParser

The SafeConfigParser class has been renamed to ConfigParser in Python
3.2. This alias will be removed in future versions.So we can use
ConfigParser directly instead.

Change-Id: Ie0292271229ee77d1bc57dd897ebbbb3d3c059aa
Closes-Bug: #1618666
---
 tests/functional/test_swiftclient.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tests/functional/test_swiftclient.py b/tests/functional/test_swiftclient.py
index 0e6a3463..7fe9a54d 100644
--- a/tests/functional/test_swiftclient.py
+++ b/tests/functional/test_swiftclient.py
@@ -42,7 +42,7 @@ def __init__(self, *args, **kwargs):
     def _get_config(self):
         config_file = os.environ.get('SWIFT_TEST_CONFIG_FILE',
                                      '/etc/swift/test.conf')
-        config = configparser.SafeConfigParser({'auth_version': '1'})
+        config = configparser.ConfigParser({'auth_version': '1'})
         config.read(config_file)
         self.config = config
         if config.has_section('func_test'):

From 432df97c3a6022e58c973ad454d99a4e5140500a Mon Sep 17 00:00:00 2001
From: "shashi.kant" <shashi.kant@nectechnologies.in>
Date: Wed, 19 Oct 2016 17:57:51 +0530
Subject: [PATCH 036/316] Enable code coverage report in console output

Modified swift-client tox.ini configuration to enable code coverage
report in console output.

Change-Id: I60276d6a87c62f4a112b01d97ab35a545d4e5462
---
 tox.ini | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/tox.ini b/tox.ini
index 26cfb112..51e5b9c2 100644
--- a/tox.ini
+++ b/tox.ini
@@ -28,7 +28,8 @@ commands =
 commands = {posargs}
 
 [testenv:cover]
-commands = python setup.py testr --coverage
+commands = python setup.py testr --coverage 
+           coverage report
 
 [testenv:func]
 setenv = OS_TEST_PATH=tests.functional

From 4d040eecd9ff72c1a0a804b753a8e43956d00d02 Mon Sep 17 00:00:00 2001
From: zheng yin <yin.zheng@easystack.cn>
Date: Wed, 31 Aug 2016 18:45:30 +0800
Subject: [PATCH 037/316] Add commands examples for copy and delete

There are no examples for copy and delete command. For beginners,
they may not use both commands. Therefore, I add examples, then
beginners are able to understand how to use both commands.

Change-Id: Id702dc3f9ab903c1c1183c1e229dc6ebedaac0a7
---
 doc/source/cli.rst | 30 ++++++++++++++++++++++++++++--
 1 file changed, 28 insertions(+), 2 deletions(-)

diff --git a/doc/source/cli.rst b/doc/source/cli.rst
index 87020c90..5670f811 100644
--- a/doc/source/cli.rst
+++ b/doc/source/cli.rst
@@ -294,6 +294,30 @@ List the contents of a container:
 
     testSwift.txt
 
+Copy an object to new destination:
+
+.. code-block:: bash
+
+    > swift copy -d /DestContainer/testSwift.txt SourceContainer testSwift.txt
+
+    SourceContainer/testSwift.txt copied to /DestContainer/testSwift.txt
+
+Delete an object from a container:
+
+.. code-block:: bash
+
+    > swift delete TestContainer testSwift.txt
+
+    testSwift.txt
+
+Delete a container:
+
+.. code-block:: bash
+
+    > swift delete TestContainer
+
+    TestContainer
+
 Display auth related authentication variables in shell friendly format:
 
 .. code-block:: bash
@@ -318,8 +342,10 @@ Download an object from a container:
 
      To upload an object to a container, your current working directory must be
      where the file is located or you must provide the complete path to the file.
-     In the case that you provide the complete path of the file, that complete
-     path will be the name of the uploaded object.
+     In other words, the --object-name <object-name> is an option that will upload
+     file and name object to <object-name> or upload directory and use <object-name> as
+     object prefix. In the case that you provide the complete path of the file,
+     that complete path will be the name of the uploaded object.
 
 For example:
 

From a38efb6031efda7a076886066b6993cdb144f6a3 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 1 Apr 2016 15:12:20 -0700
Subject: [PATCH 038/316] Add v1password keystoneauth plugin

This lets us use Keystone sessions against endpoints like swauth and
tempauth with code like:

    import keystoneauth1.loading
    import keystoneauth1.session
    import swiftclient

    loader = keystoneauth1.loading.get_plugin_loader('v1password')
    auth_plugin = loader.load_from_options(
        auth_url='http://saio:8080/auth/v1.0',
        username='test:tester',
        password='testing')
    keystone_session = keystoneauth1.session.Session(auth_plugin)

    conn = swiftclient.Connection(session=keystone_session)

The plugin includes an optional project_name option, which may be used
to override the swift account from the storage url that was returned.
Additionally, it includes enough infrastructure to support some commands
in python-openstackclient>=3.0:

    export OS_AUTH_TYPE=v1password
    export OS_AUTH_URL=http://saio:8080/auth/v1.0
    export OS_PROJECT_NAME=AUTH_test2
    export OS_USERNAME=test:tester
    export OS_PASSWORD=testing

    openstack token issue
    openstack catalog list
    openstack catalog show object-store
    openstack object store account show
    openstack container list
    openstack container create <container>
    openstack container save <container>
    openstack container show <container>
    openstack container delete <container>
    openstack object list <container>
    openstack object create <container> <file>
    openstack object save <container> <object>
    opsentack object show <container> <object>
    openstack object delete <container> <object>

Change-Id: Ia963dc44415f72a6518227e86d9528a987e07491
---
 doc/source/conf.py         |   2 +-
 doc/source/swiftclient.rst |   6 +
 setup.cfg                  |   3 +
 swiftclient/authv1.py      | 350 +++++++++++++++++++++++++++++++++++++
 tests/unit/test_authv1.py  | 246 ++++++++++++++++++++++++++
 5 files changed, 606 insertions(+), 1 deletion(-)
 create mode 100644 swiftclient/authv1.py
 create mode 100644 tests/unit/test_authv1.py

diff --git a/doc/source/conf.py b/doc/source/conf.py
index 0b3e7e1a..bf3ca714 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -51,7 +51,7 @@
 
 # General information about the project.
 project = u'Swiftclient'
-copyright = u'2013 OpenStack, LLC.'
+copyright = u'2013-2016 OpenStack, LLC.'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
diff --git a/doc/source/swiftclient.rst b/doc/source/swiftclient.rst
index e96afba5..108443ae 100644
--- a/doc/source/swiftclient.rst
+++ b/doc/source/swiftclient.rst
@@ -5,6 +5,12 @@ swiftclient
 
 .. automodule:: swiftclient
 
+swiftclient.authv1
+==================
+
+.. automodule:: swiftclient.authv1
+   :inherited-members:
+
 swiftclient.client
 ==================
 
diff --git a/setup.cfg b/setup.cfg
index 5451867f..4af3151e 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -40,6 +40,9 @@ keystone =
 console_scripts =
     swift = swiftclient.shell:main
 
+keystoneauth1.plugin =
+    v1password = swiftclient.authv1:PasswordLoader
+
 [build_sphinx]
 source-dir = doc/source
 build-dir = doc/build
diff --git a/swiftclient/authv1.py b/swiftclient/authv1.py
new file mode 100644
index 00000000..55469acf
--- /dev/null
+++ b/swiftclient/authv1.py
@@ -0,0 +1,350 @@
+# Copyright 2016 OpenStack Foundation
+#
+# 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.
+
+"""
+Authentication plugin for keystoneauth to support v1 endpoints.
+
+Way back in the long-long ago, there was no Keystone. Swift used an auth
+mechanism now known as "v1", which used only HTTP headers. Auth requests
+and responses would look something like::
+
+   > GET /auth/v1.0 HTTP/1.1
+   > Host: <swift server>
+   > X-Auth-User: <tenant>:<user>
+   > X-Auth-Key: <password>
+   >
+   < HTTP/1.1 200 OK
+   < X-Storage-Url: http://<swift server>/v1/<tenant account>
+   < X-Auth-Token: <token>
+   < X-Storage-Token: <token>
+   <
+
+This plugin provides a way for Keystone sessions (and clients that
+use them, like python-openstackclient) to communicate with old auth
+endpoints that still use this mechanism, such as tempauth, swauth,
+or https://identity.api.rackspacecloud.com/v1.0
+"""
+
+import datetime
+import json
+import time
+
+from six.moves.urllib.parse import urljoin
+
+# Note that while we import keystoneauth1 here, we *don't* need to add it to
+# requirements.txt -- this entire module only makes sense (and should only be
+# loaded) if keystoneauth is already installed.
+from keystoneauth1 import plugin
+from keystoneauth1 import exceptions
+from keystoneauth1 import loading
+from keystoneauth1.identity import base
+
+
+# stupid stdlib...
+class _UTC(datetime.tzinfo):
+    def utcoffset(self, dt):
+        return datetime.timedelta(0)
+
+    def tzname(self, dt):
+        return "UTC"
+
+    def dst(self, dt):
+        return datetime.timedelta(0)
+
+
+UTC = _UTC()
+del _UTC
+
+
+class ServiceCatalogV1(object):
+    def __init__(self, auth_url, storage_url, account):
+        self.auth_url = auth_url
+        self._storage_url = storage_url
+        self._account = account
+
+    @property
+    def storage_url(self):
+        if self._account:
+            return urljoin(self._storage_url.rstrip('/'), self._account)
+        return self._storage_url
+
+    @property
+    def catalog(self):
+        # openstackclient wants this for the `catalog list` and
+        # `catalog show` commands
+        endpoints = [{
+            'region': 'default',
+            'publicURL': self._storage_url,
+        }]
+        if self.storage_url != self._storage_url:
+            endpoints.insert(0, {
+                'region': 'override',
+                'publicURL': self.storage_url,
+            })
+
+        return [
+            {
+                'name': 'swift',
+                'type': 'object-store',
+                'endpoints': endpoints,
+            },
+            {
+                'name': 'auth',
+                'type': 'identity',
+                'endpoints': [{
+                    'region': 'default',
+                    'publicURL': self.auth_url,
+                }],
+            }
+        ]
+
+    def url_for(self, **kwargs):
+        kwargs.setdefault('interface', 'public')
+        kwargs.setdefault('service_type', None)
+
+        if kwargs['service_type'] == 'object-store':
+            return self.storage_url
+
+        # Although our "catalog" includes an identity entry, nothing that uses
+        # url_for() (including `openstack endpoint list`) will know what to do
+        # with it. Better to just raise the exception, cribbing error messages
+        # from keystoneauth1/access/service_catalog.py
+
+        if 'service_name' in kwargs and 'region_name' in kwargs:
+            msg = ('%(interface)s endpoint for %(service_type)s service '
+                   'named %(service_name)s in %(region_name)s region not '
+                   'found' % kwargs)
+        elif 'service_name' in kwargs:
+            msg = ('%(interface)s endpoint for %(service_type)s service '
+                   'named %(service_name)s not found' % kwargs)
+        elif 'region_name' in kwargs:
+            msg = ('%(interface)s endpoint for %(service_type)s service '
+                   'in %(region_name)s region not found' % kwargs)
+        else:
+            msg = ('%(interface)s endpoint for %(service_type)s service '
+                   'not found' % kwargs)
+
+        raise exceptions.EndpointNotFound(msg)
+
+
+class AccessInfoV1(object):
+    """An object for encapsulating a raw v1 auth token."""
+
+    def __init__(self, auth_url, storage_url, account, username, auth_token,
+                 token_life):
+        self.auth_url = auth_url
+        self.storage_url = storage_url
+        self.account = account
+        self.service_catalog = ServiceCatalogV1(auth_url, storage_url, account)
+        self.username = username
+        self.auth_token = auth_token
+        self._issued = time.time()
+        try:
+            self._expires = self._issued + float(token_life)
+        except (TypeError, ValueError):
+            self._expires = None
+        # following is used by openstackclient
+        self.project_id = None
+
+    @property
+    def expires(self):
+        if self._expires is None:
+            return None
+        return datetime.datetime.fromtimestamp(self._expires, UTC)
+
+    @property
+    def issued(self):
+        return datetime.datetime.fromtimestamp(self._issued, UTC)
+
+    @property
+    def user_id(self):
+        # openstackclient wants this for the `token issue` command
+        return self.username
+
+    def will_expire_soon(self, stale_duration):
+        """Determines if expiration is about to occur.
+
+        :returns: true if expiration is within the given duration
+        """
+        if self._expires is None:
+            return False  # assume no expiration
+        return time.time() + stale_duration > self._expires
+
+    def get_state(self):
+        """Serialize the current state."""
+        return json.dumps({
+            'auth_url': self.auth_url,
+            'storage_url': self.storage_url,
+            'account': self.account,
+            'username': self.username,
+            'auth_token': self.auth_token,
+            'issued': self._issued,
+            'expires': self._expires}, sort_keys=True)
+
+    @classmethod
+    def from_state(cls, data):
+        """Deserialize the given state.
+
+        :returns: a new AccessInfoV1 object with the given state
+        """
+        data = json.loads(data)
+        access = cls(
+            data['auth_url'],
+            data['storage_url'],
+            data['account'],
+            data['username'],
+            data['auth_token'],
+            token_life=None)
+        access._issued = data['issued']
+        access._expires = data['expires']
+        return access
+
+
+class PasswordPlugin(base.BaseIdentityPlugin):
+    """A plugin for authenticating with a username and password.
+
+    Subclassing from BaseIdentityPlugin gets us a few niceties, like handling
+    token invalidation and locking during authentication.
+
+    :param string auth_url: Identity v1 endpoint for authorization.
+    :param string username: Username for authentication.
+    :param string password: Password for authentication.
+    :param string project_name: Swift account to use after authentication.
+                                We use 'project_name' to be consistent with
+                                other auth plugins.
+    :param string reauthenticate: Whether to allow re-authentication.
+    """
+    access_class = AccessInfoV1
+
+    def __init__(self, auth_url, username, password, project_name=None,
+                 reauthenticate=True):
+        super(PasswordPlugin, self).__init__(
+            auth_url=auth_url,
+            reauthenticate=reauthenticate)
+        self.user = username
+        self.key = password
+        self.account = project_name
+
+    def get_auth_ref(self, session, **kwargs):
+        """Obtain a token from a v1 endpoint.
+
+        This function should not be called independently and is expected to be
+        invoked via the do_authenticate function.
+
+        This function will be invoked if the AcessInfo object cached by the
+        plugin is not valid. Thus plugins should always fetch a new AccessInfo
+        when invoked. If you are looking to just retrieve the current auth
+        data then you should use get_access.
+
+        :param session: A session object that can be used for communication.
+
+        :returns: Token access information.
+        """
+        headers = {'X-Auth-User': self.user,
+                   'X-Auth-Key': self.key}
+
+        resp = session.get(self.auth_url, headers=headers,
+                           authenticated=False, log=False)
+
+        if resp.status_code // 100 != 2:
+            raise exceptions.InvalidResponse(response=resp)
+
+        if 'X-Storage-Url' not in resp.headers:
+            raise exceptions.InvalidResponse(response=resp)
+
+        if 'X-Auth-Token' not in resp.headers and \
+                'X-Storage-Token' not in resp.headers:
+            raise exceptions.InvalidResponse(response=resp)
+        token = resp.headers.get('X-Storage-Token',
+                                 resp.headers.get('X-Auth-Token'))
+        return AccessInfoV1(
+            auth_url=self.auth_url,
+            storage_url=resp.headers['X-Storage-Url'],
+            account=self.account,
+            username=self.user,
+            auth_token=token,
+            token_life=resp.headers.get('X-Auth-Token-Expires'))
+
+    def get_cache_id_elements(self):
+        """Get the elements for this auth plugin that make it unique."""
+        return {'auth_url': self.auth_url,
+                'user': self.user,
+                'key': self.key,
+                'account': self.account}
+
+    def get_endpoint(self, session, interface='public', **kwargs):
+        """Return an endpoint for the client."""
+        if interface is plugin.AUTH_INTERFACE:
+            return self.auth_url
+        else:
+            return self.get_access(session).service_catalog.url_for(
+                interface=interface, **kwargs)
+
+    def get_auth_state(self):
+        """Retrieve the current authentication state for the plugin.
+
+        :returns: raw python data (which can be JSON serialized) that can be
+                  moved into another plugin (of the same type) to have the
+                  same authenticated state.
+        """
+        if self.auth_ref:
+            return self.auth_ref.get_state()
+
+    def set_auth_state(self, data):
+        """Install existing authentication state for a plugin.
+
+        Take the output of get_auth_state and install that authentication state
+        into the current authentication plugin.
+        """
+        if data:
+            self.auth_ref = self.access_class.from_state(data)
+        else:
+            self.auth_ref = None
+
+    def get_sp_auth_url(self, *args, **kwargs):
+        raise NotImplementedError()
+
+    def get_sp_url(self, *args, **kwargs):
+        raise NotImplementedError()
+
+    def get_discovery(self, *args, **kwargs):
+        raise NotImplementedError()
+
+
+class PasswordLoader(loading.BaseLoader):
+    """Option handling for the ``v1password`` plugin."""
+    plugin_class = PasswordPlugin
+
+    def get_options(self):
+        """Return the list of parameters associated with the auth plugin.
+
+        This list may be used to generate CLI or config arguments.
+        """
+        return [
+            loading.Opt('auth-url', required=True,
+                        help='Authentication URL'),
+            # overload project-name as a way to specify an alternate account,
+            # since:
+            #   - in a world of just users & passwords, this seems the closest
+            #     analog to a project, and
+            #   - openstackclient will (or used to?) still require that you
+            #     provide one anyway
+            loading.Opt('project-name', required=False,
+                        help='Swift account to use'),
+            loading.Opt('username', required=True,
+                        deprecated=[loading.Opt('user-name')],
+                        help='Username to login with'),
+            loading.Opt('password', required=True, secret=True,
+                        help='Password to use'),
+        ]
diff --git a/tests/unit/test_authv1.py b/tests/unit/test_authv1.py
new file mode 100644
index 00000000..968109a5
--- /dev/null
+++ b/tests/unit/test_authv1.py
@@ -0,0 +1,246 @@
+# Copyright 2016 OpenStack Foundation
+#
+# 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 datetime
+import json
+import mock
+import unittest
+from keystoneauth1 import plugin
+from keystoneauth1 import loading
+from keystoneauth1 import exceptions
+from swiftclient import authv1
+
+
+class TestDataNoAccount(object):
+    options = dict(
+        auth_url='http://saio:8080/auth/v1.0',
+        username='test:tester',
+        password='testing')
+    storage_url = 'http://saio:8080/v1/AUTH_test'
+    expected_endpoint = storage_url
+    token = 'token'
+
+
+class TestDataWithAccount(object):
+    options = dict(
+        auth_url='http://saio:8080/auth/v1.0',
+        username='test2:tester2',
+        project_name='SOME_other_account',
+        password='testing2')
+    storage_url = 'http://saio:8080/v1/AUTH_test2'
+    expected_endpoint = 'http://saio:8080/v1/SOME_other_account'
+    token = 'other_token'
+
+
+class TestPluginLoading(TestDataNoAccount, unittest.TestCase):
+    def test_can_load(self):
+        loader = loading.get_plugin_loader('v1password')
+        self.assertIsInstance(loader, authv1.PasswordLoader)
+
+        auth_plugin = loader.load_from_options(**self.options)
+        self.assertIsInstance(auth_plugin, authv1.PasswordPlugin)
+
+        self.assertEqual(self.options['auth_url'], auth_plugin.auth_url)
+        self.assertEqual(self.options['username'], auth_plugin.user)
+        self.assertEqual(self.options.get('project_name'), auth_plugin.account)
+        self.assertEqual(self.options['password'], auth_plugin.key)
+
+    def test_get_state(self):
+        auth_plugin = authv1.PasswordPlugin(**self.options)
+        self.assertIsNone(auth_plugin.get_auth_state())
+
+        with mock.patch('swiftclient.authv1.time.time', return_value=1234.56):
+            auth_plugin.auth_ref = authv1.AccessInfoV1(
+                self.options['auth_url'],
+                self.storage_url,
+                self.options.get('project_name'),
+                self.options['username'],
+                self.token,
+                60)
+
+        expected = json.dumps({
+            'auth_url': self.options['auth_url'],
+            'username': self.options['username'],
+            'account': self.options.get('project_name'),
+            'issued': 1234.56,
+            'storage_url': self.storage_url,
+            'auth_token': self.token,
+            'expires': 1234.56 + 60,
+        }, sort_keys=True)
+        self.assertEqual(expected, auth_plugin.auth_ref.get_state())
+        self.assertEqual(expected, auth_plugin.get_auth_state())
+
+    def test_set_state(self):
+        auth_plugin = authv1.PasswordPlugin(**self.options)
+        self.assertIsNone(auth_plugin.auth_ref)
+
+        auth_plugin.auth_ref = object()
+        auth_plugin.set_auth_state(None)
+        self.assertIsNone(auth_plugin.get_auth_state())
+
+        state = json.dumps({
+            'auth_url': self.options['auth_url'],
+            'username': self.options['username'],
+            'account': self.options.get('project_name'),
+            'issued': 1234.56,
+            'storage_url': self.storage_url,
+            'auth_token': self.token,
+            'expires': None,
+        }, sort_keys=True)
+        auth_plugin.set_auth_state(state)
+        self.assertIsInstance(auth_plugin.auth_ref, authv1.AccessInfoV1)
+
+        self.assertEqual(self.options['username'],
+                         auth_plugin.auth_ref.username)
+        self.assertEqual(self.options['auth_url'],
+                         auth_plugin.auth_ref.auth_url)
+        self.assertEqual(self.storage_url, auth_plugin.auth_ref.storage_url)
+        self.assertEqual(self.options.get('project_name'), auth_plugin.account)
+        self.assertEqual(self.token, auth_plugin.auth_ref.auth_token)
+        self.assertEqual(1234.56, auth_plugin.auth_ref._issued)
+        self.assertIs(datetime.datetime, type(auth_plugin.auth_ref.issued))
+        self.assertIsNone(auth_plugin.auth_ref._expires)
+        self.assertIsNone(auth_plugin.auth_ref.expires)
+
+
+class TestPluginLoadingWithAccount(TestDataWithAccount, TestPluginLoading):
+    pass
+
+
+class TestPlugin(TestDataNoAccount, unittest.TestCase):
+    def setUp(self):
+        self.mock_session = mock.MagicMock()
+        self.mock_response = self.mock_session.get.return_value
+        self.mock_response.status_code = 200
+        self.mock_response.headers = {
+            'X-Auth-Token': self.token,
+            'X-Storage-Url': self.storage_url,
+        }
+
+    def test_get_access(self):
+        auth_plugin = authv1.PasswordPlugin(**self.options)
+        with mock.patch('swiftclient.authv1.time.time', return_value=1234.56):
+            access = auth_plugin.get_access(self.mock_session)
+
+        self.assertEqual(self.mock_session.get.mock_calls, [mock.call(
+            self.options['auth_url'], authenticated=False, log=False, headers={
+                'X-Auth-User': self.options['username'],
+                'X-Auth-Key': self.options['password'],
+            })])
+
+        self.assertEqual(self.options['username'], access.username)
+        # `openstack token issue` requires a user_id property
+        self.assertEqual(self.options['username'], access.user_id)
+        self.assertEqual(self.storage_url, access.storage_url)
+        self.assertEqual(self.token, access.auth_token)
+        self.assertEqual(1234.56, access._issued)
+        self.assertIs(datetime.datetime, type(auth_plugin.auth_ref.issued))
+        self.assertIsNone(access.expires)
+
+        # `openstack catalog list/show` require a catalog property
+        catalog = access.service_catalog.catalog
+        self.assertEqual('swift', catalog[0].get('name'))
+        self.assertEqual('object-store', catalog[0].get('type'))
+        self.assertIn('endpoints', catalog[0])
+        self.assertIn(self.storage_url, [
+            e.get('publicURL') for e in catalog[0]['endpoints']])
+
+    def test_get_access_with_expiry(self):
+        auth_plugin = authv1.PasswordPlugin(**self.options)
+        self.mock_response.headers['X-Auth-Token-Expires'] = '78.9'
+        with mock.patch('swiftclient.authv1.time.time',
+                        return_value=1234.56) as mock_time:
+            access = auth_plugin.get_access(self.mock_session)
+            self.assertEqual(1234.56 + 78.9, access._expires)
+            self.assertIs(datetime.datetime,
+                          type(auth_plugin.auth_ref.expires))
+
+            self.assertIs(True, access.will_expire_soon(90))
+            self.assertIs(False, access.will_expire_soon(60))
+        self.assertEqual(3, len(mock_time.mock_calls))
+
+    def test_get_access_bad_expiry(self):
+        auth_plugin = authv1.PasswordPlugin(**self.options)
+        self.mock_response.headers['X-Auth-Token-Expires'] = 'foo'
+        access = auth_plugin.get_access(self.mock_session)
+        self.assertEqual(None, access.expires)
+
+        self.assertIs(False, access.will_expire_soon(60))
+        self.assertIs(False, access.will_expire_soon(1e20))
+
+    def test_get_access_bad_status(self):
+        auth_plugin = authv1.PasswordPlugin(**self.options)
+        self.mock_response.status_code = 401
+        self.assertRaises(exceptions.InvalidResponse,
+                          auth_plugin.get_access, self.mock_session)
+
+    def test_get_access_missing_token(self):
+        auth_plugin = authv1.PasswordPlugin(**self.options)
+        self.mock_response.headers.pop('X-Auth-Token')
+        self.assertRaises(exceptions.InvalidResponse,
+                          auth_plugin.get_access, self.mock_session)
+
+    def test_get_access_accepts_storage_token(self):
+        auth_plugin = authv1.PasswordPlugin(**self.options)
+        self.mock_response.headers.pop('X-Auth-Token')
+        self.mock_response.headers['X-Storage-Token'] = 'yet another token'
+        access = auth_plugin.get_access(self.mock_session)
+        self.assertEqual('yet another token', access.auth_token)
+
+    def test_get_access_missing_url(self):
+        auth_plugin = authv1.PasswordPlugin(**self.options)
+        self.mock_response.headers.pop('X-Storage-Url')
+        self.assertRaises(exceptions.InvalidResponse,
+                          auth_plugin.get_access, self.mock_session)
+
+    def test_get_endpoint(self):
+        auth_plugin = authv1.PasswordPlugin(**self.options)
+
+        object_store_endpoint = auth_plugin.get_endpoint(
+            self.mock_session, service_type='object-store')
+        self.assertEqual(object_store_endpoint, self.expected_endpoint)
+
+        auth_endpoint = auth_plugin.get_endpoint(
+            self.mock_session, interface=plugin.AUTH_INTERFACE)
+        self.assertEqual(auth_endpoint, self.options['auth_url'])
+
+        with self.assertRaises(exceptions.EndpointNotFound) as exc_mgr:
+            auth_plugin.get_endpoint(self.mock_session)
+        self.assertEqual('public endpoint for None service not found',
+                         str(exc_mgr.exception))
+
+        with self.assertRaises(exceptions.EndpointNotFound) as exc_mgr:
+            auth_plugin.get_endpoint(
+                self.mock_session, service_type='identity', region_name='DFW')
+        self.assertEqual(
+            'public endpoint for identity service in DFW region not found',
+            str(exc_mgr.exception))
+
+        with self.assertRaises(exceptions.EndpointNotFound) as exc_mgr:
+            auth_plugin.get_endpoint(
+                self.mock_session, service_type='image', service_name='glance')
+        self.assertEqual(
+            'public endpoint for image service named glance not found',
+            str(exc_mgr.exception))
+
+        with self.assertRaises(exceptions.EndpointNotFound) as exc_mgr:
+            auth_plugin.get_endpoint(
+                self.mock_session, service_type='compute', service_name='nova',
+                region_name='IAD')
+        self.assertEqual('public endpoint for compute service named nova in '
+                         'IAD region not found', str(exc_mgr.exception))
+
+
+class TestPluginWithAccount(TestDataWithAccount, TestPlugin):
+    pass

From 481f74caf1ffc649128bb8db84ac9104304420a9 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 28 Oct 2016 12:19:35 +0200
Subject: [PATCH 039/316] Low-level API: Don't log just before raising an
 exception

The only logging we should do is when we've encountered a problem *and
we've dealt with it ourselves*. When we're raising an exception, it
should be up to the caller to decide whether to log anything about it.

Anything else is just rude.

Change-Id: I1c96b76d90a78b7a10ffe63e4a7440c8f579147c
Closes-Bug:  1213179
Related-Bug: 1202229
---
 swiftclient/client.py | 9 ++-------
 1 file changed, 2 insertions(+), 7 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index b0d2bf35..6eefec4b 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -307,9 +307,8 @@ def read(self, length=None):
         try:
             buf = self.resp.read(length)
             self.bytes_read += len(buf)
-        except (socket.error, RequestException) as e:
+        except (socket.error, RequestException):
             if self.conn.attempts > self.conn.retries:
-                logger.exception(e)
                 raise
         if (not buf and self.bytes_read < self.expected_length and
                 self.conn.attempts <= self.conn.retries):
@@ -1659,10 +1658,9 @@ def _retry(self, reset_func, func, *args, **kwargs):
                 return rv
             except SSLError:
                 raise
-            except (socket.error, RequestException) as e:
+            except (socket.error, RequestException):
                 self._add_response_dict(caller_response_dict, kwargs)
                 if self.attempts > self.retries:
-                    logger.exception(e)
                     raise
                 self.http_conn = None
             except ClientException as err:
@@ -1677,11 +1675,9 @@ def _retry(self, reset_func, func, *args, **kwargs):
                     self.url = self.token = self.service_token = None
 
                     if retried_auth or not should_retry:
-                        logger.exception(err)
                         raise
                     retried_auth = True
                 elif self.attempts > self.retries or err.http_status is None:
-                    logger.exception(err)
                     raise
                 elif err.http_status == 408:
                     self.http_conn = None
@@ -1690,7 +1686,6 @@ def _retry(self, reset_func, func, *args, **kwargs):
                 elif self.retry_on_ratelimit and err.http_status == 498:
                     pass
                 else:
-                    logger.exception(err)
                     raise
             sleep(backoff)
             backoff = min(backoff * 2, self.max_backoff)

From 5296daad83792b29a3eb61516f87b97dfb990e4d Mon Sep 17 00:00:00 2001
From: Matthew Oliver <matt@oliver.net.au>
Date: Sat, 29 Oct 2016 11:36:27 +0200
Subject: [PATCH 040/316] Correct the example keystone session code imports

This is a follow up to patch Ia3fd947ff619c11ff0ce474897533dcf7b49d9b3.
One of the imports for the keystone session example was wrong. It was
trying to import v3 like:

  from keystoneauth1 import v3

Whereas in my testing v3 actually exists deeper under identity:

  from keystoneauth1.identity import v3

This patch fixes this import in the example documentation.

Change-Id: Ie31144fe65116d20a36b83a96079a3804bf55f29
---
 doc/source/client-api.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/source/client-api.rst b/doc/source/client-api.rst
index ff88d7d9..57f49cb2 100644
--- a/doc/source/client-api.rst
+++ b/doc/source/client-api.rst
@@ -24,7 +24,7 @@ Keystone Session
 .. code-block:: python
 
     from keystoneauth1 import session
-    from keystoneauth1 import v3
+    from keystoneauth1.identity import v3
 
     # Create a password auth plugin
     auth = v3.Password(auth_url='http://127.0.0.1:5000/v3/',

From 6cf2bd6626df8e4c68bd5463d9b030e315f76b42 Mon Sep 17 00:00:00 2001
From: Charles Hsu <charles0126@gmail.com>
Date: Mon, 19 Sep 2016 23:18:18 +0800
Subject: [PATCH 041/316] Add additional headers for HEAD/GET/DELETE requests.

Change-Id: I69276ba711057c122f97deac412e492e313c34dd
Closes-Bug: 1615830
---
 swiftclient/client.py          |  65 +++++++----
 swiftclient/command_helpers.py |  14 ++-
 swiftclient/service.py         |  46 +++++---
 swiftclient/shell.py           |  27 ++++-
 swiftclient/utils.py           |  14 +++
 tests/unit/test_service.py     | 158 ++++++++++++++++++++++----
 tests/unit/test_shell.py       | 197 ++++++++++++++++++++++++++++-----
 tests/unit/test_swiftclient.py |   2 +-
 8 files changed, 426 insertions(+), 97 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index ee5a838d..3e17430f 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -696,7 +696,7 @@ def store_response(resp, response_dict):
 
 def get_account(url, token, marker=None, limit=None, prefix=None,
                 end_marker=None, http_conn=None, full_listing=False,
-                service_token=None):
+                service_token=None, headers=None):
     """
     Get a listing of containers for the account.
 
@@ -711,20 +711,28 @@ def get_account(url, token, marker=None, limit=None, prefix=None,
     :param full_listing: if True, return a full listing, else returns a max
                          of 10000 listings
     :param service_token: service auth token
+    :param headers: additional headers to include in the request
     :returns: a tuple of (response headers, a list of containers) The response
               headers will be a dict and all header names will be lowercase.
     :raises ClientException: HTTP GET request failed
     """
+    req_headers = {'X-Auth-Token': token, 'Accept-Encoding': 'gzip'}
+    if service_token:
+        req_headers['X-Service-Token'] = service_token
+    if headers:
+        req_headers.update(headers)
+
     if not http_conn:
         http_conn = http_connection(url)
     if full_listing:
         rv = get_account(url, token, marker, limit, prefix,
-                         end_marker, http_conn)
+                         end_marker, http_conn, headers=req_headers)
         listing = rv[1]
         while listing:
             marker = listing[-1]['name']
             listing = get_account(url, token, marker, limit, prefix,
-                                  end_marker, http_conn)[1]
+                                  end_marker, http_conn,
+                                  headers=req_headers)[1]
             if listing:
                 rv[1].extend(listing)
         return rv
@@ -739,14 +747,12 @@ def get_account(url, token, marker=None, limit=None, prefix=None,
     if end_marker:
         qs += '&end_marker=%s' % quote(end_marker)
     full_path = '%s?%s' % (parsed.path, qs)
-    headers = {'X-Auth-Token': token, 'Accept-Encoding': 'gzip'}
-    if service_token:
-        headers['X-Service-Token'] = service_token
     method = 'GET'
-    conn.request(method, full_path, '', headers)
+    conn.request(method, full_path, '', req_headers)
     resp = conn.getresponse()
     body = resp.read()
-    http_log(("%s?%s" % (url, qs), method,), {'headers': headers}, resp, body)
+    http_log(("%s?%s" % (url, qs), method,), {'headers': req_headers},
+             resp, body)
 
     resp_headers = resp_header_dict(resp)
     if resp.status < 200 or resp.status >= 300:
@@ -756,7 +762,8 @@ def get_account(url, token, marker=None, limit=None, prefix=None,
     return resp_headers, parse_api_response(resp_headers, body)
 
 
-def head_account(url, token, http_conn=None, service_token=None):
+def head_account(url, token, http_conn=None, headers=None,
+                 service_token=None):
     """
     Get account stats.
 
@@ -764,6 +771,7 @@ def head_account(url, token, http_conn=None, service_token=None):
     :param token: auth token
     :param http_conn: a tuple of (parsed url, HTTPConnection object),
                       (If None, it will create the conn object)
+    :param headers: additional headers to include in the request
     :param service_token: service auth token
     :returns: a dict containing the response's headers (all header names will
               be lowercase)
@@ -774,13 +782,16 @@ def head_account(url, token, http_conn=None, service_token=None):
     else:
         parsed, conn = http_connection(url)
     method = "HEAD"
-    headers = {'X-Auth-Token': token}
+    req_headers = {'X-Auth-Token': token}
     if service_token:
-        headers['X-Service-Token'] = service_token
-    conn.request(method, parsed.path, '', headers)
+        req_headers['X-Service-Token'] = service_token
+    if headers:
+        req_headers.update(headers)
+
+    conn.request(method, parsed.path, '', req_headers)
     resp = conn.getresponse()
     body = resp.read()
-    http_log((url, method,), {'headers': headers}, resp, body)
+    http_log((url, method,), {'headers': req_headers}, resp, body)
     if resp.status < 200 or resp.status >= 300:
         raise ClientException.from_response(resp, 'Account HEAD failed', body)
     resp_headers = resp_header_dict(resp)
@@ -1047,7 +1058,7 @@ def post_container(url, token, container, headers, http_conn=None,
 
 def delete_container(url, token, container, http_conn=None,
                      response_dict=None, service_token=None,
-                     query_string=None):
+                     query_string=None, headers=None):
     """
     Delete a container
 
@@ -1060,6 +1071,7 @@ def delete_container(url, token, container, http_conn=None,
                      the response - status, reason and headers
     :param service_token: service auth token
     :param query_string: if set will be appended with '?' to generated path
+    :param headers: additional headers to include in the request
     :raises ClientException: HTTP DELETE request failed
     """
     if http_conn:
@@ -1067,7 +1079,12 @@ def delete_container(url, token, container, http_conn=None,
     else:
         parsed, conn = http_connection(url)
     path = '%s/%s' % (parsed.path, quote(container))
-    headers = {'X-Auth-Token': token}
+    if headers:
+        headers = dict(headers)
+    else:
+        headers = {}
+
+    headers['X-Auth-Token'] = token
     if service_token:
         headers['X-Service-Token'] = service_token
     if query_string:
@@ -1682,19 +1699,19 @@ def _retry(self, reset_func, func, *args, **kwargs):
             if reset_func:
                 reset_func(func, *args, **kwargs)
 
-    def head_account(self):
+    def head_account(self, headers=None):
         """Wrapper for :func:`head_account`"""
-        return self._retry(None, head_account)
+        return self._retry(None, head_account, headers=headers)
 
     def get_account(self, marker=None, limit=None, prefix=None,
-                    end_marker=None, full_listing=False):
+                    end_marker=None, full_listing=False, headers=None):
         """Wrapper for :func:`get_account`"""
         # TODO(unknown): With full_listing=True this will restart the entire
         # listing with each retry. Need to make a better version that just
         # retries where it left off.
         return self._retry(None, get_account, marker=marker, limit=limit,
                            prefix=prefix, end_marker=end_marker,
-                           full_listing=full_listing)
+                           full_listing=full_listing, headers=headers)
 
     def post_account(self, headers, response_dict=None,
                      query_string=None, data=None):
@@ -1733,11 +1750,12 @@ def post_container(self, container, headers, response_dict=None):
                            response_dict=response_dict)
 
     def delete_container(self, container, response_dict=None,
-                         query_string=None):
+                         query_string=None, headers={}):
         """Wrapper for :func:`delete_container`"""
         return self._retry(None, delete_container, container,
                            response_dict=response_dict,
-                           query_string=query_string)
+                           query_string=query_string,
+                           headers=headers)
 
     def head_object(self, container, obj, headers=None):
         """Wrapper for :func:`head_object`"""
@@ -1808,11 +1826,12 @@ def copy_object(self, container, obj, destination=None, headers=None,
                            response_dict=response_dict)
 
     def delete_object(self, container, obj, query_string=None,
-                      response_dict=None):
+                      response_dict=None, headers=None):
         """Wrapper for :func:`delete_object`"""
         return self._retry(None, delete_object, container, obj,
                            query_string=query_string,
-                           response_dict=response_dict)
+                           response_dict=response_dict,
+                           headers=headers)
 
     def get_capabilities(self, url=None):
         url = url or self.url
diff --git a/swiftclient/command_helpers.py b/swiftclient/command_helpers.py
index 08226995..49ccad1d 100644
--- a/swiftclient/command_helpers.py
+++ b/swiftclient/command_helpers.py
@@ -11,7 +11,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from swiftclient.utils import prt_bytes
+from swiftclient.utils import prt_bytes, split_request_headers
 
 
 POLICY_HEADER_PREFIX = 'x-account-storage-policy-'
@@ -19,8 +19,9 @@
 
 def stat_account(conn, options):
     items = []
+    req_headers = split_request_headers(options.get('header', []))
 
-    headers = conn.head_account()
+    headers = conn.head_account(headers=req_headers)
     if options['verbose'] > 1:
         items.extend([
             ('StorageURL', conn.url),
@@ -91,8 +92,11 @@ def print_account_stats(items, headers, output_manager):
 
 
 def stat_container(conn, options, container):
-    headers = conn.head_container(container)
+    req_headers = split_request_headers(options.get('header', []))
+
+    headers = conn.head_container(container, headers=req_headers)
     items = []
+
     if options['verbose'] > 1:
         path = '%s/%s' % (conn.url, container)
         items.extend([
@@ -137,7 +141,9 @@ def print_container_stats(items, headers, output_manager):
 
 
 def stat_object(conn, options, container, obj):
-    headers = conn.head_object(container, obj)
+    req_headers = split_request_headers(options.get('header', []))
+
+    headers = conn.head_object(container, obj, headers=req_headers)
     items = []
     if options['verbose'] > 1:
         path = '%s/%s/%s' % (conn.url, container, obj)
diff --git a/swiftclient/service.py b/swiftclient/service.py
index f204895a..de30d502 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -44,7 +44,7 @@
 )
 from swiftclient.utils import (
     config_true_value, ReadableToIterable, LengthWrapper, EMPTY_ETAG,
-    parse_api_response, report_traceback, n_groups
+    parse_api_response, report_traceback, n_groups, split_request_headers
 )
 from swiftclient.exceptions import ClientException
 from swiftclient.multithreading import MultiThreadingManager
@@ -279,15 +279,11 @@ def split_headers(options, prefix=''):
         reporting.
     """
     headers = {}
-    for item in options:
-        split_item = item.split(':', 1)
-        if len(split_item) == 2:
-            headers[(prefix + split_item[0]).title()] = split_item[1].strip()
-        else:
-            raise SwiftError(
-                "Metadata parameter %s must contain a ':'.\n%s"
-                % (item, "Example: 'Color:Blue' or 'Size:Large'")
-            )
+    try:
+        headers = split_request_headers(options, prefix)
+    except ValueError as e:
+        raise SwiftError(e)
+
     return headers
 
 
@@ -467,7 +463,8 @@ def stat(self, container=None, objects=None, options=None):
                         performed by this call::
 
                             {
-                                'human': False
+                                'human': False,
+                                'header': []
                             }
 
         :returns: Either a single dictionary containing stats about an account
@@ -849,6 +846,7 @@ def list(self, container=None, options=None):
                                 'long': False,
                                 'prefix': None,
                                 'delimiter': None,
+                                'header': []
                             }
 
         :returns: A generator for returning the results of the list operation
@@ -884,10 +882,12 @@ def list(self, container=None, options=None):
     def _list_account_job(conn, options, result_queue):
         marker = ''
         error = None
+        req_headers = split_headers(options.get('header', []))
         try:
             while True:
                 _, items = conn.get_account(
-                    marker=marker, prefix=options['prefix']
+                    marker=marker, prefix=options['prefix'],
+                    headers=req_headers
                 )
 
                 if not items:
@@ -943,11 +943,12 @@ def _list_account_job(conn, options, result_queue):
     def _list_container_job(conn, container, options, result_queue):
         marker = options.get('marker', '')
         error = None
+        req_headers = split_headers(options.get('header', []))
         try:
             while True:
                 _, items = conn.get_container(
                     container, marker=marker, prefix=options['prefix'],
-                    delimiter=options['delimiter']
+                    delimiter=options['delimiter'], headers=req_headers
                 )
 
                 if not items:
@@ -2112,6 +2113,7 @@ def delete(self, container=None, objects=None, options=None):
                                 'yes_all': False,
                                 'leave_segments': False,
                                 'prefix': None,
+                                'header': [],
                             }
 
         :returns: A generator for returning the results of the delete
@@ -2250,6 +2252,8 @@ def _delete_segment(conn, container, obj, results_queue=None):
 
     def _delete_object(self, conn, container, obj, options,
                        results_queue=None):
+        _headers = {}
+        _headers = split_headers(options.get('header', []))
         res = {
             'action': 'delete_object',
             'container': container,
@@ -2261,7 +2265,8 @@ def _delete_object(self, conn, container, obj, options,
 
             if not options['leave_segments']:
                 try:
-                    headers = conn.head_object(container, obj)
+                    headers = conn.head_object(container, obj,
+                                               headers=_headers)
                     old_manifest = headers.get('x-object-manifest')
                     if config_true_value(headers.get('x-static-large-object')):
                         query_string = 'multipart-manifest=delete'
@@ -2270,7 +2275,9 @@ def _delete_object(self, conn, container, obj, options,
                         raise
 
             results_dict = {}
-            conn.delete_object(container, obj, query_string=query_string,
+            conn.delete_object(container, obj,
+                               headers=_headers,
+                               query_string=query_string,
                                response_dict=results_dict)
 
             if old_manifest:
@@ -2322,10 +2329,13 @@ def _delete_object(self, conn, container, obj, options,
         return res
 
     @staticmethod
-    def _delete_empty_container(conn, container):
+    def _delete_empty_container(conn, container, options):
         results_dict = {}
+        _headers = {}
+        _headers = split_headers(options.get('header', []))
         try:
-            conn.delete_container(container, response_dict=results_dict)
+            conn.delete_container(container, headers=_headers,
+                                  response_dict=results_dict)
             res = {'success': True}
         except Exception as err:
             traceback, err_time = report_traceback()
@@ -2363,7 +2373,7 @@ def _delete_container(self, container, options):
                 return
 
             con_del = self.thread_manager.container_pool.submit(
-                self._delete_empty_container, container
+                self._delete_empty_container, container, options
             )
             con_del_res = get_future_result(con_del)
 
diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 2bc41065..5d611a2c 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -58,6 +58,7 @@ def immediate_exit(signum, frame):
 st_delete_options = '''[--all] [--leave-segments]
                     [--object-threads <threads>]
                     [--container-threads <threads>]
+                    [--header <header:value>]
                     [<container> [<object>] [...]]
 '''
 
@@ -72,6 +73,9 @@ def immediate_exit(signum, frame):
 Optional arguments:
   -a, --all             Delete all containers and objects.
   --leave-segments      Do not delete segments of manifest objects.
+  -H, --header <header:value>
+                        Adds a custom request header to use for deleting
+                        objects or an entire container .
   --object-threads <threads>
                         Number of threads to use for deleting objects.
                         Default is 10.
@@ -88,6 +92,11 @@ def st_delete(parser, args, output_manager):
     parser.add_argument(
         '-p', '--prefix', dest='prefix',
         help='Only delete items beginning with the <prefix>.')
+    parser.add_argument(
+        '-H', '--header', action='append', dest='header',
+        default=[],
+        help='Adds a custom request header to use for deleting objects '
+        'or an entire container.')
     parser.add_argument(
         '--leave-segments', action='store_true',
         dest='leave_segments', default=False,
@@ -445,7 +454,8 @@ def st_download(parser, args, output_manager):
 
 
 st_list_options = '''[--long] [--lh] [--totals] [--prefix <prefix>]
-                  [--delimiter <delimiter>] [<container>]
+                  [--delimiter <delimiter>] [--header <header:value>]
+                  [<container>]
 '''
 
 st_list_help = '''
@@ -465,6 +475,8 @@ def st_download(parser, args, output_manager):
                         Roll up items with the given delimiter. For containers
                         only. See OpenStack Swift API documentation for what
                         this means.
+  -H, --header <header:value>
+                        Adds a custom request header to use for listing.
 '''.strip('\n')
 
 
@@ -541,6 +553,10 @@ def _print_stats(options, stats, human):
         help='Roll up items with the given delimiter. For containers '
              'only. See OpenStack Swift API documentation for '
              'what this means.')
+    parser.add_argument(
+        '-H', '--header', action='append', dest='header',
+        default=[],
+        help='Adds a custom request header to use for listing.')
     options, args = parse_args(parser, args)
     args = args[1:]
     if options['delimiter'] and not args:
@@ -580,7 +596,7 @@ def _print_stats(options, stats, human):
             output_manager.error(e.value)
 
 
-st_stat_options = '''[--lh]
+st_stat_options = '''[--lh] [--header <header:value>]
                   [<container> [<object>]]
 '''
 
@@ -594,6 +610,8 @@ def _print_stats(options, stats, human):
 Optional arguments:
   --lh                  Report sizes in human readable format similar to
                         ls -lh.
+  -H, --header <header:value>
+                        Adds a custom request header to use for stat.
 '''.strip('\n')
 
 
@@ -601,6 +619,11 @@ def st_stat(parser, args, output_manager):
     parser.add_argument(
         '--lh', dest='human', action='store_true', default=False,
         help='Report sizes in human readable format similar to ls -lh.')
+    parser.add_argument(
+        '-H', '--header', action='append', dest='header',
+        default=[],
+        help='Adds a custom request header to use for stat.')
+
     options, args = parse_args(parser, args)
     args = args[1:]
 
diff --git a/swiftclient/utils.py b/swiftclient/utils.py
index 0d1104e7..e14602dc 100644
--- a/swiftclient/utils.py
+++ b/swiftclient/utils.py
@@ -146,6 +146,20 @@ def parse_api_response(headers, body):
     return json.loads(body.decode(charset))
 
 
+def split_request_headers(options, prefix=''):
+    headers = {}
+    for item in options:
+        split_item = item.split(':', 1)
+        if len(split_item) == 2:
+            headers[(prefix + split_item[0]).title()] = split_item[1].strip()
+        else:
+            raise ValueError(
+                "Metadata parameter %s must contain a ':'.\n%s"
+                % (item, "Example: 'Color:Blue' or 'Size:Large'")
+            )
+    return headers
+
+
 def report_traceback():
     """
     Reports a timestamp and full traceback for a given exception.
diff --git a/tests/unit/test_service.py b/tests/unit/test_service.py
index 546e495d..e8385b7d 100644
--- a/tests/unit/test_service.py
+++ b/tests/unit/test_service.py
@@ -291,9 +291,33 @@ def test_delete_object(self):
         s = SwiftService()
         r = s._delete_object(mock_conn, 'test_c', 'test_o', self.opts, mock_q)
 
-        mock_conn.head_object.assert_called_once_with('test_c', 'test_o')
+        mock_conn.head_object.assert_called_once_with('test_c', 'test_o',
+                                                      headers={})
         mock_conn.delete_object.assert_called_once_with(
-            'test_c', 'test_o', query_string=None, response_dict={}
+            'test_c', 'test_o', query_string=None, response_dict={},
+            headers={}
+        )
+        self.assertEqual(expected_r, r)
+
+    def test_delete_object_with_headers(self):
+        mock_q = Queue()
+        mock_conn = self._get_mock_connection()
+        mock_conn.head_object = Mock(return_value={})
+        expected_r = self._get_expected({
+            'action': 'delete_object',
+            'success': True
+        })
+        opt_c = self.opts.copy()
+        opt_c['header'] = ['Skip-Middleware: Test']
+
+        s = SwiftService()
+        r = s._delete_object(mock_conn, 'test_c', 'test_o', opt_c, mock_q)
+
+        mock_conn.head_object.assert_called_once_with(
+            'test_c', 'test_o', headers={'Skip-Middleware': 'Test'})
+        mock_conn.delete_object.assert_called_once_with(
+            'test_c', 'test_o', query_string=None, response_dict={},
+            headers={'Skip-Middleware': 'Test'}
         )
         self.assertEqual(expected_r, r)
 
@@ -317,9 +341,11 @@ def test_delete_object_exception(self):
         r = s._delete_object(mock_conn, 'test_c', 'test_o', self.opts, mock_q)
         after = time.time()
 
-        mock_conn.head_object.assert_called_once_with('test_c', 'test_o')
+        mock_conn.head_object.assert_called_once_with('test_c', 'test_o',
+                                                      headers={})
         mock_conn.delete_object.assert_called_once_with(
-            'test_c', 'test_o', query_string=None, response_dict={}
+            'test_c', 'test_o', query_string=None, response_dict={},
+            headers={}
         )
         self.assertEqual(expected_r, r)
         self.assertGreaterEqual(r['error_timestamp'], before)
@@ -342,11 +368,13 @@ def test_delete_object_slo_support(self):
         s = SwiftService()
         r = s._delete_object(mock_conn, 'test_c', 'test_o', self.opts, mock_q)
 
-        mock_conn.head_object.assert_called_once_with('test_c', 'test_o')
+        mock_conn.head_object.assert_called_once_with('test_c', 'test_o',
+                                                      headers={})
         mock_conn.delete_object.assert_called_once_with(
             'test_c', 'test_o',
             query_string='multipart-manifest=delete',
-            response_dict={}
+            response_dict={},
+            headers={}
         )
         self.assertEqual(expected_r, r)
 
@@ -381,7 +409,8 @@ def get_mock_list_conn(options):
 
         self.assertEqual(expected_r, r)
         expected = [
-            mock.call('test_c', 'test_o', query_string=None, response_dict={}),
+            mock.call('test_c', 'test_o', query_string=None, response_dict={},
+                      headers={}),
             mock.call('manifest_c', 'test_seg_1', response_dict={}),
             mock.call('manifest_c', 'test_seg_2', response_dict={})]
         mock_conn.delete_object.assert_has_calls(expected, any_order=True)
@@ -394,10 +423,28 @@ def test_delete_empty_container(self):
             'object': None
         })
 
-        r = SwiftService._delete_empty_container(mock_conn, 'test_c')
+        r = SwiftService._delete_empty_container(mock_conn, 'test_c',
+                                                 self.opts)
+
+        mock_conn.delete_container.assert_called_once_with(
+            'test_c', response_dict={}, headers={}
+        )
+        self.assertEqual(expected_r, r)
+
+    def test_delete_empty_container_with_headers(self):
+        mock_conn = self._get_mock_connection()
+        expected_r = self._get_expected({
+            'action': 'delete_container',
+            'success': True,
+            'object': None
+        })
+        opt_c = self.opts.copy()
+        opt_c['header'] = ['Skip-Middleware: Test']
+
+        r = SwiftService._delete_empty_container(mock_conn, 'test_c', opt_c)
 
         mock_conn.delete_container.assert_called_once_with(
-            'test_c', response_dict={}
+            'test_c', response_dict={}, headers={'Skip-Middleware': 'Test'}
         )
         self.assertEqual(expected_r, r)
 
@@ -415,11 +462,11 @@ def test_delete_empty_container_exception(self):
 
         before = time.time()
         s = SwiftService()
-        r = s._delete_empty_container(mock_conn, 'test_c')
+        r = s._delete_empty_container(mock_conn, 'test_c', {})
         after = time.time()
 
         mock_conn.delete_container.assert_called_once_with(
-            'test_c', response_dict={}
+            'test_c', response_dict={}, headers={}
         )
         self.assertEqual(expected_r, r)
         self.assertGreaterEqual(r['error_timestamp'], before)
@@ -665,6 +712,34 @@ def test_list_account(self):
         self.assertEqual(expected_r_long, self._get_queue(mock_q))
         self.assertIsNone(self._get_queue(mock_q))
 
+    def test_list_account_with_headers(self):
+        mock_q = Queue()
+        mock_conn = self._get_mock_connection()
+        get_account_returns = [
+            (None, [{'name': 'test_c'}]),
+            (None, [])
+        ]
+        mock_conn.get_account = Mock(side_effect=get_account_returns)
+
+        expected_r = self._get_expected({
+            'action': 'list_account_part',
+            'success': True,
+            'listing': [{'name': 'test_c'}],
+            'marker': ''
+        })
+        opt_c = self.opts.copy()
+        opt_c['header'] = ['Skip-Middleware: True']
+        SwiftService._list_account_job(
+            mock_conn, opt_c, mock_q
+        )
+        self.assertEqual(expected_r, self._get_queue(mock_q))
+        self.assertIsNone(self._get_queue(mock_q))
+        self.assertEqual(mock_conn.get_account.mock_calls, [
+            mock.call(headers={'Skip-Middleware': 'True'}, marker='',
+                      prefix=None),
+            mock.call(headers={'Skip-Middleware': 'True'}, marker='test_c',
+                      prefix=None)])
+
     def test_list_account_exception(self):
         mock_q = Queue()
         mock_conn = self._get_mock_connection()
@@ -682,7 +757,7 @@ def test_list_account_exception(self):
             mock_conn, self.opts, mock_q)
 
         mock_conn.get_account.assert_called_once_with(
-            marker='', prefix=None
+            marker='', prefix=None, headers={}
         )
         self.assertEqual(expected_r, self._get_queue(mock_q))
         self.assertIsNone(self._get_queue(mock_q))
@@ -767,6 +842,37 @@ def test_list_container_marker(self):
 
         self.assertIsNone(self._get_queue(mock_q))
 
+    def test_list_container_with_headers(self):
+        mock_q = Queue()
+        mock_conn = self._get_mock_connection()
+        get_container_returns = [
+            (None, [{'name': 'test_o'}]),
+            (None, [])
+        ]
+        mock_conn.get_container = Mock(side_effect=get_container_returns)
+
+        expected_r = self._get_expected({
+            'action': 'list_container_part',
+            'container': 'test_c',
+            'success': True,
+            'listing': [{'name': 'test_o'}],
+            'marker': ''
+        })
+
+        opt_c = self.opts.copy()
+        opt_c['header'] = ['Skip-Middleware: Test']
+
+        SwiftService._list_container_job(
+            mock_conn, 'test_c', opt_c, mock_q
+        )
+        self.assertEqual(expected_r, self._get_queue(mock_q))
+        self.assertIsNone(self._get_queue(mock_q))
+        self.assertEqual(mock_conn.get_container.mock_calls, [
+            mock.call('test_c', headers={'Skip-Middleware': 'Test'},
+                      delimiter='', marker='', prefix=None),
+            mock.call('test_c', headers={'Skip-Middleware': 'Test'},
+                      delimiter='', marker='test_o', prefix=None)])
+
     def test_list_container_exception(self):
         mock_q = Queue()
         mock_conn = self._get_mock_connection()
@@ -786,7 +892,7 @@ def test_list_container_exception(self):
         )
 
         mock_conn.get_container.assert_called_once_with(
-            'test_c', marker='', delimiter='', prefix=None
+            'test_c', marker='', delimiter='', prefix=None, headers={}
         )
         self.assertEqual(expected_r, self._get_queue(mock_q))
         self.assertIsNone(self._get_queue(mock_q))
@@ -1397,11 +1503,13 @@ def test_upload_object_job_identical_dlo(self):
             mock_conn.head_object.assert_called_with('test_c', 'test_o')
             expected = [
                 mock.call('test_c_segments', prefix='test_o/prefix',
-                          marker='', delimiter=None),
+                          marker='', delimiter=None, headers={}),
                 mock.call('test_c_segments', prefix='test_o/prefix',
-                          marker="test_o/prefix/01", delimiter=None),
+                          marker="test_o/prefix/01", delimiter=None,
+                          headers={}),
                 mock.call('test_c_segments', prefix='test_o/prefix',
-                          marker="test_o/prefix/02", delimiter=None),
+                          marker="test_o/prefix/02", delimiter=None,
+                          headers={}),
             ]
             mock_conn.get_container.assert_has_calls(expected)
 
@@ -2102,15 +2210,18 @@ def test_download_object_job_skip_identical_dlo(self):
                 mock.call('test_c_segments',
                           delimiter=None,
                           prefix='test_o/prefix',
-                          marker=''),
+                          marker='',
+                          headers={}),
                 mock.call('test_c_segments',
                           delimiter=None,
                           prefix='test_o/prefix',
-                          marker='test_o/prefix/2'),
+                          marker='test_o/prefix/2',
+                          headers={}),
                 mock.call('test_c_segments',
                           delimiter=None,
                           prefix='test_o/prefix',
-                          marker='test_o/prefix/3')])
+                          marker='test_o/prefix/3',
+                          headers={})])
 
     def test_download_object_job_skip_identical_nested_slo(self):
         with tempfile.NamedTemporaryFile() as f:
@@ -2243,15 +2354,18 @@ def test_download_object_job_skip_identical_diff_dlo(self):
                 mock.call('test_c_segments',
                           delimiter=None,
                           prefix='test_o/prefix',
-                          marker=''),
+                          marker='',
+                          headers={}),
                 mock.call('test_c_segments',
                           delimiter=None,
                           prefix='test_o/prefix',
-                          marker='test_o/prefix/2'),
+                          marker='test_o/prefix/2',
+                          headers={}),
                 mock.call('test_c_segments',
                           delimiter=None,
                           prefix='test_o/prefix',
-                          marker='test_o/prefix/3')])
+                          marker='test_o/prefix/3',
+                          headers={})])
             self.assertEqual(mock_conn.get_object.mock_calls, [
                 mock.call('test_c',
                           'test_o',
diff --git a/tests/unit/test_shell.py b/tests/unit/test_shell.py
index 33e297dd..a6490b8f 100644
--- a/tests/unit/test_shell.py
+++ b/tests/unit/test_shell.py
@@ -142,6 +142,28 @@ def test_stat_account(self, connection):
                              '   Objects: 2\n'
                              '     Bytes: 3\n')
 
+    @mock.patch('swiftclient.service.Connection')
+    def test_stat_account_with_headers(self, connection):
+        argv = ["", "stat", "-H", "Skip-Middleware: Test"]
+        return_headers = {
+            'x-account-container-count': '1',
+            'x-account-object-count': '2',
+            'x-account-bytes-used': '3',
+            'content-length': 0,
+            'date': ''}
+        connection.return_value.head_account.return_value = return_headers
+        connection.return_value.url = 'http://127.0.0.1/v1/AUTH_account'
+        with CaptureOutput() as output:
+            swiftclient.shell.main(argv)
+
+            self.assertEqual(output.out,
+                             '   Account: AUTH_account\n'
+                             'Containers: 1\n'
+                             '   Objects: 2\n'
+                             '     Bytes: 3\n')
+        self.assertEqual(connection.return_value.head_account.mock_calls, [
+            mock.call(headers={'Skip-Middleware': 'Test'})])
+
     @mock.patch('swiftclient.service.Connection')
     def test_stat_container(self, connection):
         return_headers = {
@@ -168,6 +190,34 @@ def test_stat_container(self, connection):
                              '  Sync To: other\n'
                              ' Sync Key: secret\n')
 
+    @mock.patch('swiftclient.service.Connection')
+    def test_stat_container_with_headers(self, connection):
+        return_headers = {
+            'x-container-object-count': '1',
+            'x-container-bytes-used': '2',
+            'x-container-read': 'test2:tester2',
+            'x-container-write': 'test3:tester3',
+            'x-container-sync-to': 'other',
+            'x-container-sync-key': 'secret',
+        }
+        argv = ["", "stat", "container", "-H", "Skip-Middleware: Test"]
+        connection.return_value.head_container.return_value = return_headers
+        connection.return_value.url = 'http://127.0.0.1/v1/AUTH_account'
+        with CaptureOutput() as output:
+            swiftclient.shell.main(argv)
+
+            self.assertEqual(output.out,
+                             '  Account: AUTH_account\n'
+                             'Container: container\n'
+                             '  Objects: 1\n'
+                             '    Bytes: 2\n'
+                             ' Read ACL: test2:tester2\n'
+                             'Write ACL: test3:tester3\n'
+                             '  Sync To: other\n'
+                             ' Sync Key: secret\n')
+        self.assertEqual(connection.return_value.head_container.mock_calls, [
+            mock.call('container', headers={'Skip-Middleware': 'Test'})])
+
     @mock.patch('swiftclient.service.Connection')
     def test_stat_object(self, connection):
         return_headers = {
@@ -194,6 +244,36 @@ def test_stat_object(self, connection):
                              '          ETag: md5\n'
                              '      Manifest: manifest\n')
 
+    @mock.patch('swiftclient.service.Connection')
+    def test_stat_object_with_headers(self, connection):
+        return_headers = {
+            'x-object-manifest': 'manifest',
+            'etag': 'md5',
+            'last-modified': 'yesterday',
+            'content-type': 'text/plain',
+            'content-length': 42,
+        }
+        argv = ["", "stat", "container", "object",
+                "-H", "Skip-Middleware: Test"]
+        connection.return_value.head_object.return_value = return_headers
+        connection.return_value.url = 'http://127.0.0.1/v1/AUTH_account'
+
+        with CaptureOutput() as output:
+            swiftclient.shell.main(argv)
+
+            self.assertEqual(output.out,
+                             '       Account: AUTH_account\n'
+                             '     Container: container\n'
+                             '        Object: object\n'
+                             '  Content Type: text/plain\n'
+                             'Content Length: 42\n'
+                             ' Last Modified: yesterday\n'
+                             '          ETag: md5\n'
+                             '      Manifest: manifest\n')
+        self.assertEqual(connection.return_value.head_object.mock_calls, [
+            mock.call('container', 'object',
+                      headers={'Skip-Middleware': 'Test'})])
+
     @mock.patch('swiftclient.service.Connection')
     def test_list_account(self, connection):
         # Test account listing
@@ -206,8 +286,28 @@ def test_list_account(self, connection):
 
         with CaptureOutput() as output:
             swiftclient.shell.main(argv)
-            calls = [mock.call(marker='', prefix=None),
-                     mock.call(marker='container', prefix=None)]
+            calls = [mock.call(marker='', prefix=None, headers={}),
+                     mock.call(marker='container', prefix=None, headers={})]
+            connection.return_value.get_account.assert_has_calls(calls)
+
+            self.assertEqual(output.out, 'container\n')
+
+    @mock.patch('swiftclient.service.Connection')
+    def test_list_account_with_headers(self, connection):
+        # Test account listing
+        connection.return_value.get_account.side_effect = [
+            [None, [{'name': 'container'}]],
+            [None, []],
+        ]
+
+        argv = ["", "list", '-H', 'Skip-Custom-Middleware: True']
+
+        with CaptureOutput() as output:
+            swiftclient.shell.main(argv)
+            calls = [mock.call(marker='', prefix=None,
+                               headers={'Skip-Custom-Middleware': 'True'}),
+                     mock.call(marker='container', prefix=None,
+                               headers={'Skip-Custom-Middleware': 'True'})]
             connection.return_value.get_account.assert_has_calls(calls)
 
             self.assertEqual(output.out, 'container\n')
@@ -223,8 +323,8 @@ def test_list_account_long(self, connection):
         argv = ["", "list", "--lh"]
         with CaptureOutput() as output:
             swiftclient.shell.main(argv)
-            calls = [mock.call(marker='', prefix=None),
-                     mock.call(marker='container', prefix=None)]
+            calls = [mock.call(marker='', prefix=None, headers={}),
+                     mock.call(marker='container', prefix=None, headers={})]
             connection.return_value.get_account.assert_has_calls(calls)
 
             self.assertEqual(output.out,
@@ -243,8 +343,8 @@ def test_list_account_long(self, connection):
         argv = ["", "list", "--lh"]
         with CaptureOutput() as output:
             swiftclient.shell.main(argv)
-            calls = [mock.call(marker='', prefix=None),
-                     mock.call(marker='container', prefix=None)]
+            calls = [mock.call(marker='', prefix=None, headers={}),
+                     mock.call(marker='container', prefix=None, headers={})]
             connection.return_value.get_account.assert_has_calls(calls)
 
             self.assertEqual(output.out,
@@ -273,7 +373,7 @@ def test_list_account_totals(self, connection):
         argv = ["", "list", "--lh", "--totals"]
         with CaptureOutput() as output:
             swiftclient.shell.main(argv)
-            calls = [mock.call(marker='', prefix=None)]
+            calls = [mock.call(marker='', prefix=None, headers={})]
             connection.return_value.get_account.assert_has_calls(calls)
             self.assertEqual(output.out, '    6    3\n')
 
@@ -287,9 +387,10 @@ def test_list_container(self, connection):
         with CaptureOutput() as output:
             swiftclient.shell.main(argv)
             calls = [
-                mock.call('container', marker='', delimiter=None, prefix=None),
+                mock.call('container', marker='',
+                          delimiter=None, prefix=None, headers={}),
                 mock.call('container', marker='object_a',
-                          delimiter=None, prefix=None)]
+                          delimiter=None, prefix=None, headers={})]
             connection.return_value.get_container.assert_has_calls(calls)
 
             self.assertEqual(output.out, 'object_a\n')
@@ -305,9 +406,10 @@ def test_list_container(self, connection):
         with CaptureOutput() as output:
             swiftclient.shell.main(argv)
             calls = [
-                mock.call('container', marker='', delimiter=None, prefix=None),
+                mock.call('container', marker='',
+                          delimiter=None, prefix=None, headers={}),
                 mock.call('container', marker='object_a',
-                          delimiter=None, prefix=None)]
+                          delimiter=None, prefix=None, headers={})]
             connection.return_value.get_container.assert_has_calls(calls)
 
             self.assertEqual(output.out,
@@ -315,6 +417,26 @@ def test_list_container(self, connection):
                              '             type/content object_a\n'
                              '           0\n')
 
+    @mock.patch('swiftclient.service.Connection')
+    def test_list_container_with_headers(self, connection):
+        connection.return_value.get_container.side_effect = [
+            [None, [{'name': 'object_a'}]],
+            [None, []],
+        ]
+        argv = ["", "list", "container", "-H", "Skip-Middleware: Test"]
+        with CaptureOutput() as output:
+            swiftclient.shell.main(argv)
+            calls = [
+                mock.call('container', marker='',
+                          delimiter=None, prefix=None,
+                          headers={'Skip-Middleware': 'Test'}),
+                mock.call('container', marker='object_a',
+                          delimiter=None, prefix=None,
+                          headers={'Skip-Middleware': 'Test'})]
+            connection.return_value.get_container.assert_has_calls(calls)
+
+            self.assertEqual(output.out, 'object_a\n')
+
     @mock.patch('swiftclient.service.makedirs')
     @mock.patch('swiftclient.service.Connection')
     def test_download(self, connection, makedirs):
@@ -835,19 +957,19 @@ def test_delete_account(self, connection):
         swiftclient.shell.main(argv)
         connection.return_value.delete_object.assert_has_calls([
             mock.call('container', 'object', query_string=None,
-                      response_dict={}),
+                      response_dict={}, headers={}),
             mock.call('container', 'obj\xe9ct2', query_string=None,
-                      response_dict={}),
+                      response_dict={}, headers={}),
             mock.call('container2', 'object', query_string=None,
-                      response_dict={})], any_order=True)
+                      response_dict={}, headers={})], any_order=True)
         self.assertEqual(3, connection.return_value.delete_object.call_count,
                          'Expected 3 calls but found\n%r'
                          % connection.return_value.delete_object.mock_calls)
         self.assertEqual(
             connection.return_value.delete_container.mock_calls, [
-                mock.call('container', response_dict={}),
-                mock.call('container2', response_dict={}),
-                mock.call('empty_container', response_dict={})])
+                mock.call('container', response_dict={}, headers={}),
+                mock.call('container2', response_dict={}, headers={}),
+                mock.call('empty_container', response_dict={}, headers={})])
 
     @mock.patch.object(swiftclient.service.SwiftService, '_should_bulk_delete',
                        lambda *a: True)
@@ -900,9 +1022,9 @@ def test_delete_bulk_account(self, connection):
             connection.return_value.post_account.mock_calls[2])
         self.assertEqual(
             connection.return_value.delete_container.mock_calls, [
-                mock.call('container', response_dict={}),
-                mock.call('container2', response_dict={}),
-                mock.call('empty_container', response_dict={})])
+                mock.call('container', response_dict={}, headers={}),
+                mock.call('container2', response_dict={}, headers={}),
+                mock.call('empty_container', response_dict={}, headers={})])
 
     @mock.patch('swiftclient.service.Connection')
     def test_delete_bulk_account_with_capabilities(self, connection):
@@ -957,9 +1079,9 @@ def test_delete_bulk_account_with_capabilities(self, connection):
                           response_dict={})])
         self.assertEqual(
             connection.return_value.delete_container.mock_calls, [
-                mock.call('container', response_dict={}),
-                mock.call('container2', response_dict={}),
-                mock.call('empty_container', response_dict={})])
+                mock.call('container', response_dict={}, headers={}),
+                mock.call('container2', response_dict={}, headers={}),
+                mock.call('empty_container', response_dict={}, headers={})])
         self.assertEqual(connection.return_value.get_capabilities.mock_calls,
                          [mock.call(None)])  # only one /info request
 
@@ -976,9 +1098,29 @@ def test_delete_container(self, connection):
         connection.return_value.head_object.return_value = {}
         swiftclient.shell.main(argv)
         connection.return_value.delete_container.assert_called_with(
-            'container', response_dict={})
+            'container', response_dict={}, headers={})
+        connection.return_value.delete_object.assert_called_with(
+            'container', 'object', query_string=None, response_dict={},
+            headers={})
+
+    @mock.patch.object(swiftclient.service.SwiftService, '_should_bulk_delete',
+                       lambda *a: False)
+    @mock.patch('swiftclient.service.Connection')
+    def test_delete_container_headers(self, connection):
+        connection.return_value.get_container.side_effect = [
+            [None, [{'name': 'object'}]],
+            [None, []],
+        ]
+        connection.return_value.attempts = 0
+        argv = ["", "delete", "container", "-H", "Skip-Middleware: Test"]
+        connection.return_value.head_object.return_value = {}
+        swiftclient.shell.main(argv)
+        connection.return_value.delete_container.assert_called_with(
+            'container', response_dict={},
+            headers={'Skip-Middleware': 'Test'})
         connection.return_value.delete_object.assert_called_with(
-            'container', 'object', query_string=None, response_dict={})
+            'container', 'object', query_string=None, response_dict={},
+            headers={'Skip-Middleware': 'Test'})
 
     @mock.patch.object(swiftclient.service.SwiftService, '_should_bulk_delete',
                        lambda *a: True)
@@ -1000,7 +1142,7 @@ def test_delete_bulk_container(self, connection):
                      'Accept': 'application/json'},
             response_dict={})
         connection.return_value.delete_container.assert_called_with(
-            'container', response_dict={})
+            'container', response_dict={}, headers={})
 
     def test_delete_verbose_output_utf8(self):
         container = 't\u00e9st_c'
@@ -1043,7 +1185,8 @@ def test_delete_per_object(self, connection):
         connection.return_value.attempts = 0
         swiftclient.shell.main(argv)
         connection.return_value.delete_object.assert_called_with(
-            'container', 'object', query_string=None, response_dict={})
+            'container', 'object', query_string=None, response_dict={},
+            headers={})
 
     @mock.patch.object(swiftclient.service.SwiftService, '_should_bulk_delete',
                        lambda *a: True)
diff --git a/tests/unit/test_swiftclient.py b/tests/unit/test_swiftclient.py
index 7d0dd9a7..f717e52a 100644
--- a/tests/unit/test_swiftclient.py
+++ b/tests/unit/test_swiftclient.py
@@ -3003,7 +3003,7 @@ def test_service_token_delete_object(self):
         with mock.patch('swiftclient.client.http_connection',
                         self.fake_http_connection(202)):
             conn = self.get_connection()
-            conn.delete_object('container1', 'obj1', 'a_string')
+            conn.delete_object('container1', 'obj1', query_string='a_string')
         self.assertEqual(1, len(self.request_log), self.request_log)
         for actual in self.iter_request_log():
             self.assertEqual('DELETE', actual['method'])

From 5a620f83e88d1b52e013cedff4bc266bcf3c292a Mon Sep 17 00:00:00 2001
From: John Dickinson <me@not.mn>
Date: Wed, 9 Nov 2016 11:07:52 -0800
Subject: [PATCH 042/316] 3.2.0 release notes

I have also reordered the AUTHORS file to be ordered by
the first character of the author's name.

Change-Id: I529988c809a2748bd6ce212a2216e692fbefe3ba
---
 .mailmap                                      |   2 +
 AUTHORS                                       | 222 +++++++++---------
 ChangeLog                                     |  13 +
 .../notes/320_notes-bb367dba1053d34c.yaml     |  12 +
 4 files changed, 142 insertions(+), 107 deletions(-)
 create mode 100644 releasenotes/notes/320_notes-bb367dba1053d34c.yaml

diff --git a/.mailmap b/.mailmap
index 859a978f..bfa98c34 100644
--- a/.mailmap
+++ b/.mailmap
@@ -91,3 +91,5 @@ James Nzomo <james@tdt.rocks> <kazikubwa@gmail.com>
 Alessandro Pilotti <ap@pilotti.it> <apilotti@cloudbasesolutions.com>
 Marek Kaleta <marek.kaleta@firma.seznam.cz> <Marek.Kaleta@firma.seznam.cz>
 Andreas Jaeger <aj@suse.de> <aj@suse.com>
+Shashi Kant <shashi.kant@nectechnologies.in>
+Nandini Tata <nandini.tata@intel.com> <nandini.tata.15@gmail.com>
diff --git a/AUTHORS b/AUTHORS
index f8b79c38..27e0e201 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -1,129 +1,137 @@
-Paul Belanger (pabelanger@redhat.com)
-Christian Berendt (berendt@b1-systems.de)
-Luis de Bethencourt (luis@debethencourt.com)
-Hu Bing (hubingsh@cn.ibm.com)
-Darrell Bishop (darrell@swiftstack.com)
-Fabien Boucher (fabien.boucher@enovance.com)
-Chmouel Boudjnah (chmouel@enovance.com)
-Clark Boylan (clark.boylan@gmail.com)
-Cedric Brandily (zzelle@gmail.com)
-Chris Buccella (chris.buccella@antallagon.com)
-Tim Burke (tim.burke@gmail.com)
-Clint Byrum (clint@fewbar.com)
-Tristan Cacqueray (tristan.cacqueray@enovance.com)
-Sergio Cazzolato (sergio.j.cazzolato@intel.com)
-Mahati Chamarthy (mahati.chamarthy@gmail.com)
-Chaozhe.Chen (chaozhe.chen@easystack.cn)
-Ray Chen (oldsharp@163.com)
-Taurus Cheung (Taurus.Cheung@harmonicinc.com)
-Alistair Coles (alistair.coles@hpe.com)
-Ian Cordasco (ian.cordasco@rackspace.com)
-Nick Craig-Wood (nick@craig-wood.com)
-Thiago da Silva (thiago@redhat.com)
-Sean Dague (sean@dague.net)
-Julien Danjou (julien@danjou.info)
-Zack M. Davis (zdavis@swiftstack.com)
-John Dickinson (me@not.mn)
-EdLeafe (ed@leafe.com)
-Sahid Orentino Ferdjaoui (sahid.ferdjaoui@cloudwatt.com)
-Flaper Fesp (flaper87@gmail.com)
-Florent Flament (florent.flament-ext@cloudwatt.com)
-Josh Gachnang (josh@pcsforeducation.com)
+Alessandro Pilotti (ap@pilotti.it)
 Alex Gaynor (alex.gaynor@gmail.com)
-Martin Geisler (martin@geisler.net)
+Alexandra Settle (alexandra.settle@rackspace.com)
+Alexis Lee (lxsli@hpe.com)
+Alistair Coles (alistair.coles@hpe.com)
+Andreas Jaeger (aj@suse.de)
+Andrew Welleck (awellec@us.ibm.com)
+Andy McCrae (andy.mccrae@gmail.com)
+Anh Tran (anhtt@vn.fujitsu.com)
 Anne Gentle (anne@openstack.org)
+Ben McCann (ben@benmccann.com)
+Cedric Brandily (zzelle@gmail.com)
+Chaozhe.Chen (chaozhe.chen@easystack.cn)
+Charles Hsu (charles0126@gmail.com)
+Cheng Li (shcli@cn.ibm.com)
+Chmouel Boudjnah (chmouel@enovance.com)
+Chris Buccella (chris.buccella@antallagon.com)
+Christian Berendt (berendt@b1-systems.de)
+Christian Schwede (cschwede@redhat.com)
+Chuck Short (chuck.short@canonical.com)
+Clark Boylan (clark.boylan@gmail.com)
+Claudiu Belu (cbelu@cloudbasesolutions.com)
 Clay Gerrard (clay.gerrard@gmail.com)
+Clint Byrum (clint@fewbar.com)
+Dan Prince (dprince@redhat.com)
+Daniel Wakefield (daniel.wakefield@hp.com)
+Darrell Bishop (darrell@swiftstack.com)
 David Goetz (david.goetz@rackspace.com)
-Thomas Goirand (thomas@goirand.fr)
-Sergey Gotliv (sgotliv@redhat.com)
+David Kranz (david.kranz@qrclab.com)
+David Shrewsbury (shrewsbury.dave@gmail.com)
 Davide Guerri (davide.guerri@hp.com)
-Shashirekha Gundur (shashirekha.j.gundur@intel.com)
-Romain Hardouin (romain_hardouin@yahoo.fr)
-Steven Hardy (shardy@redhat.com)
+Dean Troyer (dtroyer@gmail.com)
+Dirk Mueller (dirk@dmllr.de)
+Donagh McCabe (donagh.mccabe@hpe.com)
 Doug Hellmann (doug@doughellmann.com)
+EdLeafe (ed@leafe.com)
+Fabien Boucher (fabien.boucher@enovance.com)
+Feng Liu (mefengliu23@gmail.com)
+Flaper Fesp (flaper87@gmail.com)
+Florent Flament (florent.flament-ext@cloudwatt.com)
 Greg Holt (gholt@rackspace.com)
-Charles Hsu (charles0126@gmail.com)
-Kun Huang (gareth@unitedstack.com)
-Matthieu Huin (mhu@enovance.com)
-Andreas Jaeger (aj@suse.de)
-Jude Job (judeopenstack@gmail.com)
-Vasyl Khomenko (vasiliyk@yahoo-inc.com)
-Leah Klearman (lklrmn@gmail.com)
-Marek Kaleta (marek.kaleta@firma.seznam.cz)
+Greg Lange (greglange@gmail.com)
+groqez (groqez@yopmail.net)
+Hemanth Makkapati (hemanth.makkapati@mailtrust.com)
+hgangwx (hgangwx@cn.ibm.com)
+Hirokazu Sakata (h.sakata@staff.east.ntt.co.jp)
+Hiroshi Miura (miurahr@nttdata.co.jp)
+Hu Bing (hubingsh@cn.ibm.com)
+Ian Cordasco (ian.cordasco@rackspace.com)
 Jaivish Kothari (jaivish.kothari@nectechnologies.in)
 Jakub Krajcovic (jakub.krajcovic@gmail.com)
-David Kranz (david.kranz@qrclab.com)
-Sushil Kumar (sushil.kumar2@globallogic.com)
-Greg Lange (greglange@gmail.com)
-Alexis Lee (lxsli@hpe.com)
+James Nzomo (james@tdt.rocks)
 Jamie Lennox (jamielennox@gmail.com)
-Cheng Li (shcli@cn.ibm.com)
-Tong Li (litong01@us.ibm.com)
-Peter Lisak (peter.lisak@firma.seznam.cz)
-Feng Liu (mefengliu23@gmail.com)
+Jeremy Stanley (fungi@yuggoth.org)
+Ji-Wei (ji.wei3@zte.com.cn)
+Jian Zhang (jian.zhang@intel.com)
 Jing Liuqing (jing.liuqing@99cloud.net)
-Hemanth Makkapati (hemanth.makkapati@mailtrust.com)
-Pratik Mallya (pratik.mallya@gmail.com)
-Steve Martinelli (stevemar@ca.ibm.com)
-Juan J. Martinez (juan@memset.com)
-Donagh McCabe (donagh.mccabe@hpe.com)
-Ben McCann (ben@benmccann.com)
-Andy McCrae (andy.mccrae@gmail.com)
-Stuart McLaren (stuart.mclaren@hpe.com)
-Samuel Merritt (sam@swiftstack.com)
-Min Min Ren (rminmin@cn.ibm.com)
+Jiří Suchomel (jsuchome@suse.cz)
+Joel Wright (joel.wright@sohonet.com)
+John Dickinson (me@not.mn)
 Jola Mirecka (jola.mirecka@hp.com)
-Hiroshi Miura (miurahr@nttdata.co.jp)
-Sam Morrison (sorrison@gmail.com)
-Dirk Mueller (dirk@dmllr.de)
-Zhenguo Niu (zhenguo@unitedstack.com)
-Ondrej Novy (ondrej.novy@firma.seznam.cz)
-James Nzomo (james@tdt.rocks)
-Nguyen Hung Phuong (phuongnh@vn.fujitsu.com)
-Alessandro Pilotti (ap@pilotti.it)
-Stanislaw Pitucha (stanislaw.pitucha@hpe.com)
-Dan Prince (dprince@redhat.com)
-ricolin (rico.l@inwinstack.com)
+Josh Gachnang (josh@pcsforeducation.com)
+Juan J. Martinez (juan@memset.com)
+Jude Job (judeopenstack@gmail.com)
+Julien Danjou (julien@danjou.info)
+Kota Tsuyuzaki (tsuyuzaki.kota@lab.ntt.co.jp)
+Kun Huang (gareth@unitedstack.com)
+Leah Klearman (lklrmn@gmail.com)
 Li Riqiang (lrqrun@gmail.com)
-Hirokazu Sakata (h.sakata@staff.east.ntt.co.jp)
-Christian Schwede (cschwede@redhat.com)
+Luis de Bethencourt (luis@debethencourt.com)
+Mahati Chamarthy (mahati.chamarthy@gmail.com)
+Marek Kaleta (marek.kaleta@firma.seznam.cz)
 Mark Seger (mark.seger@hpe.com)
-Chuck Short (chuck.short@canonical.com)
-David Shrewsbury (shrewsbury.dave@gmail.com)
-Pradeep Kumar Singh (pradeep.singh@nectechnologies.in)
-Alexandra Settle (alexandra.settle@rackspace.com)
-Jeremy Stanley (fungi@yuggoth.org)
-Victor Stinner (victor.stinner@enovance.com)
-Jiří Suchomel (jsuchome@suse.cz)
-YUZAWA Takahiko (yuzawataka@intellilink.co.jp)
-Nandini Tata (nandini.tata.15@gmail.com)
+Mark Washenberger (mark.washenberger@rackspace.com)
+Martin Geisler (martin@geisler.net)
+Matthew Oliver (matt@oliver.net.au)
+Matthieu Huin (mhu@enovance.com)
+Mike Widman (mwidman@endurancewindpower.com)
+Min Min Ren (rminmin@cn.ibm.com)
+Mohit Motiani (mohit.motiani@intel.com)
 Monty Taylor (mordred@inaugust.com)
+Nandini Tata (nandini.tata@intel.com)
+Nguyen Hung Phuong (phuongnh@vn.fujitsu.com)
+Nick Craig-Wood (nick@craig-wood.com)
+Ondrej Novy (ondrej.novy@firma.seznam.cz)
+Pallavi (pallavi.s@nectechnologies.in)
+Paul Belanger (pabelanger@redhat.com)
+Paulo Ewerton (pauloewerton@lsd.ufcg.edu.br)
+Pete Zaitcev (zaitcev@kotori.zaitcev.us)
+Peter Lisak (peter.lisak@firma.seznam.cz)
+Pradeep Kumar Singh (pradeep.singh@nectechnologies.in)
+Pratik Mallya (pratik.mallya@gmail.com)
+Qiu Yu (qiuyu@ebaysf.com)
+Ray Chen (oldsharp@163.com)
+ricolin (rico.l@inwinstack.com)
+Romain Hardouin (romain_hardouin@yahoo.fr)
+Sahid Orentino Ferdjaoui (sahid.ferdjaoui@cloudwatt.com)
+SaiKiran (saikiranveeravarapu@gmail.com)
+Sam Morrison (sorrison@gmail.com)
+Samuel Merritt (sam@swiftstack.com)
+Sean Dague (sean@dague.net)
+Sergey Gotliv (sgotliv@redhat.com)
+Sergio Cazzolato (sergio.j.cazzolato@intel.com)
+Shane Wang (shane.wang@intel.com)
+Shashi Kant (shashi.kant@nectechnologies.in)
+Shashirekha Gundur (shashirekha.j.gundur@intel.com)
+shu-mutou (shu-mutou@rf.jp.nec.com)
+Stanislav Vitkovskiy (stas.vitkovsky@gmail.com)
+Stanislaw Pitucha (stanislaw.pitucha@hpe.com)
+Steve Martinelli (stevemar@ca.ibm.com)
+Steven Hardy (shardy@redhat.com)
+Stuart McLaren (stuart.mclaren@hpe.com)
+Sushil Kumar (sushil.kumar2@globallogic.com)
+tanlin (lin.tan@intel.com)
+Taurus Cheung (Taurus.Cheung@harmonicinc.com)
 TheSriram (sriram@klusterkloud.com)
+Thiago da Silva (thiago@redhat.com)
+Thomas Goirand (thomas@goirand.fr)
 Tihomir Trifonov (t.trifonov@gmail.com)
-Dean Troyer (dtroyer@gmail.com)
-Kota Tsuyuzaki (tsuyuzaki.kota@lab.ntt.co.jp)
-Stanislav Vitkovskiy (stas.vitkovsky@gmail.com)
-Daniel Wakefield (daniel.wakefield@hp.com)
-Shane Wang (shane.wang@intel.com)
-Mark Washenberger (mark.washenberger@rackspace.com)
-Andrew Welleck (awellec@us.ibm.com)
+Tim Burke (tim.burke@gmail.com)
+Tong Li (litong01@us.ibm.com)
+Tristan Cacqueray (tristan.cacqueray@enovance.com)
+Vasyl Khomenko (vasiliyk@yahoo-inc.com)
+venkatamahesh (venkatamaheshkotha@gmail.com)
+Victor Stinner (victor.stinner@enovance.com)
 Wu Wenxiang (wu.wenxiang@99cloud.net)
-Mike Widman (mwidman@endurancewindpower.com)
-Joel Wright (joel.wright@sohonet.com)
-You Yamagata (bi.yamagata@gmail.com)
-zheng yin (yin.zheng@easystack.cn)
-Qiu Yu (qiuyu@ebaysf.com)
 YangLei (yanglyy@cn.ibm.com)
-Pete Zaitcev (zaitcev@kotori.zaitcev.us)
-Jian Zhang (jian.zhang@intel.com)
-Yuan Zhou (yuan.zhou@intel.com)
-groqez (groqez@yopmail.net)
-tanlin (lin.tan@intel.com)
 yangxurong (yangxurong@huawei.com)
+You Yamagata (bi.yamagata@gmail.com)
+Yuan Zhou (yuan.zhou@intel.com)
 yuxcer (yuxcer@126.com)
-zhang-jinnan (ben.os@99cloud.net)
-hgangwx (hgangwx@cn.ibm.com)
-shu-mutou (shu-mutou@rf.jp.nec.com)
-SaiKiran (saikiranveeravarapu@gmail.com)
-venkatamahesh (venkatamaheshkotha@gmail.com)
 yuyafei (yu.yafei@zte.com.cn)
+YUZAWA Takahiko (yuzawataka@intellilink.co.jp)
+Zack M. Davis (zdavis@swiftstack.com)
+zhang-jinnan (ben.os@99cloud.net)
+zheng yin (yin.zheng@easystack.cn)
+Zhenguo Niu (zhenguo@unitedstack.com)
diff --git a/ChangeLog b/ChangeLog
index 7697bdb1..458c606a 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,16 @@
+3.2.0
+-----
+
+* Added Keystone session support and a "v1password" plugin for Keystone.
+  This plugin provides a way for Keystone sessions (and clients that
+  use them, like python-openstackclient) to communicate with old auth
+  endpoints that still use this mechanism.
+
+* HEAD, GET, and DELETE now support sending additional headers to match
+  existing functionality on PUT requests.
+
+* Various other minor bug fixes and improvements.
+
 3.1.0
 -----
 
diff --git a/releasenotes/notes/320_notes-bb367dba1053d34c.yaml b/releasenotes/notes/320_notes-bb367dba1053d34c.yaml
new file mode 100644
index 00000000..a6035550
--- /dev/null
+++ b/releasenotes/notes/320_notes-bb367dba1053d34c.yaml
@@ -0,0 +1,12 @@
+features:
+  - >
+    Added Keystone session support and a "v1password" plugin for Keystone.
+    This plugin provides a way for Keystone sessions (and clients that
+    use them, like python-openstackclient) to communicate with old auth
+    endpoints that still use this mechanism.
+
+  - >
+    HEAD, GET, and DELETE now support sending additional headers to match
+    existing functionality on PUT requests.
+
+  - Various other minor bug fixes and improvements.

From 12d42efad23f95461692af99a77136d7591a5fee Mon Sep 17 00:00:00 2001
From: howardlee <lihongweibj@inspur.com>
Date: Fri, 18 Nov 2016 15:26:14 +0800
Subject: [PATCH 043/316] Replace 'assertEqual(None, ...)' with
 'assertIsNone(...)'

[H203] Use assertIs(Not)None to check for None (off by default) Unit
test assertions tend to give better messages for more specific
assertions. As a result, assertIsNone(...) is preferred over
assertEqual(None, ...) and assertIs(None, ...), and assertIsNotNone(...)
is preferred over assertNotEqual(None, ...) and assertIsNot(None,
...). Off by default.

More details, see:
http://docs.openstack.org/developer/hacking/#unit-tests-and-assertraises

Trivial fix.

Change-Id: Icd268b96dea5e5bb9bd344f597dfcd9cc82253f0
---
 tests/unit/test_authv1.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tests/unit/test_authv1.py b/tests/unit/test_authv1.py
index 968109a5..2ddf24b3 100644
--- a/tests/unit/test_authv1.py
+++ b/tests/unit/test_authv1.py
@@ -174,7 +174,7 @@ def test_get_access_bad_expiry(self):
         auth_plugin = authv1.PasswordPlugin(**self.options)
         self.mock_response.headers['X-Auth-Token-Expires'] = 'foo'
         access = auth_plugin.get_access(self.mock_session)
-        self.assertEqual(None, access.expires)
+        self.assertIsNone(access.expires)
 
         self.assertIs(False, access.will_expire_soon(60))
         self.assertIs(False, access.will_expire_soon(1e20))

From a1e2bcde4a54a33054c7dcb31c3c3b0e6d72d021 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Tue, 23 Aug 2016 16:17:21 -0700
Subject: [PATCH 044/316] Accept more types of input for headers/meta

Previously, we only accepted iterables of strings like 'Header: Value'.
Now, we'll also accept lists of tuples like ('Header', 'Value') as well
as dictionaries like {'Header': 'Value'}.

This should be more intuitive for application developers, who are
already used to being able to pass dicts or lists of tuples to libraries
like requests.

Change-Id: I93ed2f1e8305f0168b7a4bd90c205b04730da836
---
 swiftclient/service.py     |  8 +++++---
 swiftclient/utils.py       | 22 ++++++++++++++++------
 tests/unit/test_service.py | 19 ++++++++++++++++---
 3 files changed, 37 insertions(+), 12 deletions(-)

diff --git a/swiftclient/service.py b/swiftclient/service.py
index de30d502..8c6880ae 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -29,11 +29,10 @@
 from random import shuffle
 from time import time
 from threading import Thread
-from six import StringIO, text_type
+from six import Iterator, StringIO, string_types, text_type
 from six.moves.queue import Queue
 from six.moves.queue import Empty as QueueEmpty
 from six.moves.urllib.parse import quote
-from six import Iterator, string_types
 
 import json
 
@@ -274,7 +273,10 @@ def split_headers(options, prefix=''):
     """
     Splits 'Key: Value' strings and returns them as a dictionary.
 
-    :param options: An array of 'Key: Value' strings
+    :param options: Must be one of:
+        * an iterable of 'Key: Value' strings
+        * an iterable of ('Key', 'Value') pairs
+        * a dict of {'Key': 'Value'} pairs
     :param prefix: String to prepend to all of the keys in the dictionary.
         reporting.
     """
diff --git a/swiftclient/utils.py b/swiftclient/utils.py
index e14602dc..aa8b28a5 100644
--- a/swiftclient/utils.py
+++ b/swiftclient/utils.py
@@ -13,6 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 """Miscellaneous utility functions for use with Swift."""
+import collections
 import gzip
 import hashlib
 import hmac
@@ -148,15 +149,24 @@ def parse_api_response(headers, body):
 
 def split_request_headers(options, prefix=''):
     headers = {}
+    if isinstance(options, collections.Mapping):
+        options = options.items()
     for item in options:
-        split_item = item.split(':', 1)
-        if len(split_item) == 2:
-            headers[(prefix + split_item[0]).title()] = split_item[1].strip()
-        else:
+        if isinstance(item, six.string_types):
+            if ':' not in item:
+                raise ValueError(
+                    "Metadata parameter %s must contain a ':'.\n"
+                    "Example: 'Color:Blue' or 'Size:Large'"
+                    % item
+                )
+            item = item.split(':', 1)
+        if len(item) != 2:
             raise ValueError(
-                "Metadata parameter %s must contain a ':'.\n%s"
-                % (item, "Example: 'Color:Blue' or 'Size:Large'")
+                "Metadata parameter %r must have exactly two items.\n"
+                "Example: ('Color', 'Blue') or ['Size', 'Large']"
+                % (item, )
             )
+        headers[(prefix + item[0]).title()] = item[1].strip()
     return headers
 
 
diff --git a/tests/unit/test_service.py b/tests/unit/test_service.py
index e8385b7d..2fc827ca 100644
--- a/tests/unit/test_service.py
+++ b/tests/unit/test_service.py
@@ -592,11 +592,24 @@ def test_split_headers_prefix(self):
         actual = swiftclient.service.split_headers(mock_headers, 'prefix-')
         self.assertEqual(expected, actual)
 
-    def test_split_headers_error(self):
-        mock_headers = ['notvalid']
+    def test_split_headers_list_of_tuples(self):
+        mock_headers = [('color', 'blue'), ('size', 'large')]
+        expected = {'Prefix-Color': 'blue', 'Prefix-Size': 'large'}
+
+        actual = swiftclient.service.split_headers(mock_headers, 'prefix-')
+        self.assertEqual(expected, actual)
 
+    def test_split_headers_dict(self):
+        expected = {'Color': 'blue', 'Size': 'large'}
+
+        actual = swiftclient.service.split_headers(expected)
+        self.assertEqual(expected, actual)
+
+    def test_split_headers_error(self):
+        self.assertRaises(SwiftError, swiftclient.service.split_headers,
+                          ['notvalid'])
         self.assertRaises(SwiftError, swiftclient.service.split_headers,
-                          mock_headers)
+                          [('also', 'not', 'valid')])
 
 
 class TestSwiftUploadObject(unittest.TestCase):

From 03acc41c58c8ea795ec0725cb23e8dba052a32a8 Mon Sep 17 00:00:00 2001
From: Flavio Percoco <flaper87@gmail.com>
Date: Fri, 25 Nov 2016 09:54:49 +0100
Subject: [PATCH 045/316] Show team and repo badges on README

This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

https://gist.github.com/7d9f14fa125fa35b52bc840eb94828b2

Change-Id: I5f6a3351469516aa81d5eb0fe7c842fe35d1433a
---
 README.rst | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/README.rst b/README.rst
index cd5efc3e..688acfff 100644
--- a/README.rst
+++ b/README.rst
@@ -1,3 +1,12 @@
+========================
+Team and repository tags
+========================
+
+.. image:: http://governance.openstack.org/badges/python-swiftclient.svg
+    :target: http://governance.openstack.org/reference/tags/index.html
+
+.. Change things from this point on
+
 Python bindings to the OpenStack Object Storage API
 ===================================================
 

From 41666d60c88e4b70bceb7898459a93e6cf389382 Mon Sep 17 00:00:00 2001
From: Shashirekha Gundur <shashirekha.j.gundur@intel.com>
Date: Sun, 23 Oct 2016 19:59:11 +0000
Subject: [PATCH 046/316] =?UTF-8?q?modify=20'swift=20<sub=5Fcommand>=20?=
 =?UTF-8?q?=E2=80=94help'=20display?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

In python swiftclient:  swift <sub_command> —help will now
display st_<sub_command>_options + st_<sub_command>_help texts
e.g. http://paste.openstack.org/show/589752/

Change-Id: I34e4b2ac29ef395f8ca474ce7a82f59a1fd8c7f4
Closes-Bug: #1621415
---
 swiftclient/shell.py     | 18 ++++++++++++------
 tests/unit/test_shell.py |  7 +++++--
 2 files changed, 17 insertions(+), 8 deletions(-)

diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 3f8aad63..259379ed 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -861,7 +861,8 @@ def st_copy(parser, args, output_manager):
                     <container> <file_or_directory> [<file_or_directory>] [...]
 '''
 
-st_upload_help = ''' Uploads specified files and directories to the given container.
+st_upload_help = '''
+Uploads specified files and directories to the given container.
 
 Positional arguments:
   <container>           Name of container to upload to.
@@ -1098,7 +1099,8 @@ def st_upload(parser, args, output_manager):
             output_manager.error(e.value)
 
 
-st_capabilities_options = "[--json] [<proxy_url>]"
+st_capabilities_options = '''[--json] [<proxy_url>]
+'''
 st_info_options = st_capabilities_options
 st_capabilities_help = '''
 Retrieve capability of the proxy.
@@ -1198,7 +1200,8 @@ def st_auth(parser, args, thread_manager):
 
 
 st_tempurl_options = '''[--absolute]
-                     <method> <seconds> <path> <key>'''
+                     <method> <seconds> <path> <key>
+'''
 
 
 st_tempurl_help = '''
@@ -1306,9 +1309,12 @@ def parse_args(parser, args, enforce_requires=True):
             logging.basicConfig(level=logging.INFO)
 
     if args and options.get('help'):
-        _help = globals().get('st_%s_help' % args[0],
-                              "no help for %s" % args[0])
-        print(_help)
+        _help = globals().get('st_%s_help' % args[0])
+        _options = globals().get('st_%s_options' % args[0], "\n")
+        if _help:
+            print("Usage: %s %s %s\n%s" % (BASENAME, args[0], _options, _help))
+        else:
+            print("no such command: %s" % args[0])
         exit()
 
     # Short circuit for tempurl, which doesn't need auth
diff --git a/tests/unit/test_shell.py b/tests/unit/test_shell.py
index 718615d6..70ac696d 100644
--- a/tests/unit/test_shell.py
+++ b/tests/unit/test_shell.py
@@ -1545,18 +1545,21 @@ class TestSubcommandHelp(unittest.TestCase):
     def test_subcommand_help(self):
         for command in swiftclient.shell.commands:
             help_var = 'st_%s_help' % command
+            options_var = 'st_%s_options' % command
             self.assertTrue(hasattr(swiftclient.shell, help_var))
             with CaptureOutput() as out:
                 argv = ['', command, '--help']
                 self.assertRaises(SystemExit, swiftclient.shell.main, argv)
-            expected = vars(swiftclient.shell)[help_var]
+            expected = 'Usage: swift %s %s\n%s' % (
+                command, vars(swiftclient.shell).get(options_var, "\n"),
+                vars(swiftclient.shell)[help_var])
             self.assertEqual(out.strip('\n'), expected)
 
     def test_no_help(self):
         with CaptureOutput() as out:
             argv = ['', 'bad_command', '--help']
             self.assertRaises(SystemExit, swiftclient.shell.main, argv)
-        expected = 'no help for bad_command'
+        expected = 'no such command: bad_command'
         self.assertEqual(out.strip('\n'), expected)
 
 

From ae57155d390d453d48a02f73fb08d50d4d441fcd Mon Sep 17 00:00:00 2001
From: wangxiyuan <wangxiyuan@huawei.com>
Date: Thu, 15 Dec 2016 16:23:43 +0800
Subject: [PATCH 047/316] Typo fix

Change "novaclient" to "swiftclient"

Change-Id: I685b476cb05c223959c977b135a8217fb961afb1
---
 doc/Makefile | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/Makefile b/doc/Makefile
index 73aeb6ed..3943da49 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -62,9 +62,9 @@ qthelp:
 	@echo
 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/python-novaclient.qhcp"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/python-swiftclient.qhcp"
 	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/python-novaclient.qhc"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/python-swiftclient.qhc"
 
 latex:
 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex

From aea0585ddbc749b6f4d501430d41b671932c11a4 Mon Sep 17 00:00:00 2001
From: zhangyanxian <zhangyanxianmail@163.com>
Date: Fri, 16 Dec 2016 02:41:35 +0000
Subject: [PATCH 048/316] Fix typo in shell.py

TrivialFix

Change-Id: I0b0a21df1433ec8f355c452c91a818feb9f6f134
---
 swiftclient/shell.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index e6075c78..9819bf35 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -793,7 +793,7 @@ def st_post(parser, args, output_manager):
 Optional arguments:
   -d, --destination </container[/object]>
                         The container and name of the destination object. Name
-                        of destination object can be ommited, then will be
+                        of destination object can be omitted, then will be
                         same as name of source object. Supplying multiple
                         objects and destination with object name is invalid.
   -M, --fresh-metadata  Copy the object without any existing metadata,

From f2f278fcbec3ad52a1726bb5a3f775d13bcc99dc Mon Sep 17 00:00:00 2001
From: Tony Breeds <tony@bakeyournoodle.com>
Date: Wed, 21 Dec 2016 13:27:20 +1100
Subject: [PATCH 049/316] Add Constraints support

Adding constraints support to libraries is slightly more complex than
services as the libraries themselves are listed in upper-constraints.txt
which leads to errors that you can't install a specific version and a
constrained version.

This change adds constraints support by also adding a helper script to
edit the constraints to remove python-swiftclient.

Change-Id: I3947a6165eaa9f5cb62a7df4f5a2c16065da2f1d
---
 bindep.txt           |  1 +
 tools/tox_install.sh | 31 +++++++++++++++++++++++++++++++
 tox.ini              | 13 +++++++++----
 3 files changed, 41 insertions(+), 4 deletions(-)
 create mode 100755 tools/tox_install.sh

diff --git a/bindep.txt b/bindep.txt
index efc54415..e3ea9c18 100644
--- a/bindep.txt
+++ b/bindep.txt
@@ -1,5 +1,6 @@
 # This is a cross-platform list tracking distribution packages needed by tests;
 # see http://docs.openstack.org/infra/bindep/ for additional information.
 
+curl
 pypy [test]
 pypy-dev [test]
diff --git a/tools/tox_install.sh b/tools/tox_install.sh
new file mode 100755
index 00000000..15aa9dec
--- /dev/null
+++ b/tools/tox_install.sh
@@ -0,0 +1,31 @@
+#!/usr/bin/env bash
+
+# Client constraint file contains this client version pin that is in conflict
+# with installing the client from source. We should remove the version pin in
+# the constraints file before applying it for from-source installation.
+
+set -e
+
+if [[ -z "$CONSTRAINTS_FILE" ]]; then
+    echo 'WARNING: expected $CONSTRAINTS_FILE to be set' >&2
+    PIP_FLAGS=(-U)
+else
+    # NOTE(tonyb): Place this in the tox enviroment's log dir so it will get
+    # published to logs.openstack.org for easy debugging.
+    localfile="$VIRTUAL_ENV/log/upper-constraints.txt"
+
+    if [[ "$CONSTRAINTS_FILE" != http* ]]; then
+        CONSTRAINTS_FILE="file://$CONSTRAINTS_FILE"
+    fi
+    curl "$CONSTRAINTS_FILE" --insecure --progress-bar --output "$localfile"
+
+    pip install -c"$localfile" openstack-requirements
+
+    # This is the main purpose of the script: Allow local installation of
+    # the current repo. It is listed in constraints file and thus any
+    # install will be constrained and we need to unconstrain it.
+    edit-constraints "$localfile" -- "$CLIENT_NAME"
+    PIP_FLAGS=(-c"$localfile" -U)
+fi
+
+pip install "${PIP_FLAGS[@]}" "$@"
diff --git a/tox.ini b/tox.ini
index e2f1265f..df01bf8a 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,14 +1,17 @@
 [tox]
 envlist = py27,py34,py35,pypy,pep8
-minversion = 1.6
+minversion = 2.0
 skipsdist = True
 
 [testenv]
 usedevelop = True
-install_command = pip install -U {opts} {packages}
+install_command = {toxinidir}/tools/tox_install.sh {opts} {packages}
 setenv =
   LANG=en_US.utf8
   VIRTUAL_ENV={envdir}
+  BRANCH_NAME=master
+  CLIENT_NAME=python-swiftclient
+  CONSTRAINTS_FILE={env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt}
 
 deps = -r{toxinidir}/requirements.txt
        -r{toxinidir}/test-requirements.txt
@@ -28,11 +31,13 @@ commands =
 commands = {posargs}
 
 [testenv:cover]
-commands = python setup.py testr --coverage 
+commands = python setup.py testr --coverage
            coverage report
 
 [testenv:func]
-setenv = OS_TEST_PATH=tests.functional
+setenv =
+    {[testenv]setenv}
+    OS_TEST_PATH=tests.functional
 whitelist_externals =
     coverage
     rm

From 3934bd606acc2333ee9ae63a40baa35928ef908d Mon Sep 17 00:00:00 2001
From: Christopher Bartz <bartz@dkrz.de>
Date: Thu, 8 Dec 2016 13:42:35 +0100
Subject: [PATCH 050/316] prefix-based tempurls support

Implements client-side functionality for
prefix-based tempurls.

Please see: https://review.openstack.org/#/c/274048/

Change-Id: I8d7701daee888ed1120271a96c0660b01543ca2d
---
 doc/manpages/swift.1     |  4 +++-
 doc/source/cli.rst       |  7 +++++--
 swiftclient/shell.py     | 17 ++++++++++++-----
 swiftclient/utils.py     | 22 ++++++++++++++++------
 tests/unit/test_shell.py | 33 +++++++++++++++++++++++++++++++--
 tests/unit/test_utils.py | 35 +++++++++++++++++++++++++++++++++++
 6 files changed, 102 insertions(+), 16 deletions(-)

diff --git a/doc/manpages/swift.1 b/doc/manpages/swift.1
index 5d21c187..b65170c4 100644
--- a/doc/manpages/swift.1
+++ b/doc/manpages/swift.1
@@ -134,10 +134,12 @@ programs, such as jq.
 .RS 4
 Generates a temporary URL allowing unauthenticated access to the Swift object
 at the given path, using the given HTTP method, for the given number of
-seconds, using the given TempURL key. If optional \-\-absolute argument is
+seconds, using the given TempURL key. With the optional \-\-prefix\-based option a
+prefix-based URL is generated. If optional \-\-absolute argument is
 provided, seconds is instead interpreted as a Unix timestamp at which the URL
 should expire. \fBExample\fR: tempurl GET $(date \-d "Jan 1 2016" +%s)
 /v1/AUTH_foo/bar_container/quux.md my_secret_tempurl_key \-\-absolute
+
 .RE
 
 \fBauth\fR
diff --git a/doc/source/cli.rst b/doc/source/cli.rst
index 6c58d112..1f76b054 100644
--- a/doc/source/cli.rst
+++ b/doc/source/cli.rst
@@ -228,7 +228,7 @@ Capabilities
 Tempurl
 -------
 
-    ``tempurl [method] [seconds] [path] [key]``
+    ``tempurl [command-options] [method] [seconds] [path] [key]``
 
        Generates a temporary URL for a Swift object. ``method`` option sets an HTTP method to
        allow for this temporary URL that is usually 'GET' or 'PUT'. ``seconds`` option sets
@@ -236,7 +236,10 @@ Tempurl
        is passed, the Unix timestamp when the temporary URL will expire. ``path`` option sets
        the full path to the Swift object. Example: ``/v1/AUTH_account/c/o``. ``key`` option is
        the secret temporary URL key set on the Swift cluster. To set a key, run
-       ``swift post -m "Temp-URL-Key: <your secret key>"``.
+       ``swift post -m "Temp-URL-Key: <your secret key>"``. To generate a prefix-based temporary
+       URL use the ``--prefix-based`` option. This URL will contain the path to the prefix. Do not
+       forget to append the desired objectname at the end of the path portion (and before the
+       query portion) before sharing the URL.
 
 Auth
 ----
diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 9819bf35..6956a159 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -1222,9 +1222,8 @@ def st_auth(parser, args, thread_manager):
         print('export OS_AUTH_TOKEN=%s' % sh_quote(token))
 
 
-st_tempurl_options = '''[--absolute]
-                     <method> <seconds> <path> <key>
-'''
+st_tempurl_options = '''[--absolute] [--prefix-based]
+                     <method> <seconds> <path> <key>'''
 
 
 st_tempurl_help = '''
@@ -1247,6 +1246,7 @@ def st_auth(parser, args, thread_manager):
   --absolute            Interpret the <seconds> positional argument as a Unix
                         timestamp rather than a number of seconds in the
                         future.
+  --prefix-based	If present, a prefix-based tempURL will be generated.
 '''.strip('\n')
 
 
@@ -1256,8 +1256,14 @@ def st_tempurl(parser, args, thread_manager):
         dest='absolute_expiry', default=False,
         help=("If present, seconds argument will be interpreted as a Unix "
               "timestamp representing when the tempURL should expire, rather "
-              "than an offset from the current time")
+              "than an offset from the current time"),
     )
+    parser.add_argument(
+        '--prefix-based', action='store_true',
+        default=False,
+        help=("If present, a prefix-based tempURL will be generated."),
+    )
+
     (options, args) = parse_args(parser, args)
     args = args[1:]
     if len(args) < 4:
@@ -1274,7 +1280,8 @@ def st_tempurl(parser, args, thread_manager):
                                  method.upper())
     try:
         path = generate_temp_url(parsed.path, seconds, key, method,
-                                 absolute=options['absolute_expiry'])
+                                 absolute=options['absolute_expiry'],
+                                 prefix=options['prefix_based'],)
     except ValueError as err:
         thread_manager.error(err)
         return
diff --git a/swiftclient/utils.py b/swiftclient/utils.py
index e14602dc..5ba6d5b2 100644
--- a/swiftclient/utils.py
+++ b/swiftclient/utils.py
@@ -62,12 +62,14 @@ def prt_bytes(num_bytes, human_flag):
         return '%.1f%s' % (num, suffix)
 
 
-def generate_temp_url(path, seconds, key, method, absolute=False):
+def generate_temp_url(path, seconds, key, method, absolute=False,
+                      prefix=False):
     """Generates a temporary URL that gives unauthenticated access to the
     Swift object.
 
-    :param path: The full path to the Swift object. Example:
-        /v1/AUTH_account/c/o.
+    :param path: The full path to the Swift object or prefix if
+         a prefix-based temporary URL should be generated. Example:
+        /v1/AUTH_account/c/o or /v1/AUTH_account/c/prefix.
     :param seconds: If absolute is False then this specifies the amount of time
         in seconds for which the temporary URL will be valid. If absolute is
         True then this specifies an absolute time at which the temporary URL
@@ -80,6 +82,7 @@ def generate_temp_url(path, seconds, key, method, absolute=False):
     :param absolute: if True then the seconds parameter is interpreted as an
         absolute Unix time, otherwise seconds is interpreted as a relative time
         offset from current time.
+    :param prefix: if True then a prefix-based temporary URL will be generated.
     :raises: ValueError if seconds is not a whole number or path is not to
         an object.
     :return: the path portion of a temporary URL
@@ -103,8 +106,12 @@ def generate_temp_url(path, seconds, key, method, absolute=False):
         path_for_body = path
 
     parts = path_for_body.split('/', 4)
-    if len(parts) != 5 or parts[0] or not all(parts[1:]):
-        raise ValueError('path must be full path to an object e.g. /v1/a/c/o')
+    if len(parts) != 5 or parts[0] or not all(parts[1:(4 if prefix else 5)]):
+        if prefix:
+            raise ValueError('path must at least contain /v1/a/c/')
+        else:
+            raise ValueError('path must be full path to an object'
+                             ' e.g. /v1/a/c/o')
 
     standard_methods = ['GET', 'PUT', 'HEAD', 'POST', 'DELETE']
     if method.upper() not in standard_methods:
@@ -116,7 +123,8 @@ def generate_temp_url(path, seconds, key, method, absolute=False):
         expiration = int(time.time() + seconds)
     else:
         expiration = seconds
-    hmac_body = u'\n'.join([method.upper(), str(expiration), path_for_body])
+    hmac_body = u'\n'.join([method.upper(), str(expiration),
+                            ('prefix:' if prefix else '') + path_for_body])
 
     # Encode to UTF-8 for py3 compatibility
     if not isinstance(key, six.binary_type):
@@ -125,6 +133,8 @@ def generate_temp_url(path, seconds, key, method, absolute=False):
 
     temp_url = u'{path}?temp_url_sig={sig}&temp_url_expires={exp}'.format(
         path=path_for_body, sig=sig, exp=expiration)
+    if prefix:
+        temp_url += u'&temp_url_prefix={}'.format(parts[4])
     # Have return type match path from caller
     if isinstance(path, six.binary_type):
         return temp_url.encode('utf-8')
diff --git a/tests/unit/test_shell.py b/tests/unit/test_shell.py
index 00677dfe..f7e9c1ab 100644
--- a/tests/unit/test_shell.py
+++ b/tests/unit/test_shell.py
@@ -1549,7 +1549,17 @@ def test_temp_url(self, temp_url):
                 "secret_key"]
         swiftclient.shell.main(argv)
         temp_url.assert_called_with(
-            '/v1/AUTH_account/c/o', "60", 'secret_key', 'GET', absolute=False)
+            '/v1/AUTH_account/c/o', "60", 'secret_key', 'GET', absolute=False,
+            prefix=False)
+
+    @mock.patch('swiftclient.shell.generate_temp_url', return_value='')
+    def test_temp_url_prefix_based(self, temp_url):
+        argv = ["", "tempurl", "GET", "60", "/v1/AUTH_account/c/",
+                "secret_key", "--prefix-based"]
+        swiftclient.shell.main(argv)
+        temp_url.assert_called_with(
+            '/v1/AUTH_account/c/', "60", 'secret_key', 'GET', absolute=False,
+            prefix=True)
 
     @mock.patch('swiftclient.shell.generate_temp_url', return_value='')
     def test_absolute_expiry_temp_url(self, temp_url):
@@ -1557,7 +1567,8 @@ def test_absolute_expiry_temp_url(self, temp_url):
                 "secret_key", "--absolute"]
         swiftclient.shell.main(argv)
         temp_url.assert_called_with(
-            '/v1/AUTH_account/c/o', "60", 'secret_key', 'GET', absolute=True)
+            '/v1/AUTH_account/c/o', "60", 'secret_key', 'GET', absolute=True,
+            prefix=False)
 
     def test_temp_url_output(self):
         argv = ["", "tempurl", "GET", "60", "/v1/a/c/o",
@@ -1575,6 +1586,15 @@ def test_temp_url_output(self):
         expected = "http://saio:8080%s" % expected
         self.assertEqual(expected, output.out)
 
+        argv = ["", "tempurl", "GET", "60", "/v1/a/c/",
+                "secret_key", "--absolute", "--prefix"]
+        with CaptureOutput(suppress_systemexit=True) as output:
+            swiftclient.shell.main(argv)
+        sig = '00008c4be1573ba74fc2ab9bce02e3a93d04b349'
+        expected = ("/v1/a/c/?temp_url_sig=%s&temp_url_expires=60"
+                    "&temp_url_prefix=\n" % sig)
+        self.assertEqual(expected, output.out)
+
     def test_temp_url_error_output(self):
         expected = 'path must be full path to an object e.g. /v1/a/c/o\n'
         for bad_path in ('/v1/a/c', 'v1/a/c/o', '/v1/a/c/', '/v1/a//o',
@@ -1587,6 +1607,15 @@ def test_temp_url_error_output(self):
                              'Expected %r but got %r for path %r' %
                              (expected, output.err, bad_path))
 
+        expected = 'path must at least contain /v1/a/c/\n'
+        argv = ["", "tempurl", "GET", "60", '/v1/a/c',
+                    "secret_key", "--absolute", '--prefix-based']
+        with CaptureOutput(suppress_systemexit=True) as output:
+                swiftclient.shell.main(argv)
+        self.assertEqual(expected, output.err,
+                         'Expected %r but got %r for path %r' %
+                         (expected, output.err, bad_path))
+
     @mock.patch('swiftclient.service.Connection')
     def test_capabilities(self, connection):
         argv = ["", "capabilities"]
diff --git a/tests/unit/test_utils.py b/tests/unit/test_utils.py
index 787f645b..cbea8d86 100644
--- a/tests/unit/test_utils.py
+++ b/tests/unit/test_utils.py
@@ -150,6 +150,35 @@ def test_generate_temp_url(self, time_mock, hmac_mock):
         ])
         self.assertIsInstance(url, type(self.url))
 
+    @mock.patch('hmac.HMAC')
+    @mock.patch('time.time', return_value=1400000000)
+    def test_generate_temp_url_prefix(self, time_mock, hmac_mock):
+        hmac_mock().hexdigest.return_value = 'temp_url_signature'
+        prefixes = ['', 'o', 'p0/p1/']
+        for p in prefixes:
+            hmac_mock.reset_mock()
+            path = '/v1/AUTH_account/c/' + p
+            expected_url = path + ('?temp_url_sig=temp_url_signature'
+                                   '&temp_url_expires=1400003600'
+                                   '&temp_url_prefix=' + p)
+            expected_body = '\n'.join([
+                self.method,
+                '1400003600',
+                'prefix:' + path,
+            ]).encode('utf-8')
+            url = u.generate_temp_url(path, self.seconds,
+                                      self.key, self.method, prefix=True)
+            key = self.key
+            if not isinstance(key, six.binary_type):
+                key = key.encode('utf-8')
+            self.assertEqual(url, expected_url)
+            self.assertEqual(hmac_mock.mock_calls, [
+                mock.call(key, expected_body, sha1),
+                mock.call().hexdigest(),
+            ])
+
+            self.assertIsInstance(url, type(path))
+
     def test_generate_temp_url_invalid_path(self):
         with self.assertRaises(ValueError) as exc_manager:
             u.generate_temp_url(b'/v1/a/c/\xff', self.seconds, self.key,
@@ -221,6 +250,12 @@ def test_generate_temp_url_bad_path(self):
         self.assertEqual(exc_manager.exception.args[0],
                          'path must be full path to an object e.g. /v1/a/c/o')
 
+        with self.assertRaises(ValueError) as exc_manager:
+            u.generate_temp_url('/v1/a/c', 60, self.key, self.method,
+                                prefix=True)
+        self.assertEqual(exc_manager.exception.args[0],
+                         'path must at least contain /v1/a/c/')
+
 
 class TestTempURLUnicodePathAndKey(TestTempURL):
     url = u'/v1/\u00e4/c/\u00f3'

From 307d4c007afaccdcd70628d9fce44231115d62cd Mon Sep 17 00:00:00 2001
From: John Dickinson <me@not.mn>
Date: Wed, 25 Jan 2017 15:12:59 -0800
Subject: [PATCH 051/316] 3.3.0 authors/changelog update

Change-Id: Idc92915d5b23019bc0d65d17b1f5104b3dca57ee
---
 .mailmap  |  1 +
 AUTHORS   |  8 +++++++-
 ChangeLog | 15 +++++++++++++++
 3 files changed, 23 insertions(+), 1 deletion(-)

diff --git a/.mailmap b/.mailmap
index bfa98c34..9e53d387 100644
--- a/.mailmap
+++ b/.mailmap
@@ -93,3 +93,4 @@ Marek Kaleta <marek.kaleta@firma.seznam.cz> <Marek.Kaleta@firma.seznam.cz>
 Andreas Jaeger <aj@suse.de> <aj@suse.com>
 Shashi Kant <shashi.kant@nectechnologies.in>
 Nandini Tata <nandini.tata@intel.com> <nandini.tata.15@gmail.com>
+Flavio Percoco <flaper87@gmail.com>
diff --git a/AUTHORS b/AUTHORS
index 27e0e201..7c162e02 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -17,6 +17,7 @@ Chmouel Boudjnah (chmouel@enovance.com)
 Chris Buccella (chris.buccella@antallagon.com)
 Christian Berendt (berendt@b1-systems.de)
 Christian Schwede (cschwede@redhat.com)
+Christopher Bartz (bartz@dkrz.de)
 Chuck Short (chuck.short@canonical.com)
 Clark Boylan (clark.boylan@gmail.com)
 Claudiu Belu (cbelu@cloudbasesolutions.com)
@@ -36,7 +37,7 @@ Doug Hellmann (doug@doughellmann.com)
 EdLeafe (ed@leafe.com)
 Fabien Boucher (fabien.boucher@enovance.com)
 Feng Liu (mefengliu23@gmail.com)
-Flaper Fesp (flaper87@gmail.com)
+Flavio Percoco (flaper87@gmail.com)
 Florent Flament (florent.flament-ext@cloudwatt.com)
 Greg Holt (gholt@rackspace.com)
 Greg Lange (greglange@gmail.com)
@@ -45,6 +46,7 @@ Hemanth Makkapati (hemanth.makkapati@mailtrust.com)
 hgangwx (hgangwx@cn.ibm.com)
 Hirokazu Sakata (h.sakata@staff.east.ntt.co.jp)
 Hiroshi Miura (miurahr@nttdata.co.jp)
+howardlee (lihongweibj@inspur.com)
 Hu Bing (hubingsh@cn.ibm.com)
 Ian Cordasco (ian.cordasco@rackspace.com)
 Jaivish Kothari (jaivish.kothari@nectechnologies.in)
@@ -119,19 +121,23 @@ Thomas Goirand (thomas@goirand.fr)
 Tihomir Trifonov (t.trifonov@gmail.com)
 Tim Burke (tim.burke@gmail.com)
 Tong Li (litong01@us.ibm.com)
+Tony Breeds (tony@bakeyournoodle.com)
 Tristan Cacqueray (tristan.cacqueray@enovance.com)
 Vasyl Khomenko (vasiliyk@yahoo-inc.com)
 venkatamahesh (venkatamaheshkotha@gmail.com)
 Victor Stinner (victor.stinner@enovance.com)
+wangxiyuan (wangxiyuan@huawei.com)
 Wu Wenxiang (wu.wenxiang@99cloud.net)
 YangLei (yanglyy@cn.ibm.com)
 yangxurong (yangxurong@huawei.com)
 You Yamagata (bi.yamagata@gmail.com)
 Yuan Zhou (yuan.zhou@intel.com)
+Yushiro FURUKAWA (y.furukawa_2@jp.fujitsu.com)
 yuxcer (yuxcer@126.com)
 yuyafei (yu.yafei@zte.com.cn)
 YUZAWA Takahiko (yuzawataka@intellilink.co.jp)
 Zack M. Davis (zdavis@swiftstack.com)
 zhang-jinnan (ben.os@99cloud.net)
+zhangyanxian (zhangyanxianmail@163.com)
 zheng yin (yin.zheng@easystack.cn)
 Zhenguo Niu (zhenguo@unitedstack.com)
diff --git a/ChangeLog b/ChangeLog
index 458c606a..749d22cb 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,18 @@
+3.3.0
+-----
+
+* Added support for prefix-based tempurls. This allows you to create a
+  tempurl that is valid for all objects which share a given prefix and
+  matches the feature in Swift 2.12.0 and later.
+
+* In the SDK, we previously only accepted iterables of strings like
+  'Header: Value'. Now, we'll also accept lists of tuples like
+  ('Header', 'Value') as well as dictionaries like {'Header': 'Value'}.
+
+* Improved help message strings
+
+* Various other minor bug fixes and improvements.
+
 3.2.0
 -----
 

From 91de5e8a385178b58cfeeb702c005ec2f2c5068a Mon Sep 17 00:00:00 2001
From: Joel Wright <joel.wright@sohonet.com>
Date: Thu, 23 Feb 2017 11:00:09 +0000
Subject: [PATCH 052/316] Expose --prefix as an option for st_delete

The SwiftService and shell support the ability to limit
deletions to only those objects that match a specified
prefix, so let's expose that (really useful) behaviour
in the command line help as well :)

Change-Id: I9ef177aa96e4829196b5200dd8e9d0d2f7f89b63
---
 swiftclient/shell.py | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 6956a159..ceca5922 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -59,6 +59,7 @@ def immediate_exit(signum, frame):
                     [--object-threads <threads>]
                     [--container-threads <threads>]
                     [--header <header:value>]
+                    [--prefix <prefix>]
                     [<container> [<object>] [...]]
 '''
 
@@ -82,6 +83,7 @@ def immediate_exit(signum, frame):
   --container-threads <threads>
                         Number of threads to use for deleting containers.
                         Default is 10.
+  --prefix <prefix>     Only delete objects beginning with <prefix>.
 '''.strip("\n")
 
 
@@ -91,7 +93,7 @@ def st_delete(parser, args, output_manager):
         default=False, help='Delete all containers and objects.')
     parser.add_argument(
         '-p', '--prefix', dest='prefix',
-        help='Only delete items beginning with the <prefix>.')
+        help='Only delete items beginning with <prefix>.')
     parser.add_argument(
         '-H', '--header', action='append', dest='header',
         default=[],

From 028c4824d0190e0b605ae9c90756167083e46cd3 Mon Sep 17 00:00:00 2001
From: Vitaly Gridnev <vgridnev@mirantis.com>
Date: Tue, 7 Mar 2017 13:38:22 +0400
Subject: [PATCH 053/316] Fix logging of the gzipped body

Change-Id: I6d7ccbf4ef9b46e890ecec58842c5cdd2804c7a9
Closes-bug: 1670620
---
 swiftclient/client.py          |  7 ++++--
 swiftclient/utils.py           |  9 +++++--
 tests/unit/test_swiftclient.py | 44 +++++++++++++++++++++++++++++++++-
 tests/unit/test_utils.py       | 18 ++++++++++++++
 4 files changed, 73 insertions(+), 5 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index 21cbe279..80b6eda2 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -32,7 +32,8 @@
 from swiftclient import version as swiftclient_version
 from swiftclient.exceptions import ClientException
 from swiftclient.utils import (
-    iter_wrapper, LengthWrapper, ReadableToIterable, parse_api_response)
+    iter_wrapper, LengthWrapper, ReadableToIterable, parse_api_response,
+    get_body)
 
 # Default is 100, increase to 256
 http_client._MAXHEADERS = 256
@@ -165,7 +166,9 @@ def http_log(args, kwargs, resp, body):
     log_method("RESP STATUS: %s %s", resp.status, resp.reason)
     log_method("RESP HEADERS: %s", scrub_headers(resp.getheaders()))
     if body:
-        log_method("RESP BODY: %s", body)
+        resp_headers = resp_header_dict(resp)
+        nbody = get_body(resp_headers, body)
+        log_method("RESP BODY: %s", nbody)
 
 
 def parse_header_string(data):
diff --git a/swiftclient/utils.py b/swiftclient/utils.py
index 9f8af1f5..47856c21 100644
--- a/swiftclient/utils.py
+++ b/swiftclient/utils.py
@@ -143,11 +143,16 @@ def generate_temp_url(path, seconds, key, method, absolute=False,
         return temp_url
 
 
-def parse_api_response(headers, body):
+def get_body(headers, body):
     if headers.get('content-encoding') == 'gzip':
         with gzip.GzipFile(fileobj=six.BytesIO(body), mode='r') as gz:
-            body = gz.read()
+            nbody = gz.read()
+        return nbody
+    return body
+
 
+def parse_api_response(headers, body):
+    body = get_body(headers, body)
     charset = 'utf-8'
     # Swift *should* be speaking UTF-8, but check content-type just in case
     content_type = headers.get('content-type', '')
diff --git a/tests/unit/test_swiftclient.py b/tests/unit/test_swiftclient.py
index 3a24b003..d4a704e1 100644
--- a/tests/unit/test_swiftclient.py
+++ b/tests/unit/test_swiftclient.py
@@ -13,6 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import gzip
 import logging
 import mock
 import six
@@ -82,7 +83,7 @@ def test_attrs(self):
 
 
 class MockHttpResponse(object):
-    def __init__(self, status=0, headers=None, verify=False):
+    def __init__(self, status=0, headers=None, verify=False, need_items=None):
         self.status = status
         self.status_code = status
         self.reason = "OK"
@@ -91,6 +92,7 @@ def __init__(self, status=0, headers=None, verify=False):
         self.verify = verify
         self.md5sum = md5()
         self.headers = {'etag': '"%s"' % EMPTY_ETAG}
+        self.need_items = need_items
         if headers:
             self.headers.update(headers)
         self.closed = False
@@ -117,6 +119,8 @@ def getheader(self, name, default):
         return self.headers.get(name, default)
 
     def getheaders(self):
+        if self.need_items:
+            return dict(self.headers).items()
         return dict(self.headers)
 
     def fake_response(self):
@@ -2607,6 +2611,44 @@ def test_redact_token(self):
             self.assertNotIn(unicode_token_value, output)
             self.assertNotIn(set_cookie_value, output)
 
+    def test_logging_body(self):
+        with mock.patch('swiftclient.client.logger.debug') as mock_log:
+            token_value = 'tkee96b40a8ca44fc5ad72ec5a7c90d9b'
+            token_encoded = token_value.encode('utf8')
+            unicode_token_value = (u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91'
+                                   u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91'
+                                   u'\u5929\u7a7a\u4e2d\u7684\u4e4c')
+            unicode_token_encoded = unicode_token_value.encode('utf8')
+            set_cookie_value = 'X-Auth-Token=%s' % token_value
+            set_cookie_encoded = set_cookie_value.encode('utf8')
+            buf = six.BytesIO()
+            gz = gzip.GzipFile(fileobj=buf, mode='w')
+            gz.write(u'{"test": "\u2603"}'.encode('utf8'))
+            gz.close()
+            c.http_log(
+                ['GET'],
+                {'headers': {
+                    'X-Auth-Token': token_encoded,
+                    'X-Storage-Token': unicode_token_encoded
+                }},
+                MockHttpResponse(
+                    status=200,
+                    headers={
+                        'X-Auth-Token': token_encoded,
+                        'X-Storage-Token': unicode_token_encoded,
+                        'content-encoding': 'gzip',
+                        'Etag': b'mock_etag',
+                        'Set-Cookie': set_cookie_encoded
+                    },
+                    need_items=True,
+                ),
+                buf.getvalue(),
+            )
+            self.assertEqual(
+                mock.call(
+                    'RESP BODY: %s', u'{"test": "\u2603"}'.encode('utf8')),
+                mock_log.mock_calls[3])
+
     def test_show_token(self):
         with mock.patch('swiftclient.client.logger.debug') as mock_log:
             token_value = 'tkee96b40a8ca44fc5ad72ec5a7c90d9b'
diff --git a/tests/unit/test_utils.py b/tests/unit/test_utils.py
index cbea8d86..c5961e87 100644
--- a/tests/unit/test_utils.py
+++ b/tests/unit/test_utils.py
@@ -507,3 +507,21 @@ def test_gzipped_utf8(self):
             {'content-encoding': 'gzip'},
             buf.getvalue())
         self.assertEqual({'test': u'\u2603'}, result)
+
+
+class TestGetBody(unittest.TestCase):
+
+    def test_not_gzipped(self):
+        result = u.parse_api_response(
+            {}, u'{"test": "\\u2603"}'.encode('utf8'))
+        self.assertEqual({'test': u'\u2603'}, result)
+
+    def test_gzipped_body(self):
+        buf = six.BytesIO()
+        gz = gzip.GzipFile(fileobj=buf, mode='w')
+        gz.write(u'{"test": "\u2603"}'.encode('utf8'))
+        gz.close()
+        result = u.parse_api_response(
+            {'content-encoding': 'gzip'},
+            buf.getvalue())
+        self.assertEqual({'test': u'\u2603'}, result)

From ee8620de940297f8b754ce0ffcfcbc4dceb29794 Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Wed, 8 Mar 2017 16:53:24 +0100
Subject: [PATCH 054/316] Change swift.o.o URL

This is an obsolete URL that redirects, use docs.o.o - and use https for
it.

Change-Id: I7ba2c49db2c620071f8eeb96d0b63af8381ed899
---
 doc/manpages/swift.1 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/manpages/swift.1 b/doc/manpages/swift.1
index b65170c4..bbf5280a 100644
--- a/doc/manpages/swift.1
+++ b/doc/manpages/swift.1
@@ -186,4 +186,4 @@ swift \-A https://127.0.0.1:443/auth/v1.0 \-U swiftops:swiftops \-K swiftops sta
 .SH DOCUMENTATION
 .LP
 More in depth documentation about OpenStack Swift as a whole can be found at
-.BI http://swift.openstack.org
+.BI https://docs.openstack.org/developer/swift

From dd34af42f8ac8311d857ee1bf509269dfcfcfb24 Mon Sep 17 00:00:00 2001
From: Clay Gerrard <clay.gerrard@gmail.com>
Date: Tue, 7 Mar 2017 16:52:51 -0800
Subject: [PATCH 055/316] Fix MockHttpResponse to be more like the Real

This change pulls out that relatively new [1] little string to pull at
in the MockHttpResponse that I think is sorta ugly.  And replaces it
with the correct behavior that's representative of the Real for which
it's standing in (which is sadly our wrapper to make a requests response
feel like a httplib.HTTPResponse).

It's not clear (to me) the history which allowed this difference in the
behavior of the Real and Fake to persist - it seems to have always been
this way [2].

I also reworded a relatively new test [1] to cover more code, and make
assertions on the desired behavior of the client instead of "just" the
http_log method.

FWIW, I don't think there was necessarily anything wrong with the scope
of the new test [1] - and it certainly makes sense to see new tests copy
nearby existing tests.  But I subjectively think this smaller test is
more demonstrative of the desired behavior.

1. Related-Change-Id: I6d7ccbf4ef9b46e890ecec58842c5cdd2804c7a9
2. Related-Change-Id: If07af46cb377f3f3d70f6c4284037241d360a8b7
Change-Id: Ib99a029c1bd1ea1efa8060fe8a11cb01deea41c6
---
 tests/unit/test_swiftclient.py | 75 ++++++++++++++--------------------
 1 file changed, 31 insertions(+), 44 deletions(-)

diff --git a/tests/unit/test_swiftclient.py b/tests/unit/test_swiftclient.py
index d4a704e1..2cd5cf15 100644
--- a/tests/unit/test_swiftclient.py
+++ b/tests/unit/test_swiftclient.py
@@ -14,6 +14,7 @@
 # limitations under the License.
 
 import gzip
+import json
 import logging
 import mock
 import six
@@ -83,7 +84,7 @@ def test_attrs(self):
 
 
 class MockHttpResponse(object):
-    def __init__(self, status=0, headers=None, verify=False, need_items=None):
+    def __init__(self, status=0, headers=None, verify=False):
         self.status = status
         self.status_code = status
         self.reason = "OK"
@@ -92,7 +93,6 @@ def __init__(self, status=0, headers=None, verify=False, need_items=None):
         self.verify = verify
         self.md5sum = md5()
         self.headers = {'etag': '"%s"' % EMPTY_ETAG}
-        self.need_items = need_items
         if headers:
             self.headers.update(headers)
         self.closed = False
@@ -119,9 +119,7 @@ def getheader(self, name, default):
         return self.headers.get(name, default)
 
     def getheaders(self):
-        if self.need_items:
-            return dict(self.headers).items()
-        return dict(self.headers)
+        return dict(self.headers).items()
 
     def fake_response(self):
         return self
@@ -2319,7 +2317,7 @@ def getheader(self, *args, **kwargs):
                 return 'header'
 
             def getheaders(self):
-                return {"key1": "value1", "key2": "value2"}
+                return [('key1', 'value1'), ('key2', 'value2')]
 
             def read(self, *args, **kwargs):
                 return ''
@@ -2569,6 +2567,33 @@ def test_get_error(self):
             c.get_object('http://www.test.com', 'asdf', 'asdf', 'asdf')
         self.assertEqual(exc_context.exception.http_status, 404)
 
+    def test_content_encoding_gzip_body_is_logged_decoded(self):
+        buf = six.BytesIO()
+        gz = gzip.GzipFile(fileobj=buf, mode='w')
+        data = {"test": u"\u2603"}
+        decoded_body = json.dumps(data).encode('utf-8')
+        gz.write(decoded_body)
+        gz.close()
+        # stub a gzip encoded body
+        body = buf.getvalue()
+        headers = {'content-encoding': 'gzip'}
+        # ... and make a content-encoding gzip error response
+        stub_response = StubResponse(500, body, headers)
+        with mock.patch('swiftclient.client.logger.info') as mock_log:
+            # ... if the client gets such a response
+            c.http_connection = self.fake_http_connection(stub_response)
+            with self.assertRaises(c.ClientException) as exc_context:
+                c.get_object('http://www.test.com', 'asdf', 'asdf', 'asdf')
+            self.assertEqual(exc_context.exception.http_status, 500)
+        # it will log the decoded body
+        self.assertEqual([
+            mock.call('REQ: %s', u'curl -i http://www.test.com/asdf/asdf '
+                      '-X GET -H "X-Auth-Token: ..."'),
+            mock.call('RESP STATUS: %s %s', 500, 'Fake'),
+            mock.call('RESP HEADERS: %s', {'content-encoding': 'gzip'}),
+            mock.call('RESP BODY: %s', decoded_body)
+        ], mock_log.mock_calls)
+
     def test_redact_token(self):
         with mock.patch('swiftclient.client.logger.debug') as mock_log:
             token_value = 'tkee96b40a8ca44fc5ad72ec5a7c90d9b'
@@ -2611,44 +2636,6 @@ def test_redact_token(self):
             self.assertNotIn(unicode_token_value, output)
             self.assertNotIn(set_cookie_value, output)
 
-    def test_logging_body(self):
-        with mock.patch('swiftclient.client.logger.debug') as mock_log:
-            token_value = 'tkee96b40a8ca44fc5ad72ec5a7c90d9b'
-            token_encoded = token_value.encode('utf8')
-            unicode_token_value = (u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91'
-                                   u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91'
-                                   u'\u5929\u7a7a\u4e2d\u7684\u4e4c')
-            unicode_token_encoded = unicode_token_value.encode('utf8')
-            set_cookie_value = 'X-Auth-Token=%s' % token_value
-            set_cookie_encoded = set_cookie_value.encode('utf8')
-            buf = six.BytesIO()
-            gz = gzip.GzipFile(fileobj=buf, mode='w')
-            gz.write(u'{"test": "\u2603"}'.encode('utf8'))
-            gz.close()
-            c.http_log(
-                ['GET'],
-                {'headers': {
-                    'X-Auth-Token': token_encoded,
-                    'X-Storage-Token': unicode_token_encoded
-                }},
-                MockHttpResponse(
-                    status=200,
-                    headers={
-                        'X-Auth-Token': token_encoded,
-                        'X-Storage-Token': unicode_token_encoded,
-                        'content-encoding': 'gzip',
-                        'Etag': b'mock_etag',
-                        'Set-Cookie': set_cookie_encoded
-                    },
-                    need_items=True,
-                ),
-                buf.getvalue(),
-            )
-            self.assertEqual(
-                mock.call(
-                    'RESP BODY: %s', u'{"test": "\u2603"}'.encode('utf8')),
-                mock_log.mock_calls[3])
-
     def test_show_token(self):
         with mock.patch('swiftclient.client.logger.debug') as mock_log:
             token_value = 'tkee96b40a8ca44fc5ad72ec5a7c90d9b'

From 24dda6af9f9ea1c741b57c5709046be993ba788a Mon Sep 17 00:00:00 2001
From: Petr Kovar <pkovar@redhat.com>
Date: Mon, 13 Mar 2017 16:24:50 +0100
Subject: [PATCH 056/316] [trivial] Be consistent in using example.com

* Use distro-agnostic example.com in all examples.

Change-Id: If0a7217b7312875bb4ca8258f4ef86c52cd2e577
---
 doc/source/cli.rst   | 4 ++--
 swiftclient/shell.py | 2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/doc/source/cli.rst b/doc/source/cli.rst
index 1f76b054..b107448c 100644
--- a/doc/source/cli.rst
+++ b/doc/source/cli.rst
@@ -85,7 +85,7 @@ below:
 
 .. code-block:: bash
 
-    swift -A https://auth.api.rackspacecloud.com/v1.0 -U user -K api_key list
+    swift -A https://api.example.com/v1.0 -U user -K api_key list
 
 Specifying the options above manually on the command line can be avoided by
 setting the following environment variables:
@@ -93,7 +93,7 @@ setting the following environment variables:
 .. code-block:: bash
 
     ST_AUTH_VERSION=1.0
-    ST_AUTH=https://auth.api.rackspacecloud.com/v1.0
+    ST_AUTH=https://api.example.com/v1.0
     ST_USER=user
     ST_KEY=key
 
diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index ceca5922..4a8a3561 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -1442,7 +1442,7 @@ def main(arguments=None):
 Examples:
   %(prog)s download --help
 
-  %(prog)s -A https://auth.api.rackspacecloud.com/v1.0 \\
+  %(prog)s -A https://api.example.com/v1.0 \\
       -U user -K api_key stat -v
 
   %(prog)s --os-auth-url https://api.example.com/v2.0 \\

From 809e4cf98fceed1ddef033c86199cca48708d710 Mon Sep 17 00:00:00 2001
From: Kazufumi Noto <noto.kazufumi@gmail.com>
Date: Wed, 15 Mar 2017 20:47:33 +0000
Subject: [PATCH 057/316] Close file handle after upload job

The opened file for upload is not closed.
This fix prevents possible file handle leak.

Closes-Bug: #1559079
Change-Id: Ibc58667789e8f54c74ae2bbd32717a45f7b30550
---
 swiftclient/service.py     |  57 +++++++++++-------
 tests/unit/test_service.py | 119 ++++++++++++++++++++++---------------
 2 files changed, 106 insertions(+), 70 deletions(-)

diff --git a/swiftclient/service.py b/swiftclient/service.py
index 8c6880ae..b2b00c65 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -1714,6 +1714,7 @@ def _upload_segment_job(conn, path, container, segment_name, segment_start,
                                             segment_name),
             'log_line': '%s segment %s' % (obj_name, segment_index),
         }
+        fp = None
         try:
             fp = open(path, 'rb')
             fp.seek(segment_start)
@@ -1761,6 +1762,9 @@ def _upload_segment_job(conn, path, container, segment_name, segment_start,
             if results_queue is not None:
                 results_queue.put(res)
             return res
+        finally:
+            if fp is not None:
+                fp.close()
 
     def _get_chunk_data(self, conn, container, obj, headers, manifest=None):
         chunks = []
@@ -2008,29 +2012,36 @@ def _upload_object_job(self, conn, container, source, obj, options,
             else:
                 res['large_object'] = False
                 obr = {}
-                if path is not None:
-                    content_length = getsize(path)
-                    contents = LengthWrapper(open(path, 'rb'),
-                                             content_length,
-                                             md5=options['checksum'])
-                else:
-                    content_length = None
-                    contents = ReadableToIterable(stream,
-                                                  md5=options['checksum'])
-
-                etag = conn.put_object(
-                    container, obj, contents,
-                    content_length=content_length, headers=put_headers,
-                    response_dict=obr
-                )
-                res['response_dict'] = obr
-
-                if (options['checksum'] and
-                        etag and etag != contents.get_md5sum()):
-                    raise SwiftError('Object upload verification failed: '
-                                     'md5 mismatch, local {0} != remote {1} '
-                                     '(remote object has not been removed)'
-                                     .format(contents.get_md5sum(), etag))
+                fp = None
+                try:
+                    if path is not None:
+                        content_length = getsize(path)
+                        fp = open(path, 'rb')
+                        contents = LengthWrapper(fp,
+                                                 content_length,
+                                                 md5=options['checksum'])
+                    else:
+                        content_length = None
+                        contents = ReadableToIterable(stream,
+                                                      md5=options['checksum'])
+
+                    etag = conn.put_object(
+                        container, obj, contents,
+                        content_length=content_length, headers=put_headers,
+                        response_dict=obr
+                    )
+                    res['response_dict'] = obr
+
+                    if (options['checksum'] and
+                            etag and etag != contents.get_md5sum()):
+                        raise SwiftError(
+                            'Object upload verification failed: '
+                            'md5 mismatch, local {0} != remote {1} '
+                            '(remote object has not been removed)'
+                            .format(contents.get_md5sum(), etag))
+                finally:
+                    if fp is not None:
+                        fp.close()
 
             if old_manifest or old_slo_manifest_paths:
                 drs = []
diff --git a/tests/unit/test_service.py b/tests/unit/test_service.py
index 2fc827ca..378b70b6 100644
--- a/tests/unit/test_service.py
+++ b/tests/unit/test_service.py
@@ -14,6 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 from __future__ import unicode_literals
+import contextlib
 import mock
 import os
 import six
@@ -1002,7 +1003,6 @@ def test_upload_with_bad_segment_size(self):
     @mock.patch('swiftclient.service.stat')
     @mock.patch('swiftclient.service.getmtime', return_value=1.0)
     @mock.patch('swiftclient.service.getsize', return_value=4)
-    @mock.patch.object(builtins, 'open', return_value=six.StringIO('asdf'))
     def test_upload_with_relative_path(self, *args, **kwargs):
         service = SwiftService({})
         objects = [{'path': "./test",
@@ -1012,7 +1012,9 @@ def test_upload_with_relative_path(self, *args, **kwargs):
                    {'path': ".\\test",
                     'strt_indx': 2}]
         for obj in objects:
-            with mock.patch('swiftclient.service.Connection') as mock_conn:
+            with mock.patch('swiftclient.service.Connection') as mock_conn, \
+                    mock.patch.object(builtins, 'open') as mock_open:
+                mock_open.return_value = six.StringIO('asdf')
                 mock_conn.return_value.head_object.side_effect = \
                     ClientException('Not Found', http_status=404)
                 mock_conn.return_value.put_object.return_value =\
@@ -1032,10 +1034,29 @@ def test_upload_with_relative_path(self, *args, **kwargs):
                 self.assertEqual(upload_obj_resp['object'],
                                  obj['path'][obj['strt_indx']:])
                 self.assertEqual(upload_obj_resp['path'], obj['path'])
+                self.assertTrue(mock_open.return_value.closed)
 
 
 class TestServiceUpload(_TestServiceBase):
 
+    @contextlib.contextmanager
+    def assert_open_results_are_closed(self):
+        opened_files = []
+        builtin_open = builtins.open
+
+        def open_wrapper(*a, **kw):
+            opened_files.append((builtin_open(*a, **kw), a, kw))
+            return opened_files[-1][0]
+
+        with mock.patch.object(builtins, 'open', open_wrapper):
+            yield
+        for fp, args, kwargs in opened_files:
+            formatted_args = [repr(a) for a in args]
+            formatted_args.extend('%s=%r' % kv for kv in kwargs.items())
+            formatted_args = ', '.join(formatted_args)
+            self.assertTrue(fp.closed,
+                            'Failed to close open(%s)' % formatted_args)
+
     def test_upload_object_job_file_with_unicode_path(self):
         # Uploading a file results in the file object being wrapped in a
         # LengthWrapper. This test sets the options in such a way that much
@@ -1109,11 +1130,14 @@ def test_upload_segment_job(self):
             f.write(b'c' * 10)
             f.flush()
 
-            # Mock the connection to return an empty etag. This
-            # skips etag validation which would fail as the LengthWrapper
-            # isn't read from.
+            # run read() when put_object is called to calculate md5sum
+            def _consuming_conn(*a, **kw):
+                contents = a[2]
+                contents.read()  # Force md5 calculation
+                return contents.get_md5sum()
+
             mock_conn = mock.Mock()
-            mock_conn.put_object.return_value = ''
+            mock_conn.put_object.side_effect = _consuming_conn
             type(mock_conn).attempts = mock.PropertyMock(return_value=2)
             expected_r = {
                 'action': 'upload_segment',
@@ -1125,21 +1149,22 @@ def test_upload_segment_job(self):
                 'log_line': 'test_o segment 2',
                 'success': True,
                 'response_dict': {},
-                'segment_etag': '',
+                'segment_etag': md5(b'b' * 10).hexdigest(),
                 'attempts': 2,
             }
 
             s = SwiftService()
-            r = s._upload_segment_job(conn=mock_conn,
-                                      path=f.name,
-                                      container='test_c',
-                                      segment_name='test_s_1',
-                                      segment_start=10,
-                                      segment_size=10,
-                                      segment_index=2,
-                                      obj_name='test_o',
-                                      options={'segment_container': None,
-                                               'checksum': True})
+            with self.assert_open_results_are_closed():
+                r = s._upload_segment_job(conn=mock_conn,
+                                          path=f.name,
+                                          container='test_c',
+                                          segment_name='test_s_1',
+                                          segment_start=10,
+                                          segment_size=10,
+                                          segment_index=2,
+                                          obj_name='test_o',
+                                          options={'segment_container': None,
+                                                   'checksum': True})
 
             self.assertEqual(r, expected_r)
 
@@ -1153,10 +1178,6 @@ def test_upload_segment_job(self):
             contents = mock_conn.put_object.call_args[0][2]
             self.assertIsInstance(contents, utils.LengthWrapper)
             self.assertEqual(len(contents), 10)
-            # This read forces the LengthWrapper to calculate the md5
-            # for the read content.
-            self.assertEqual(contents.read(), b'b' * 10)
-            self.assertEqual(contents.get_md5sum(), md5(b'b' * 10).hexdigest())
 
     def test_etag_mismatch_with_ignore_checksum(self):
         def _consuming_conn(*a, **kw):
@@ -1215,16 +1236,17 @@ def _consuming_conn(*a, **kw):
             type(mock_conn).attempts = mock.PropertyMock(return_value=2)
 
             s = SwiftService()
-            r = s._upload_segment_job(conn=mock_conn,
-                                      path=f.name,
-                                      container='test_c',
-                                      segment_name='test_s_1',
-                                      segment_start=10,
-                                      segment_size=10,
-                                      segment_index=2,
-                                      obj_name='test_o',
-                                      options={'segment_container': None,
-                                               'checksum': True})
+            with self.assert_open_results_are_closed():
+                r = s._upload_segment_job(conn=mock_conn,
+                                          path=f.name,
+                                          container='test_c',
+                                          segment_name='test_s_1',
+                                          segment_start=10,
+                                          segment_size=10,
+                                          segment_index=2,
+                                          obj_name='test_o',
+                                          options={'segment_container': None,
+                                                   'checksum': True})
 
             self.assertIn('md5 mismatch', str(r.get('error')))
 
@@ -1259,21 +1281,29 @@ def test_upload_object_job_file(self):
             }
             expected_mtime = '%f' % os.path.getmtime(f.name)
 
+            # run read() when put_object is called to calculate md5sum
+            # md5sum is verified in _upload_object_job.
+            def _consuming_conn(*a, **kw):
+                contents = a[2]
+                contents.read()  # Force md5 calculation
+                return contents.get_md5sum()
+
             mock_conn = mock.Mock()
-            mock_conn.put_object.return_value = ''
+            mock_conn.put_object.side_effect = _consuming_conn
             type(mock_conn).attempts = mock.PropertyMock(return_value=2)
 
             s = SwiftService()
-            r = s._upload_object_job(conn=mock_conn,
-                                     container='test_c',
-                                     source=f.name,
-                                     obj='test_o',
-                                     options={'changed': False,
-                                              'skip_identical': False,
-                                              'leave_segments': True,
-                                              'header': '',
-                                              'segment_size': 0,
-                                              'checksum': True})
+            with self.assert_open_results_are_closed():
+                r = s._upload_object_job(conn=mock_conn,
+                                         container='test_c',
+                                         source=f.name,
+                                         obj='test_o',
+                                         options={'changed': False,
+                                                  'skip_identical': False,
+                                                  'leave_segments': True,
+                                                  'header': '',
+                                                  'segment_size': 0,
+                                                  'checksum': True})
 
             mtime = r['headers']['x-object-meta-mtime']
             self.assertEqual(expected_mtime, mtime)
@@ -1292,11 +1322,6 @@ def test_upload_object_job_file(self):
             contents = mock_conn.put_object.call_args[0][2]
             self.assertIsInstance(contents, utils.LengthWrapper)
             self.assertEqual(len(contents), 30)
-            # This read forces the LengthWrapper to calculate the md5
-            # for the read content. This also checks that LengthWrapper was
-            # initialized with md5=True
-            self.assertEqual(contents.read(), b'a' * 30)
-            self.assertEqual(contents.get_md5sum(), md5(b'a' * 30).hexdigest())
 
     @mock.patch('swiftclient.service.time', return_value=1400000000)
     def test_upload_object_job_stream(self, time_mock):

From e684913489e84a1e70a9ffa4149dd6e94da71db9 Mon Sep 17 00:00:00 2001
From: Kota Tsuyuzaki <tsuyuzaki.kota@lab.ntt.co.jp>
Date: Thu, 16 Mar 2017 22:26:29 -0700
Subject: [PATCH 058/316] Don't recommend to overwrite imported `session`
 variable

Change-Id: I34e25e674aac3a85a4702779053d95962b292281
---
 doc/source/client-api.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/source/client-api.rst b/doc/source/client-api.rst
index 57f49cb2..db93b599 100644
--- a/doc/source/client-api.rst
+++ b/doc/source/client-api.rst
@@ -35,10 +35,10 @@ Keystone Session
                        project_domain_name='Default')
 
     # Create session
-    session = session.Session(auth=auth)
+    keystone_session = session.Session(auth=auth)
 
     # Create swiftclient Connection
-    swift_conn = Connection(session=session)
+    swift_conn = Connection(session=keystone_session)
 
 Keystone v3
 ~~~~~~~~~~~

From b404df9abad6d2c4611adee17fd9c33599cd6903 Mon Sep 17 00:00:00 2001
From: Nelson Marcos <nelsonmarcos@gmail.com>
Date: Mon, 27 Mar 2017 16:23:16 -0300
Subject: [PATCH 059/316] Removing duplicated doc from client-api

Change-Id: I1a9ef0c33c68a32808686194c74c27d66d2617e0
---
 doc/source/client-api.rst | 20 --------------------
 1 file changed, 20 deletions(-)

diff --git a/doc/source/client-api.rst b/doc/source/client-api.rst
index db93b599..b9936427 100644
--- a/doc/source/client-api.rst
+++ b/doc/source/client-api.rst
@@ -63,26 +63,6 @@ Keystone v3
         auth_version=_auth_version
     )
 
-.. code-block:: python
-
-    _authurl = 'http://127.0.0.1:5000/v3/'
-    _auth_version = '3'
-    _user = 'tester'
-    _key = 'testing'
-    _os_options = {
-        'user_domain_id': 'Default',
-        'project_domain_id': 'Default',
-        'project_id': 'Default'
-    }
-
-    conn = Connection(
-        authurl=_authurl,
-        user=_user,
-        key=_key,
-        os_options=_os_options,
-        auth_version=_auth_version
-    )
-
 Keystone v2
 ~~~~~~~~~~~
 

From 2710ff255b5d3954eebdf469587bf73bbfd48431 Mon Sep 17 00:00:00 2001
From: liuyamin <liuyamin@fiberhome.com>
Date: Tue, 28 Mar 2017 16:50:55 +0800
Subject: [PATCH 060/316] Fix some reST field lists in docstrings

Probably the most common format for documenting arguments is
reST field lists [1]. This change updates some docstrings to
comply with the field lists syntax.

[1] http://sphinx-doc.org/domains.html#info-field-lists

Change-Id: Ic011fd3e3a8c5bafa24a3438a6ed5bb126b50e95
---
 swiftclient/service.py | 20 ++++++++++----------
 swiftclient/utils.py   |  2 +-
 2 files changed, 11 insertions(+), 11 deletions(-)

diff --git a/swiftclient/service.py b/swiftclient/service.py
index b2b00c65..ce0c4fc6 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -473,7 +473,7 @@ def stat(self, container=None, objects=None, options=None):
                   or container, or an iterator for returning the results of the
                   stat operations on a list of objects.
 
-        :raises: SwiftError
+        :raises SwiftError:
         """
         if options is not None:
             options = dict(self._options, **options)
@@ -637,7 +637,7 @@ def post(self, container=None, objects=None, options=None):
                   container/account, or an iterator for returning the results
                   of posts to a list of objects.
 
-        :raises: SwiftError
+        :raises SwiftError:
         """
         if options is not None:
             options = dict(self._options, **options)
@@ -1031,8 +1031,8 @@ def download(self, container=None, objects=None, options=None):
                   'download_object' dictionary containing the results of an
                   individual file download.
 
-        :raises: ClientException
-        :raises: SwiftError
+        :raises ClientException:
+        :raises SwiftError:
         """
         if options is not None:
             options = dict(self._options, **options)
@@ -1396,8 +1396,8 @@ def upload(self, container, objects, options=None):
 
         :returns: A generator for returning the results of the uploads.
 
-        :raises: SwiftError
-        :raises: ClientException
+        :raises SwiftError:
+        :raises ClientException:
         """
         if options is not None:
             options = dict(self._options, **options)
@@ -2135,8 +2135,8 @@ def delete(self, container=None, objects=None, options=None):
                   'bulk_delete' dictionary containing the results of an
                   individual delete operation.
 
-        :raises: ClientException
-        :raises: SwiftError
+        :raises ClientException:
+        :raises SwiftError:
         """
         if options is not None:
             options = dict(self._options, **options)
@@ -2504,7 +2504,7 @@ def copy(self, container, objects, options=None):
         :returns: A generator returning the results of copying the given list
                   of objects.
 
-        :raises: SwiftError
+        :raises SwiftError:
         """
         if options is not None:
             options = dict(self._options, **options)
@@ -2646,7 +2646,7 @@ def capabilities(self, url=None, refresh_cache=False):
 
         :returns: A dictionary containing the capabilities of the cluster.
 
-        :raises: ClientException
+        :raises ClientException:
         """
         if not refresh_cache and url in self.capabilities_cache:
             return self.capabilities_cache[url]
diff --git a/swiftclient/utils.py b/swiftclient/utils.py
index 47856c21..08cd7b29 100644
--- a/swiftclient/utils.py
+++ b/swiftclient/utils.py
@@ -84,7 +84,7 @@ def generate_temp_url(path, seconds, key, method, absolute=False,
         absolute Unix time, otherwise seconds is interpreted as a relative time
         offset from current time.
     :param prefix: if True then a prefix-based temporary URL will be generated.
-    :raises: ValueError if seconds is not a whole number or path is not to
+    :raises ValueError: if seconds is not a whole number or path is not to
         an object.
     :return: the path portion of a temporary URL
     """

From 8e08931b9ffd872a2b5537149a5d3b9f3e9bb5d4 Mon Sep 17 00:00:00 2001
From: Christopher Bartz <bartz@dkrz.de>
Date: Fri, 20 Jan 2017 18:04:31 +0100
Subject: [PATCH 061/316] ISO 8601 timestamps for tempurl

Client-side implementation for ISO 8601 timestamp
support of tempurl middleware. Please see

https://review.openstack.org/#/c/422679/

Change-Id: I76da28b48948475ec1bae5258e0b39a316553fb7
---
 doc/manpages/swift.1     | 31 +++++++++++---
 doc/source/cli.rst       | 33 ++++++++++++---
 swiftclient/shell.py     | 68 ++++++++++++++++++++++++-------
 swiftclient/utils.py     | 73 ++++++++++++++++++++++++---------
 tests/unit/test_shell.py | 80 +++++++++++++++++++++++++++++++++---
 tests/unit/test_utils.py | 87 +++++++++++++++++++++++++++++++++++-----
 6 files changed, 310 insertions(+), 62 deletions(-)

diff --git a/doc/manpages/swift.1 b/doc/manpages/swift.1
index bbf5280a..1f288d65 100644
--- a/doc/manpages/swift.1
+++ b/doc/manpages/swift.1
@@ -130,14 +130,33 @@ programs, such as jq.
          capabilities \-\-json
 .RE
 
-\fBtempurl\fR [\fIcommand-option\fR] \fImethod\fR \fIseconds\fR \fIpath\fR \fIkey\fR
+\fBtempurl\fR [\fIcommand-option\fR] \fImethod\fR \fItime\fR \fIpath\fR \fIkey\fR
 .RS 4
 Generates a temporary URL allowing unauthenticated access to the Swift object
-at the given path, using the given HTTP method, for the given number of
-seconds, using the given TempURL key. With the optional \-\-prefix\-based option a
-prefix-based URL is generated. If optional \-\-absolute argument is
-provided, seconds is instead interpreted as a Unix timestamp at which the URL
-should expire. \fBExample\fR: tempurl GET $(date \-d "Jan 1 2016" +%s)
+at the given path, using the given HTTP method, for the given time,
+using the given TempURL key.
+
+The time can be specified either as an integer
+denoting the amount of seconds the temporary URL is valid, or as an ISO 8601
+timestamp in one of following formats:  Complete date: YYYY\-MM\-DD (eg 1997\-07\-16),
+complete date plus hours, minutes and seconds: YYYY\-MM\-DDThh:mm:ss
+(eg 1997\-07\-16T19:20:30) or complete date plus hours, minutes and seconds with
+UTC designator: YYYY\-MM\-DDThh:mm:ssZ (eg 1997\-07\-16T19:20:30Z). Be aware that
+if you do not use the latter format, the timestamp is generated using your locale
+timezone. If the first format is used, the time part used will equal to 00:00:00.
+
+With the \-\-prefix\-based option a
+prefix-based URL is generated.
+
+The option \-\-iso8601 provides ISO 8601 UTC timestamps
+instead of Unix timestamps inside the generated URL.
+
+If optional \-\-absolute argument is
+provided and the time argument is specified in seconds, the seconds are
+interpreted as a Unix timestamp at which the URL
+should expire.
+
+\fBExample\fR: tempurl GET $(date \-d "Jan 1 2016" +%s)
 /v1/AUTH_foo/bar_container/quux.md my_secret_tempurl_key \-\-absolute
 
 .RE
diff --git a/doc/source/cli.rst b/doc/source/cli.rst
index b107448c..8d80d1b4 100644
--- a/doc/source/cli.rst
+++ b/doc/source/cli.rst
@@ -228,18 +228,39 @@ Capabilities
 Tempurl
 -------
 
-    ``tempurl [command-options] [method] [seconds] [path] [key]``
+    ``tempurl [command-options] [method] [time] [path] [key]``
 
        Generates a temporary URL for a Swift object. ``method`` option sets an HTTP method to
-       allow for this temporary URL that is usually 'GET' or 'PUT'. ``seconds`` option sets
-       the amount of time in seconds the temporary URL will be valid for; or, if ``--absolute``
-       is passed, the Unix timestamp when the temporary URL will expire. ``path`` option sets
-       the full path to the Swift object. Example: ``/v1/AUTH_account/c/o``. ``key`` option is
+       allow for this temporary URL that is usually ``GET` or ``PUT``. ``time`` option sets
+       the amount of time the temporary URL will be valid for.
+       ``time`` can be specified as an integer, denoting the number of seconds
+       from now on until the URL shall be valid; or, if ``--absolute``
+       is passed, the Unix timestamp when the temporary URL will expire.
+       But beyond that, ``time`` can also be specified as an ISO 8601 timestamp
+       in one of following formats:
+
+        i) Complete date: YYYY-MM-DD (eg 1997-07-16)
+
+        ii) Complete date plus hours, minutes and seconds:
+           YYYY-MM-DDThh:mm:ss
+         (eg 1997-07-16T19:20:30)
+
+        iii) Complete date plus hours, minutes and seconds with UTC designator:
+            YYYY-MM-DDThh:mm:ssZ
+         (eg 1997-07-16T19:20:30Z)
+
+       Please be aware that if you don't provide the UTC designator (i.e., Z)
+       the timestamp is generated using your local timezone. If only a date is
+       specified, the time part used will equal to ``00:00:00``.
+
+       ``path`` option sets the full path to the Swift object.
+       Example: ``/v1/AUTH_account/c/o``. ``key`` option is
        the secret temporary URL key set on the Swift cluster. To set a key, run
        ``swift post -m "Temp-URL-Key: <your secret key>"``. To generate a prefix-based temporary
        URL use the ``--prefix-based`` option. This URL will contain the path to the prefix. Do not
        forget to append the desired objectname at the end of the path portion (and before the
-       query portion) before sharing the URL.
+       query portion) before sharing the URL. It is possible to use ISO 8601 UTC timestamps within the
+       URL by using the ``--iso8601`` option.
 
 Auth
 ----
diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 4a8a3561..841ed6e5 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -1224,8 +1224,8 @@ def st_auth(parser, args, thread_manager):
         print('export OS_AUTH_TOKEN=%s' % sh_quote(token))
 
 
-st_tempurl_options = '''[--absolute] [--prefix-based]
-                     <method> <seconds> <path> <key>'''
+st_tempurl_options = '''[--absolute] [--prefix-based] [--iso8601]
+                     <method> <time> <path> <key>'''
 
 
 st_tempurl_help = '''
@@ -1234,9 +1234,35 @@ def st_auth(parser, args, thread_manager):
 Positional arguments:
   <method>              An HTTP method to allow for this temporary URL.
                         Usually 'GET' or 'PUT'.
-  <seconds>             The amount of time in seconds the temporary URL will be
-                        valid for; or, if --absolute is passed, the Unix
-                        timestamp when the temporary URL will expire.
+  <time>                The amount of time the temporary URL will be
+                        valid. The time can be specified in two ways:
+                        an integer representing the time in seconds or an
+                        ISO 8601 timestamp in a specific format.
+                        If --absolute is passed and time
+                        is an integer, the seconds are intepreted as the Unix
+                        timestamp when the temporary URL will expire. The ISO
+                        8601 timestamp can be specified in one of following
+                        formats:
+
+                        i) Complete date: YYYY-MM-DD (eg 1997-07-16)
+
+                        ii) Complete date plus hours, minutes and seconds:
+
+                            YYYY-MM-DDThh:mm:ss
+
+                           (eg 1997-07-16T19:20:30)
+
+                        iii) Complete date plus hours, minutes and seconds with
+                             UTC designator:
+
+                             YYYY-MM-DDThh:mm:ssZ
+
+                             (eg 1997-07-16T19:20:30Z)
+
+                        Please be aware that if you don't provide the UTC
+                        designator (i.e., Z) the timestamp is generated using
+                        your local timezone. If only a date is specified,
+                        the time part used will equal to 00:00:00.
   <path>                The full path or storage URL to the Swift object.
                         Example: /v1/AUTH_account/c/o
                         or: http://saio:8080/v1/AUTH_account/c/o
@@ -1245,10 +1271,14 @@ def st_auth(parser, args, thread_manager):
                         "Temp-URL-Key:b3968d0207b54ece87cccc06515a89d4"\'
 
 Optional arguments:
-  --absolute            Interpret the <seconds> positional argument as a Unix
+  --absolute            Interpret the <time> positional argument as a Unix
                         timestamp rather than a number of seconds in the
-                        future.
-  --prefix-based	If present, a prefix-based tempURL will be generated.
+                        future. If an ISO 8601 timestamp is passed for <time>,
+                        this argument is ignored.
+  --prefix-based        If present, a prefix-based temporary URL will be
+                        generated.
+  --iso8601             If present, the generated temporary URL will contain an
+                        ISO 8601 UTC timestamp instead of a Unix timestamp.
 '''.strip('\n')
 
 
@@ -1256,14 +1286,21 @@ def st_tempurl(parser, args, thread_manager):
     parser.add_argument(
         '--absolute', action='store_true',
         dest='absolute_expiry', default=False,
-        help=("If present, seconds argument will be interpreted as a Unix "
-              "timestamp representing when the tempURL should expire, rather "
-              "than an offset from the current time"),
+        help=("If present, and time argument is an integer, "
+              "time argument will be interpreted as a Unix "
+              "timestamp representing when the temporary URL should expire, "
+              "rather than an offset from the current time."),
     )
     parser.add_argument(
         '--prefix-based', action='store_true',
         default=False,
-        help=("If present, a prefix-based tempURL will be generated."),
+        help=("If present, a prefix-based temporary URL will be generated."),
+    )
+    parser.add_argument(
+        '--iso8601', action='store_true',
+        default=False,
+        help=("If present, the temporary URL will contain an ISO 8601 UTC "
+              "timestamp instead of a Unix timestamp."),
     )
 
     (options, args) = parse_args(parser, args)
@@ -1272,7 +1309,7 @@ def st_tempurl(parser, args, thread_manager):
         thread_manager.error('Usage: %s tempurl %s\n%s', BASENAME,
                              st_tempurl_options, st_tempurl_help)
         return
-    method, seconds, path, key = args[:4]
+    method, timestamp, path, key = args[:4]
 
     parsed = urlparse(path)
 
@@ -1281,9 +1318,10 @@ def st_tempurl(parser, args, thread_manager):
                                  'tempurl specified, possibly an error' %
                                  method.upper())
     try:
-        path = generate_temp_url(parsed.path, seconds, key, method,
+        path = generate_temp_url(parsed.path, timestamp, key, method,
                                  absolute=options['absolute_expiry'],
-                                 prefix=options['prefix_based'],)
+                                 iso8601=options['iso8601'],
+                                 prefix=options['prefix_based'])
     except ValueError as err:
         thread_manager.error(err)
         return
diff --git a/swiftclient/utils.py b/swiftclient/utils.py
index 08cd7b29..8afcde97 100644
--- a/swiftclient/utils.py
+++ b/swiftclient/utils.py
@@ -13,6 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 """Miscellaneous utility functions for use with Swift."""
+from calendar import timegm
 import collections
 import gzip
 import hashlib
@@ -25,6 +26,10 @@
 
 TRUE_VALUES = set(('true', '1', 'yes', 'on', 't', 'y'))
 EMPTY_ETAG = 'd41d8cd98f00b204e9800998ecf8427e'
+EXPIRES_ISO8601_FORMAT = '%Y-%m-%dT%H:%M:%SZ'
+SHORT_EXPIRES_ISO8601_FORMAT = '%Y-%m-%d'
+TIME_ERRMSG = ('time must either be a whole number or in specific '
+               'ISO 8601 format.')
 
 
 def config_true_value(value):
@@ -64,39 +69,65 @@ def prt_bytes(num_bytes, human_flag):
 
 
 def generate_temp_url(path, seconds, key, method, absolute=False,
-                      prefix=False):
+                      prefix=False, iso8601=False):
     """Generates a temporary URL that gives unauthenticated access to the
     Swift object.
 
     :param path: The full path to the Swift object or prefix if
          a prefix-based temporary URL should be generated. Example:
         /v1/AUTH_account/c/o or /v1/AUTH_account/c/prefix.
-    :param seconds: If absolute is False then this specifies the amount of time
-        in seconds for which the temporary URL will be valid. If absolute is
-        True then this specifies an absolute time at which the temporary URL
-        will expire.
+    :param seconds: time in seconds or ISO 8601 timestamp.
+        If absolute is False and this is the string representation of an
+        integer, then this specifies the amount of time in seconds for which
+        the temporary URL will be valid.
+        If absolute is True then this specifies an absolute time at which the
+        temporary URL will expire.
     :param key: The secret temporary URL key set on the Swift
         cluster. To set a key, run 'swift post -m
         "Temp-URL-Key: <substitute tempurl key here>"'
     :param method: A HTTP method, typically either GET or PUT, to allow
         for this temporary URL.
-    :param absolute: if True then the seconds parameter is interpreted as an
-        absolute Unix time, otherwise seconds is interpreted as a relative time
-        offset from current time.
+    :param absolute: if True then the seconds parameter is interpreted as a
+        Unix timestamp, if seconds represents an integer.
     :param prefix: if True then a prefix-based temporary URL will be generated.
-    :raises ValueError: if seconds is not a whole number or path is not to
-        an object.
+    :param iso8601: if True, a URL containing an ISO 8601 UTC timestamp
+        instead of a UNIX timestamp will be created.
+    :raises ValueError: if timestamp or path is not in valid format.
     :return: the path portion of a temporary URL
     """
     try:
-        seconds = float(seconds)
-        if not seconds.is_integer():
-            raise ValueError()
-        seconds = int(seconds)
-        if seconds < 0:
-            raise ValueError()
+        try:
+            timestamp = float(seconds)
+        except ValueError:
+            formats = (
+                EXPIRES_ISO8601_FORMAT,
+                EXPIRES_ISO8601_FORMAT[:-1],
+                SHORT_EXPIRES_ISO8601_FORMAT)
+            for f in formats:
+                try:
+                    t = time.strptime(seconds, f)
+                except ValueError:
+                    t = None
+                else:
+                    if f == EXPIRES_ISO8601_FORMAT:
+                        timestamp = timegm(t)
+                    else:
+                        # Use local time if UTC designator is missing.
+                        timestamp = int(time.mktime(t))
+
+                    absolute = True
+                    break
+
+            if t is None:
+                raise ValueError()
+        else:
+            if not timestamp.is_integer():
+                raise ValueError()
+            timestamp = int(timestamp)
+            if timestamp < 0:
+                raise ValueError()
     except ValueError:
-        raise ValueError('seconds must be a whole number')
+        raise ValueError(TIME_ERRMSG)
 
     if isinstance(path, six.binary_type):
         try:
@@ -121,9 +152,9 @@ def generate_temp_url(path, seconds, key, method, absolute=False,
                        'possibly an error', method.upper())
 
     if not absolute:
-        expiration = int(time.time() + seconds)
+        expiration = int(time.time() + timestamp)
     else:
-        expiration = seconds
+        expiration = timestamp
     hmac_body = u'\n'.join([method.upper(), str(expiration),
                             ('prefix:' if prefix else '') + path_for_body])
 
@@ -132,6 +163,10 @@ def generate_temp_url(path, seconds, key, method, absolute=False,
         key = key.encode('utf-8')
     sig = hmac.new(key, hmac_body.encode('utf-8'), hashlib.sha1).hexdigest()
 
+    if iso8601:
+        expiration = time.strftime(
+            EXPIRES_ISO8601_FORMAT, time.gmtime(expiration))
+
     temp_url = u'{path}?temp_url_sig={sig}&temp_url_expires={exp}'.format(
         path=path_for_body, sig=sig, exp=expiration)
     if prefix:
diff --git a/tests/unit/test_shell.py b/tests/unit/test_shell.py
index f7e9c1ab..2fe0139d 100644
--- a/tests/unit/test_shell.py
+++ b/tests/unit/test_shell.py
@@ -23,6 +23,7 @@
 import tempfile
 import unittest
 import textwrap
+from time import localtime, mktime, strftime, strptime
 
 from requests.packages.urllib3.exceptions import InsecureRequestWarning
 import six
@@ -36,7 +37,9 @@
 from .utils import (
     CaptureOutput, fake_get_auth_keystone, _make_fake_import_keystone_client,
     FakeKeystone, StubResponse, MockHttpTest)
-from swiftclient.utils import EMPTY_ETAG
+from swiftclient.utils import (
+    EMPTY_ETAG, EXPIRES_ISO8601_FORMAT,
+    SHORT_EXPIRES_ISO8601_FORMAT, TIME_ERRMSG)
 
 
 if six.PY2:
@@ -1550,7 +1553,7 @@ def test_temp_url(self, temp_url):
         swiftclient.shell.main(argv)
         temp_url.assert_called_with(
             '/v1/AUTH_account/c/o', "60", 'secret_key', 'GET', absolute=False,
-            prefix=False)
+            iso8601=False, prefix=False)
 
     @mock.patch('swiftclient.shell.generate_temp_url', return_value='')
     def test_temp_url_prefix_based(self, temp_url):
@@ -1559,7 +1562,28 @@ def test_temp_url_prefix_based(self, temp_url):
         swiftclient.shell.main(argv)
         temp_url.assert_called_with(
             '/v1/AUTH_account/c/', "60", 'secret_key', 'GET', absolute=False,
-            prefix=True)
+            iso8601=False, prefix=True)
+
+    @mock.patch('swiftclient.shell.generate_temp_url', return_value='')
+    def test_temp_url_iso8601_in(self, temp_url):
+        dates = ('1970-01-01T00:01:00Z', '1970-01-01T00:01:00',
+                 '1970-01-01')
+        for d in dates:
+            argv = ["", "tempurl", "GET", d, "/v1/AUTH_account/c/",
+                    "secret_key"]
+            swiftclient.shell.main(argv)
+            temp_url.assert_called_with(
+                '/v1/AUTH_account/c/', d, 'secret_key', 'GET', absolute=False,
+                iso8601=False, prefix=False)
+
+    @mock.patch('swiftclient.shell.generate_temp_url', return_value='')
+    def test_temp_url_iso8601_out(self, temp_url):
+        argv = ["", "tempurl", "GET", "60", "/v1/AUTH_account/c/",
+                "secret_key", "--iso8601"]
+        swiftclient.shell.main(argv)
+        temp_url.assert_called_with(
+            '/v1/AUTH_account/c/', "60", 'secret_key', 'GET', absolute=False,
+            iso8601=True, prefix=False)
 
     @mock.patch('swiftclient.shell.generate_temp_url', return_value='')
     def test_absolute_expiry_temp_url(self, temp_url):
@@ -1568,7 +1592,7 @@ def test_absolute_expiry_temp_url(self, temp_url):
         swiftclient.shell.main(argv)
         temp_url.assert_called_with(
             '/v1/AUTH_account/c/o', "60", 'secret_key', 'GET', absolute=True,
-            prefix=False)
+            iso8601=False, prefix=False)
 
     def test_temp_url_output(self):
         argv = ["", "tempurl", "GET", "60", "/v1/a/c/o",
@@ -1595,6 +1619,42 @@ def test_temp_url_output(self):
                     "&temp_url_prefix=\n" % sig)
         self.assertEqual(expected, output.out)
 
+        argv = ["", "tempurl", "GET", "60", "/v1/a/c/",
+                "secret_key", "--absolute", "--prefix", '--iso8601']
+        with CaptureOutput(suppress_systemexit=True) as output:
+            swiftclient.shell.main(argv)
+        sig = '00008c4be1573ba74fc2ab9bce02e3a93d04b349'
+        expires = '1970-01-01T00:01:00Z'
+        expected = ("/v1/a/c/?temp_url_sig=%s&temp_url_expires=%s"
+                    "&temp_url_prefix=\n" % (sig, expires))
+        self.assertEqual(expected, output.out)
+
+        dates = ("1970-01-01T00:01:00Z",
+                 strftime(EXPIRES_ISO8601_FORMAT[:-1], localtime(60)))
+        for d in dates:
+            argv = ["", "tempurl", "GET", d, "/v1/a/c/o",
+                    "secret_key"]
+            with CaptureOutput(suppress_systemexit=True) as output:
+                swiftclient.shell.main(argv)
+            sig = "63bc77a473a1c2ce956548cacf916f292eb9eac3"
+            expected = "/v1/a/c/o?temp_url_sig=%s&temp_url_expires=60\n" % sig
+            self.assertEqual(expected, output.out)
+
+        ts = str(int(
+            mktime(strptime('2005-05-01', SHORT_EXPIRES_ISO8601_FORMAT))))
+
+        argv = ["", "tempurl", "GET", ts, "/v1/a/c/",
+                "secret_key", "--absolute"]
+        with CaptureOutput(suppress_systemexit=True) as output:
+            swiftclient.shell.main(argv)
+            expected = output.out
+
+        argv = ["", "tempurl", "GET", '2005-05-01', "/v1/a/c/",
+                "secret_key", "--absolute"]
+        with CaptureOutput(suppress_systemexit=True) as output:
+            swiftclient.shell.main(argv)
+            self.assertEqual(expected, output.out)
+
     def test_temp_url_error_output(self):
         expected = 'path must be full path to an object e.g. /v1/a/c/o\n'
         for bad_path in ('/v1/a/c', 'v1/a/c/o', '/v1/a/c/', '/v1/a//o',
@@ -1614,7 +1674,17 @@ def test_temp_url_error_output(self):
                 swiftclient.shell.main(argv)
         self.assertEqual(expected, output.err,
                          'Expected %r but got %r for path %r' %
-                         (expected, output.err, bad_path))
+                         (expected, output.err, '/v1/a/c'))
+
+        expected = TIME_ERRMSG + '\n'
+        for bad_time in ('not_an_int', '-1', '2015-05', '2015-05-01T01:00'):
+            argv = ["", "tempurl", "GET", bad_time, '/v1/a/c/o',
+                        "secret_key", "--absolute"]
+            with CaptureOutput(suppress_systemexit=True) as output:
+                    swiftclient.shell.main(argv)
+            self.assertEqual(expected, output.err,
+                             'Expected %r but got %r for time %r' %
+                             (expected, output.err, bad_time))
 
     @mock.patch('swiftclient.service.Connection')
     def test_capabilities(self, connection):
diff --git a/tests/unit/test_utils.py b/tests/unit/test_utils.py
index c5961e87..adead005 100644
--- a/tests/unit/test_utils.py
+++ b/tests/unit/test_utils.py
@@ -18,6 +18,7 @@
 import mock
 import six
 import tempfile
+from time import gmtime, localtime, mktime, strftime, strptime
 from hashlib import md5, sha1
 
 from swiftclient import utils as u
@@ -150,6 +151,67 @@ def test_generate_temp_url(self, time_mock, hmac_mock):
         ])
         self.assertIsInstance(url, type(self.url))
 
+    @mock.patch('hmac.HMAC')
+    def test_generate_temp_url_iso8601_argument(self, hmac_mock):
+        hmac_mock().hexdigest.return_value = 'temp_url_signature'
+        url = u.generate_temp_url(self.url, '2014-05-13T17:53:20Z',
+                                  self.key, self.method)
+        self.assertEqual(url, self.expected_url)
+
+        # Don't care about absolute arg.
+        url = u.generate_temp_url(self.url, '2014-05-13T17:53:20Z',
+                                  self.key, self.method, absolute=True)
+        self.assertEqual(url, self.expected_url)
+
+        lt = localtime()
+        expires = strftime(u.EXPIRES_ISO8601_FORMAT[:-1], lt)
+
+        if not isinstance(self.expected_url, six.string_types):
+            expected_url = self.expected_url.replace(
+                b'1400003600', bytes(str(int(mktime(lt))), encoding='ascii'))
+        else:
+            expected_url = self.expected_url.replace(
+                '1400003600', str(int(mktime(lt))))
+        url = u.generate_temp_url(self.url, expires,
+                                  self.key, self.method)
+        self.assertEqual(url, expected_url)
+
+        expires = strftime(u.SHORT_EXPIRES_ISO8601_FORMAT, lt)
+        lt = strptime(expires, u.SHORT_EXPIRES_ISO8601_FORMAT)
+
+        if not isinstance(self.expected_url, six.string_types):
+            expected_url = self.expected_url.replace(
+                b'1400003600', bytes(str(int(mktime(lt))), encoding='ascii'))
+        else:
+            expected_url = self.expected_url.replace(
+                '1400003600', str(int(mktime(lt))))
+        url = u.generate_temp_url(self.url, expires,
+                                  self.key, self.method)
+        self.assertEqual(url, expected_url)
+
+    @mock.patch('hmac.HMAC')
+    @mock.patch('time.time', return_value=1400000000)
+    def test_generate_temp_url_iso8601_output(self, time_mock, hmac_mock):
+        hmac_mock().hexdigest.return_value = 'temp_url_signature'
+        url = u.generate_temp_url(self.url, self.seconds,
+                                  self.key, self.method,
+                                  iso8601=True)
+        key = self.key
+        if not isinstance(key, six.binary_type):
+            key = key.encode('utf-8')
+
+        expires = strftime(u.EXPIRES_ISO8601_FORMAT, gmtime(1400003600))
+        if not isinstance(self.url, six.string_types):
+            self.assertTrue(url.endswith(bytes(expires, 'utf-8')))
+        else:
+            self.assertTrue(url.endswith(expires))
+        self.assertEqual(hmac_mock.mock_calls, [
+            mock.call(),
+            mock.call(key, self.expected_body, sha1),
+            mock.call().hexdigest(),
+        ])
+        self.assertIsInstance(url, type(self.url))
+
     @mock.patch('hmac.HMAC')
     @mock.patch('time.time', return_value=1400000000)
     def test_generate_temp_url_prefix(self, time_mock, hmac_mock):
@@ -198,31 +260,34 @@ def test_generate_absolute_expiry_temp_url(self, hmac_mock):
                                   absolute=True)
         self.assertEqual(url, expected_url)
 
-    def test_generate_temp_url_bad_seconds(self):
+    def test_generate_temp_url_bad_time(self):
         with self.assertRaises(ValueError) as exc_manager:
             u.generate_temp_url(self.url, 'not_an_int', self.key, self.method)
-        self.assertEqual(exc_manager.exception.args[0],
-                         'seconds must be a whole number')
+        self.assertEqual(exc_manager.exception.args[0], u.TIME_ERRMSG)
 
         with self.assertRaises(ValueError) as exc_manager:
             u.generate_temp_url(self.url, -1, self.key, self.method)
-        self.assertEqual(exc_manager.exception.args[0],
-                         'seconds must be a whole number')
+        self.assertEqual(exc_manager.exception.args[0], u.TIME_ERRMSG)
 
         with self.assertRaises(ValueError) as exc_manager:
             u.generate_temp_url(self.url, 1.1, self.key, self.method)
-        self.assertEqual(exc_manager.exception.args[0],
-                         'seconds must be a whole number')
+        self.assertEqual(exc_manager.exception.args[0], u.TIME_ERRMSG)
 
         with self.assertRaises(ValueError) as exc_manager:
             u.generate_temp_url(self.url, '-1', self.key, self.method)
-        self.assertEqual(exc_manager.exception.args[0],
-                         'seconds must be a whole number')
+        self.assertEqual(exc_manager.exception.args[0], u.TIME_ERRMSG)
 
         with self.assertRaises(ValueError) as exc_manager:
             u.generate_temp_url(self.url, '1.1', self.key, self.method)
-        self.assertEqual(exc_manager.exception.args[0],
-                         'seconds must be a whole number')
+        self.assertEqual(exc_manager.exception.args[0], u.TIME_ERRMSG)
+        with self.assertRaises(ValueError) as exc_manager:
+            u.generate_temp_url(self.url, '2015-05', self.key, self.method)
+        self.assertEqual(exc_manager.exception.args[0], u.TIME_ERRMSG)
+
+        with self.assertRaises(ValueError) as exc_manager:
+            u.generate_temp_url(
+                self.url, '2015-05-01T01:00', self.key, self.method)
+        self.assertEqual(exc_manager.exception.args[0], u.TIME_ERRMSG)
 
     def test_generate_temp_url_bad_path(self):
         with self.assertRaises(ValueError) as exc_manager:

From 058fb0323f9bc579a891ad48dcff80a7eda4f8ac Mon Sep 17 00:00:00 2001
From: M V P Nitesh <m.nitesh@nectechnologies.in>
Date: Mon, 10 Apr 2017 15:59:43 +0530
Subject: [PATCH 062/316] Optimize the link address

Use https instead of http to ensure the safety

Change-Id: I1e072bd3288f2de530ac22a4e99899f18f1ceaf3
---
 README.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/README.rst b/README.rst
index 688acfff..42ec2772 100644
--- a/README.rst
+++ b/README.rst
@@ -2,8 +2,8 @@
 Team and repository tags
 ========================
 
-.. image:: http://governance.openstack.org/badges/python-swiftclient.svg
-    :target: http://governance.openstack.org/reference/tags/index.html
+.. image:: https://governance.openstack.org/badges/python-swiftclient.svg
+    :target: https://governance.openstack.org/reference/tags/index.html
 
 .. Change things from this point on
 

From aaaed55cd46902612f1ba93ac3394cfd99679b00 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Mon, 10 Apr 2017 15:38:58 -0700
Subject: [PATCH 063/316] Stop sending X-Static-Large-Object headers

If we were to include this in a normal PUT, it would 400, but only if
slo is actually in the pipeline. If it's *not*, we'll create a normal
Swift object and the header sticks.

- This is really confusing for users; see the related bug.
- If slo is later enabled in the cluster, Swift starts responding 500
  with a KeyError because the client and on-disk formats don't match!

Change-Id: I1d80c76af02f2ca847123349224ddc36d2a6996b
Related-Change: I986c1656658f874172860469624118cc63bff9bc
Related-Bug: #1680083
---
 swiftclient/service.py   | 1 -
 tests/unit/test_shell.py | 1 -
 2 files changed, 2 deletions(-)

diff --git a/swiftclient/service.py b/swiftclient/service.py
index ce0c4fc6..b933d4b8 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -1983,7 +1983,6 @@ def _upload_object_job(self, conn, container, source, obj, options,
                         } for d in segment_results
                     ])
 
-                    put_headers['x-static-large-object'] = 'true'
                     mr = {}
                     conn.put_object(
                         container, obj, manifest_data,
diff --git a/tests/unit/test_shell.py b/tests/unit/test_shell.py
index f7e9c1ab..2b3736ce 100644
--- a/tests/unit/test_shell.py
+++ b/tests/unit/test_shell.py
@@ -714,7 +714,6 @@ def test_upload(self, connection, walk):
             mock.ANY,
             headers={
                 'x-object-meta-mtime': mock.ANY,
-                'x-static-large-object': 'true'
             },
             query_string='multipart-manifest=put',
             response_dict={})

From 0cc4d8af18157000d4d5d1205700d6494c5935ce Mon Sep 17 00:00:00 2001
From: John Dickinson <me@not.mn>
Date: Tue, 4 Apr 2017 15:20:30 -0700
Subject: [PATCH 064/316] respect bulk delete page size and fix logic error

Previously, using SwiftService to delete "many" objects would use
bulk delete if available, but it would not respect the bulk delete
page size. If the number of objects to delete exceeded the bulk delete
page size, SwiftService would ignore the error and nothing would be
deleted.

This patch changes _should_bulk_delete() to be _bulk_delete_page_size();
instead of returning a simple True/False, it returns the page size for
the bulk deleter, or 1 if objects should be deleted one at a time.
Delete SDK calls are then spread across multiple bulk DELETEs if the
requested number of objects to delete exceeds the returned page size.

Fixed the logic in _should_bulk_delete() so that if the object list
is exactly 2x the thread count, it will not bulk delete. This is the
natural conclusion following the logic that existed previously: if
the delete request can be satisfied by every worker thread doing one
or two tasks, don't bulk delete. But if it requires a worker thread
to do three or more tasks, do a bulk delete instead. Previously, the
logic would mean that if every worker thread did exactly two tasks, it
would bulk delete. This patch changes a "<" to a "<=".

Closes-Bug: 1679851
Change-Id: I3c18f89bac1170dc62187114ef06dbe721afcc2e
---
 swiftclient/service.py     |  42 ++++++++++----
 tests/unit/test_service.py |  34 +++++++++++
 tests/unit/test_shell.py   | 112 ++++++++++++++++++++++++++++++-------
 3 files changed, 156 insertions(+), 32 deletions(-)

diff --git a/swiftclient/service.py b/swiftclient/service.py
index ce0c4fc6..223641bd 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -43,7 +43,8 @@
 )
 from swiftclient.utils import (
     config_true_value, ReadableToIterable, LengthWrapper, EMPTY_ETAG,
-    parse_api_response, report_traceback, n_groups, split_request_headers
+    parse_api_response, report_traceback, n_groups, split_request_headers,
+    n_at_a_time
 )
 from swiftclient.exceptions import ClientException
 from swiftclient.multithreading import MultiThreadingManager
@@ -2151,11 +2152,15 @@ def delete(self, container=None, objects=None, options=None):
                 rq = Queue()
                 obj_dels = {}
 
-                if self._should_bulk_delete(objects):
-                    for obj_slice in n_groups(
-                            objects, self._options['object_dd_threads']):
-                        self._bulk_delete(container, obj_slice, options,
-                                          obj_dels)
+                bulk_page_size = self._bulk_delete_page_size(objects)
+                if bulk_page_size > 1:
+                    page_at_a_time = n_at_a_time(objects, bulk_page_size)
+                    for page_slice in page_at_a_time:
+                        for obj_slice in n_groups(
+                                page_slice,
+                                self._options['object_dd_threads']):
+                            self._bulk_delete(container, obj_slice, options,
+                                              obj_dels)
                 else:
                     self._per_item_delete(container, objects, options,
                                           obj_dels, rq)
@@ -2208,23 +2213,36 @@ def delete(self, container=None, objects=None, options=None):
                                     and not res['success']):
                                 cancelled = True
 
-    def _should_bulk_delete(self, objects):
-        if len(objects) < 2 * self._options['object_dd_threads']:
+    def _bulk_delete_page_size(self, objects):
+        '''
+        Given the iterable 'objects', will return how many items should be
+        deleted at a time.
+
+        :param objects: An iterable that supports 'len()'
+        :returns: The bulk delete page size (i.e. the max number of
+                  objects that can be bulk deleted at once, as reported by
+                  the cluster). If bulk delete is disabled, return 1
+        '''
+        if len(objects) <= 2 * self._options['object_dd_threads']:
             # Not many objects; may as well delete one-by-one
-            return False
+            return 1
 
         try:
             cap_result = self.capabilities()
             if not cap_result['success']:
                 # This shouldn't actually happen, but just in case we start
                 # being more nuanced about our capabilities result...
-                return False
+                return 1
         except ClientException:
             # Old swift, presumably; assume no bulk middleware
-            return False
+            return 1
 
         swift_info = cap_result['capabilities']
-        return 'bulk_delete' in swift_info
+        if 'bulk_delete' in swift_info:
+            return swift_info['bulk_delete'].get(
+                'max_deletes_per_request', 10000)
+        else:
+            return 1
 
     def _per_item_delete(self, container, objects, options, rdict, rq):
         for obj in objects:
diff --git a/tests/unit/test_service.py b/tests/unit/test_service.py
index 378b70b6..260f1cb9 100644
--- a/tests/unit/test_service.py
+++ b/tests/unit/test_service.py
@@ -474,6 +474,40 @@ def test_delete_empty_container_exception(self):
         self.assertLessEqual(r['error_timestamp'], after)
         self.assertIn('Traceback', r['traceback'])
 
+    @mock.patch.object(swiftclient.service.SwiftService, 'capabilities',
+                       lambda *a: {'action': 'capabilities',
+                                   'timestamp': time.time(),
+                                   'success': True,
+                                   'capabilities': {
+                                       'bulk_delete':
+                                       {'max_deletes_per_request': 10}}
+                                   })
+    def test_bulk_delete_page_size(self):
+        # make a list of 100 objects
+        obj_list = ['x%02d' % i for i in range(100)]
+        errors = []
+
+        # _bulk_delete_page_size uses 2x the number of threads to determine
+        # if if there are "many" object to delete or not
+
+        # format is: [(thread_count, expected result), ...]
+        obj_threads_exp = [
+            (10, 10),  # something small
+            (49, 10),  # just under the bounds
+            (50, 1),  # cutover point
+            (51, 1),  # just over bounds
+            (100, 1),  # something big
+        ]
+        for thread_count, exp in obj_threads_exp:
+            s = SwiftService(options={'object_dd_threads': thread_count})
+            res = s._bulk_delete_page_size(obj_list)
+            if res != exp:
+                msg = 'failed for thread_count %d: got %r expected %r' % \
+                    (thread_count, res, exp)
+                errors.append(msg)
+        if errors:
+            self.fail('_bulk_delete_page_size() failed\n' + '\n'.join(errors))
+
 
 class TestSwiftError(unittest.TestCase):
 
diff --git a/tests/unit/test_shell.py b/tests/unit/test_shell.py
index f7e9c1ab..481aedd2 100644
--- a/tests/unit/test_shell.py
+++ b/tests/unit/test_shell.py
@@ -903,8 +903,8 @@ def test_upload_segments_to_same_container(self, connection):
                      'x-object-meta-mtime': mock.ANY},
             response_dict={})
 
-    @mock.patch.object(swiftclient.service.SwiftService, '_should_bulk_delete',
-                       lambda *a: False)
+    @mock.patch.object(swiftclient.service.SwiftService,
+                       '_bulk_delete_page_size', lambda *a: 0)
     @mock.patch('swiftclient.service.Connection')
     def test_delete_bad_threads(self, mock_connection):
         mock_connection.return_value.get_container.return_value = (None, [])
@@ -934,8 +934,8 @@ def check_good(argv):
         check_good(["--object-threads", "1"])
         check_good(["--container-threads", "1"])
 
-    @mock.patch.object(swiftclient.service.SwiftService, '_should_bulk_delete',
-                       lambda *a: False)
+    @mock.patch.object(swiftclient.service.SwiftService,
+                       '_bulk_delete_page_size', lambda *a: 1)
     @mock.patch('swiftclient.service.Connection')
     def test_delete_account(self, connection):
         connection.return_value.get_account.side_effect = [
@@ -971,8 +971,8 @@ def test_delete_account(self, connection):
                 mock.call('container2', response_dict={}, headers={}),
                 mock.call('empty_container', response_dict={}, headers={})])
 
-    @mock.patch.object(swiftclient.service.SwiftService, '_should_bulk_delete',
-                       lambda *a: True)
+    @mock.patch.object(swiftclient.service.SwiftService,
+                       '_bulk_delete_page_size', lambda *a: 10)
     @mock.patch('swiftclient.service.Connection')
     def test_delete_bulk_account(self, connection):
         connection.return_value.get_account.side_effect = [
@@ -1085,8 +1085,80 @@ def test_delete_bulk_account_with_capabilities(self, connection):
         self.assertEqual(connection.return_value.get_capabilities.mock_calls,
                          [mock.call(None)])  # only one /info request
 
-    @mock.patch.object(swiftclient.service.SwiftService, '_should_bulk_delete',
-                       lambda *a: False)
+    @mock.patch('swiftclient.service.Connection')
+    def test_delete_bulk_account_with_capabilities_and_pages(self, connection):
+        connection.return_value.get_capabilities.return_value = {
+            'bulk_delete': {
+                'max_deletes_per_request': 2,
+                'max_failed_deletes': 1000,
+            },
+        }
+        connection.return_value.get_account.side_effect = [
+            [None, [{'name': 'container'}]],
+            [None, [{'name': 'container2'}]],
+            [None, [{'name': 'empty_container'}]],
+            [None, []],
+        ]
+        connection.return_value.get_container.side_effect = [
+            [None, [{'name': 'object'}, {'name': 'obj\xe9ct2'},
+                    {'name': 'z_object'}, {'name': 'z_obj\xe9ct2'}]],
+            [None, []],
+            [None, [{'name': 'object'}, {'name': 'obj\xe9ct2'},
+                    {'name': 'z_object'}, {'name': 'z_obj\xe9ct2'}]],
+            [None, []],
+            [None, []],
+        ]
+        connection.return_value.attempts = 0
+        argv = ["", "delete", "--all", "--object-threads", "1"]
+        connection.return_value.post_account.return_value = {}, (
+            b'{"Number Not Found": 0, "Response Status": "200 OK", '
+            b'"Errors": [], "Number Deleted": 1, "Response Body": ""}')
+        swiftclient.shell.main(argv)
+        # check that each bulk call was only called with 2 objects
+        self.assertEqual(
+            connection.return_value.post_account.mock_calls, [
+                mock.call(query_string='bulk-delete',
+                          data=b''.join([
+                              b'/container/object\n',
+                              b'/container/obj%C3%A9ct2\n',
+                          ]),
+                          headers={'Content-Type': 'text/plain',
+                                   'Accept': 'application/json'},
+                          response_dict={}),
+                mock.call(query_string='bulk-delete',
+                          data=b''.join([
+                              b'/container/z_object\n',
+                              b'/container/z_obj%C3%A9ct2\n'
+                          ]),
+                          headers={'Content-Type': 'text/plain',
+                                   'Accept': 'application/json'},
+                          response_dict={}),
+                mock.call(query_string='bulk-delete',
+                          data=b''.join([
+                              b'/container2/object\n',
+                              b'/container2/obj%C3%A9ct2\n',
+                          ]),
+                          headers={'Content-Type': 'text/plain',
+                                   'Accept': 'application/json'},
+                          response_dict={}),
+                mock.call(query_string='bulk-delete',
+                          data=b''.join([
+                              b'/container2/z_object\n',
+                              b'/container2/z_obj%C3%A9ct2\n'
+                          ]),
+                          headers={'Content-Type': 'text/plain',
+                                   'Accept': 'application/json'},
+                          response_dict={})])
+        self.assertEqual(
+            connection.return_value.delete_container.mock_calls, [
+                mock.call('container', response_dict={}, headers={}),
+                mock.call('container2', response_dict={}, headers={}),
+                mock.call('empty_container', response_dict={}, headers={})])
+        self.assertEqual(connection.return_value.get_capabilities.mock_calls,
+                         [mock.call(None)])  # only one /info request
+
+    @mock.patch.object(swiftclient.service.SwiftService,
+                       '_bulk_delete_page_size', lambda *a: 1)
     @mock.patch('swiftclient.service.Connection')
     def test_delete_container(self, connection):
         connection.return_value.get_container.side_effect = [
@@ -1103,8 +1175,8 @@ def test_delete_container(self, connection):
             'container', 'object', query_string=None, response_dict={},
             headers={})
 
-    @mock.patch.object(swiftclient.service.SwiftService, '_should_bulk_delete',
-                       lambda *a: False)
+    @mock.patch.object(swiftclient.service.SwiftService,
+                       '_bulk_delete_page_size', lambda *a: 1)
     @mock.patch('swiftclient.service.Connection')
     def test_delete_container_headers(self, connection):
         connection.return_value.get_container.side_effect = [
@@ -1122,8 +1194,8 @@ def test_delete_container_headers(self, connection):
             'container', 'object', query_string=None, response_dict={},
             headers={'Skip-Middleware': 'Test'})
 
-    @mock.patch.object(swiftclient.service.SwiftService, '_should_bulk_delete',
-                       lambda *a: True)
+    @mock.patch.object(swiftclient.service.SwiftService,
+                       '_bulk_delete_page_size', lambda *a: 10)
     @mock.patch('swiftclient.service.Connection')
     def test_delete_bulk_container(self, connection):
         connection.return_value.get_container.side_effect = [
@@ -1176,8 +1248,8 @@ def test_delete_verbose_output_utf8(self):
                 self.assertTrue(out.out.find(
                     't\u00e9st_c [after 2 attempts]') >= 0, out)
 
-    @mock.patch.object(swiftclient.service.SwiftService, '_should_bulk_delete',
-                       lambda *a: False)
+    @mock.patch.object(swiftclient.service.SwiftService,
+                       '_bulk_delete_page_size', lambda *a: 1)
     @mock.patch('swiftclient.service.Connection')
     def test_delete_per_object(self, connection):
         argv = ["", "delete", "container", "object"]
@@ -1188,8 +1260,8 @@ def test_delete_per_object(self, connection):
             'container', 'object', query_string=None, response_dict={},
             headers={})
 
-    @mock.patch.object(swiftclient.service.SwiftService, '_should_bulk_delete',
-                       lambda *a: True)
+    @mock.patch.object(swiftclient.service.SwiftService,
+                       '_bulk_delete_page_size', lambda *a: 10)
     @mock.patch('swiftclient.service.Connection')
     def test_delete_bulk_object(self, connection):
         argv = ["", "delete", "container", "object"]
@@ -2714,8 +2786,8 @@ def on_request(method, path, *args, **kwargs):
             return status
         return on_request
 
-    @mock.patch.object(swiftclient.service.SwiftService, '_should_bulk_delete',
-                       lambda *a: False)
+    @mock.patch.object(swiftclient.service.SwiftService,
+                       '_bulk_delete_page_size', lambda *a: 1)
     @mock.patch('swiftclient.service.Connection')
     def test_upload_bad_threads(self, mock_connection):
         mock_connection.return_value.put_object.return_value = EMPTY_ETAG
@@ -2897,8 +2969,8 @@ def test_upload_with_no_access(self):
         self.assertIn(expected_err, out.err)
         self.assertEqual('', out)
 
-    @mock.patch.object(swiftclient.service.SwiftService, '_should_bulk_delete',
-                       lambda *a: False)
+    @mock.patch.object(swiftclient.service.SwiftService,
+                       '_bulk_delete_page_size', lambda *a: 1)
     @mock.patch('swiftclient.service.Connection')
     def test_download_bad_threads(self, mock_connection):
         mock_connection.return_value.get_object.return_value = [{}, '']

From 64da481ccde9863b0b062cadb27402a5e18b876e Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Mon, 10 Apr 2017 18:09:53 -0700
Subject: [PATCH 065/316] Tolerate RFC-compliant ETags

Since time immemorial, Swift has returned unquoted ETags for plain-old
Swift objects -- I hear tell that we once tried to change this, but
quickly backed it out when some clients broke.

However, some proxies (such as nginx) apparently may force the ETag to
adhere to the RFC, which states [1]:

    An entity-tag consists of an opaque *quoted* string

(emphasis mine). See the related bug for an instance of this happening.

Since we can still get the original ETag easily, we should tolerate the
more-compliant format.

[1] https://tools.ietf.org/html/rfc2616.html#section-3.11 or, if you
    prefer the new ones, https://tools.ietf.org/html/rfc7232#section-2.3

Change-Id: I7cfacab3f250a9443af4b67111ef8088d37d9171
Closes-Bug: 1681529
Related-Bug: 1678976
---
 swiftclient/service.py     | 27 ++++++++++++++++++++-------
 tests/unit/test_service.py | 38 +++++++++++++++++++++++---------------
 2 files changed, 43 insertions(+), 22 deletions(-)

diff --git a/swiftclient/service.py b/swiftclient/service.py
index ce0c4fc6..c842d232 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -377,10 +377,23 @@ def __init__(self, path, body, headers, checksum=True):
         self._actual_read = 0
         self._content_length = None
         self._actual_md5 = None
-        self._expected_etag = headers.get('etag')
-
-        if ('x-object-manifest' not in headers
-                and 'x-static-large-object' not in headers and checksum):
+        self._expected_md5 = headers.get('etag', '')
+
+        if len(self._expected_md5) > 1 and self._expected_md5[0] == '"' \
+                and self._expected_md5[-1] == '"':
+            self._expected_md5 = self._expected_md5[1:-1]
+
+        # Some headers indicate the MD5 of the response
+        # definitely *won't* match the ETag
+        bad_md5_headers = set([
+            'x-object-manifest',
+            'x-static-large-object',
+        ])
+        if bad_md5_headers.intersection(headers):
+            # This isn't a useful checksum
+            self._expected_md5 = ''
+
+        if self._expected_md5 and checksum:
             self._actual_md5 = md5()
 
         if 'content-length' in headers:
@@ -398,12 +411,12 @@ def __iter__(self):
         self._check_contents()
 
     def _check_contents(self):
-        if self._actual_md5 and self._expected_etag:
+        if self._actual_md5 and self._expected_md5:
             etag = self._actual_md5.hexdigest()
-            if etag != self._expected_etag:
+            if etag != self._expected_md5:
                 raise SwiftError('Error downloading {0}: md5sum != etag, '
                                  '{1} != {2}'.format(
-                                     self._path, etag, self._expected_etag))
+                                     self._path, etag, self._expected_md5))
 
         if (self._content_length is not None
                 and self._actual_read != self._content_length):
diff --git a/tests/unit/test_service.py b/tests/unit/test_service.py
index 378b70b6..0db5b7a6 100644
--- a/tests/unit/test_service.py
+++ b/tests/unit/test_service.py
@@ -119,25 +119,26 @@ def test_create(self):
         self.assertEqual(sr._path, 'path')
         self.assertEqual(sr._body, 'body')
         self.assertIsNone(sr._content_length)
-        self.assertIsNone(sr._expected_etag)
+        self.assertFalse(sr._expected_md5)
 
-        self.assertIsNotNone(sr._actual_md5)
-        self.assertIs(type(sr._actual_md5), self.md5_type)
+        self.assertIsNone(sr._actual_md5)
 
     def test_create_with_large_object_headers(self):
         # md5 should not be initialized if large object headers are present
-        sr = self.sr('path', 'body', {'x-object-manifest': 'test'})
+        sr = self.sr('path', 'body', {'x-object-manifest': 'test',
+                                      'etag': '"%s"' % ('0' * 32)})
         self.assertEqual(sr._path, 'path')
         self.assertEqual(sr._body, 'body')
         self.assertIsNone(sr._content_length)
-        self.assertIsNone(sr._expected_etag)
+        self.assertFalse(sr._expected_md5)
         self.assertIsNone(sr._actual_md5)
 
-        sr = self.sr('path', 'body', {'x-static-large-object': 'test'})
+        sr = self.sr('path', 'body', {'x-static-large-object': 'test',
+                                      'etag': '"%s"' % ('0' * 32)})
         self.assertEqual(sr._path, 'path')
         self.assertEqual(sr._body, 'body')
         self.assertIsNone(sr._content_length)
-        self.assertIsNone(sr._expected_etag)
+        self.assertFalse(sr._expected_md5)
         self.assertIsNone(sr._actual_md5)
 
     def test_create_with_ignore_checksum(self):
@@ -146,7 +147,7 @@ def test_create_with_ignore_checksum(self):
         self.assertEqual(sr._path, 'path')
         self.assertEqual(sr._body, 'body')
         self.assertIsNone(sr._content_length)
-        self.assertIsNone(sr._expected_etag)
+        self.assertFalse(sr._expected_md5)
         self.assertIsNone(sr._actual_md5)
 
     def test_create_with_content_length(self):
@@ -155,10 +156,9 @@ def test_create_with_content_length(self):
         self.assertEqual(sr._path, 'path')
         self.assertEqual(sr._body, 'body')
         self.assertEqual(sr._content_length, 5)
-        self.assertIsNone(sr._expected_etag)
+        self.assertFalse(sr._expected_md5)
 
-        self.assertIsNotNone(sr._actual_md5)
-        self.assertIs(type(sr._actual_md5), self.md5_type)
+        self.assertIsNone(sr._actual_md5)
 
         # Check Contentlength raises error if it isn't an integer
         self.assertRaises(SwiftError, self.sr, 'path', 'body',
@@ -175,11 +175,17 @@ def _consume(sr):
         # Check error is raised if expected etag doesn't match calculated md5.
         # md5 for a SwiftReader that has done nothing is
         # d41d8cd98f00b204e9800998ecf8427e  i.e md5 of nothing
-        sr = self.sr('path', BytesIO(b'body'), {'etag': 'doesntmatch'})
+        sr = self.sr('path', BytesIO(b'body'),
+                     {'etag': md5(b'doesntmatch').hexdigest()})
         self.assertRaises(SwiftError, _consume, sr)
 
         sr = self.sr('path', BytesIO(b'body'),
-                     {'etag': '841a2d689ad86bd1611447453c22c6fc'})
+                     {'etag': md5(b'body').hexdigest()})
+        _consume(sr)
+
+        # Should still work if etag was quoted
+        sr = self.sr('path', BytesIO(b'body'),
+                     {'etag': '"%s"' % md5(b'body').hexdigest()})
         _consume(sr)
 
         # Check error is raised if SwiftReader doesn't read the same length
@@ -191,11 +197,13 @@ def _consume(sr):
         _consume(sr)
 
         # Check that the iterator generates expected length and etag values
-        sr = self.sr('path', ['abc'.encode()] * 3, {})
+        sr = self.sr('path', ['abc'.encode()] * 3,
+                     {'content-length': 9,
+                      'etag': md5('abc'.encode() * 3).hexdigest()})
         _consume(sr)
         self.assertEqual(sr._actual_read, 9)
         self.assertEqual(sr._actual_md5.hexdigest(),
-                         '97ac82a5b825239e782d0339e2d7b910')
+                         md5('abc'.encode() * 3).hexdigest())
 
 
 class _TestServiceBase(unittest.TestCase):

From 527f2ff687faa120659cfefd82b8db26ddbfeafa Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Mon, 10 Apr 2017 18:51:45 -0700
Subject: [PATCH 066/316] Skip checksum validation on partial downloads

If we get back some partial content, we can't validate the MD5.
That's OK.

Change-Id: Ic1d65272190af0d3d982f3cd06833cac5c791a1e
Closes-Bug: 1642021
---
 swiftclient/service.py     |  1 +
 tests/unit/test_service.py | 10 ++++++++++
 2 files changed, 11 insertions(+)

diff --git a/swiftclient/service.py b/swiftclient/service.py
index c842d232..c5f815f6 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -386,6 +386,7 @@ def __init__(self, path, body, headers, checksum=True):
         # Some headers indicate the MD5 of the response
         # definitely *won't* match the ETag
         bad_md5_headers = set([
+            'content-range',
             'x-object-manifest',
             'x-static-large-object',
         ])
diff --git a/tests/unit/test_service.py b/tests/unit/test_service.py
index 0db5b7a6..af32d84c 100644
--- a/tests/unit/test_service.py
+++ b/tests/unit/test_service.py
@@ -141,6 +141,16 @@ def test_create_with_large_object_headers(self):
         self.assertFalse(sr._expected_md5)
         self.assertIsNone(sr._actual_md5)
 
+    def test_create_with_content_range_header(self):
+        # md5 should not be initialized if large object headers are present
+        sr = self.sr('path', 'body', {'content-range': 'bytes 0-3/10',
+                                      'etag': '"%s"' % ('0' * 32)})
+        self.assertEqual(sr._path, 'path')
+        self.assertEqual(sr._body, 'body')
+        self.assertIsNone(sr._content_length)
+        self.assertFalse(sr._expected_md5)
+        self.assertIsNone(sr._actual_md5)
+
     def test_create_with_ignore_checksum(self):
         # md5 should not be initialized if checksum is False
         sr = self.sr('path', 'body', {}, False)

From b27127fd09629568d51570b721e515331a65f6e6 Mon Sep 17 00:00:00 2001
From: lingyongxu <lyxu@fiberhome.com>
Date: Wed, 7 Jun 2017 17:42:16 +0800
Subject: [PATCH 067/316] Drop py34 target in tox.ini

We support py35 now.so it is no need to keep
the supoort for py34.

Change-Id: Ie76e897bea3c184410e2b151fbe978d93bc21624
---
 setup.cfg | 1 -
 tox.ini   | 2 +-
 2 files changed, 1 insertion(+), 2 deletions(-)

diff --git a/setup.cfg b/setup.cfg
index 4af3151e..2b15aef0 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -17,7 +17,6 @@ classifier =
     Programming Language :: Python :: 2
     Programming Language :: Python :: 2.7
     Programming Language :: Python :: 3
-    Programming Language :: Python :: 3.4
     Programming Language :: Python :: 3.5
 
 [global]
diff --git a/tox.ini b/tox.ini
index df01bf8a..c1c69ae9 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,5 +1,5 @@
 [tox]
-envlist = py27,py34,py35,pypy,pep8
+envlist = py27,py35,pypy,pep8
 minversion = 2.0
 skipsdist = True
 

From 2ff3102cf779a507af8fa39296154a17a60f540a Mon Sep 17 00:00:00 2001
From: Christian Schwede <cschwede@redhat.com>
Date: Tue, 13 Jun 2017 10:51:33 +0200
Subject: [PATCH 068/316] Add support for versionless endpoints

Newer deployments are using versionless Keystone endpoints, and most
OpenStack clients already support this.

This patch enables this for Swift: if an auth_url without any path
component is found, it assumes a versionless endpoint will be used.
In this case the v3 suffix will be appended to the path if none
auth_version is set, and v2.0 is appended if auth_version requires v2.

Closes-Bug: 1554885
Related-Bug: 1691106
Change-Id: If7ecb67776cb77828f93ad8278cc5040015216b7
---
 swiftclient/client.py          | 17 +++++++++++++++--
 tests/unit/test_swiftclient.py | 20 ++++++++++++++++++++
 2 files changed, 35 insertions(+), 2 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index 80b6eda2..54d2c80f 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -25,7 +25,7 @@
 from requests.exceptions import RequestException, SSLError
 from six.moves import http_client
 from six.moves.urllib.parse import quote as _quote, unquote
-from six.moves.urllib.parse import urlparse, urlunparse
+from six.moves.urllib.parse import urljoin, urlparse, urlunparse
 from time import sleep, time
 import six
 
@@ -550,9 +550,22 @@ def get_auth_keystone(auth_url, user, key, os_options, **kwargs):
 
     insecure = kwargs.get('insecure', False)
     timeout = kwargs.get('timeout', None)
-    auth_version = kwargs.get('auth_version', '2.0')
+    auth_version = kwargs.get('auth_version', None)
     debug = logger.isEnabledFor(logging.DEBUG)
 
+    # Add the version suffix in case of versionless Keystone endpoints. If
+    # auth_version is also unset it is likely that it is v3
+    if len(urlparse(auth_url).path) <= 1:
+        if auth_version and auth_version in AUTH_VERSIONS_V2:
+            auth_url = urljoin(auth_url, "v2.0")
+        else:
+            auth_url = urljoin(auth_url, "v3")
+            auth_version = '3'
+        logger.debug("Versionless auth_url - using %s as endpoint" % auth_url)
+
+    # Legacy default if not set
+    if auth_version is None:
+        auth_version = 'v2.0'
     ksclient, exceptions = _import_keystone_client(auth_version)
 
     try:
diff --git a/tests/unit/test_swiftclient.py b/tests/unit/test_swiftclient.py
index 2cd5cf15..9de407f1 100644
--- a/tests/unit/test_swiftclient.py
+++ b/tests/unit/test_swiftclient.py
@@ -575,6 +575,26 @@ def test_get_keystone_client_2_0(self):
         self.assertTrue(url.startswith("http"))
         self.assertTrue(token)
 
+    def test_get_auth_keystone_versionless(self):
+        fake_ks = FakeKeystone(endpoint='http://some_url', token='secret')
+
+        with mock.patch('swiftclient.client._import_keystone_client',
+                        _make_fake_import_keystone_client(fake_ks)):
+            c.get_auth_keystone('http://authurl', 'user', 'key', {})
+        self.assertEqual(1, len(fake_ks.calls))
+        self.assertEqual('http://authurl/v3', fake_ks.calls[0].get('auth_url'))
+
+    def test_get_auth_keystone_versionless_auth_version_set(self):
+        fake_ks = FakeKeystone(endpoint='http://some_url', token='secret')
+
+        with mock.patch('swiftclient.client._import_keystone_client',
+                        _make_fake_import_keystone_client(fake_ks)):
+            c.get_auth_keystone('http://auth_url', 'user', 'key',
+                                {}, auth_version='2.0')
+        self.assertEqual(1, len(fake_ks.calls))
+        self.assertEqual('http://auth_url/v2.0',
+                         fake_ks.calls[0].get('auth_url'))
+
     def test_auth_with_session(self):
         mock_session = mock.MagicMock()
         mock_session.get_endpoint.return_value = 'http://storagehost/v1/acct'

From 32f6b3c642fd5830a63e06ea4fac86956160312f Mon Sep 17 00:00:00 2001
From: Timur Alperovich <timuralp@swiftstack.com>
Date: Thu, 8 Jun 2017 23:47:14 -0700
Subject: [PATCH 069/316] Do not set Content-Type to '' with new requests.

Previously, python-swiftclient worked around a requests issue where
Content-Type could be set to application/x-www-form-urlencoded when
using python3. This issue has been resolved and a fix released in
requests 2.4 (fixed in subsequent releases as well). The patch makes
the workaround conditional on the requests version, so that with
sufficiently new requests libraries, the Content-Type is not set.

For reference, requests 2.4 was released August 29th, 2014. The
specific issue filed in the requests tracker is:
https://github.com/requests/requests/issues/2071.

Related-Change: I035f8b4b9c9ccdc79820b907770a48f86d0343b4
Closes-Bug: #1433767

Change-Id: Ieb2243d2ff5326920a27ce8c3c6f0f5c396701ed
---
 swiftclient/client.py          |  6 ++++--
 tests/unit/test_swiftclient.py | 19 +++++++++++++++++--
 2 files changed, 21 insertions(+), 4 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index 80b6eda2..80bc4a3a 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -1286,8 +1286,10 @@ def put_object(url, token=None, container=None, name=None, contents=None,
     if content_type is not None:
         headers['Content-Type'] = content_type
     elif 'Content-Type' not in headers:
-        # python-requests sets application/x-www-form-urlencoded otherwise
-        headers['Content-Type'] = ''
+        if StrictVersion(requests.__version__) < StrictVersion('2.4.0'):
+            # python-requests sets application/x-www-form-urlencoded otherwise
+            # if using python3.
+            headers['Content-Type'] = ''
     if not contents:
         headers['Content-Length'] = '0'
 
diff --git a/tests/unit/test_swiftclient.py b/tests/unit/test_swiftclient.py
index d4a704e1..9e9280d7 100644
--- a/tests/unit/test_swiftclient.py
+++ b/tests/unit/test_swiftclient.py
@@ -1165,6 +1165,7 @@ def test_request_headers(self):
 
 class TestPutObject(MockHttpTest):
 
+    @mock.patch('swiftclient.requests.__version__', '2.2.0')
     def test_ok(self):
         c.http_connection = self.fake_http_connection(200)
         args = ('http://www.test.com', 'TOKEN', 'container', 'obj', 'body', 4)
@@ -1222,6 +1223,7 @@ def test_chunk_warning(self):
             self.assertEqual(len(w), 1)
             self.assertTrue(issubclass(w[-1].category, UserWarning))
 
+    @mock.patch('swiftclient.requests.__version__', '2.2.0')
     def test_server_error(self):
         body = 'c' * 60
         headers = {'foo': 'bar'}
@@ -1236,7 +1238,8 @@ def test_server_error(self):
         self.assertEqual(e.http_status, 500)
         self.assertRequests([
             ('PUT', '/asdf/asdf', 'asdf', {
-                'x-auth-token': 'asdf', 'content-type': ''}),
+                'x-auth-token': 'asdf',
+                'content-type': ''}),
         ])
 
     def test_query_string(self):
@@ -1377,7 +1380,8 @@ def test_params(self):
         self.assertEqual(request_header['etag'], b'1234-5678')
         self.assertEqual(request_header['content-type'], b'text/plain')
 
-    def test_no_content_type(self):
+    @mock.patch('swiftclient.requests.__version__', '2.2.0')
+    def test_no_content_type_old_requests(self):
         conn = c.http_connection(u'http://www.test.com/')
         resp = MockHttpResponse(status=200)
         conn[1].getresponse = resp.fake_response
@@ -1387,6 +1391,17 @@ def test_no_content_type(self):
         request_header = resp.requests_params['headers']
         self.assertEqual(request_header['content-type'], b'')
 
+    @mock.patch('swiftclient.requests.__version__', '2.4.0')
+    def test_no_content_type_new_requests(self):
+        conn = c.http_connection(u'http://www.test.com/')
+        resp = MockHttpResponse(status=200)
+        conn[1].getresponse = resp.fake_response
+        conn[1]._request = resp._fake_request
+
+        c.put_object(url='http://www.test.com', http_conn=conn)
+        request_header = resp.requests_params['headers']
+        self.assertNotIn('content-type', request_header)
+
     def test_content_type_in_headers(self):
         conn = c.http_connection(u'http://www.test.com/')
         resp = MockHttpResponse(status=200)

From 01f5a9f3af3a1630297a92dff0f998b4f0e97a49 Mon Sep 17 00:00:00 2001
From: Clay Gerrard <clay.gerrard@gmail.com>
Date: Tue, 13 Jun 2017 10:46:10 -0700
Subject: [PATCH 070/316] Support pdb in tests better

Not really "better" so much as "at all" - the thing we do with the
capture stderr *everywhere* is probably brilliant - but absolutely not
strictly necessary for every MockHttpTest TestCase and comes with the
annoying overhead of trying to get into a debugger causes tests to hang
inexplicably and you can't even do debug prints in tests!?

Now if you add SWIFTCLIENT_DEBUG=1 to your nose -vsx command you can not
only jump into debugger, but if you're "in the know" you could even get
some stderr print debugging going on!

If you're not "in the know" when you try to pdb.set_trace() the tests
will blow-up for you because we monkeypatch pdb when not in
SWIFTCLIENT_DEBUG mode, you're welcome.

Change-Id: I21298bfd39fe386b5ea19e3a6f4408d8a0459c92
---
 tests/unit/utils.py | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/tests/unit/utils.py b/tests/unit/utils.py
index c05146ec..f7e48d30 100644
--- a/tests/unit/utils.py
+++ b/tests/unit/utils.py
@@ -20,6 +20,7 @@
 import unittest
 import mock
 import six
+import os
 from six.moves import reload_module
 from six.moves.urllib.parse import urlparse, ParseResult
 from swiftclient import client as c
@@ -206,7 +207,19 @@ def setUp(self):
         # won't cover the references to sys.stdout/sys.stderr in
         # swiftclient.multithreading
         self.capture_output = CaptureOutput()
-        self.capture_output.__enter__()
+        if 'SWIFTCLIENT_DEBUG' not in os.environ:
+            self.capture_output.__enter__()
+            self.addCleanup(self.capture_output.__exit__)
+
+            # since we're going to steal all stderr output globally; we should
+            # give the developer an escape hatch or risk scorn
+            def blowup_but_with_the_helpful(*args, **kwargs):
+                raise Exception(
+                    "You tried to enter a debugger while stderr is "
+                    "patched, you need to set SWIFTCLIENT_DEBUG=1 "
+                    "and try again")
+            import pdb
+            pdb.set_trace = blowup_but_with_the_helpful
 
         def fake_http_connection(*args, **kwargs):
             self.validateMockedRequestsConsumed()
@@ -384,7 +397,6 @@ def tearDown(self):
         # un-hygienic mocking on the swiftclient.client module; which may lead
         # to some unfortunate test order dependency bugs by way of the broken
         # window theory if any other modules are similarly patched
-        self.capture_output.__exit__()
         reload_module(c)
 
 

From cde73c196d4f161b227fb924cd59cf02eaa33c03 Mon Sep 17 00:00:00 2001
From: Christopher Bartz <bartz@dkrz.de>
Date: Thu, 6 Jul 2017 17:30:48 +0200
Subject: [PATCH 071/316] Option to ignore mtime metadata entry.

Currently, the swiftclient upload command passes a custom metadata
header for each object (called object-meta-mtime), whose value is
the current UNIX timestamp. When downloading such an object with the
swiftclient, the mtime header is parsed and passed as the atime and
mtime for the newly created file.

There are use-cases where this is not desired, for example when using
tmp or scratch directories in which files older than a specific date
are deleted. This commit provides a boolean option for ignoring the
mtime header.

Change-Id: If60b389aa910c6f1969b999b5d3b6d0940375686
---
 doc/manpages/swift.1       |  3 +++
 doc/source/cli.rst         |  4 +++-
 swiftclient/service.py     |  4 +++-
 swiftclient/shell.py       |  9 ++++++++
 tests/unit/test_service.py | 46 ++++++++++++++++++++++++++++++++++++++
 5 files changed, 64 insertions(+), 2 deletions(-)

diff --git a/doc/manpages/swift.1 b/doc/manpages/swift.1
index 1f288d65..d44a7d5c 100644
--- a/doc/manpages/swift.1
+++ b/doc/manpages/swift.1
@@ -102,6 +102,9 @@ with \-\-no-download actually not to write anything to disk.
 The \-\-ignore-checksum is an option that turns off checksum validation.
 You can specify optional headers with the repeatable cURL-like option
 \-H [\-\-header]. For more details and options see swift download \-\-help.
+The \-\-ignore\-mtime option ignores the x\-object\-meta\-mtime metadata entry
+on the object (if present) and instead creates the downloaded files with
+fresh atime and mtime values.
 .RE
 
 \fBdelete\fR [\fIcommand-options\fR] [\fIcontainer\fR] [\fIobject\fR] [\fIobject\fR] [...]
diff --git a/doc/source/cli.rst b/doc/source/cli.rst
index 8d80d1b4..8df95aa7 100644
--- a/doc/source/cli.rst
+++ b/doc/source/cli.rst
@@ -188,7 +188,9 @@ Download
        option to redirect the output to a specific file or ``-`` to
        redirect to stdout. The ``--ignore-checksum`` is an option that turn off
        checksum validation. You can specify optional headers with the repeatable
-       cURL-like option ``-H [--header <name:value>]``.
+       cURL-like option ``-H [--header <name:value>]``. ``--ignore-mtime`` ignores the
+       ``x-object-meta-mtime`` metadata entry on the object (if present) and instead
+       creates the downloaded files with fresh atime and mtime values.
 
 Delete
 ------
diff --git a/swiftclient/service.py b/swiftclient/service.py
index b9b843eb..5a43bf27 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -203,6 +203,7 @@ def _build_default_global_options():
     'shuffle': False,
     'destination': None,
     'fresh_metadata': False,
+    'ignore_mtime': False,
 }
 
 POLICY = 'X-Storage-Policy'
@@ -1240,7 +1241,8 @@ def _download_object_job(self, conn, container, obj, options):
                 bytes_read = obj_body.bytes_read()
                 if fp is not None:
                     fp.close()
-                    if 'x-object-meta-mtime' in headers and not no_file:
+                    if ('x-object-meta-mtime' in headers and not no_file
+                            and not options['ignore_mtime']):
                         try:
                             mtime = float(headers['x-object-meta-mtime'])
                         except ValueError:
diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 841ed6e5..19a224a2 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -272,6 +272,9 @@ def st_delete(parser, args, output_manager):
                         script to multiple servers). Enable this option to
                         submit download jobs to the thread pool in the order
                         they are listed in the object store.
+  --ignore-mtime        Ignore the 'X-Object-Meta-Mtime' header when
+                        downloading an object. Instead, create atime and mtime
+                        with fresh timestamps.
 '''.strip("\n")
 
 
@@ -332,6 +335,12 @@ def st_download(parser, args, output_manager):
         'nightly automated download script to multiple servers). Enable this '
         'option to submit download jobs to the thread pool in the order they '
         'are listed in the object store.')
+    parser.add_argument(
+        '--ignore-mtime', action='store_true', dest='ignore_mtime',
+        default=False, help='By default, the object-meta-mtime header is used '
+        'to store the access and modified timestamp for the downloaded file. '
+        'With this option, the header is ignored and the timestamps are '
+        'created freshly.')
     (options, args) = parse_args(parser, args)
     args = args[1:]
     if options['out_file'] == '-':
diff --git a/tests/unit/test_service.py b/tests/unit/test_service.py
index b759e6ba..6490b3f8 100644
--- a/tests/unit/test_service.py
+++ b/tests/unit/test_service.py
@@ -2051,6 +2051,52 @@ def test_download_object_job_bad_mtime(self):
         )
         self.assertEqual(expected_r, actual_r)
 
+    def test_download_object_job_ignore_mtime(self):
+        mock_conn = self._get_mock_connection()
+        objcontent = six.BytesIO(b'objcontent')
+        mock_conn.get_object.side_effect = [
+            ({'content-type': 'text/plain',
+              'etag': '2cbbfe139a744d6abbe695e17f3c1991',
+              'x-object-meta-mtime': '1454113727.682512'},
+             objcontent)
+        ]
+        expected_r = self._get_expected({
+            'success': True,
+            'start_time': 1,
+            'finish_time': 2,
+            'headers_receipt': 3,
+            'auth_end_time': 4,
+            'read_length': len(b'objcontent'),
+        })
+
+        with mock.patch.object(builtins, 'open') as mock_open, \
+                mock.patch('swiftclient.service.utime') as mock_utime:
+            written_content = Mock()
+            mock_open.return_value = written_content
+            s = SwiftService()
+            _opts = self.opts.copy()
+            _opts['no_download'] = False
+            _opts['ignore_mtime'] = True
+            actual_r = s._download_object_job(
+                mock_conn, 'test_c', 'test_o', _opts)
+            actual_r = dict(  # Need to override the times we got from the call
+                actual_r,
+                **{
+                    'start_time': 1,
+                    'finish_time': 2,
+                    'headers_receipt': 3
+                }
+            )
+            mock_open.assert_called_once_with('test_o', 'wb')
+            self.assertEqual([], mock_utime.mock_calls)
+            written_content.write.assert_called_once_with(b'objcontent')
+
+        mock_conn.get_object.assert_called_once_with(
+            'test_c', 'test_o', resp_chunk_size=65536, headers={},
+            response_dict={}
+        )
+        self.assertEqual(expected_r, actual_r)
+
     def test_download_object_job_exception(self):
         mock_conn = self._get_mock_connection()
         mock_conn.get_object = Mock(side_effect=self.exc)

From 484d7ee9b21396d066604e8e876ffb3d6ed6d359 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Thu, 6 Jul 2017 12:43:11 -0700
Subject: [PATCH 072/316] Allow --meta on upload

Previously, the --meta option was only allowed on post or copy subcommands.

Change-Id: I87bf0338c34b5e89aa946505bee68dbeb37d784c
Closes-Bug: #1616238
---
 swiftclient/service.py     |  2 ++
 swiftclient/shell.py       | 11 +++++++++--
 tests/unit/test_service.py | 35 +++++++++--------------------------
 tests/unit/test_shell.py   |  6 ++++--
 4 files changed, 24 insertions(+), 30 deletions(-)

diff --git a/swiftclient/service.py b/swiftclient/service.py
index b9b843eb..8301ae93 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -1912,6 +1912,8 @@ def _upload_object_job(self, conn, container, source, obj, options,
                         return res
 
             # Merge the command line header options to the put_headers
+            put_headers.update(split_headers(
+                options['meta'], 'X-Object-Meta-'))
             put_headers.update(split_headers(options['header'], ''))
 
             # Don't do segment job if object is not big enough, and never do
diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 841ed6e5..58b9f54d 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -881,8 +881,8 @@ def st_copy(parser, args, output_manager):
 st_upload_options = '''[--changed] [--skip-identical] [--segment-size <size>]
                     [--segment-container <container>] [--leave-segments]
                     [--object-threads <thread>] [--segment-threads <threads>]
-                    [--header <header>] [--use-slo] [--ignore-checksum]
-                    [--object-name <object-name>]
+                    [--meta <name:value>] [--header <header>] [--use-slo]
+                    [--ignore-checksum] [--object-name <object-name>]
                     <container> <file_or_directory> [<file_or_directory>] [...]
 '''
 
@@ -916,6 +916,9 @@ def st_copy(parser, args, output_manager):
   --segment-threads <threads>
                         Number of threads to use for uploading object segments.
                         Default is 10.
+  -m, --meta <name:value>
+                        Sets a meta data item. This option may be repeated.
+                        Example: -m Color:Blue -m Size:Large
   -H, --header <header:value>
                         Adds a customized request header. This option may be
                         repeated. Example: -H "content-type:text/plain"
@@ -966,6 +969,10 @@ def st_upload(parser, args, output_manager):
         '--segment-threads', type=int, default=10,
         help='Number of threads to use for uploading object segments. '
         'Its value must be a positive integer. Default is 10.')
+    parser.add_argument(
+        '-m', '--meta', action='append', dest='meta', default=[],
+        help='Sets a meta data item. This option may be repeated. '
+        'Example: -m Color:Blue -m Size:Large')
     parser.add_argument(
         '-H', '--header', action='append', dest='header',
         default=[], help='Set request headers with the syntax header:value. '
diff --git a/tests/unit/test_service.py b/tests/unit/test_service.py
index b759e6ba..2a477fed 100644
--- a/tests/unit/test_service.py
+++ b/tests/unit/test_service.py
@@ -1146,14 +1146,9 @@ def test_upload_object_job_file_with_unicode_path(self):
                                          container='test_c',
                                          source=f.name,
                                          obj='テスト/dummy.dat',
-                                         options={'changed': False,
-                                                  'skip_identical': False,
-                                                  'leave_segments': True,
-                                                  'header': '',
-                                                  'segment_size': 10,
-                                                  'segment_container': None,
-                                                  'use_slo': False,
-                                                  'checksum': True})
+                                         options=dict(s._options,
+                                                      segment_size=10,
+                                                      leave_segments=True))
 
             mtime = r['headers']['x-object-meta-mtime']
             self.assertEqual(expected_mtime, mtime)
@@ -1350,12 +1345,8 @@ def _consuming_conn(*a, **kw):
                                          container='test_c',
                                          source=f.name,
                                          obj='test_o',
-                                         options={'changed': False,
-                                                  'skip_identical': False,
-                                                  'leave_segments': True,
-                                                  'header': '',
-                                                  'segment_size': 0,
-                                                  'checksum': True})
+                                         options=dict(s._options,
+                                                      leave_segments=True))
 
             mtime = r['headers']['x-object-meta-mtime']
             self.assertEqual(expected_mtime, mtime)
@@ -1405,12 +1396,8 @@ def test_upload_object_job_stream(self, time_mock):
                                      container='test_c',
                                      source=f,
                                      obj='test_o',
-                                     options={'changed': False,
-                                              'skip_identical': False,
-                                              'leave_segments': True,
-                                              'header': '',
-                                              'segment_size': 0,
-                                              'checksum': True})
+                                     options=dict(s._options,
+                                                  leave_segments=True))
 
             mtime = float(r['headers']['x-object-meta-mtime'])
             self.assertEqual(mtime, expected_mtime)
@@ -1452,12 +1439,8 @@ def _consuming_conn(*a, **kw):
                                      container='test_c',
                                      source=f.name,
                                      obj='test_o',
-                                     options={'changed': False,
-                                              'skip_identical': False,
-                                              'leave_segments': True,
-                                              'header': '',
-                                              'segment_size': 0,
-                                              'checksum': True})
+                                     options=dict(s._options,
+                                                  leave_segments=True))
 
             self.assertIs(r['success'], False)
             self.assertIn('md5 mismatch', str(r.get('error')))
diff --git a/tests/unit/test_shell.py b/tests/unit/test_shell.py
index db96df75..3f87c6d9 100644
--- a/tests/unit/test_shell.py
+++ b/tests/unit/test_shell.py
@@ -623,7 +623,8 @@ def test_upload(self, connection, walk):
         connection.return_value.put_object.return_value = EMPTY_ETAG
         connection.return_value.attempts = 0
         argv = ["", "upload", "container", self.tmpfile,
-                "-H", "X-Storage-Policy:one"]
+                "-H", "X-Storage-Policy:one",
+                "--meta", "Color:Blue"]
         swiftclient.shell.main(argv)
         connection.return_value.put_container.assert_called_once_with(
             'container',
@@ -636,7 +637,8 @@ def test_upload(self, connection, walk):
             mock.ANY,
             content_length=0,
             headers={'x-object-meta-mtime': mock.ANY,
-                     'X-Storage-Policy': 'one'},
+                     'X-Storage-Policy': 'one',
+                     'X-Object-Meta-Color': 'Blue'},
             response_dict={})
 
         # upload to pseudo-folder (via <container> param)

From 638d7c789cf3ccab61bf6af6fcab6e6d79b9e0a4 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Wed, 15 Mar 2017 18:05:38 +0000
Subject: [PATCH 073/316] Buffer reads from disk

Otherwise, Python defaults to 8k reads which seems kinda terrible.

Change-Id: I3160626e947083af487fd1c3cb0aa6a62646527b
Closes-Bug: #1671621
---
 swiftclient/service.py     | 19 ++++++++++---------
 tests/unit/test_service.py |  8 ++++----
 tests/unit/test_shell.py   | 12 ++++++------
 3 files changed, 20 insertions(+), 19 deletions(-)

diff --git a/swiftclient/service.py b/swiftclient/service.py
index 5a43bf27..5f032be7 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -50,6 +50,7 @@
 from swiftclient.multithreading import MultiThreadingManager
 
 
+DISK_BUFFER = 2 ** 16
 logger = logging.getLogger("swiftclient.service")
 
 
@@ -1126,14 +1127,14 @@ def _download_object_job(self, conn, container, obj, options):
         if options['skip_identical']:
             filename = out_file if out_file else path
             try:
-                fp = open(filename, 'rb')
+                fp = open(filename, 'rb', DISK_BUFFER)
             except IOError:
                 pass
             else:
                 with fp:
                     md5sum = md5()
                     while True:
-                        data = fp.read(65536)
+                        data = fp.read(DISK_BUFFER)
                         if not data:
                             break
                         md5sum.update(data)
@@ -1141,7 +1142,7 @@ def _download_object_job(self, conn, container, obj, options):
 
         try:
             start_time = time()
-            get_args = {'resp_chunk_size': 65536,
+            get_args = {'resp_chunk_size': DISK_BUFFER,
                         'headers': req_headers,
                         'response_dict': results_dict}
             if options['skip_identical']:
@@ -1224,10 +1225,10 @@ def _download_object_job(self, conn, container, obj, options):
 
                     if not no_file:
                         if out_file:
-                            fp = open(out_file, 'wb')
+                            fp = open(out_file, 'wb', DISK_BUFFER)
                         else:
                             if basename(path):
-                                fp = open(path, 'wb')
+                                fp = open(path, 'wb', DISK_BUFFER)
                             else:
                                 pseudodir = True
 
@@ -1733,7 +1734,7 @@ def _upload_segment_job(conn, path, container, segment_name, segment_start,
         }
         fp = None
         try:
-            fp = open(path, 'rb')
+            fp = open(path, 'rb', DISK_BUFFER)
             fp.seek(segment_start)
 
             contents = LengthWrapper(fp, segment_size, md5=options['checksum'])
@@ -1811,7 +1812,7 @@ def _get_chunk_data(self, conn, container, obj, headers, manifest=None):
 
     def _is_identical(self, chunk_data, path):
         try:
-            fp = open(path, 'rb')
+            fp = open(path, 'rb', DISK_BUFFER)
         except IOError:
             return False
 
@@ -1820,7 +1821,7 @@ def _is_identical(self, chunk_data, path):
                 to_read = chunk['bytes']
                 md5sum = md5()
                 while to_read:
-                    data = fp.read(min(65536, to_read))
+                    data = fp.read(min(DISK_BUFFER, to_read))
                     if not data:
                         return False
                     md5sum.update(data)
@@ -2032,7 +2033,7 @@ def _upload_object_job(self, conn, container, source, obj, options,
                 try:
                     if path is not None:
                         content_length = getsize(path)
-                        fp = open(path, 'rb')
+                        fp = open(path, 'rb', DISK_BUFFER)
                         contents = LengthWrapper(fp,
                                                  content_length,
                                                  md5=options['checksum'])
diff --git a/tests/unit/test_service.py b/tests/unit/test_service.py
index 6490b3f8..54f0a11a 100644
--- a/tests/unit/test_service.py
+++ b/tests/unit/test_service.py
@@ -1951,7 +1951,7 @@ def test_download_object_job(self):
                     'headers_receipt': 3
                 }
             )
-            mock_open.assert_called_once_with('test_o', 'wb')
+            mock_open.assert_called_once_with('test_o', 'wb', 65536)
             written_content.write.assert_called_once_with(b'objcontent')
 
         mock_conn.get_object.assert_called_once_with(
@@ -1995,7 +1995,7 @@ def test_download_object_job_with_mtime(self):
                     'headers_receipt': 3
                 }
             )
-            mock_open.assert_called_once_with('test_o', 'wb')
+            mock_open.assert_called_once_with('test_o', 'wb', 65536)
             mock_utime.assert_called_once_with(
                 'test_o', (1454113727.682512, 1454113727.682512))
             written_content.write.assert_called_once_with(b'objcontent')
@@ -2041,7 +2041,7 @@ def test_download_object_job_bad_mtime(self):
                     'headers_receipt': 3
                 }
             )
-            mock_open.assert_called_once_with('test_o', 'wb')
+            mock_open.assert_called_once_with('test_o', 'wb', 65536)
             self.assertEqual(0, len(mock_utime.mock_calls))
             written_content.write.assert_called_once_with(b'objcontent')
 
@@ -2087,7 +2087,7 @@ def test_download_object_job_ignore_mtime(self):
                     'headers_receipt': 3
                 }
             )
-            mock_open.assert_called_once_with('test_o', 'wb')
+            mock_open.assert_called_once_with('test_o', 'wb', 65536)
             self.assertEqual([], mock_utime.mock_calls)
             written_content.write.assert_called_once_with(b'objcontent')
 
diff --git a/tests/unit/test_shell.py b/tests/unit/test_shell.py
index db96df75..4c47db14 100644
--- a/tests/unit/test_shell.py
+++ b/tests/unit/test_shell.py
@@ -473,7 +473,7 @@ def test_download(self, connection, makedirs):
                            response_dict={})]
         connection.return_value.get_object.assert_has_calls(
             calls, any_order=True)
-        mock_open.assert_called_once_with('object', 'wb')
+        mock_open.assert_called_once_with('object', 'wb', 65536)
         self.assertEqual([mock.call('pseudo')], makedirs.mock_calls)
         makedirs.reset_mock()
 
@@ -490,7 +490,7 @@ def test_download(self, connection, makedirs):
         connection.return_value.get_object.assert_called_with(
             'container', 'object', headers={}, resp_chunk_size=65536,
             response_dict={})
-        mock_open.assert_called_with('object', 'wb')
+        mock_open.assert_called_with('object', 'wb', 65536)
         self.assertEqual([], makedirs.mock_calls)
 
         # Test downloading without md5 checks
@@ -507,7 +507,7 @@ def test_download(self, connection, makedirs):
         connection.return_value.get_object.assert_called_with(
             'container', 'object', headers={}, resp_chunk_size=65536,
             response_dict={})
-        mock_open.assert_called_with('object', 'wb')
+        mock_open.assert_called_with('object', 'wb', 65536)
         sr.assert_called_once_with('object', mock.ANY, mock.ANY, False)
         self.assertEqual([], makedirs.mock_calls)
 
@@ -553,7 +553,7 @@ def test_download_shuffle(self, connection, mock_shuffle):
         mock_shuffle.assert_any_call(['container'])
         mock_shuffle.assert_any_call(['object'])
         mock_shuffle.assert_any_call(['pseudo/'])
-        mock_open.assert_called_once_with('container/object', 'wb')
+        mock_open.assert_called_once_with('container/object', 'wb', 65536)
         self.assertEqual([
             mock.call('container'),
             mock.call('container/pseudo'),
@@ -577,7 +577,7 @@ def test_download_shuffle(self, connection, mock_shuffle):
                 argv = ["", "download", "--all", "--no-shuffle"]
                 swiftclient.shell.main(argv)
         self.assertEqual(0, mock_shuffle.call_count)
-        mock_open.assert_called_once_with('container/object', 'wb')
+        mock_open.assert_called_once_with('container/object', 'wb', 65536)
         self.assertEqual([
             mock.call('container'),
             mock.call('container/pseudo'),
@@ -610,7 +610,7 @@ def test_download_no_content_type(self, connection):
                            response_dict={})]
         connection.return_value.get_object.assert_has_calls(
             calls, any_order=True)
-        mock_open.assert_called_once_with('object', 'wb')
+        mock_open.assert_called_once_with('object', 'wb', 65536)
         self.assertEqual([
             mock.call('pseudo'),
         ], mock_mkdir.mock_calls)

From 487b5a1ce479c12fc47673f3c8cd3259082dce6a Mon Sep 17 00:00:00 2001
From: John Dickinson <me@not.mn>
Date: Fri, 21 Jul 2017 11:09:15 -0700
Subject: [PATCH 074/316] merged openstack-manuals content with existing
 content

Change-Id: I05bc8f80daefbb32f32727550a9cbe43e9754e2f
---
 doc/source/cli.rst | 748 ++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 632 insertions(+), 116 deletions(-)

diff --git a/doc/source/cli.rst b/doc/source/cli.rst
index 8df95aa7..1277caa5 100644
--- a/doc/source/cli.rst
+++ b/doc/source/cli.rst
@@ -6,6 +6,139 @@ The ``swift`` tool is a command line utility for communicating with an OpenStack
 Object Storage (swift) environment. It allows one to perform several types of
 operations.
 
+
+For help on a specific :command:`swift` command, enter:
+
+.. code-block:: console
+
+   $ swift COMMAND --help
+
+.. _swift_command_usage:
+
+swift usage
+~~~~~~~~~~~
+
+.. code-block:: console
+
+   Usage: swift [--version] [--help] [--os-help] [--snet] [--verbose]
+                [--debug] [--info] [--quiet] [--auth <auth_url>]
+                [--auth-version <auth_version> |
+                    --os-identity-api-version <auth_version> ]
+                [--user <username>]
+                [--key <api_key>] [--retries <num_retries>]
+                [--os-username <auth-user-name>] [--os-password <auth-password>]
+                [--os-user-id <auth-user-id>]
+                [--os-user-domain-id <auth-user-domain-id>]
+                [--os-user-domain-name <auth-user-domain-name>]
+                [--os-tenant-id <auth-tenant-id>]
+                [--os-tenant-name <auth-tenant-name>]
+                [--os-project-id <auth-project-id>]
+                [--os-project-name <auth-project-name>]
+                [--os-project-domain-id <auth-project-domain-id>]
+                [--os-project-domain-name <auth-project-domain-name>]
+                [--os-auth-url <auth-url>] [--os-auth-token <auth-token>]
+                [--os-storage-url <storage-url>] [--os-region-name <region-name>]
+                [--os-service-type <service-type>]
+                [--os-endpoint-type <endpoint-type>]
+                [--os-cacert <ca-certificate>] [--insecure]
+                [--os-cert <client-certificate-file>]
+                [--os-key <client-certificate-key-file>]
+                [--no-ssl-compression]
+                <subcommand> [--help] [<subcommand options>]
+
+**Subcommands:**
+
+``delete``
+  Delete a container or objects within a container.
+
+``download``
+  Download objects from containers.
+
+``list``
+  Lists the containers for the account or the objects
+  for a container.
+
+``post``
+  Updates meta information for the account, container,
+  or object; creates containers if not present.
+
+``copy``
+  Copies object, optionally adds meta
+
+``stat``
+  Displays information for the account, container,
+  or object.
+
+``upload``
+  Uploads files or directories to the given container.
+
+``capabilities``
+  List cluster capabilities.
+
+``tempurl``
+  Create a temporary URL.
+
+``auth``
+  Display auth related environment variables.
+
+.. _swift_command_options:
+
+swift optional arguments
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+``--version``
+  show program's version number and exit
+
+``-h, --help``
+  show this help message and exit
+
+``--os-help``
+  Show OpenStack authentication options.
+
+``-s, --snet``
+  Use SERVICENET internal network.
+
+``-v, --verbose``
+  Print more info.
+
+``--debug``
+  Show the curl commands and results of all http queries
+  regardless of result status.
+
+``--info``
+  Show the curl commands and results of all http queries
+  which return an error.
+
+``-q, --quiet``
+  Suppress status output.
+
+``-A AUTH, --auth=AUTH``
+  URL for obtaining an auth token.
+
+``-V AUTH_VERSION, --auth-version=AUTH_VERSION, --os-identity-api-version=AUTH_VERSION``
+  Specify a version for authentication. Defaults to
+  ``env[ST_AUTH_VERSION]``, ``env[OS_AUTH_VERSION]``,
+  ``env[OS_IDENTITY_API_VERSION]`` or 1.0.
+
+``-U USER, --user=USER``
+  User name for obtaining an auth token.
+
+``-K KEY, --key=KEY``
+  Key for obtaining an auth token.
+
+``-R RETRIES, --retries=RETRIES``
+  The number of times to retry a failed connection.
+
+``--insecure``
+  Allow swiftclient to access servers without having to
+  verify the SSL certificate. Defaults to
+  ``env[SWIFTCLIENT_INSECURE]`` (set to 'true' to enable).
+
+``--no-ssl-compression``
+  This option is deprecated and not used anymore. SSL
+  compression should be disabled by default by the
+  system SSL library.
+
 Authentication
 ~~~~~~~~~~~~~~
 
@@ -119,160 +252,543 @@ storage URL options shown below:
 CLI commands
 ~~~~~~~~~~~~
 
-Stat
+.. _swift_auth:
+
+Auth
 ----
 
-    ``stat [container [object]]``
+.. code-block:: console
 
-       Displays information for the account, container, or object depending on
-       the arguments given (if any). In verbose mode, the storage URL and the
-       authentication token are displayed as well.
+   Usage: swift auth
 
-List
-----
+Display authentication variables in shell friendly format. Command to run to export storage
+URL and auth token into ``OS_STORAGE_URL`` and ``OS_AUTH_TOKEN``: ``swift auth``.
+Command to append to a runcom file (e.g. ``~/.bashrc``, ``/etc/profile``) for automatic
+authentication: ``swift auth -v -U test:tester -K testing``.
 
-    ``list [command-options] [container]``
+.. _swift_stat:
 
-       Lists the containers for the account or the objects for a container.
-       The ``-p <prefix>`` or ``--prefix <prefix>`` is an option that will only
-       list items beginning with that prefix. The ``-d <delimiter>`` or
-       ``--delimiter <delimiter>`` is an option (for container listings only)
-       that will roll up items with the given delimiter (see `OpenStack Swift
-       general documentation <http://docs.openstack.org/developer/swift/>` for
-       what this means).
+swift stat
+----------
 
-       The ``-l`` and ``--lh`` options provide more detail, similar to ``ls -l``
-       and ``ls -lh``, the latter providing sizes in human readable format
-       (For example: ``3K``, ``12M``, etc). The latter two switches use more
-       overhead to retrieve the displayed details, which is directly proportional
-       to the number of container or objects listed.
+.. code-block:: console
 
-Upload
-------
+   Usage: swift stat [--lh] [--header <header:value>]
+                     [<container> [<object>]]
 
-    ``upload [command-options] container file_or_directory [file_or_directory] [...]``
+Displays information for the account, container, or object depending on
+the arguments given (if any). In verbose mode, the storage URL and the
+authentication token are displayed as well.
 
-       Uploads the files and directories specified by the remaining arguments to the
-       given container. The ``-c`` or ``--changed`` is an option that will only
-       upload files that have changed since the last upload. The
-       ``--object-name <object-name>`` is an option that will upload a file and
-       name object to ``<object-name>`` or upload a directory and use ``<object-name>``
-       as object prefix. The ``-S <size>`` or ``--segment-size <size>`` and
-       ``--leave-segments`` are options as well (see ``--help`` for more).
+**Positional arguments:**
 
-Post
-----
+``[container]``
+  Name of container to stat from.
 
-    ``post [command-options] [container] [object]``
+``[object]``
+  Name of object to stat.
 
-       Updates meta information for the account, container, or object depending
-       on the arguments given. If the container is not found, the ``swiftclient``
-       will create it automatically, but this is not true for accounts and
-       objects. Containers also allow the ``-r <read-acl>`` (or ``--read-acl
-       <read-acl>``) and ``-w <write-acl>`` (or ``--write-acl <write-acl>``) options.
-       The ``-m`` or ``--meta`` option is allowed on accounts, containers and objects,
-       and is used to define the user metadata items to set in the form ``Name:Value``.
-       You can repeat this option. For example: ``post -m Color:Blue -m Size:Large``
+**Optional arguments:**
 
-       For more information about ACL formats see the documentation:
-       `ACLs <http://docs.openstack.org/developer/swift/misc.html#acls/>`_.
+``--lh``
+  Report sizes in human readable format similar to
+  ls -lh.
 
-Download
---------
+``-H, --header <header:value>``
+  Adds a custom request header to use for stat.
 
-    ``download [command-options] [container] [object] [object] [...]``
+.. _swift_list:
 
-       Downloads everything in the account (with ``--all``), or everything in a
-       container, or a list of objects depending on the arguments given. For a
-       single object download, you may use the ``-o <filename>`` or ``--output <filename>``
-       option to redirect the output to a specific file or ``-`` to
-       redirect to stdout. The ``--ignore-checksum`` is an option that turn off
-       checksum validation. You can specify optional headers with the repeatable
-       cURL-like option ``-H [--header <name:value>]``. ``--ignore-mtime`` ignores the
-       ``x-object-meta-mtime`` metadata entry on the object (if present) and instead
-       creates the downloaded files with fresh atime and mtime values.
+swift list
+----------
 
-Delete
-------
+.. code-block:: console
 
-    ``delete [command-options] [container] [object] [object] [...]``
+   Usage: swift list [--long] [--lh] [--totals] [--prefix <prefix>]
+                     [--delimiter <delimiter>] [--header <header:value>]
+                     [<container>]
 
-       Deletes everything in the account (with ``--all``), or everything in a
-       container, or a list of objects depending on the arguments given. Segments
-       of manifest objects will be deleted as well, unless you specify the
-       ``--leave-segments`` option.
+Lists the containers for the account or the objects for a container.
+The ``-p <prefix>`` or ``--prefix <prefix>`` is an option that will only
+list items beginning with that prefix. The ``-d <delimiter>`` or
+``--delimiter <delimiter>`` is an option (for container listings only)
+that will roll up items with the given delimiter (see `OpenStack Swift
+general documentation <http://docs.openstack.org/developer/swift/>` for
+what this means).
 
-Copy
-----
+The ``-l`` and ``--lh`` options provide more detail, similar to ``ls -l``
+and ``ls -lh``, the latter providing sizes in human readable format
+(For example: ``3K``, ``12M``, etc). The latter two switches use more
+overhead to retrieve the displayed details, which is directly proportional
+to the number of container or objects listed.
+
+**Positional arguments:**
+
+``[container]``
+  Name of container to list object in.
+
+**Optional arguments:**
+
+``-l, --long``
+  Long listing format, similar to ls -l.
 
-    ``copy [command-options] container object``
+``--lh``
+  Report sizes in human readable format similar to
+  ls -lh.
 
-       Copies an object to a new destination or adds user metadata to an object. Depending
-       on the options supplied, you can preserve existing metadata in contrast to the post
-       command. The ``--destination`` option sets the copy target destination in the form
-       ``/container/object``. If not set, the object will be copied onto itself which is useful
-       for adding metadata. You can use the ``-M`` or ``--fresh-metadata`` option to copy
-       an object without existing user meta data, and the ``-m`` or ``--meta`` option
-       to define user meta data items to set in the form ``Name:Value``. You can repeat
-       this option. For example: ``copy -m Color:Blue -m Size:Large``.
+``-t, --totals``
+  Used with -l or --lh, only report totals.
 
-Capabilities
+``-p <prefix>, --prefix <prefix>``
+  Only list items beginning with the prefix.
+
+``-d <delim>, --delimiter <delim>``
+  Roll up items with the given delimiter. For containers
+  only. See OpenStack Swift API documentation for what
+  this means.
+
+``-H, --header <header:value>``
+  Adds a custom request header to use for listing.
+
+.. _swift_upload:
+
+swift upload
 ------------
 
-    ``capabilities [proxy-url]``
+.. code-block:: console
 
-       Displays cluster capabilities. The output includes the list of the
-       activated Swift middlewares as well as relevant options for each ones.
-       Additionally the command displays relevant options for the Swift core. If
-       the ``proxy-url`` option is not provided, the storage URL retrieved after
-       authentication is used as ``proxy-url``.
+   Usage: swift upload [--changed] [--skip-identical] [--segment-size <size>]
+                       [--segment-container <container>] [--leave-segments]
+                       [--object-threads <thread>] [--segment-threads <threads>]
+                       [--header <header>] [--use-slo] [--ignore-checksum]
+                       [--object-name <object-name>]
+                       <container> <file_or_directory> [<file_or_directory>] [...]
 
-Tempurl
--------
+Uploads the files and directories specified by the remaining arguments to the
+given container. The ``-c`` or ``--changed`` is an option that will only
+upload files that have changed since the last upload. The
+``--object-name <object-name>`` is an option that will upload a file and
+name object to ``<object-name>`` or upload a directory and use ``<object-name>``
+as object prefix. The ``-S <size>`` or ``--segment-size <size>`` and
+``--leave-segments`` are options as well (see ``--help`` for more).
 
-    ``tempurl [command-options] [method] [time] [path] [key]``
+Uploads specified files and directories to the given container.
 
-       Generates a temporary URL for a Swift object. ``method`` option sets an HTTP method to
-       allow for this temporary URL that is usually ``GET` or ``PUT``. ``time`` option sets
-       the amount of time the temporary URL will be valid for.
-       ``time`` can be specified as an integer, denoting the number of seconds
-       from now on until the URL shall be valid; or, if ``--absolute``
-       is passed, the Unix timestamp when the temporary URL will expire.
-       But beyond that, ``time`` can also be specified as an ISO 8601 timestamp
-       in one of following formats:
+**Positional arguments:**
 
-        i) Complete date: YYYY-MM-DD (eg 1997-07-16)
+``<container>``
+  Name of container to upload to.
 
-        ii) Complete date plus hours, minutes and seconds:
-           YYYY-MM-DDThh:mm:ss
-         (eg 1997-07-16T19:20:30)
+``<file_or_directory>``
+  Name of file or directory to upload. Specify multiple
+  times for multiple uploads.
 
-        iii) Complete date plus hours, minutes and seconds with UTC designator:
-            YYYY-MM-DDThh:mm:ssZ
-         (eg 1997-07-16T19:20:30Z)
+**Optional arguments:**
 
-       Please be aware that if you don't provide the UTC designator (i.e., Z)
-       the timestamp is generated using your local timezone. If only a date is
-       specified, the time part used will equal to ``00:00:00``.
+``-c, --changed``
+  Only upload files that have changed since the last
+  upload.
 
-       ``path`` option sets the full path to the Swift object.
-       Example: ``/v1/AUTH_account/c/o``. ``key`` option is
-       the secret temporary URL key set on the Swift cluster. To set a key, run
-       ``swift post -m "Temp-URL-Key: <your secret key>"``. To generate a prefix-based temporary
-       URL use the ``--prefix-based`` option. This URL will contain the path to the prefix. Do not
-       forget to append the desired objectname at the end of the path portion (and before the
-       query portion) before sharing the URL. It is possible to use ISO 8601 UTC timestamps within the
-       URL by using the ``--iso8601`` option.
+``--skip-identical``
+  Skip uploading files that are identical on both sides.
 
-Auth
-----
+``-S, --segment-size <size>``
+  Upload files in segments no larger than <size> (in
+  Bytes) and then create a "manifest" file that will
+  download all the segments as if it were the original
+  file.
+
+``--segment-container <container>``
+  Upload the segments into the specified container. If
+  not specified, the segments will be uploaded to a
+  <container>_segments container to not pollute the
+  main <container> listings.
+
+``--leave-segments``
+  Indicates that you want the older segments of manifest
+  objects left alone (in the case of overwrites).
+
+``--object-threads <threads>``
+  Number of threads to use for uploading full objects.
+  Default is 10.
+
+``--segment-threads <threads>``
+  Number of threads to use for uploading object segments.
+  Default is 10.
+
+``-H, --header <header:value>``
+  Adds a customized request header. This option may be
+  repeated. Example: -H "content-type:text/plain"
+  -H "Content-Length: 4000".
+
+``--use-slo``
+  When used in conjunction with --segment-size it will
+  create a Static Large Object instead of the default
+  Dynamic Large Object.
+
+``--object-name <object-name>``
+  Upload file and name object to <object-name> or upload
+  dir and use <object-name> as object prefix instead of
+  folder name.
+
+``--ignore-checksum``
+  Turn off checksum validation for uploads.
+
+
+.. _swift_post:
+
+swift post
+----------
+
+.. code-block:: console
+
+   Usage: swift post [--read-acl <acl>] [--write-acl <acl>] [--sync-to]
+                     [--sync-key <sync-key>] [--meta <name:value>]
+                     [--header <header>]
+                     [<container> [<object>]]
+
+Updates meta information for the account, container, or object depending
+on the arguments given. If the container is not found, the ``swiftclient``
+will create it automatically, but this is not true for accounts and
+objects. Containers also allow the ``-r <read-acl>`` (or ``--read-acl
+<read-acl>``) and ``-w <write-acl>`` (or ``--write-acl <write-acl>``) options.
+The ``-m`` or ``--meta`` option is allowed on accounts, containers and objects,
+and is used to define the user metadata items to set in the form ``Name:Value``.
+You can repeat this option. For example: ``post -m Color:Blue -m Size:Large``
+
+For more information about ACL formats see the documentation:
+`ACLs <http://docs.openstack.org/developer/swift/misc.html#acls/>`_.
+
+**Positional arguments:**
+
+``[container]``
+  Name of container to post to.
+
+``[object]``
+  Name of object to post.
+
+**Optional arguments:**
+
+``-r, --read-acl <acl>``
+  Read ACL for containers. Quick summary of ACL syntax:
+  ``.r:*``, ``.r:-.example.com``, ``.r:www.example.com``,
+  ``account1`` (v1.0 identity API only),
+  ``account1:*``, ``account2:user2`` (v2.0+ identity API).
+
+``-w, --write-acl <acl>``
+  Write ACL for containers. Quick summary of ACL syntax:
+  ``account1`` (v1.0 identity API only),
+  ``account1:*``, ``account2:user2`` (v2.0+ identity API).
+
+``-t, --sync-to <sync-to>``
+  Sync To for containers, for multi-cluster replication.
+
+``-k, --sync-key <sync-key>``
+  Sync Key for containers, for multi-cluster replication.
+
+``-m, --meta <name:value>``
+  Sets a meta data item. This option may be repeated.
+
+  Example: -m Color:Blue -m Size:Large
+
+``-H, --header <header:value>``
+  Adds a customized request header.
+  This option may be repeated.
+
+  Example: -H "content-type:text/plain" -H "Content-Length: 4000"
+
+.. _swift_download:
+
+swift download
+--------------
+
+.. code-block:: console
+
+   Usage: swift download [--all] [--marker <marker>] [--prefix <prefix>]
+                         [--output <out_file>] [--output-dir <out_directory>]
+                         [--object-threads <threads>] [--ignore-checksum]
+                         [--container-threads <threads>] [--no-download]
+                         [--skip-identical] [--remove-prefix]
+                         [--header <header:value>] [--no-shuffle]
+                         [<container> [<object>] [...]]
+
+Downloads everything in the account (with ``--all``), or everything in a
+container, or a list of objects depending on the arguments given. For a
+single object download, you may use the ``-o <filename>`` or ``--output <filename>``
+option to redirect the output to a specific file or ``-`` to
+redirect to stdout. The ``--ignore-checksum`` is an option that turn off
+checksum validation. You can specify optional headers with the repeatable
+cURL-like option ``-H [--header <name:value>]``. ``--ignore-mtime`` ignores the
+``x-object-meta-mtime`` metadata entry on the object (if present) and instead
+creates the downloaded files with fresh atime and mtime values.
+
+**Positional arguments:**
+
+``<container>``
+  Name of container to download from. To download a
+  whole account, omit this and specify --all.
+
+``<object>``
+  Name of object to download. Specify multiple times
+  for multiple objects. Omit this to download all
+  objects from the container.
+
+**Optional arguments:**
+
+``-a, --all``
+  Indicates that you really want to download
+  everything in the account.
+
+``-m, --marker <marker>``
+  Marker to use when starting a container or account
+  download.
+
+``-p, --prefix <prefix>``
+  Only download items beginning with <prefix>
+
+``-r, --remove-prefix``
+  An optional flag for --prefix <prefix>, use this
+  option to download items without <prefix>
+
+``-o, --output <out_file>``
+  For a single file download, stream the output to
+  <out_file>. Specifying "-" as <out_file> will
+  redirect to stdout.
+
+``-D, --output-dir <out_directory>``
+  An optional directory to which to store objects.
+  By default, all objects are recreated in the current
+  directory.
+
+``--object-threads <threads>``
+  Number of threads to use for downloading objects.
+  Default is 10.
+
+``--container-threads <threads>``
+  Number of threads to use for downloading containers.
+  Default is 10.
+
+``--no-download``
+  Perform download(s), but don't actually write anything
+  to disk.
+
+``-H, --header <header:value>``
+  Adds a customized request header to the query, like
+  "Range" or "If-Match". This option may be repeated.
+
+  Example: --header "content-type:text/plain"
+
+``--skip-identical``
+  Skip downloading files that are identical on both
+  sides.
+
+``--ignore-checksum``
+  Turn off checksum validation for downloads.
+
+``--no-shuffle``
+  By default, when downloading a complete account or
+  container, download order is randomised in order to
+  reduce the load on individual drives when multiple
+  clients are executed simultaneously to download the
+  same set of objects (e.g. a nightly automated download
+  script to multiple servers). Enable this option to
+  submit download jobs to the thread pool in the order
+  they are listed in the object store.
+
+.. _swift_delete:
+
+swift delete
+------------
+
+.. code-block:: console
+
+   Usage: swift delete [--all] [--leave-segments]
+                       [--object-threads <threads>]
+                       [--container-threads <threads>]
+                       [--header <header:value>]
+                       [<container> [<object>] [...]]
+
+Deletes everything in the account (with ``--all``), or everything in a
+container, or a list of objects depending on the arguments given. Segments
+of manifest objects will be deleted as well, unless you specify the
+``--leave-segments`` option.
+
+**Positional arguments:**
+
+``[<container>]``
+  Name of container to delete from.
+
+``[<object>]``
+  Name of object to delete. Specify multiple times
+  for multiple objects.
+
+**Optional arguments:**
+
+``-a, --all``
+  Delete all containers and objects.
+
+``--leave-segments``
+  Do not delete segments of manifest objects.
+
+``-H, --header <header:value>``
+  Adds a custom request header to use for deleting
+  objects or an entire container.
+
+
+``--object-threads <threads>``
+  Number of threads to use for deleting objects.
+  Default is 10.
+
+``--container-threads <threads>``
+  Number of threads to use for deleting containers.
+  Default is 10.
+
+.. _swift_copy:
+
+swift copy
+----------
+
+.. code-block:: console
+
+   Usage: swift copy [--destination </container/object>] [--fresh-metadata]
+                     [--meta <name:value>] [--header <header>] <container>
+                     <object> [<object>] [...]
+
+Copies an object to a new destination or adds user metadata to an object. Depending
+on the options supplied, you can preserve existing metadata in contrast to the post
+command. The ``--destination`` option sets the copy target destination in the form
+``/container/object``. If not set, the object will be copied onto itself which is useful
+for adding metadata. You can use the ``-M`` or ``--fresh-metadata`` option to copy
+an object without existing user meta data, and the ``-m`` or ``--meta`` option
+to define user meta data items to set in the form ``Name:Value``. You can repeat
+this option. For example: ``copy -m Color:Blue -m Size:Large``.
+
+**Positional arguments:**
+
+``<container>``
+  Name of container to copy from.
+
+``<object>``
+  Name of object to copy. Specify multiple times for multiple objects
+
+**Optional arguments:**
+
+``-d, --destination </container[/object]>``
+  The container and name of the destination object. Name
+  of destination object can be omitted, then will be
+  same as name of source object. Supplying multiple
+  objects and destination with object name is invalid.
+
+``-M, --fresh-metadata``
+  Copy the object without any existing metadata,
+  If not set, metadata will be preserved or appended
+
+``-m, --meta <name:value>``
+  Sets a meta data item. This option may be repeated.
+
+  Example: -m Color:Blue -m Size:Large
+
+``-H, --header <header:value>``
+  Adds a customized request header. This option may be repeated.
+
+  Example: -H "content-type:text/plain" -H "Content-Length: 4000"
+
+.. _swift_capabilities:
+
+swift capabilities
+------------------
+
+.. code-block:: console
+
+   Usage: swift capabilities [--json] [<proxy_url>]
+
+Displays cluster capabilities. The output includes the list of the
+activated Swift middlewares as well as relevant options for each ones.
+Additionally the command displays relevant options for the Swift core. If
+the ``proxy-url`` option is not provided, the storage URL retrieved after
+authentication is used as ``proxy-url``.
+
+**Optional positional arguments:**
+
+``<proxy_url>``
+  Proxy URL of the cluster to retrieve capabilities.
+
+``--json``
+  Print the cluster capabilities in JSON format.
+
+.. _swift_tempurl:
+
+swift tempurl
+-------------
+
+.. code-block:: console
+
+   Usage: swift tempurl [--absolute] [--prefix-based]
+                        <method> <seconds> <path> <key>
+
+Generates a temporary URL for a Swift object. ``method`` option sets an HTTP method to
+allow for this temporary URL that is usually ``GET`` or ``PUT``. ``time`` option sets
+the amount of time the temporary URL will be valid for.
+``time`` can be specified as an integer, denoting the number of seconds
+from now on until the URL shall be valid; or, if ``--absolute``
+is passed, the Unix timestamp when the temporary URL will expire.
+But beyond that, ``time`` can also be specified as an ISO 8601 timestamp
+in one of following formats:
+
+    i) Complete date: YYYY-MM-DD (eg 1997-07-16)
+
+    ii) Complete date plus hours, minutes and seconds:
+        YYYY-MM-DDThh:mm:ss
+        (eg 1997-07-16T19:20:30)
+
+    iii) Complete date plus hours, minutes and seconds with UTC designator:
+        YYYY-MM-DDThh:mm:ssZ
+        (eg 1997-07-16T19:20:30Z)
+
+Please be aware that if you don't provide the UTC designator (i.e., Z)
+the timestamp is generated using your local timezone. If only a date is
+specified, the time part used will equal to ``00:00:00``.
+
+``path`` option sets the full path to the Swift object.
+Example: ``/v1/AUTH_account/c/o``. ``key`` option is
+the secret temporary URL key set on the Swift cluster. To set a key, run
+``swift post -m "Temp-URL-Key: <your secret key>"``. To generate a prefix-based temporary
+URL use the ``--prefix-based`` option. This URL will contain the path to the prefix. Do not
+forget to append the desired objectname at the end of the path portion (and before the
+query portion) before sharing the URL. It is possible to use ISO 8601 UTC timestamps within the
+URL by using the ``--iso8601`` option.
+
+**Positional arguments:**
+
+``<method>``
+  An HTTP method to allow for this temporary URL.
+  Usually 'GET' or 'PUT'.
+
+``<seconds>``
+  The amount of time in seconds the temporary URL will be
+  valid for; or, if --absolute is passed, the Unix
+  timestamp when the temporary URL will expire.
+
+``<path>``
+  The full path to the Swift object.
+
+  Example: /v1/AUTH_account/c/o
+  or: http://saio:8080/v1/AUTH_account/c/o
+
+``<key>``
+  The secret temporary URL key set on the Swift cluster.
+  To set a key, run 'swift post -m
+  "Temp-URL-Key:b3968d0207b54ece87cccc06515a89d4"'
+
+**Optional arguments:**
 
-    ``auth``
+``--absolute``
+  Interpret the <seconds> positional argument as a Unix
+  timestamp rather than a number of seconds in the
+  future.
 
-       Display authentication variables in shell friendly format. Command to run to export storage
-       URL and auth token into ``OS_STORAGE_URL`` and ``OS_AUTH_TOKEN``: ``swift auth``.
-       Command to append to a runcom file (e.g. ``~/.bashrc``, ``/etc/profile``) for automatic
-       authentication: ``swift auth -v -U test:tester -K testing``.
+``--prefix-based``
+  If present, a prefix-based tempURL will be generated.
 
 Examples
 ~~~~~~~~

From 3db6ddd6e480a7cb45e947290816f3dd42ac66c5 Mon Sep 17 00:00:00 2001
From: Hangdong Zhang <hdzhang@fiberhome.com>
Date: Fri, 21 Jul 2017 15:42:56 +0800
Subject: [PATCH 075/316] Update the documentation link for doc migration

Change-Id: I1a5a354675b3ca6a7dbb5ab2dc78bf60209fa2b5
---
 README.rst           | 2 +-
 doc/manpages/swift.1 | 2 +-
 doc/source/cli.rst   | 6 +++---
 setup.cfg            | 2 +-
 4 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/README.rst b/README.rst
index 42ec2772..38104392 100644
--- a/README.rst
+++ b/README.rst
@@ -43,7 +43,7 @@ __ http://github.com/openstack/swift
 * `How to Contribute`_
 
 .. _PyPI: https://pypi.python.org/pypi/python-swiftclient
-.. _Online Documentation: http://docs.openstack.org/developer/python-swiftclient
+.. _Online Documentation: https://docs.openstack.org/python-swiftclient/latest/
 .. _Launchpad project: https://launchpad.net/python-swiftclient
 .. _Blueprints: https://blueprints.launchpad.net/python-swiftclient
 .. _Bugs: https://bugs.launchpad.net/python-swiftclient
diff --git a/doc/manpages/swift.1 b/doc/manpages/swift.1
index d44a7d5c..f7723826 100644
--- a/doc/manpages/swift.1
+++ b/doc/manpages/swift.1
@@ -208,4 +208,4 @@ swift \-A https://127.0.0.1:443/auth/v1.0 \-U swiftops:swiftops \-K swiftops sta
 .SH DOCUMENTATION
 .LP
 More in depth documentation about OpenStack Swift as a whole can be found at
-.BI https://docs.openstack.org/developer/swift
+.BI https://docs.openstack.org/swift/latest/
diff --git a/doc/source/cli.rst b/doc/source/cli.rst
index 1277caa5..bded3497 100644
--- a/doc/source/cli.rst
+++ b/doc/source/cli.rst
@@ -313,7 +313,7 @@ The ``-p <prefix>`` or ``--prefix <prefix>`` is an option that will only
 list items beginning with that prefix. The ``-d <delimiter>`` or
 ``--delimiter <delimiter>`` is an option (for container listings only)
 that will roll up items with the given delimiter (see `OpenStack Swift
-general documentation <http://docs.openstack.org/developer/swift/>` for
+general documentation <http://docs.openstack.org/swift/latest/>` for
 what this means).
 
 The ``-l`` and ``--lh`` options provide more detail, similar to ``ls -l``
@@ -457,7 +457,7 @@ and is used to define the user metadata items to set in the form ``Name:Value``.
 You can repeat this option. For example: ``post -m Color:Blue -m Size:Large``
 
 For more information about ACL formats see the documentation:
-`ACLs <http://docs.openstack.org/developer/swift/misc.html#acls/>`_.
+`ACLs <http://docs.openstack.org/swift/latest/misc.html#acls>`_.
 
 **Positional arguments:**
 
@@ -927,7 +927,7 @@ object in 1GiB segments:
 This command will upload segments to a container named ``videos_segments``, and
 create a manifest file describing the entire object in the ``videos`` container.
 For more information on large objects, see the documentation `here
-<http://docs.openstack.org/developer/swift/overview_large_objects.html>`_.
+<https://docs.openstack.org/swift/latest/overview_large_objects.html>`_.
 
 .. code-block:: bash
 
diff --git a/setup.cfg b/setup.cfg
index 4af3151e..e4963dba 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -5,7 +5,7 @@ description-file =
     README.rst
 author = OpenStack
 author-email = openstack-dev@lists.openstack.org
-home-page = http://docs.openstack.org/developer/python-swiftclient
+home-page = https://docs.openstack.org/python-swiftclient/latest/
 classifier =
     Environment :: OpenStack
     Intended Audience :: Information Technology

From 124c7de67669ad314f7357a2d845c2bf4e2397ca Mon Sep 17 00:00:00 2001
From: John Dickinson <me@not.mn>
Date: Wed, 26 Jul 2017 13:47:59 -0700
Subject: [PATCH 076/316] moved cli doc to the right place for new links
 process

Change-Id: I5d2f681ba5ce1f95d006eb7208cdb388a64811c9
---
 doc/source/{cli.rst => cli/index.rst} | 0
 doc/source/index.rst                  | 2 +-
 2 files changed, 1 insertion(+), 1 deletion(-)
 rename doc/source/{cli.rst => cli/index.rst} (100%)

diff --git a/doc/source/cli.rst b/doc/source/cli/index.rst
similarity index 100%
rename from doc/source/cli.rst
rename to doc/source/cli/index.rst
diff --git a/doc/source/index.rst b/doc/source/index.rst
index f123b7b1..3c2cb1eb 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -16,7 +16,7 @@ Developer Documentation
 .. toctree::
     :maxdepth: 2
 
-    cli
+    cli/index
     service-api
     client-api
 

From 0982791db2ccb851f277ffa653065e4021e52b3f Mon Sep 17 00:00:00 2001
From: Timur Alperovich <timuralp@swiftstack.com>
Date: Thu, 15 Jun 2017 20:53:04 -0700
Subject: [PATCH 077/316] Allow for uploads from standard input.

If "-" is passed in for the source, python-swiftclient will upload
the object by reading the contents of the standard input. The object
name option must be set, as well, and this cannot be used in
conjunction with other files.

This approach stores the entire contents as one object. A follow on
patch will change this behavior to upload from standard input as SLO,
unless the segment size is larger than the content size.

Change-Id: I1a8be6377de06f702e0f336a5a593408ed49be02
---
 doc/manpages/swift.1     |  7 +++++--
 doc/source/cli/index.rst |  8 ++++----
 swiftclient/service.py   |  2 ++
 swiftclient/shell.py     | 26 ++++++++++++++++++++++---
 tests/unit/test_shell.py | 41 +++++++++++++++++++++++++++++++++++++++-
 5 files changed, 74 insertions(+), 10 deletions(-)

diff --git a/doc/manpages/swift.1 b/doc/manpages/swift.1
index f7723826..00e1440e 100644
--- a/doc/manpages/swift.1
+++ b/doc/manpages/swift.1
@@ -63,8 +63,11 @@ Uploads to the given container the files and directories specified by the
 remaining args. The \-c or \-\-changed is an option that will only upload files
 that have changed since the last upload. The \-\-object\-name <object\-name> is
 an option that will upload file and name object to <object\-name> or upload dir
-and use <object\-name> as object prefix. The \-S <size> or \-\-segment\-size <size>
-and \-\-leave\-segments and others are options as well (see swift upload \-\-help for more).
+and use <object\-name> as object prefix. If the file name is "-", reads the
+content from standard input. In this case, \-\-object\-name is required and no
+other files may be given. The \-S <size> or \-\-segment\-size <size> and
+\-\-leave\-segments and others are options as well (see swift upload \-\-help
+for more).
 .RE
 
 \fBpost\fR [\fIcommand-options\fR] [\fIcontainer\fR] [\fIobject\fR]
diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst
index bded3497..bec1f5e5 100644
--- a/doc/source/cli/index.rst
+++ b/doc/source/cli/index.rst
@@ -369,10 +369,10 @@ given container. The ``-c`` or ``--changed`` is an option that will only
 upload files that have changed since the last upload. The
 ``--object-name <object-name>`` is an option that will upload a file and
 name object to ``<object-name>`` or upload a directory and use ``<object-name>``
-as object prefix. The ``-S <size>`` or ``--segment-size <size>`` and
-``--leave-segments`` are options as well (see ``--help`` for more).
-
-Uploads specified files and directories to the given container.
+as object prefix. If the file name is "-", client reads content from standard
+input. In this case ``--object-name`` is required to set the name of the object
+and no other files may be given.  The ``-S <size>`` or ``--segment-size <size>``
+and ``--leave-segments`` are options as well (see ``--help`` for more).
 
 **Positional arguments:**
 
diff --git a/swiftclient/service.py b/swiftclient/service.py
index 5f032be7..31ea898e 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -1811,6 +1811,8 @@ def _get_chunk_data(self, conn, container, obj, headers, manifest=None):
         return chunks
 
     def _is_identical(self, chunk_data, path):
+        if path is None:
+            return False
         try:
             fp = open(path, 'rb', DISK_BUFFER)
         except IOError:
diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 19a224a2..894cd291 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -17,6 +17,7 @@
 from __future__ import print_function, unicode_literals
 
 import argparse
+import io
 import json
 import logging
 import signal
@@ -26,7 +27,7 @@
 from os.path import isfile, isdir, join
 from six import text_type, PY2
 from six.moves.urllib.parse import unquote, urlparse
-from sys import argv as sys_argv, exit, stderr
+from sys import argv as sys_argv, exit, stderr, stdin
 from time import gmtime, strftime
 
 from swiftclient import RequestException
@@ -901,7 +902,9 @@ def st_copy(parser, args, output_manager):
 Positional arguments:
   <container>           Name of container to upload to.
   <file_or_directory>   Name of file or directory to upload. Specify multiple
-                        times for multiple uploads.
+                        times for multiple uploads. If "-" is specified, reads
+                        content from standard input (--object-name is required
+                        in this case).
 
 Optional arguments:
   -c, --changed         Only upload files that have changed since the last
@@ -1002,6 +1005,11 @@ def st_upload(parser, args, output_manager):
     else:
         container = args[0]
         files = args[1:]
+        from_stdin = '-' in files
+        if from_stdin and len(files) > 1:
+            output_manager.error(
+                'upload from stdin cannot be used along with other files')
+            return
 
     if options['object_name'] is not None:
         if len(files) > 1:
@@ -1009,6 +1017,10 @@ def st_upload(parser, args, output_manager):
             return
         else:
             orig_path = files[0]
+    elif from_stdin:
+        output_manager.error(
+            'object-name must be specified with uploads from stdin')
+        return
 
     if options['segment_size']:
         try:
@@ -1047,6 +1059,14 @@ def st_upload(parser, args, output_manager):
             objs = []
             dir_markers = []
             for f in files:
+                if f == '-':
+                    fd = io.open(stdin.fileno(), mode='rb')
+                    objs.append(SwiftUploadObject(
+                        fd, object_name=options['object_name']))
+                    # We ensure that there is exactly one "file" to upload in
+                    # this case -- stdin
+                    break
+
                 if isfile(f):
                     objs.append(f)
                 elif isdir(f):
@@ -1060,7 +1080,7 @@ def st_upload(parser, args, output_manager):
 
             # Now that we've collected all the required files and dir markers
             # build the tuples for the call to upload
-            if options['object_name'] is not None:
+            if options['object_name'] is not None and not from_stdin:
                 objs = [
                     SwiftUploadObject(
                         o, object_name=o.replace(
diff --git a/tests/unit/test_shell.py b/tests/unit/test_shell.py
index 4c47db14..2e20a876 100644
--- a/tests/unit/test_shell.py
+++ b/tests/unit/test_shell.py
@@ -27,6 +27,7 @@
 
 from requests.packages.urllib3.exceptions import InsecureRequestWarning
 import six
+import sys
 
 import swiftclient
 from swiftclient.service import SwiftError
@@ -719,7 +720,7 @@ def test_upload(self, connection, walk):
                 'x-object-meta-mtime': mock.ANY,
             },
             query_string='multipart-manifest=put',
-            response_dict={})
+            response_dict=mock.ANY)
 
     @mock.patch('swiftclient.service.SwiftService.upload')
     def test_upload_object_with_account_readonly(self, upload):
@@ -905,6 +906,44 @@ def test_upload_segments_to_same_container(self, connection):
                      'x-object-meta-mtime': mock.ANY},
             response_dict={})
 
+    @mock.patch('swiftclient.shell.io.open')
+    @mock.patch('swiftclient.service.SwiftService.upload')
+    def test_upload_from_stdin(self, upload_mock, io_open_mock):
+        def fake_open(fd, mode):
+            mock_io = mock.Mock()
+            mock_io.fileno.return_value = fd
+            return mock_io
+
+        io_open_mock.side_effect = fake_open
+
+        argv = ["", "upload", "container", "-", "--object-name", "foo"]
+        swiftclient.shell.main(argv)
+        upload_mock.assert_called_once_with("container", mock.ANY)
+        # This is a little convoluted: we want to examine the first call ([0]),
+        # the argv list([1]), the second parameter ([1]), and the first
+        # element.  This is because the upload method takes a container and a
+        # list of SwiftUploadObjects.
+        swift_upload_obj = upload_mock.mock_calls[0][1][1][0]
+        self.assertEqual(sys.stdin.fileno(), swift_upload_obj.source.fileno())
+        io_open_mock.assert_called_once_with(sys.stdin.fileno(), mode='rb')
+
+    @mock.patch('swiftclient.service.SwiftService.upload')
+    def test_upload_from_stdin_no_name(self, upload_mock):
+        argv = ["", "upload", "container", "-"]
+        with CaptureOutput() as out:
+            self.assertRaises(SystemExit, swiftclient.shell.main, argv)
+            self.assertEqual(0, len(upload_mock.mock_calls))
+            self.assertTrue(out.err.find('object-name must be specified') >= 0)
+
+    @mock.patch('swiftclient.service.SwiftService.upload')
+    def test_upload_from_stdin_and_others(self, upload_mock):
+        argv = ["", "upload", "container", "-", "foo", "--object-name", "bar"]
+        with CaptureOutput() as out:
+            self.assertRaises(SystemExit, swiftclient.shell.main, argv)
+            self.assertEqual(0, len(upload_mock.mock_calls))
+            self.assertTrue(out.err.find(
+                'upload from stdin cannot be used') >= 0)
+
     @mock.patch.object(swiftclient.service.SwiftService,
                        '_bulk_delete_page_size', lambda *a: 0)
     @mock.patch('swiftclient.service.Connection')

From e1945ea0fac3badd23013b5b559be1f8a79bf114 Mon Sep 17 00:00:00 2001
From: John Dickinson <me@not.mn>
Date: Thu, 20 Jul 2017 16:50:08 -0700
Subject: [PATCH 078/316] 3.4.0 authors/changelog update

Change-Id: Ib6a7c97ff90f03a26fe7396c0104c5a0c483c226
---
 AUTHORS                                       |  7 +++++
 ChangeLog                                     | 28 +++++++++++++++++++
 .../notes/340_notes-1777780bbfdb4d96.yaml     | 20 +++++++++++++
 3 files changed, 55 insertions(+)
 create mode 100644 releasenotes/notes/340_notes-1777780bbfdb4d96.yaml

diff --git a/AUTHORS b/AUTHORS
index 7c162e02..bf69dba5 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -65,11 +65,14 @@ Josh Gachnang (josh@pcsforeducation.com)
 Juan J. Martinez (juan@memset.com)
 Jude Job (judeopenstack@gmail.com)
 Julien Danjou (julien@danjou.info)
+Kazufumi Noto (noto.kazufumi@gmail.com)
 Kota Tsuyuzaki (tsuyuzaki.kota@lab.ntt.co.jp)
 Kun Huang (gareth@unitedstack.com)
 Leah Klearman (lklrmn@gmail.com)
 Li Riqiang (lrqrun@gmail.com)
+liuyamin (liuyamin@fiberhome.com)
 Luis de Bethencourt (luis@debethencourt.com)
+M V P Nitesh (m.nitesh@nectechnologies.in)
 Mahati Chamarthy (mahati.chamarthy@gmail.com)
 Marek Kaleta (marek.kaleta@firma.seznam.cz)
 Mark Seger (mark.seger@hpe.com)
@@ -82,6 +85,7 @@ Min Min Ren (rminmin@cn.ibm.com)
 Mohit Motiani (mohit.motiani@intel.com)
 Monty Taylor (mordred@inaugust.com)
 Nandini Tata (nandini.tata@intel.com)
+Nelson Marcos (nelsonmarcos@gmail.com)
 Nguyen Hung Phuong (phuongnh@vn.fujitsu.com)
 Nick Craig-Wood (nick@craig-wood.com)
 Ondrej Novy (ondrej.novy@firma.seznam.cz)
@@ -90,6 +94,7 @@ Paul Belanger (pabelanger@redhat.com)
 Paulo Ewerton (pauloewerton@lsd.ufcg.edu.br)
 Pete Zaitcev (zaitcev@kotori.zaitcev.us)
 Peter Lisak (peter.lisak@firma.seznam.cz)
+Petr Kovar (pkovar@redhat.com)
 Pradeep Kumar Singh (pradeep.singh@nectechnologies.in)
 Pratik Mallya (pratik.mallya@gmail.com)
 Qiu Yu (qiuyu@ebaysf.com)
@@ -120,12 +125,14 @@ Thiago da Silva (thiago@redhat.com)
 Thomas Goirand (thomas@goirand.fr)
 Tihomir Trifonov (t.trifonov@gmail.com)
 Tim Burke (tim.burke@gmail.com)
+Timur Alperovich (timuralp@swiftstack.com)
 Tong Li (litong01@us.ibm.com)
 Tony Breeds (tony@bakeyournoodle.com)
 Tristan Cacqueray (tristan.cacqueray@enovance.com)
 Vasyl Khomenko (vasiliyk@yahoo-inc.com)
 venkatamahesh (venkatamaheshkotha@gmail.com)
 Victor Stinner (victor.stinner@enovance.com)
+Vitaly Gridnev (vgridnev@mirantis.com)
 wangxiyuan (wangxiyuan@huawei.com)
 Wu Wenxiang (wu.wenxiang@99cloud.net)
 YangLei (yanglyy@cn.ibm.com)
diff --git a/ChangeLog b/ChangeLog
index 749d22cb..967d7e22 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,31 @@
+3.4.0
+-----
+
+* The `swift` CLI now supports streaming from stdin. If "-" is given
+  as the source, the object content is read from stdin. The
+  `--object-name` must be given when content is loaded from stdin.
+
+* Tolerate RFC-compliant ETags returned from the server.
+
+* Skip checksum validation on partial downloads.
+
+* Buffer reads from disk, resulting in much faster upload throughput.
+
+* Added support for ISO 8601 timestamps for tempurl, matching the
+  feature in Swift 2.13.0.
+
+* Added an option to ignore mtime metadata entry (`--ignore-mtime`).
+
+* When using SwiftService to delete many objects, the bulk delete page
+  size will now be respected. Previously, exceeding this limit would
+  prevent any objects from being deleted.
+
+* Expose `--prefix` as an option for st_delete.
+
+* Imported docs content from openstack-manuals project.
+
+* Various other minor bug fixes and improvements.
+
 3.3.0
 -----
 
diff --git a/releasenotes/notes/340_notes-1777780bbfdb4d96.yaml b/releasenotes/notes/340_notes-1777780bbfdb4d96.yaml
new file mode 100644
index 00000000..0aae5cf3
--- /dev/null
+++ b/releasenotes/notes/340_notes-1777780bbfdb4d96.yaml
@@ -0,0 +1,20 @@
+---
+features:
+
+  - The ``swift`` CLI now supports streaming from stdin. If "-" is given
+    as the source, the object content is read from stdin. The
+    ``--object-name`` must be given when content is loaded from stdin.
+  - Tolerate RFC-compliant ETags returned from the server.
+  - Skip checksum validation on partial downloads.
+  - Buffer reads from disk, resulting in much faster upload throughput.
+  - >
+    Added support for ISO 8601 timestamps for tempurl, matching the
+    feature in Swift 2.13.0.
+  - Added an option to ignore mtime metadata entry (``--ignore-mtime``).
+  - >
+    When using SwiftService to delete many objects, the bulk delete page
+    size will now be respected. Previously, exceeding this limit would
+    prevent any objects from being deleted.
+  - Expose `--prefix` as an option for st_delete.
+  - Imported docs content from openstack-manuals project.
+  - Various other minor bug fixes and improvements.

From ed0858a4e4f94b723bb93b71142f88c318992cfe Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Tue, 8 Aug 2017 22:03:54 +0000
Subject: [PATCH 079/316] Add releasenotes tox env

After this, we need to

* add release notes jobs for python-swiftclient in openstack-infra/project-config
* add release notes links for python-swiftclient in openstack/releases

For the corresponding change in the swift repo, see
I4e5f1ce1fcfbb2943036c821a24a0b4a3a2d9fc8

Change-Id: Iea6ed2ee26873edb3ef10146cdc906cf1a236255
---
 releasenotes/source/conf.py     | 360 ++++++++++++++++++++++++++++++++
 releasenotes/source/current.rst |   5 +
 releasenotes/source/index.rst   |  11 +
 releasenotes/source/newton.rst  |   6 +
 releasenotes/source/ocata.rst   |   6 +
 releasenotes/source/pike.rst    |   6 +
 test-requirements.txt           |   2 +
 tox.ini                         |   3 +
 8 files changed, 399 insertions(+)
 create mode 100644 releasenotes/source/conf.py
 create mode 100644 releasenotes/source/current.rst
 create mode 100644 releasenotes/source/index.rst
 create mode 100644 releasenotes/source/newton.rst
 create mode 100644 releasenotes/source/ocata.rst
 create mode 100644 releasenotes/source/pike.rst

diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
new file mode 100644
index 00000000..ec105fa9
--- /dev/null
+++ b/releasenotes/source/conf.py
@@ -0,0 +1,360 @@
+# -*- coding: utf-8 -*-
+# 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.
+
+# swift documentation build configuration file, created by
+# sphinx-quickstart on Mon Oct  3 17:01:55 2016.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+import datetime
+from swiftclient import __version__
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'reno.sphinxext',
+    'openstackdocstheme',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+# templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The encoding of source files.
+#
+# source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Swift Client Release Notes'
+copyright = u'%d, OpenStack Foundation' % datetime.datetime.now().year
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = __version__.rsplit('.', 1)[0]
+# The full version, including alpha/beta/rc tags.
+release = __version__
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#
+# today = ''
+#
+# Else, today_fmt is used as the format for a strftime call.
+#
+# today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#
+# default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#
+# add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#
+# add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#
+# show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+# modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+# keep_warnings = False
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+# todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'openstackdocs'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+# html_theme_path = []
+
+# The name for this set of Sphinx documents.
+# "<project> v<release> documentation" by default.
+#
+# html_title = u'swift v2.10.0'
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#
+# html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#
+# html_logo = None
+
+# The name of an image file (relative to this directory) to use as a favicon of
+# the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#
+# html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+# html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#
+# html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+# html_last_updated_fmt = '%b %d, %Y'
+html_last_updated_fmt = '%Y-%m-%d %H:%M'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#
+# html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#
+# html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#
+# html_additional_pages = {}
+
+# If false, no module index is generated.
+#
+# html_domain_indices = True
+
+# If false, no index is generated.
+#
+# html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#
+# html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#
+# html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#
+# html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#
+# html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#
+# html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+# html_file_suffix = None
+
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
+#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
+#
+# html_search_language = 'en'
+
+# A dictionary with options for the search language support, empty by default.
+# 'ja' uses this config value.
+# 'zh' user can custom change `jieba` dictionary path.
+#
+# html_search_options = {'type': 'default'}
+
+# The name of a javascript file (relative to the configuration directory) that
+# implements a search results scorer. If empty, the default will be used.
+#
+# html_search_scorer = 'scorer.js'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'SwiftClientReleaseNotesdoc'
+
+# -- Options for LaTeX output ---------------------------------------------
+
+# latex_elements = {
+#      # The paper size ('letterpaper' or 'a4paper').
+#      #
+#      # 'papersize': 'letterpaper',
+
+#      # The font size ('10pt', '11pt' or '12pt').
+#      #
+#      # 'pointsize': '10pt',
+
+#      # Additional stuff for the LaTeX preamble.
+#      #
+#      # 'preamble': '',
+
+#      # Latex figure (float) alignment
+#      #
+#      # 'figure_align': 'htbp',
+# }
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+# latex_documents = [
+#     (master_doc, 'swift.tex', u'swift Documentation',
+#      u'swift', 'manual'),
+# ]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#
+# latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#
+# latex_use_parts = False
+
+# If true, show page references after internal links.
+#
+# latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#
+# latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#
+# latex_appendices = []
+
+# It false, will not define \strong, \code, 	itleref, \crossref ... but only
+# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
+# packages.
+#
+# latex_keep_old_macro_names = True
+
+# If false, no module index is generated.
+#
+# latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+# man_pages = [
+#     (master_doc, 'swift', u'swift Documentation',
+#      [author], 1)
+# ]
+
+# If true, show URL addresses after external links.
+#
+# man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+# texinfo_documents = [
+#     (master_doc, 'swift', u'swift Documentation',
+#      author, 'swift', 'One line description of project.',
+#      'Miscellaneous'),
+# ]
+
+# Documents to append as an appendix to all manuals.
+#
+# texinfo_appendices = []
+
+# If false, no module index is generated.
+#
+# texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#
+# texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#
+# texinfo_no_detailmenu = False
+
+locale_dirs = ['locale/']
+
+# -- Options for openstackdocstheme -------------------------------------------
+repository_name = 'openstack/python-swiftclient'
+bug_project = 'python-swiftclient'
+bug_tag = ''
diff --git a/releasenotes/source/current.rst b/releasenotes/source/current.rst
new file mode 100644
index 00000000..87a748f2
--- /dev/null
+++ b/releasenotes/source/current.rst
@@ -0,0 +1,5 @@
+====================================
+ Current (Unreleased) Release Notes
+====================================
+
+.. release-notes::
diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst
new file mode 100644
index 00000000..6e3419df
--- /dev/null
+++ b/releasenotes/source/index.rst
@@ -0,0 +1,11 @@
+============================
+ Swift Client Release Notes
+============================
+
+.. toctree::
+   :maxdepth: 1
+
+   current
+   pike
+   ocata
+   newton
diff --git a/releasenotes/source/newton.rst b/releasenotes/source/newton.rst
new file mode 100644
index 00000000..59418a33
--- /dev/null
+++ b/releasenotes/source/newton.rst
@@ -0,0 +1,6 @@
+=============================
+ Newton Series Release Notes
+=============================
+
+.. release-notes::
+   :branch: stable/newton
diff --git a/releasenotes/source/ocata.rst b/releasenotes/source/ocata.rst
new file mode 100644
index 00000000..726307b4
--- /dev/null
+++ b/releasenotes/source/ocata.rst
@@ -0,0 +1,6 @@
+============================
+ Ocata Series Release Notes
+============================
+
+.. release-notes::
+   :branch: stable/ocata
diff --git a/releasenotes/source/pike.rst b/releasenotes/source/pike.rst
new file mode 100644
index 00000000..e2c48067
--- /dev/null
+++ b/releasenotes/source/pike.rst
@@ -0,0 +1,6 @@
+===========================
+ Pike Series Release Notes
+===========================
+
+.. release-notes::
+   :branch: stable/pike
diff --git a/test-requirements.txt b/test-requirements.txt
index 0ce9cece..a9a0c7fb 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -5,3 +5,5 @@ mock>=1.2
 oslosphinx>=4.7.0  # Apache-2.0
 sphinx>=1.1.2,<1.2
 testrepository>=0.0.18
+reno>=1.8.0,!=2.3.1 # Apache-2.0
+openstackdocstheme>=1.16.0 # Apache-2.0
diff --git a/tox.ini b/tox.ini
index df01bf8a..1be9a39c 100644
--- a/tox.ini
+++ b/tox.ini
@@ -71,3 +71,6 @@ exclude = .venv,.tox,dist,doc,*egg
 usedevelop = False
 deps = bindep
 commands = bindep test
+
+[testenv:releasenotes]
+commands = sphinx-build -a -W -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html

From f323bb4824d98e74fdd5e357526ce678d0f7d45a Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Tue, 8 Aug 2017 22:40:10 +0000
Subject: [PATCH 080/316] Trying out the new releasenotes jobs

Change-Id: I96a29ab48cd7a349d0eb17efce7df097d4174cbe
Depends-On: I5820bb2ffa0e3c65ac846ced97435b7c3086aefc
---
 releasenotes/source/conf.py | 1 +
 1 file changed, 1 insertion(+)

diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index ec105fa9..214bcef6 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -33,6 +33,7 @@
 # sys.path.insert(0, os.path.abspath('.'))
 
 import datetime
+
 from swiftclient import __version__
 
 # -- General configuration ------------------------------------------------

From ae5fd46e8772e50a0ab2ac89216188b1cdc83d8e Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 25 Aug 2017 12:13:12 -0700
Subject: [PATCH 081/316] Stop mutating header dicts

Change-Id: Ia1638c216eff9db6fbe416bc0570c27cfdcfe730
---
 swiftclient/client.py          | 65 ++++++++++++++++++----------------
 tests/unit/test_swiftclient.py | 15 ++++++--
 2 files changed, 47 insertions(+), 33 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index 80bc4a3a..95e89b8f 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -302,7 +302,7 @@ def __init__(self, resp, connection, container, obj,
         self.obj = obj
         self.query_string = query_string
         self.response_dict = response_dict
-        self.headers = headers if headers is not None else {}
+        self.headers = dict(headers) if headers is not None else {}
         self.bytes_read = 0
 
     def read(self, length=None):
@@ -834,13 +834,15 @@ def post_account(url, token, headers, http_conn=None, response_dict=None,
     path = parsed.path
     if query_string:
         path += '?' + query_string
-    headers['X-Auth-Token'] = token
+    req_headers = {'X-Auth-Token': token}
     if service_token:
-        headers['X-Service-Token'] = service_token
-    conn.request(method, path, data, headers)
+        req_headers['X-Service-Token'] = service_token
+    if headers:
+        req_headers.update(headers)
+    conn.request(method, path, data, req_headers)
     resp = conn.getresponse()
     body = resp.read()
-    http_log((url, method,), {'headers': headers}, resp, body)
+    http_log((url, method,), {'headers': req_headers}, resp, body)
 
     store_response(resp, response_dict)
 
@@ -882,12 +884,6 @@ def get_container(url, token, container, marker=None, limit=None,
     """
     if not http_conn:
         http_conn = http_connection(url)
-    if headers:
-        headers = dict(headers)
-    else:
-        headers = {}
-    headers['X-Auth-Token'] = token
-    headers['Accept-Encoding'] = 'gzip'
     if full_listing:
         rv = get_container(url, token, container, marker, limit, prefix,
                            delimiter, end_marker, path, http_conn,
@@ -922,17 +918,20 @@ def get_container(url, token, container, marker=None, limit=None,
         qs += '&path=%s' % quote(path)
     if query_string:
         qs += '&%s' % query_string.lstrip('?')
+    req_headers = {'X-Auth-Token': token, 'Accept-Encoding': 'gzip'}
     if service_token:
-        headers['X-Service-Token'] = service_token
+        req_headers['X-Service-Token'] = service_token
+    if headers:
+        req_headers.update(headers)
     method = 'GET'
-    conn.request(method, '%s?%s' % (cont_path, qs), '', headers)
+    conn.request(method, '%s?%s' % (cont_path, qs), '', req_headers)
     resp = conn.getresponse()
     body = resp.read()
     http_log(('%(url)s%(cont_path)s?%(qs)s' %
               {'url': url.replace(parsed.path, ''),
                'cont_path': cont_path,
                'qs': qs}, method,),
-             {'headers': headers}, resp, body)
+             {'headers': req_headers}, resp, body)
 
     if resp.status < 200 or resp.status >= 300:
         raise ClientException.from_response(resp, 'Container GET failed', body)
@@ -1005,23 +1004,23 @@ def put_container(url, token, container, headers=None, http_conn=None,
         parsed, conn = http_connection(url)
     path = '%s/%s' % (parsed.path, quote(container))
     method = 'PUT'
-    if not headers:
-        headers = {}
-    headers['X-Auth-Token'] = token
+    req_headers = {'X-Auth-Token': token}
     if service_token:
-        headers['X-Service-Token'] = service_token
-    if 'content-length' not in (k.lower() for k in headers):
-        headers['Content-Length'] = '0'
+        req_headers['X-Service-Token'] = service_token
+    if headers:
+        req_headers.update(headers)
+    if 'content-length' not in (k.lower() for k in req_headers):
+        req_headers['Content-Length'] = '0'
     if query_string:
         path += '?' + query_string.lstrip('?')
-    conn.request(method, path, '', headers)
+    conn.request(method, path, '', req_headers)
     resp = conn.getresponse()
     body = resp.read()
 
     store_response(resp, response_dict)
 
     http_log(('%s%s' % (url.replace(parsed.path, ''), path), method,),
-             {'headers': headers}, resp, body)
+             {'headers': req_headers}, resp, body)
     if resp.status < 200 or resp.status >= 300:
         raise ClientException.from_response(resp, 'Container PUT failed', body)
 
@@ -1048,16 +1047,18 @@ def post_container(url, token, container, headers, http_conn=None,
         parsed, conn = http_connection(url)
     path = '%s/%s' % (parsed.path, quote(container))
     method = 'POST'
-    headers['X-Auth-Token'] = token
+    req_headers = {'X-Auth-Token': token}
     if service_token:
-        headers['X-Service-Token'] = service_token
+        req_headers['X-Service-Token'] = service_token
+    if headers:
+        req_headers.update(headers)
     if 'content-length' not in (k.lower() for k in headers):
-        headers['Content-Length'] = '0'
-    conn.request(method, path, '', headers)
+        req_headers['Content-Length'] = '0'
+    conn.request(method, path, '', req_headers)
     resp = conn.getresponse()
     body = resp.read()
     http_log(('%s%s' % (url.replace(parsed.path, ''), path), method,),
-             {'headers': headers}, resp, body)
+             {'headers': req_headers}, resp, body)
 
     store_response(resp, response_dict)
 
@@ -1352,14 +1353,16 @@ def post_object(url, token, container, name, headers, http_conn=None,
     else:
         parsed, conn = http_connection(url)
     path = '%s/%s/%s' % (parsed.path, quote(container), quote(name))
-    headers['X-Auth-Token'] = token
+    req_headers = {'X-Auth-Token': token}
     if service_token:
-        headers['X-Service-Token'] = service_token
-    conn.request('POST', path, '', headers)
+        req_headers['X-Service-Token'] = service_token
+    if headers:
+        req_headers.update(headers)
+    conn.request('POST', path, '', req_headers)
     resp = conn.getresponse()
     body = resp.read()
     http_log(('%s%s' % (url.replace(parsed.path, ''), path), 'POST',),
-             {'headers': headers}, resp, body)
+             {'headers': req_headers}, resp, body)
 
     store_response(resp, response_dict)
 
diff --git a/tests/unit/test_swiftclient.py b/tests/unit/test_swiftclient.py
index 5384ac7f..852c2d39 100644
--- a/tests/unit/test_swiftclient.py
+++ b/tests/unit/test_swiftclient.py
@@ -680,9 +680,10 @@ def test_ok(self):
         c.http_connection = self.fake_http_connection(200, headers={
             'X-Account-Meta-Color': 'blue',
         }, body='foo')
+        headers = {'x-account-meta-shape': 'square'}
         resp_headers, body = c.post_account(
             'http://www.tests.com/path/to/account', 'asdf',
-            {'x-account-meta-shape': 'square'}, query_string='bar=baz',
+            headers, query_string='bar=baz',
             data='some data')
         self.assertEqual('blue', resp_headers.get('x-account-meta-color'))
         self.assertEqual('foo', body)
@@ -691,6 +692,8 @@ def test_ok(self):
              'some data', {'x-auth-token': 'asdf',
                            'x-account-meta-shape': 'square'})
         ])
+        # Check that we didn't mutate the request ehader dict
+        self.assertEqual(headers, {'x-account-meta-shape': 'square'})
 
     def test_server_error(self):
         body = 'c' * 65
@@ -1434,6 +1437,11 @@ def test_ok(self):
                 'X-Object-Meta-Test': 'mymeta',
                 'X-Delete-At': delete_at}),
         ])
+        # Check that the request header dict didn't get mutated
+        self.assertEqual(args[-1], {
+            'X-Object-Meta-Test': 'mymeta',
+            'X-Delete-At': delete_at,
+        })
 
     def test_unicode_ok(self):
         conn = c.http_connection(u'http://www.test.com/')
@@ -2996,10 +3004,11 @@ def test_service_token_head_container(self):
         self.assertEqual(conn.attempts, 1)
 
     def test_service_token_post_container(self):
+        headers = {'X-Container-Meta-Color': 'blue'}
         with mock.patch('swiftclient.client.http_connection',
                         self.fake_http_connection(201)):
             conn = self.get_connection()
-            conn.post_container('container1', {})
+            conn.post_container('container1', headers)
         self.assertEqual(1, len(self.request_log), self.request_log)
         for actual in self.iter_request_log():
             self.assertEqual('POST', actual['method'])
@@ -3009,6 +3018,8 @@ def test_service_token_post_container(self):
             self.assertEqual('http://storage_url.com/container1',
                              actual['full_path'])
         self.assertEqual(conn.attempts, 1)
+        # Check that we didn't mutate the request header dict
+        self.assertEqual(headers, {'X-Container-Meta-Color': 'blue'})
 
     def test_service_token_put_container(self):
         with mock.patch('swiftclient.client.http_connection',

From 3be8eca70b53148f2dbcbab98dafd04b07e99da6 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Tue, 29 Aug 2017 09:47:11 -0700
Subject: [PATCH 082/316] Add pypy-devel for RPM-based systems

Also, don't try to do any pypy stuff on Fedora -- apparently that's only
available from the Everything repo instead of the stripped-down Server
one the gate images use? I only wanted Fedora for py36 testing, anyway.

Change-Id: Iba8142e4e1093cf7f7a9dcf782288364d43cb64d
---
 bindep.txt | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/bindep.txt b/bindep.txt
index e3ea9c18..cc3a7700 100644
--- a/bindep.txt
+++ b/bindep.txt
@@ -2,5 +2,6 @@
 # see http://docs.openstack.org/infra/bindep/ for additional information.
 
 curl
-pypy [test]
-pypy-dev [test]
+pypy [test !platform:fedora]
+pypy-dev [test platform:dpkg]
+pypy-devel [test platform:rpm !platform:fedora]

From f48f421a86a9086c50211d4c50d639c5b4a46c7c Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Thu, 16 Nov 2017 20:49:19 +0100
Subject: [PATCH 083/316] Remove setting of version/release from releasenotes

Release notes are version independent, so remove version/release
values. We've found that projects now require the service package
to be installed in order to build release notes, and this is entirely
due to the current convention of pulling in the version information.

Release notes should not need installation in order to build, so this
unnecessary version setting needs to be removed.

This is needed for new release notes publishing, see
I56909152975f731a9d2c21b2825b972195e48ee8 and the discussion starting
at
http://lists.openstack.org/pipermail/openstack-dev/2017-November/124480.html
.

Change-Id: I623fe918c1e4ddafa93efc91ed550a365cec1cf0
---
 releasenotes/source/conf.py | 11 +++--------
 1 file changed, 3 insertions(+), 8 deletions(-)

diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index 214bcef6..b27aa963 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -34,8 +34,6 @@
 
 import datetime
 
-from swiftclient import __version__
-
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
@@ -70,14 +68,11 @@
 project = u'Swift Client Release Notes'
 copyright = u'%d, OpenStack Foundation' % datetime.datetime.now().year
 
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
+# Release notes are version independent.
 # The short X.Y version.
-version = __version__.rsplit('.', 1)[0]
+version = ''
 # The full version, including alpha/beta/rc tags.
-release = __version__
+release = ''
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

From ae2dfaec367dabadb4c74a5d635d9633247465f1 Mon Sep 17 00:00:00 2001
From: Monty Taylor <mordred@inaugust.com>
Date: Wed, 22 Nov 2017 07:20:00 -0600
Subject: [PATCH 084/316] Update tox_install.sh to align for sphinx jobs

The updates to the sphinx docs jobs in support of the updates to
the PTI wound up exposing an unintended interface. There are two flavors
of the tox_install.sh file out there, and we basically need to collapse
them into one flavor.

Update the tox_install.sh script to match the
constraints-as-first-argument form.

Change-Id: I7cb4b44952713752435e1faf0f63bf0d37e7dda6
---
 tools/tox_install.sh | 41 ++++++++++++++++++++---------------------
 tox.ini              |  3 +--
 2 files changed, 21 insertions(+), 23 deletions(-)

diff --git a/tools/tox_install.sh b/tools/tox_install.sh
index 15aa9dec..43468e45 100755
--- a/tools/tox_install.sh
+++ b/tools/tox_install.sh
@@ -4,28 +4,27 @@
 # with installing the client from source. We should remove the version pin in
 # the constraints file before applying it for from-source installation.
 
+CONSTRAINTS_FILE=$1
+shift 1
+
 set -e
 
-if [[ -z "$CONSTRAINTS_FILE" ]]; then
-    echo 'WARNING: expected $CONSTRAINTS_FILE to be set' >&2
-    PIP_FLAGS=(-U)
-else
-    # NOTE(tonyb): Place this in the tox enviroment's log dir so it will get
-    # published to logs.openstack.org for easy debugging.
-    localfile="$VIRTUAL_ENV/log/upper-constraints.txt"
-
-    if [[ "$CONSTRAINTS_FILE" != http* ]]; then
-        CONSTRAINTS_FILE="file://$CONSTRAINTS_FILE"
-    fi
-    curl "$CONSTRAINTS_FILE" --insecure --progress-bar --output "$localfile"
-
-    pip install -c"$localfile" openstack-requirements
-
-    # This is the main purpose of the script: Allow local installation of
-    # the current repo. It is listed in constraints file and thus any
-    # install will be constrained and we need to unconstrain it.
-    edit-constraints "$localfile" -- "$CLIENT_NAME"
-    PIP_FLAGS=(-c"$localfile" -U)
+# NOTE(tonyb): Place this in the tox enviroment's log dir so it will get
+# published to logs.openstack.org for easy debugging.
+localfile="$VIRTUAL_ENV/log/upper-constraints.txt"
+
+if [[ $CONSTRAINTS_FILE != http* ]]; then
+    CONSTRAINTS_FILE=file://$CONSTRAINTS_FILE
 fi
+# NOTE(tonyb): need to add curl to bindep.txt if the project supports bindep
+curl $CONSTRAINTS_FILE --insecure --progress-bar --output $localfile
+
+pip install -c$localfile openstack-requirements
+
+# This is the main purpose of the script: Allow local installation of
+# the current repo. It is listed in constraints file and thus any
+# install will be constrained and we need to unconstrain it.
+edit-constraints $localfile -- $CLIENT_NAME
 
-pip install "${PIP_FLAGS[@]}" "$@"
+pip install -c$localfile -U $*
+exit $?
diff --git a/tox.ini b/tox.ini
index 1be9a39c..303ce660 100644
--- a/tox.ini
+++ b/tox.ini
@@ -5,13 +5,12 @@ skipsdist = True
 
 [testenv]
 usedevelop = True
-install_command = {toxinidir}/tools/tox_install.sh {opts} {packages}
+install_command = {toxinidir}/tools/tox_install.sh {env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} {opts} {packages}
 setenv =
   LANG=en_US.utf8
   VIRTUAL_ENV={envdir}
   BRANCH_NAME=master
   CLIENT_NAME=python-swiftclient
-  CONSTRAINTS_FILE={env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt}
 
 deps = -r{toxinidir}/requirements.txt
        -r{toxinidir}/test-requirements.txt

From cb2778659e8d69d8741ca3167314862f8555a989 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Tue, 28 Nov 2017 11:02:45 -0800
Subject: [PATCH 085/316] Make tox runnable in a directory with spaces

I noticed a disturbing lack of quote-wrapping in change
I7cb4b44952713752435e1faf0f63bf0d37e7dda6 but as I poked at it, I
realized that trouble runs rampant.

This seems to clean it all up, though I haven't tested *every*
environment we define.

Change-Id: I1454eb113e5bd9125d39f2e57e2ed96f6ddc42fc
---
 tools/tox_install.sh | 14 +++++++-------
 tox.ini              |  5 +++--
 2 files changed, 10 insertions(+), 9 deletions(-)

diff --git a/tools/tox_install.sh b/tools/tox_install.sh
index 43468e45..f3a83e94 100755
--- a/tools/tox_install.sh
+++ b/tools/tox_install.sh
@@ -4,7 +4,7 @@
 # with installing the client from source. We should remove the version pin in
 # the constraints file before applying it for from-source installation.
 
-CONSTRAINTS_FILE=$1
+CONSTRAINTS_FILE="$1"
 shift 1
 
 set -e
@@ -13,18 +13,18 @@ set -e
 # published to logs.openstack.org for easy debugging.
 localfile="$VIRTUAL_ENV/log/upper-constraints.txt"
 
-if [[ $CONSTRAINTS_FILE != http* ]]; then
-    CONSTRAINTS_FILE=file://$CONSTRAINTS_FILE
+if [[ "$CONSTRAINTS_FILE" != http* ]]; then
+    CONSTRAINTS_FILE="file://$CONSTRAINTS_FILE"
 fi
 # NOTE(tonyb): need to add curl to bindep.txt if the project supports bindep
-curl $CONSTRAINTS_FILE --insecure --progress-bar --output $localfile
+curl "$CONSTRAINTS_FILE" --insecure --progress-bar --output "$localfile"
 
-pip install -c$localfile openstack-requirements
+python -m pip install -c"$localfile" openstack-requirements
 
 # This is the main purpose of the script: Allow local installation of
 # the current repo. It is listed in constraints file and thus any
 # install will be constrained and we need to unconstrain it.
-edit-constraints $localfile -- $CLIENT_NAME
+python "$(which edit-constraints)" "$localfile" -- $CLIENT_NAME
 
-pip install -c$localfile -U $*
+python -m pip install -c"$localfile" -U "$@"
 exit $?
diff --git a/tox.ini b/tox.ini
index 303ce660..e7372413 100644
--- a/tox.ini
+++ b/tox.ini
@@ -5,7 +5,8 @@ skipsdist = True
 
 [testenv]
 usedevelop = True
-install_command = {toxinidir}/tools/tox_install.sh {env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} {opts} {packages}
+install_command = "{toxinidir}/tools/tox_install.sh" "{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt}" {opts} {packages}
+list_dependencies_command = python -m pip freeze
 setenv =
   LANG=en_US.utf8
   VIRTUAL_ENV={envdir}
@@ -24,7 +25,7 @@ passenv = SWIFT_* *_proxy
 
 [testenv:pep8]
 commands =
-    flake8 swiftclient tests
+    python -m flake8 swiftclient tests
 
 [testenv:venv]
 commands = {posargs}

From a9b8f0a0d191873ac88b0c70166a2b889096fa69 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Wed, 17 Jan 2018 10:09:47 -0800
Subject: [PATCH 086/316] Revert "Add Constraints support"

Per http://lists.openstack.org/pipermail/openstack-dev/2017-December/125348.html

> For many projects, tox_install.sh is not needed at all

Let's see if that holds for python-swiftclient!

This reverts commit f2f278fcbec3ad52a1726bb5a3f775d13bcc99dc.

Change-Id: I0462c50ec71d87bac226f83a0d0942871ef5a0e7
---
 bindep.txt           |  1 -
 tools/tox_install.sh | 30 ------------------------------
 tox.ini              | 10 +++-------
 3 files changed, 3 insertions(+), 38 deletions(-)
 delete mode 100755 tools/tox_install.sh

diff --git a/bindep.txt b/bindep.txt
index cc3a7700..27f27363 100644
--- a/bindep.txt
+++ b/bindep.txt
@@ -1,7 +1,6 @@
 # This is a cross-platform list tracking distribution packages needed by tests;
 # see http://docs.openstack.org/infra/bindep/ for additional information.
 
-curl
 pypy [test !platform:fedora]
 pypy-dev [test platform:dpkg]
 pypy-devel [test platform:rpm !platform:fedora]
diff --git a/tools/tox_install.sh b/tools/tox_install.sh
deleted file mode 100755
index f3a83e94..00000000
--- a/tools/tox_install.sh
+++ /dev/null
@@ -1,30 +0,0 @@
-#!/usr/bin/env bash
-
-# Client constraint file contains this client version pin that is in conflict
-# with installing the client from source. We should remove the version pin in
-# the constraints file before applying it for from-source installation.
-
-CONSTRAINTS_FILE="$1"
-shift 1
-
-set -e
-
-# NOTE(tonyb): Place this in the tox enviroment's log dir so it will get
-# published to logs.openstack.org for easy debugging.
-localfile="$VIRTUAL_ENV/log/upper-constraints.txt"
-
-if [[ "$CONSTRAINTS_FILE" != http* ]]; then
-    CONSTRAINTS_FILE="file://$CONSTRAINTS_FILE"
-fi
-# NOTE(tonyb): need to add curl to bindep.txt if the project supports bindep
-curl "$CONSTRAINTS_FILE" --insecure --progress-bar --output "$localfile"
-
-python -m pip install -c"$localfile" openstack-requirements
-
-# This is the main purpose of the script: Allow local installation of
-# the current repo. It is listed in constraints file and thus any
-# install will be constrained and we need to unconstrain it.
-python "$(which edit-constraints)" "$localfile" -- $CLIENT_NAME
-
-python -m pip install -c"$localfile" -U "$@"
-exit $?
diff --git a/tox.ini b/tox.ini
index e7372413..541df654 100644
--- a/tox.ini
+++ b/tox.ini
@@ -5,13 +5,11 @@ skipsdist = True
 
 [testenv]
 usedevelop = True
-install_command = "{toxinidir}/tools/tox_install.sh" "{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt}" {opts} {packages}
+install_command = python -m pip install -U {opts} {packages}
 list_dependencies_command = python -m pip freeze
 setenv =
   LANG=en_US.utf8
   VIRTUAL_ENV={envdir}
-  BRANCH_NAME=master
-  CLIENT_NAME=python-swiftclient
 
 deps = -r{toxinidir}/requirements.txt
        -r{toxinidir}/test-requirements.txt
@@ -31,13 +29,11 @@ commands =
 commands = {posargs}
 
 [testenv:cover]
-commands = python setup.py testr --coverage
+commands = python setup.py testr --coverage 
            coverage report
 
 [testenv:func]
-setenv =
-    {[testenv]setenv}
-    OS_TEST_PATH=tests.functional
+setenv = OS_TEST_PATH=tests.functional
 whitelist_externals =
     coverage
     rm

From 2faea932870956583f83226886d33304ee1eee46 Mon Sep 17 00:00:00 2001
From: Timur Alperovich <timuralp@swiftstack.com>
Date: Wed, 28 Jun 2017 12:02:21 -0700
Subject: [PATCH 087/316] Allow for object uploads > 5GB from stdin.

When uploading from standard input, swiftclient should turn the upload
into an SLO in the case of large objects. This patch picks the
threshold as 10MB (and uses that as the default segment size). The
consumers can also supply the --segment-size option to alter that
threshold and the SLO segment size. The patch does buffer one segment
in memory (which is why 10MB default was chosen).

(test is updated)

Change-Id: Ib13e0b687bc85930c29fe9f151cf96bc53b2e594
---
 swiftclient/service.py     | 244 +++++++++++++++++++++++++++++++++----
 swiftclient/shell.py       |   8 ++
 tests/unit/test_service.py | 214 ++++++++++++++++++++++++++++++++
 tests/unit/utils.py        |  21 ++++
 4 files changed, 462 insertions(+), 25 deletions(-)

diff --git a/swiftclient/service.py b/swiftclient/service.py
index 7b5ecd44..ed5e9e98 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -1502,7 +1502,8 @@ def upload(self, container, objects, options=None):
             if hasattr(s, 'read'):
                 # We've got a file like object to upload to o
                 file_future = self.thread_manager.object_uu_pool.submit(
-                    self._upload_object_job, container, s, o, object_options
+                    self._upload_object_job, container, s, o, object_options,
+                    results_queue=rq
                 )
                 details['file'] = s
                 details['object'] = o
@@ -1784,6 +1785,132 @@ def _upload_segment_job(conn, path, container, segment_name, segment_start,
             if fp is not None:
                 fp.close()
 
+    @staticmethod
+    def _put_object(conn, container, name, content, headers=None, md5=None):
+        """
+        Upload object into a given container and verify the resulting ETag, if
+        the md5 optional parameter is passed.
+
+        :param conn: The Swift connection to use for uploads.
+        :param container: The container to put the object into.
+        :param name: The name of the object.
+        :param content: Object content.
+        :param headers: Headers (optional) to associate with the object.
+        :param md5: MD5 sum of the content. If passed in, will be used to
+                    verify the returned ETag.
+
+        :returns: A dictionary as the response from calling put_object.
+                  The keys are:
+                    - status
+                    - reason
+                    - headers
+                  On error, the dictionary contains the following keys:
+                    - success (with value False)
+                    - error - the encountered exception (object)
+                    - error_timestamp
+                    - response_dict - results from the put_object call, as
+                      documented above
+                    - attempts - number of attempts made
+        """
+        if headers is None:
+            headers = {}
+        else:
+            headers = dict(headers)
+        if md5 is not None:
+            headers['etag'] = md5
+        results = {}
+        try:
+            etag = conn.put_object(
+                container, name, content, content_length=len(content),
+                headers=headers, response_dict=results)
+            if md5 is not None and etag != md5:
+                raise SwiftError('Upload verification failed for {0}: md5 '
+                                 'mismatch {1} != {2}'.format(name, md5, etag))
+            results['success'] = True
+        except Exception as err:
+            traceback, err_time = report_traceback()
+            logger.exception(err)
+            return {
+                'success': False,
+                'error': err,
+                'error_timestamp': err_time,
+                'response_dict': results,
+                'attempts': conn.attempts,
+                'traceback': traceback
+            }
+        return results
+
+    @staticmethod
+    def _upload_stream_segment(conn, container, object_name,
+                               segment_container, segment_name,
+                               segment_size, segment_index,
+                               headers, fd):
+        """
+        Upload a segment from a stream, buffering it in memory first. The
+        resulting object is placed either as a segment in the segment
+        container, or if it is smaller than a single segment, as the given
+        object name.
+
+        :param conn: Swift Connection to use.
+        :param container: Container in which the object would be placed.
+        :param object_name: Name of the final object (used in case the stream
+                            is smaller than the segment_size)
+        :param segment_container: Container to hold the object segments.
+        :param segment_name: The name of the segment.
+        :param segment_size: Minimum segment size.
+        :param segment_index: The segment index.
+        :param headers: Headers to attach to the segment/object.
+        :param fd: File-like handle for the content. Must implement read().
+
+        :returns: Dictionary, containing the following keys:
+                    - complete -- whether the stream is exhausted
+                    - segment_size - the actual size of the segment (may be
+                                     smaller than the passed in segment_size)
+                    - segment_location - path to the segment
+                    - segment_index - index of the segment
+                    - segment_etag - the ETag for the segment
+        """
+        buf = []
+        dgst = md5()
+        bytes_read = 0
+        while bytes_read < segment_size:
+            data = fd.read(segment_size - bytes_read)
+            if not data:
+                break
+            bytes_read += len(data)
+            dgst.update(data)
+            buf.append(data)
+        buf = b''.join(buf)
+        segment_hash = dgst.hexdigest()
+
+        if not buf and segment_index > 0:
+            # Happens if the segment size aligns with the object size
+            return {'complete': True,
+                    'segment_size': 0,
+                    'segment_index': None,
+                    'segment_etag': None,
+                    'segment_location': None,
+                    'success': True}
+
+        if segment_index == 0 and len(buf) < segment_size:
+            ret = SwiftService._put_object(
+                conn, container, object_name, buf, headers, segment_hash)
+            ret['segment_location'] = '/%s/%s' % (container, object_name)
+        else:
+            ret = SwiftService._put_object(
+                conn, segment_container, segment_name, buf, headers,
+                segment_hash)
+            ret['segment_location'] = '/%s/%s' % (
+                segment_container, segment_name)
+
+        ret.update(
+            dict(complete=len(buf) < segment_size,
+                 segment_size=len(buf),
+                 segment_index=segment_index,
+                 segment_etag=segment_hash,
+                 for_object=object_name))
+        return ret
+
     def _get_chunk_data(self, conn, container, obj, headers, manifest=None):
         chunks = []
         if 'x-object-manifest' in headers:
@@ -1833,6 +1960,47 @@ def _is_identical(self, chunk_data, path):
             # Each chunk is verified; check that we're at the end of the file
             return not fp.read(1)
 
+    @staticmethod
+    def _upload_slo_manifest(conn, segment_results, container, obj, headers):
+        """
+        Upload an SLO manifest, given the results of uploading each segment, to
+        the specified container.
+
+        :param segment_results: List of response_dict structures, as populated
+                                by _upload_segment_job. Specifically, each
+                                entry must container the following keys:
+                                - segment_location
+                                - segment_etag
+                                - segment_size
+                                - segment_index
+        :param container: The container to put the manifest into.
+        :param obj: The name of the manifest object to use.
+        :param headers: Optional set of headers to attach to the manifest.
+        """
+        if headers is None:
+            headers = {}
+        segment_results.sort(key=lambda di: di['segment_index'])
+        for seg in segment_results:
+            seg_loc = seg['segment_location'].lstrip('/')
+            if isinstance(seg_loc, text_type):
+                seg_loc = seg_loc.encode('utf-8')
+
+        manifest_data = json.dumps([
+            {
+                'path': d['segment_location'],
+                'etag': d['segment_etag'],
+                'size_bytes': d['segment_size']
+            } for d in segment_results
+        ])
+
+        response = {}
+        conn.put_object(
+            container, obj, manifest_data,
+            headers=headers,
+            query_string='multipart-manifest=put',
+            response_dict=response)
+        return response
+
     def _upload_object_job(self, conn, container, source, obj, options,
                            results_queue=None):
         if obj.startswith('./') or obj.startswith('.\\'):
@@ -1990,29 +2158,11 @@ def _upload_object_job(self, conn, container, source, obj, options,
                 res['segment_results'] = segment_results
 
                 if options['use_slo']:
-                    segment_results.sort(key=lambda di: di['segment_index'])
-                    for seg in segment_results:
-                        seg_loc = seg['segment_location'].lstrip('/')
-                        if isinstance(seg_loc, text_type):
-                            seg_loc = seg_loc.encode('utf-8')
-                        new_slo_manifest_paths.add(seg_loc)
-
-                    manifest_data = json.dumps([
-                        {
-                            'path': d['segment_location'],
-                            'etag': d['segment_etag'],
-                            'size_bytes': d['segment_size']
-                        } for d in segment_results
-                    ])
-
-                    mr = {}
-                    conn.put_object(
-                        container, obj, manifest_data,
-                        headers=put_headers,
-                        query_string='multipart-manifest=put',
-                        response_dict=mr
-                    )
-                    res['manifest_response_dict'] = mr
+                    response = self._upload_slo_manifest(
+                        conn, segment_results, container, obj, put_headers)
+                    res['manifest_response_dict'] = response
+                    new_slo_manifest_paths = {
+                        seg['segment_location'] for seg in segment_results}
                 else:
                     new_object_manifest = '%s/%s/%s/%s/%s/' % (
                         quote(seg_container.encode('utf8')),
@@ -2030,6 +2180,51 @@ def _upload_object_job(self, conn, container, source, obj, options,
                         response_dict=mr
                     )
                     res['manifest_response_dict'] = mr
+            elif options['use_slo'] and segment_size and not path:
+                segment = 0
+                results = []
+                while True:
+                    segment_name = '%s/slo/%s/%s/%08d' % (
+                        obj, put_headers['x-object-meta-mtime'],
+                        segment_size, segment
+                    )
+                    seg_container = container + '_segments'
+                    if options['segment_container']:
+                        seg_container = options['segment_container']
+                    ret = self._upload_stream_segment(
+                        conn, container, obj,
+                        seg_container,
+                        segment_name,
+                        segment_size,
+                        segment,
+                        put_headers,
+                        stream
+                    )
+                    if not ret['success']:
+                        return ret
+                    if (ret['complete'] and segment == 0) or\
+                            ret['segment_size'] > 0:
+                        results.append(ret)
+                    if results_queue is not None:
+                        # Don't insert the 0-sized segments or objects
+                        # themselves
+                        if ret['segment_location'] != '/%s/%s' % (
+                                container, obj) and ret['segment_size'] > 0:
+                            results_queue.put(ret)
+                    if ret['complete']:
+                        break
+                    segment += 1
+                if results[0]['segment_location'] != '/%s/%s' % (
+                        container, obj):
+                    response = self._upload_slo_manifest(
+                        conn, results, container, obj, put_headers)
+                    res['manifest_response_dict'] = response
+                    new_slo_manifest_paths = {
+                        r['segment_location'] for r in results}
+                    res['large_object'] = True
+                else:
+                    res['response_dict'] = ret
+                    res['large_object'] = False
             else:
                 res['large_object'] = False
                 obr = {}
@@ -2063,7 +2258,6 @@ def _upload_object_job(self, conn, container, source, obj, options,
                 finally:
                     if fp is not None:
                         fp.close()
-
             if old_manifest or old_slo_manifest_paths:
                 drs = []
                 delobjsmap = {}
diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 43fcf475..d02c709f 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -947,6 +947,8 @@ def st_copy(parser, args, output_manager):
 
 
 def st_upload(parser, args, output_manager):
+    DEFAULT_STDIN_SEGMENT = 10 * 1024 * 1024
+
     parser.add_argument(
         '-c', '--changed', action='store_true', dest='changed',
         default=False, help='Only upload files that have changed since '
@@ -1060,6 +1062,12 @@ def st_upload(parser, args, output_manager):
             st_upload_help)
         return
 
+    if from_stdin:
+        if not options['use_slo']:
+            options['use_slo'] = True
+        if not options['segment_size']:
+            options['segment_size'] = DEFAULT_STDIN_SEGMENT
+
     options['object_uu_threads'] = options['object_threads']
     with SwiftService(options=options) as swift:
         try:
diff --git a/tests/unit/test_service.py b/tests/unit/test_service.py
index 5ccc0813..12fbaa00 100644
--- a/tests/unit/test_service.py
+++ b/tests/unit/test_service.py
@@ -36,6 +36,8 @@
     SwiftService, SwiftError, SwiftUploadObject
 )
 
+from tests.unit import utils as test_utils
+
 
 clean_os_environ = {}
 environ_prefixes = ('ST_', 'OS_')
@@ -1088,6 +1090,83 @@ def test_upload_with_relative_path(self, *args, **kwargs):
                 self.assertEqual(upload_obj_resp['path'], obj['path'])
                 self.assertTrue(mock_open.return_value.closed)
 
+    @mock.patch('swiftclient.service.Connection')
+    def test_upload_stream(self, mock_conn):
+        service = SwiftService({})
+
+        stream = test_utils.FakeStream(2048)
+        segment_etag = md5(b'A' * 1024).hexdigest()
+
+        mock_conn.return_value.head_object.side_effect = \
+            ClientException('Not Found', http_status=404)
+        mock_conn.return_value.put_object.return_value = \
+            segment_etag
+        options = {'use_slo': True, 'segment_size': 1024}
+        resp_iter = service.upload(
+            'container',
+            [SwiftUploadObject(stream, object_name='streamed')],
+            options)
+        responses = [x for x in resp_iter]
+        for resp in responses:
+            self.assertFalse('error' in resp)
+            self.assertTrue(resp['success'])
+        self.assertEqual(5, len(responses))
+        container_resp, segment_container_resp = responses[0:2]
+        segment_response = responses[2:4]
+        upload_obj_resp = responses[-1]
+        self.assertEqual(container_resp['action'],
+                         'create_container')
+        self.assertEqual(upload_obj_resp['action'],
+                         'upload_object')
+        self.assertEqual(upload_obj_resp['object'],
+                         'streamed')
+        self.assertTrue(upload_obj_resp['path'] is None)
+        self.assertTrue(upload_obj_resp['large_object'])
+        self.assertIn('manifest_response_dict', upload_obj_resp)
+        self.assertEqual(upload_obj_resp['manifest_response_dict'], {})
+        for i, resp in enumerate(segment_response):
+            self.assertEqual(i, resp['segment_index'])
+            self.assertEqual(1024, resp['segment_size'])
+            self.assertEqual('d47b127bc2de2d687ddc82dac354c415',
+                             resp['segment_etag'])
+            self.assertTrue(resp['segment_location'].endswith(
+                '/0000000%d' % i))
+            self.assertTrue(resp['segment_location'].startswith(
+                '/container_segments/streamed'))
+
+    @mock.patch('swiftclient.service.Connection')
+    def test_upload_stream_fits_in_one_segment(self, mock_conn):
+        service = SwiftService({})
+
+        stream = test_utils.FakeStream(2048)
+        whole_etag = md5(b'A' * 2048).hexdigest()
+
+        mock_conn.return_value.head_object.side_effect = \
+            ClientException('Not Found', http_status=404)
+        mock_conn.return_value.put_object.return_value = \
+            whole_etag
+        options = {'use_slo': True, 'segment_size': 10240}
+        resp_iter = service.upload(
+            'container',
+            [SwiftUploadObject(stream, object_name='streamed')],
+            options)
+        responses = [x for x in resp_iter]
+        for resp in responses:
+            self.assertNotIn('error', resp)
+            self.assertTrue(resp['success'])
+        self.assertEqual(3, len(responses))
+        container_resp, segment_container_resp = responses[0:2]
+        upload_obj_resp = responses[-1]
+        self.assertEqual(container_resp['action'],
+                         'create_container')
+        self.assertEqual(upload_obj_resp['action'],
+                         'upload_object')
+        self.assertEqual(upload_obj_resp['object'],
+                         'streamed')
+        self.assertTrue(upload_obj_resp['path'] is None)
+        self.assertFalse(upload_obj_resp['large_object'])
+        self.assertNotIn('manifest_response_dict', upload_obj_resp)
+
 
 class TestServiceUpload(_TestServiceBase):
 
@@ -1226,6 +1305,141 @@ def _consuming_conn(*a, **kw):
             self.assertIsInstance(contents, utils.LengthWrapper)
             self.assertEqual(len(contents), 10)
 
+    def test_upload_stream_segment(self):
+        common_params = {
+            'segment_container': 'segments',
+            'segment_name': 'test_stream_2',
+            'container': 'test_stream',
+            'object': 'stream_object',
+        }
+        tests = [
+            {'test_params': {
+                'segment_size': 1024,
+                'segment_index': 2,
+                'content_size': 1024},
+             'put_object_args': {
+                'container': 'segments',
+                'object': 'test_stream_2'},
+             'expected': {
+                'complete': False,
+                'segment_etag': md5(b'A' * 1024).hexdigest()}},
+            {'test_params': {
+                'segment_size': 2048,
+                'segment_index': 0,
+                'content_size': 512},
+             'put_object_args': {
+                'container': 'test_stream',
+                'object': 'stream_object'},
+             'expected': {
+                'complete': True,
+                'segment_etag': md5(b'A' * 512).hexdigest()}},
+            # 0-sized segment should not be uploaded
+            {'test_params': {
+                'segment_size': 1024,
+                'segment_index': 1,
+                'content_size': 0},
+             'put_object_args': {},
+             'expected': {
+                'complete': True}},
+            # 0-sized objects should be uploaded
+            {'test_params': {
+                'segment_size': 1024,
+                'segment_index': 0,
+                'content_size': 0},
+             'put_object_args': {
+                'container': 'test_stream',
+                'object': 'stream_object'},
+             'expected': {
+                'complete': True,
+                'segment_etag': md5(b'').hexdigest()}},
+            # Test boundary conditions
+            {'test_params': {
+                'segment_size': 1024,
+                'segment_index': 1,
+                'content_size': 1023},
+             'put_object_args': {
+                'container': 'segments',
+                'object': 'test_stream_2'},
+             'expected': {
+                'complete': True,
+                'segment_etag': md5(b'A' * 1023).hexdigest()}},
+            {'test_params': {
+                'segment_size': 2048,
+                'segment_index': 0,
+                'content_size': 2047},
+             'put_object_args': {
+                'container': 'test_stream',
+                'object': 'stream_object'},
+             'expected': {
+                'complete': True,
+                'segment_etag': md5(b'A' * 2047).hexdigest()}},
+            {'test_params': {
+                'segment_size': 1024,
+                'segment_index': 2,
+                'content_size': 1025},
+             'put_object_args': {
+                'container': 'segments',
+                'object': 'test_stream_2'},
+             'expected': {
+                'complete': False,
+                'segment_etag': md5(b'A' * 1024).hexdigest()}},
+        ]
+
+        for test_args in tests:
+            params = test_args['test_params']
+            stream = test_utils.FakeStream(params['content_size'])
+            segment_size = params['segment_size']
+            segment_index = params['segment_index']
+
+            def _fake_put_object(*args, **kwargs):
+                contents = args[2]
+                # Consume and compute md5
+                return md5(contents).hexdigest()
+
+            mock_conn = mock.Mock()
+            mock_conn.put_object.side_effect = _fake_put_object
+
+            s = SwiftService()
+            resp = s._upload_stream_segment(
+                conn=mock_conn,
+                container=common_params['container'],
+                object_name=common_params['object'],
+                segment_container=common_params['segment_container'],
+                segment_name=common_params['segment_name'],
+                segment_size=segment_size,
+                segment_index=segment_index,
+                headers={},
+                fd=stream)
+            expected_args = test_args['expected']
+            put_args = test_args['put_object_args']
+            expected_response = {
+                'segment_size': min(len(stream), segment_size),
+                'complete': expected_args['complete'],
+                'success': True,
+            }
+            if len(stream) or segment_index == 0:
+                segment_location = '/%s/%s' % (put_args['container'],
+                                               put_args['object'])
+                expected_response.update(
+                    {'segment_index': segment_index,
+                     'segment_location': segment_location,
+                     'segment_etag': expected_args['segment_etag'],
+                     'for_object': common_params['object']})
+                mock_conn.put_object.assert_called_once_with(
+                    put_args['container'],
+                    put_args['object'],
+                    mock.ANY,
+                    content_length=min(len(stream), segment_size),
+                    headers={'etag': expected_args['segment_etag']},
+                    response_dict=mock.ANY)
+            else:
+                self.assertEqual([], mock_conn.put_object.mock_calls)
+                expected_response.update(
+                    {'segment_index': None,
+                     'segment_location': None,
+                     'segment_etag': None})
+            self.assertEqual(expected_response, resp)
+
     def test_etag_mismatch_with_ignore_checksum(self):
         def _consuming_conn(*a, **kw):
             contents = a[2]
diff --git a/tests/unit/utils.py b/tests/unit/utils.py
index c05146ec..2def73f5 100644
--- a/tests/unit/utils.py
+++ b/tests/unit/utils.py
@@ -548,3 +548,24 @@ def _fake_import_keystone_client(auth_version):
         return fake_import, fake_import
 
     return _fake_import_keystone_client
+
+
+class FakeStream(object):
+    def __init__(self, size):
+        self.bytes_read = 0
+        self.size = size
+
+    def read(self, size=-1):
+        if self.bytes_read == self.size:
+            return b''
+
+        if size == -1 or size + self.bytes_read > self.size:
+            remaining = self.size - self.bytes_read
+            self.bytes_read = self.size
+            return b'A' * remaining
+
+        self.bytes_read += size
+        return b'A' * size
+
+    def __len__(self):
+        return self.size

From b91651eba09ed43903c55f24e3a1a52aefeea75f Mon Sep 17 00:00:00 2001
From: John Dickinson <me@not.mn>
Date: Tue, 23 Jan 2018 11:15:26 +1100
Subject: [PATCH 088/316] authors/changelog updates for 3.5.0 release

Change-Id: I70b79c0fd6e9adbfdcc799459dc52063c7402be2
---
 AUTHORS                                       |  1 +
 ChangeLog                                     | 19 +++++++++++++++++++
 .../notes/350_notes-ad0ae19704b2eb88.yaml     | 18 ++++++++++++++++++
 3 files changed, 38 insertions(+)
 create mode 100644 releasenotes/notes/350_notes-ad0ae19704b2eb88.yaml

diff --git a/AUTHORS b/AUTHORS
index bf69dba5..388d8700 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -42,6 +42,7 @@ Florent Flament (florent.flament-ext@cloudwatt.com)
 Greg Holt (gholt@rackspace.com)
 Greg Lange (greglange@gmail.com)
 groqez (groqez@yopmail.net)
+Hangdong Zhang (hdzhang@fiberhome.com)
 Hemanth Makkapati (hemanth.makkapati@mailtrust.com)
 hgangwx (hgangwx@cn.ibm.com)
 Hirokazu Sakata (h.sakata@staff.east.ntt.co.jp)
diff --git a/ChangeLog b/ChangeLog
index 967d7e22..efa7e8a8 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,22 @@
+3.5.0
+-----
+
+* Allow for object uploads > 5GB from stdin.
+
+  When uploading from standard input, swiftclient will turn the upload
+  into an SLO in the case of large objects. By default, input larger
+  than 10MB will be uploaded as an SLO with 10MB segment sizes. Users
+  can also supply the ``--segment-size`` option to alter that
+  threshold and the SLO segment size. One segment is buffered in
+  memory (which is why 10MB default was chosen).
+
+* The ``--meta`` option can now be set on the upload command.
+
+* Updated PyPy test dependency references to be more accurate
+  on different distros.
+
+* Various other minor bug fixes and improvements.
+
 3.4.0
 -----
 
diff --git a/releasenotes/notes/350_notes-ad0ae19704b2eb88.yaml b/releasenotes/notes/350_notes-ad0ae19704b2eb88.yaml
new file mode 100644
index 00000000..2e6b4eac
--- /dev/null
+++ b/releasenotes/notes/350_notes-ad0ae19704b2eb88.yaml
@@ -0,0 +1,18 @@
+---
+features:
+  - |
+    Allow for object uploads > 5GB from stdin.
+
+    When uploading from standard input, swiftclient will turn the upload
+    into an SLO in the case of large objects. By default, input larger
+    than 10MB will be uploaded as an SLO with 10MB segment sizes. Users
+    can also supply the ``--segment-size`` option to alter that
+    threshold and the SLO segment size. One segment is buffered in
+    memory (which is why 10MB default was chosen).
+
+  - |
+    The ``--meta`` option can now be set on the upload command.
+
+  - |
+    Updated PyPy test dependency references to be more accurate
+    on different distros.

From 2901e1e9ef1932b0b3874e608422bbfdfbd1448a Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 26 Jan 2018 14:14:18 -0800
Subject: [PATCH 089/316] Treat 404 as success when deleting segments

Change-Id: I76be70ddb289bd4f1054a684a247279ab16ca34a
---
 swiftclient/service.py | 19 ++++++++++---------
 1 file changed, 10 insertions(+), 9 deletions(-)

diff --git a/swiftclient/service.py b/swiftclient/service.py
index ed5e9e98..607c1aea 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -2471,17 +2471,18 @@ def _per_item_delete(self, container, objects, options, rdict, rq):
     def _delete_segment(conn, container, obj, results_queue=None):
         results_dict = {}
         try:
-            conn.delete_object(container, obj, response_dict=results_dict)
             res = {'success': True}
+            conn.delete_object(container, obj, response_dict=results_dict)
         except Exception as err:
-            traceback, err_time = report_traceback()
-            logger.exception(err)
-            res = {
-                'success': False,
-                'error': err,
-                'traceback': traceback,
-                'error_timestamp': err_time
-            }
+            if not isinstance(err, ClientException) or err.http_status != 404:
+                traceback, err_time = report_traceback()
+                logger.exception(err)
+                res = {
+                    'success': False,
+                    'error': err,
+                    'traceback': traceback,
+                    'error_timestamp': err_time
+                }
 
         res.update({
             'action': 'delete_segment',

From 65bfbb00bf31c1cca0b37bb6a3db33f38e7146d5 Mon Sep 17 00:00:00 2001
From: OpenStack Release Bot <infra-root@openstack.org>
Date: Mon, 29 Jan 2018 16:54:44 +0000
Subject: [PATCH 090/316] Update reno for stable/queens

Change-Id: I7f7b21e3dd0d1ef71c159e2b72f9ad9f963b0773
---
 releasenotes/source/index.rst  | 1 +
 releasenotes/source/queens.rst | 6 ++++++
 2 files changed, 7 insertions(+)
 create mode 100644 releasenotes/source/queens.rst

diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst
index 6e3419df..a5240ea2 100644
--- a/releasenotes/source/index.rst
+++ b/releasenotes/source/index.rst
@@ -6,6 +6,7 @@
    :maxdepth: 1
 
    current
+   queens
    pike
    ocata
    newton
diff --git a/releasenotes/source/queens.rst b/releasenotes/source/queens.rst
new file mode 100644
index 00000000..36ac6160
--- /dev/null
+++ b/releasenotes/source/queens.rst
@@ -0,0 +1,6 @@
+===================================
+ Queens Series Release Notes
+===================================
+
+.. release-notes::
+   :branch: stable/queens

From 8bf86accca4d3a742c552cac2e523a13b6293fb6 Mon Sep 17 00:00:00 2001
From: shangxiaobj <shangxiaobj@inspur.com>
Date: Mon, 22 Jan 2018 18:58:54 -0800
Subject: [PATCH 091/316] Update the old http doc links

Update the old http doc links to the https ones according to the
official OpenStack website.

Change-Id: Ibf9ecbccb743d2b9a678a1ca69f0b3adc9106a12
---
 CONTRIBUTING.rst         | 4 ++--
 README.rst               | 8 ++++----
 bindep.txt               | 2 +-
 doc/source/cli/index.rst | 4 ++--
 4 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index ec32d855..0bde9680 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -1,13 +1,13 @@
 If you would like to contribute to the development of OpenStack, you
 must follow the steps in this page:
 
-    http://docs.openstack.org/infra/manual/developers.html
+    https://docs.openstack.org/infra/manual/developers.html
 
 Once those steps have been completed, changes to OpenStack should be
 submitted for review via the Gerrit tool, following the workflow
 documented at:
 
-    http://docs.openstack.org/infra/manual/developers.html#development-workflow.
+    https://docs.openstack.org/infra/manual/developers.html#development-workflow
 
 Gerrit is the review system used in the OpenStack projects. We're sorry,
 but we won't be able to respond to pull requests submitted through
diff --git a/README.rst b/README.rst
index 38104392..cd6a7aca 100644
--- a/README.rst
+++ b/README.rst
@@ -24,13 +24,13 @@ This is a python client for the Swift API. There's a Python API (the
 Development takes place via the usual OpenStack processes as outlined
 in the `OpenStack wiki`__.
 
-__ http://docs.openstack.org/infra/manual/developers.html
+__ https://docs.openstack.org/infra/manual/developers.html
 
 This code is based on the original client previously included with
 `OpenStack's Swift`__ The python-swiftclient is licensed under the
 Apache License like the rest of OpenStack.
 
-__ http://github.com/openstack/swift
+__ https://github.com/openstack/swift
 
 * Free software: Apache license
 * `PyPI`_ - package installation
@@ -48,8 +48,8 @@ __ http://github.com/openstack/swift
 .. _Blueprints: https://blueprints.launchpad.net/python-swiftclient
 .. _Bugs: https://bugs.launchpad.net/python-swiftclient
 .. _Source: https://git.openstack.org/cgit/openstack/python-swiftclient
-.. _How to Contribute: http://docs.openstack.org/infra/manual/developers.html
-.. _Specs: http://specs.openstack.org/openstack/swift-specs/
+.. _How to Contribute: https://docs.openstack.org/infra/manual/developers.html
+.. _Specs: https://specs.openstack.org/openstack/swift-specs/
 
 
 .. contents:: Contents:
diff --git a/bindep.txt b/bindep.txt
index 27f27363..17c0cd56 100644
--- a/bindep.txt
+++ b/bindep.txt
@@ -1,5 +1,5 @@
 # This is a cross-platform list tracking distribution packages needed by tests;
-# see http://docs.openstack.org/infra/bindep/ for additional information.
+# see https://docs.openstack.org/infra/bindep/ for additional information.
 
 pypy [test !platform:fedora]
 pypy-dev [test platform:dpkg]
diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst
index bec1f5e5..4aa3bfcd 100644
--- a/doc/source/cli/index.rst
+++ b/doc/source/cli/index.rst
@@ -313,7 +313,7 @@ The ``-p <prefix>`` or ``--prefix <prefix>`` is an option that will only
 list items beginning with that prefix. The ``-d <delimiter>`` or
 ``--delimiter <delimiter>`` is an option (for container listings only)
 that will roll up items with the given delimiter (see `OpenStack Swift
-general documentation <http://docs.openstack.org/swift/latest/>` for
+general documentation <https://docs.openstack.org/swift/latest/>` for
 what this means).
 
 The ``-l`` and ``--lh`` options provide more detail, similar to ``ls -l``
@@ -457,7 +457,7 @@ and is used to define the user metadata items to set in the form ``Name:Value``.
 You can repeat this option. For example: ``post -m Color:Blue -m Size:Large``
 
 For more information about ACL formats see the documentation:
-`ACLs <http://docs.openstack.org/swift/latest/misc.html#acls>`_.
+`ACLs <https://docs.openstack.org/swift/latest/misc.html#acls>`_.
 
 **Positional arguments:**
 

From 097f4b26d9e68fb818c078cd0a0d30658042fff7 Mon Sep 17 00:00:00 2001
From: Kota Tsuyuzaki <tsuyuzaki.kota@lab.ntt.co.jp>
Date: Fri, 23 Feb 2018 18:02:40 +0900
Subject: [PATCH 092/316] Add missing <sync-to> value in command line docs

Because it should take a value of either realm or full url.

Change-Id: I1fe30825ef1620e256c9fd3057da6808b03d7200
---
 doc/source/cli/index.rst | 2 +-
 swiftclient/shell.py     | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst
index 4aa3bfcd..b57c25ef 100644
--- a/doc/source/cli/index.rst
+++ b/doc/source/cli/index.rst
@@ -442,7 +442,7 @@ swift post
 
 .. code-block:: console
 
-   Usage: swift post [--read-acl <acl>] [--write-acl <acl>] [--sync-to]
+   Usage: swift post [--read-acl <acl>] [--write-acl <acl>] [--sync-to <sync-to>]
                      [--sync-key <sync-key>] [--meta <name:value>]
                      [--header <header>]
                      [<container> [<object>]]
diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index d02c709f..6ccc16df 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -687,7 +687,7 @@ def st_stat(parser, args, output_manager):
             output_manager.error(e.value)
 
 
-st_post_options = '''[--read-acl <acl>] [--write-acl <acl>] [--sync-to]
+st_post_options = '''[--read-acl <acl>] [--write-acl <acl>] [--sync-to <sync-to>]
                   [--sync-key <sync-key>] [--meta <name:value>]
                   [--header <header>]
                   [<container> [<object>]]

From cec0f0e4ed6d04515441390c01de096d2afb60dd Mon Sep 17 00:00:00 2001
From: wangqi <wang.qi@99cloud.net>
Date: Mon, 5 Mar 2018 13:23:36 +0000
Subject: [PATCH 093/316] Update links in README

Change the outdated links to the latest links in README

Change-Id: Ic0adc686592265f2be2acb55f0520c35d1717f76
---
 README.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/README.rst b/README.rst
index cd6a7aca..46c0b0ac 100644
--- a/README.rst
+++ b/README.rst
@@ -2,8 +2,8 @@
 Team and repository tags
 ========================
 
-.. image:: https://governance.openstack.org/badges/python-swiftclient.svg
-    :target: https://governance.openstack.org/reference/tags/index.html
+.. image:: https://governance.openstack.org/tc/badges/python-swiftclient.svg
+    :target: https://governance.openstack.org/tc/reference/tags/index.html
 
 .. Change things from this point on
 

From a36c3cfda1c243273fcd11b9e123aca877869244 Mon Sep 17 00:00:00 2001
From: Timur Alperovich <timuralp@swiftstack.com>
Date: Mon, 5 Mar 2018 17:33:22 -0800
Subject: [PATCH 094/316] Add a query_string option to head_object().

Submitting a path parameter with a HEAD request on an object can be
useful if one is trying to find out information about an SLO/DLO without
retrieving the manifest.

Change-Id: I39efd098e72bd31de271ac51d4d75381929c9638
---
 swiftclient/client.py          |  9 ++++++---
 tests/unit/test_swiftclient.py | 15 +++++++++++++--
 2 files changed, 19 insertions(+), 5 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index 7db75f00..60abbd81 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -1188,7 +1188,7 @@ def get_object(url, token, container, name, http_conn=None,
 
 
 def head_object(url, token, container, name, http_conn=None,
-                service_token=None, headers=None):
+                service_token=None, headers=None, query_string=None):
     """
     Get object info
 
@@ -1209,6 +1209,8 @@ def head_object(url, token, container, name, http_conn=None,
     else:
         parsed, conn = http_connection(url)
     path = '%s/%s/%s' % (parsed.path, quote(container), quote(name))
+    if query_string:
+        path += '?' + query_string
     if headers:
         headers = dict(headers)
     else:
@@ -1785,9 +1787,10 @@ def delete_container(self, container, response_dict=None,
                            query_string=query_string,
                            headers=headers)
 
-    def head_object(self, container, obj, headers=None):
+    def head_object(self, container, obj, headers=None, query_string=None):
         """Wrapper for :func:`head_object`"""
-        return self._retry(None, head_object, container, obj, headers=headers)
+        return self._retry(None, head_object, container, obj, headers=headers,
+                           query_string=query_string)
 
     def get_object(self, container, obj, resp_chunk_size=None,
                    query_string=None, response_dict=None, headers=None):
diff --git a/tests/unit/test_swiftclient.py b/tests/unit/test_swiftclient.py
index 3de5f027..7b8628bb 100644
--- a/tests/unit/test_swiftclient.py
+++ b/tests/unit/test_swiftclient.py
@@ -1180,6 +1180,16 @@ def test_request_headers(self):
             }),
         ])
 
+    def test_query_string(self):
+        c.http_connection = self.fake_http_connection(204)
+        conn = c.http_connection('http://www.test.com')
+        query_string = 'foo=bar'
+        c.head_object('url_is_irrelevant', 'token', 'container', 'key',
+                      http_conn=conn, query_string=query_string)
+        self.assertRequests([
+            ('HEAD', '/container/key?foo=bar', '', {'x-auth-token': 'token'})
+        ])
+
 
 class TestPutObject(MockHttpTest):
 
@@ -2459,16 +2469,17 @@ def test_head_container(self):
 
     def test_head_object(self):
         headers = {'X-Favourite-Pet': 'Aardvark'}
+        query_string = 'foo=bar'
         with mock.patch('swiftclient.client.http_connection',
                         self.fake_http_connection(200)):
             with mock.patch('swiftclient.client.get_auth',
                             lambda *a, **k: ('http://url:8080/v1/a', 'token')):
                 conn = c.Connection()
                 conn.head_object('c1', 'o1',
-                                 headers=headers)
+                                 headers=headers, query_string=query_string)
         self.assertEqual(1, len(self.request_log), self.request_log)
         self.assertRequests([
-            ('HEAD', '/v1/a/c1/o1', '', {
+            ('HEAD', '/v1/a/c1/o1?foo=bar', '', {
                 'x-auth-token': 'token',
                 'X-Favourite-Pet': 'Aardvark',
             }),

From e65070964c7b1e04119c87e5f344d39358780d18 Mon Sep 17 00:00:00 2001
From: Kota Tsuyuzaki <tsuyuzaki.kota@lab.ntt.co.jp>
Date: Mon, 12 Mar 2018 17:54:17 +0900
Subject: [PATCH 095/316] Add force auth retry mode in swiftclient

This patch attemps to add an option to force get_auth call while retrying
an operation even if it gets errors other than 401 Unauthorized.

Why we need this:
The main reason why we need this is current python-swiftclient requests could
never get succeeded under certion situation using third party proxies/load balancers
between the client and swift-proxy server. I think, it would be general situation
of the use case.

Specifically describing nginx case, the nginx can close the socket from the client
when the response code from swift is not 2xx series. In default, nginx can wait the
buffers from the client for a while (default 30s)[1] but after the time past, nginx
will close the socket immediately. Unfortunately, if python-swiftclient has still been
sending the data into the socket, python-swiftclient will get socket error (EPIPE,
BrokenPipe). From the swiftclient perspective, this is absolutely not an auth error,
so current python-swiftclient will continue to retry without re-auth.
However, if the root cause is sort of 401 (i.e. nginx got 401 unauthorized from the
swift-proxy because of token expiration), swiftclient will loop 401 -> EPIPE -> 401...
until it consume the max retry times.

In particlar, less time to live of the token and multipart object upload with large
segments could not get succeeded as below:

Connection Model:

python-swiftclient -> nginx -> swift-proxy -> swift-backend

Case: Try to create slo with large segments and the auth token expired with 1 hour

1. client create a connection to nginx with successful response from swift-proxy and its auth
2. client continue to put large segment objects
   (e.g. 1~5GB for each and the total would 20~30GB, i.e. 20~30 segments)
3. after some of segments uploaded, 1 hour past but client is still trying to
   send remaining segment objects.
4. nginx got 401 from swift-proxy for a request and wait that the connection is closed
   from the client but timeout past because the python-swiftclient is still sending much data
   into the socket before reading the 401 response.
5. client got socket error because nginx closed the connection during sending the buffer.
6. client retries a new connection to nginx without re-auth...

<loop 4-6>

7. finally python-swiftclient failed with socket error (Broken Pipe)

In operational perspective, setting longer timeout for lingering close would be an option but
it's not complete solution because any other proxy/LB may not support the options.

If we actually do THE RIGHT THING in python-swiftclient, we should send expects: 100-continue
header and handle the first response to re-auth correctly.

HOWEVER, the current python's httplib and requests module used by python-swiftclient doesn't
support expects: 100-continue header [2] and the thread proposed a fix [3] is not super active.
And we know the reason we depends on the library is to fix a security issue that existed
in older python-swiftclient [4] so that we should touch around it super carefully.

In the reality, as the hot fix, this patch try to mitigate the unfortunate situation
described above WITHOUT 100-continue fix, just users can force to re-auth when any errors
occurred during the retries that can be accepted in the upstream.

1: http://nginx.org/en/docs/http/ngx_http_core_module.html#lingering_close
2: https://github.com/requests/requests/issues/713
3: https://bugs.python.org/issue1346874
4: https://review.openstack.org/#/c/69187/

Change-Id: I3470b56e3f9cf9cdb8c2fc2a94b2c551927a3440
---
 swiftclient/client.py          |  9 ++++-
 swiftclient/service.py         |  4 +-
 swiftclient/shell.py           |  6 +++
 tests/unit/test_swiftclient.py | 67 ++++++++++++++++++++++++++++++++++
 4 files changed, 84 insertions(+), 2 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index 60abbd81..ab0fde80 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -1542,7 +1542,7 @@ def __init__(self, authurl=None, user=None, key=None, retries=5,
                  os_options=None, auth_version="1", cacert=None,
                  insecure=False, cert=None, cert_key=None,
                  ssl_compression=True, retry_on_ratelimit=False,
-                 timeout=None, session=None):
+                 timeout=None, session=None, force_auth_retry=False):
         """
         :param authurl: authentication URL
         :param user: user name to authenticate as
@@ -1578,6 +1578,8 @@ def __init__(self, authurl=None, user=None, key=None, retries=5,
                                    after a backoff.
         :param timeout: The connect timeout for the HTTP connection.
         :param session: A keystoneauth session object.
+        :param force_auth_retry: reset auth info even if client got unexpected
+                                 error except 401 Unauthorized.
         """
         self.session = session
         self.authurl = authurl
@@ -1610,6 +1612,7 @@ def __init__(self, authurl=None, user=None, key=None, retries=5,
         self.auth_end_time = 0
         self.retry_on_ratelimit = retry_on_ratelimit
         self.timeout = timeout
+        self.force_auth_retry = force_auth_retry
 
     def close(self):
         if (self.http_conn and isinstance(self.http_conn, tuple)
@@ -1724,6 +1727,10 @@ def _retry(self, reset_func, func, *args, **kwargs):
                     pass
                 else:
                     raise
+
+            if self.force_auth_retry:
+                self.url = self.token = self.service_token = None
+
             sleep(backoff)
             backoff = min(backoff * 2, self.max_backoff)
             if reset_func:
diff --git a/swiftclient/service.py b/swiftclient/service.py
index ed5e9e98..0679fec4 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -144,6 +144,7 @@ def _build_default_global_options():
         "user": environ.get('ST_USER'),
         "key": environ.get('ST_KEY'),
         "retries": 5,
+        "force_auth_retry": False,
         "os_username": environ.get('OS_USERNAME'),
         "os_user_id": environ.get('OS_USER_ID'),
         "os_user_domain_name": environ.get('OS_USER_DOMAIN_NAME'),
@@ -261,7 +262,8 @@ def get_conn(options):
                       insecure=options['insecure'],
                       cert=options['os_cert'],
                       cert_key=options['os_key'],
-                      ssl_compression=options['ssl_compression'])
+                      ssl_compression=options['ssl_compression'],
+                      force_auth_retry=options['force_auth_retry'])
 
 
 def mkdirs(path):
diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index d02c709f..6010b5d4 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -1501,6 +1501,7 @@ def main(arguments=None):
              [--os-cert <client-certificate-file>]
              [--os-key <client-certificate-key-file>]
              [--no-ssl-compression]
+             [--force-auth-retry]
              <subcommand> [--help] [<subcommand options>]
 
 Command-line interface to the OpenStack Swift API.
@@ -1610,6 +1611,11 @@ def main(arguments=None):
                         help='This option is deprecated and not used anymore. '
                              'SSL compression should be disabled by default '
                              'by the system SSL library.')
+    parser.add_argument('--force-auth-retry',
+                        action='store_true', dest='force_auth_retry',
+                        default=False,
+                        help='Force a re-auth attempt on '
+                             'any error other than 401 unauthorized')
 
     os_grp = parser.add_argument_group("OpenStack authentication options")
     os_grp.add_argument('--os-username',
diff --git a/tests/unit/test_swiftclient.py b/tests/unit/test_swiftclient.py
index 7b8628bb..52153dca 100644
--- a/tests/unit/test_swiftclient.py
+++ b/tests/unit/test_swiftclient.py
@@ -26,11 +26,13 @@
 from hashlib import md5
 from six import binary_type
 from six.moves.urllib.parse import urlparse
+from requests.exceptions import RequestException
 
 from .utils import (MockHttpTest, fake_get_auth_keystone, StubResponse,
                     FakeKeystone, _make_fake_import_keystone_client)
 
 from swiftclient.utils import EMPTY_ETAG
+from swiftclient.exceptions import ClientException
 from swiftclient import client as c
 import swiftclient.utils
 import swiftclient
@@ -1978,6 +1980,71 @@ def quick_sleep(*args):
         self.assertIn('Account HEAD failed', str(exc_context.exception))
         self.assertEqual(conn.attempts, 1)
 
+    def test_retry_with_socket_error(self):
+        def quick_sleep(*args):
+            pass
+        c.sleep = quick_sleep
+        conn = c.Connection('http://www.test.com', 'asdf', 'asdf')
+        with mock.patch('swiftclient.client.http_connection') as \
+                fake_http_connection, \
+                mock.patch('swiftclient.client.get_auth_1_0') as mock_auth:
+            mock_auth.return_value = ('http://mock.com', 'mock_token')
+            fake_http_connection.side_effect = socket.error
+            self.assertRaises(socket.error, conn.head_account)
+        self.assertEqual(mock_auth.call_count, 1)
+        self.assertEqual(conn.attempts, conn.retries + 1)
+
+    def test_retry_with_force_auth_retry_exceptions(self):
+        def quick_sleep(*args):
+            pass
+
+        def do_test(exception):
+            c.sleep = quick_sleep
+            conn = c.Connection(
+                'http://www.test.com', 'asdf', 'asdf',
+                force_auth_retry=True)
+            with mock.patch('swiftclient.client.http_connection') as \
+                    fake_http_connection, \
+                    mock.patch('swiftclient.client.get_auth_1_0') as mock_auth:
+                mock_auth.return_value = ('http://mock.com', 'mock_token')
+                fake_http_connection.side_effect = exception
+                self.assertRaises(exception, conn.head_account)
+            self.assertEqual(mock_auth.call_count, conn.retries + 1)
+            self.assertEqual(conn.attempts, conn.retries + 1)
+
+        do_test(socket.error)
+        do_test(RequestException)
+
+    def test_retry_with_force_auth_retry_client_exceptions(self):
+        def quick_sleep(*args):
+            pass
+
+        def do_test(http_status, count):
+
+            def mock_http_connection(*args, **kwargs):
+                raise ClientException('fake', http_status=http_status)
+
+            c.sleep = quick_sleep
+            conn = c.Connection(
+                'http://www.test.com', 'asdf', 'asdf',
+                force_auth_retry=True)
+            with mock.patch('swiftclient.client.http_connection') as \
+                    fake_http_connection, \
+                    mock.patch('swiftclient.client.get_auth_1_0') as mock_auth:
+                mock_auth.return_value = ('http://mock.com', 'mock_token')
+                fake_http_connection.side_effect = mock_http_connection
+                self.assertRaises(ClientException, conn.head_account)
+            self.assertEqual(mock_auth.call_count, count)
+            self.assertEqual(conn.attempts, count)
+
+        # sanity, in case of 401, the auth will be called only twice because of
+        # retried_auth mechanism
+        do_test(401, 2)
+        # others will be tried until retry limits
+        do_test(408, 6)
+        do_test(500, 6)
+        do_test(503, 6)
+
     def test_resp_read_on_server_error(self):
         conn = c.Connection('http://www.test.com', 'asdf', 'asdf', retries=0)
 

From 071926d19b7305830920964434e993bbc1c41b18 Mon Sep 17 00:00:00 2001
From: Thiago da Silva <thiago@redhat.com>
Date: Sat, 17 Mar 2018 13:00:05 -0400
Subject: [PATCH 096/316] show option per line

ading multiple options on the same line makes
it easy to miss when quickly scanning the options.

Change-Id: I8e324fca48cd05d9e381d5106135542274c2ff7f
Signed-off-by: Thiago da Silva <thiago@redhat.com>
---
 swiftclient/shell.py | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index d02c709f..31b27eaf 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -1483,7 +1483,8 @@ def main(arguments=None):
                  --os-identity-api-version <auth_version> ]
              [--user <username>]
              [--key <api_key>] [--retries <num_retries>]
-             [--os-username <auth-user-name>] [--os-password <auth-password>]
+             [--os-username <auth-user-name>]
+             [--os-password <auth-password>]
              [--os-user-id <auth-user-id>]
              [--os-user-domain-id <auth-user-domain-id>]
              [--os-user-domain-name <auth-user-domain-name>]
@@ -1493,11 +1494,14 @@ def main(arguments=None):
              [--os-project-name <auth-project-name>]
              [--os-project-domain-id <auth-project-domain-id>]
              [--os-project-domain-name <auth-project-domain-name>]
-             [--os-auth-url <auth-url>] [--os-auth-token <auth-token>]
-             [--os-storage-url <storage-url>] [--os-region-name <region-name>]
+             [--os-auth-url <auth-url>]
+             [--os-auth-token <auth-token>]
+             [--os-storage-url <storage-url>]
+             [--os-region-name <region-name>]
              [--os-service-type <service-type>]
              [--os-endpoint-type <endpoint-type>]
-             [--os-cacert <ca-certificate>] [--insecure]
+             [--os-cacert <ca-certificate>]
+             [--insecure]
              [--os-cert <client-certificate-file>]
              [--os-key <client-certificate-key-file>]
              [--no-ssl-compression]

From 5f23f9a70277314308432d73d2a2f2d78a844a97 Mon Sep 17 00:00:00 2001
From: Nguyen Hai <nguyentrihai93@gmail.com>
Date: Fri, 16 Mar 2018 00:12:39 +0900
Subject: [PATCH 097/316] Remove py34 from envlist in tox.ini

py35 is enough.

Change-Id: Iebd7a6741dd60ed2fb11d1758bfec8e03e30a086
---
 tox.ini | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tox.ini b/tox.ini
index 541df654..5b4d3a43 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,5 +1,5 @@
 [tox]
-envlist = py27,py34,py35,pypy,pep8
+envlist = py27,py35,pypy,pep8
 minversion = 2.0
 skipsdist = True
 

From 046e04a7a43e3712241b2391a3864d843c7651e8 Mon Sep 17 00:00:00 2001
From: Kota Tsuyuzaki <tsuyuzaki.kota@lab.ntt.co.jp>
Date: Thu, 12 Apr 2018 17:37:01 +0900
Subject: [PATCH 098/316] Remove trailing white space in tox.ini

Change-Id: I706b69b7230390234ab255682478e8f69261cafe
---
 tox.ini | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tox.ini b/tox.ini
index 541df654..2a27bfdf 100644
--- a/tox.ini
+++ b/tox.ini
@@ -29,7 +29,7 @@ commands =
 commands = {posargs}
 
 [testenv:cover]
-commands = python setup.py testr --coverage 
+commands = python setup.py testr --coverage
            coverage report
 
 [testenv:func]

From 5ed910cd32b0148b086ba4102a082aadb5e283bc Mon Sep 17 00:00:00 2001
From: Tovin Seven <vinhnt@vn.fujitsu.com>
Date: Fri, 20 Apr 2018 17:25:34 +0700
Subject: [PATCH 099/316] Trivial: Update pypi url to new url

Pypi url changed from [1] to [2]

[1] https://pypi.python.org/pypi/<package>
[2] https://pypi.org/project/<package>

Change-Id: Ia406e9c8be6ba672b96e8584ef26f92348c8328b
---
 README.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/README.rst b/README.rst
index 46c0b0ac..bc06f544 100644
--- a/README.rst
+++ b/README.rst
@@ -11,11 +11,11 @@ Python bindings to the OpenStack Object Storage API
 ===================================================
 
 .. image:: https://img.shields.io/pypi/v/python-swiftclient.svg
-    :target: https://pypi.python.org/pypi/python-swiftclient/
+    :target: https://pypi.org/project/python-swiftclient/
     :alt: Latest Version
 
 .. image:: https://img.shields.io/pypi/dm/python-swiftclient.svg
-    :target: https://pypi.python.org/pypi/python-swiftclient/
+    :target: https://pypi.org/project/python-swiftclient/
     :alt: Downloads
 
 This is a python client for the Swift API. There's a Python API (the
@@ -42,7 +42,7 @@ __ https://github.com/openstack/swift
 * `Specs`_
 * `How to Contribute`_
 
-.. _PyPI: https://pypi.python.org/pypi/python-swiftclient
+.. _PyPI: https://pypi.org/project/python-swiftclient
 .. _Online Documentation: https://docs.openstack.org/python-swiftclient/latest/
 .. _Launchpad project: https://launchpad.net/python-swiftclient
 .. _Blueprints: https://blueprints.launchpad.net/python-swiftclient

From b5ed14f90a8214700a9be2139d9e7aba82baaa99 Mon Sep 17 00:00:00 2001
From: Doug Hellmann <doug@doughellmann.com>
Date: Thu, 22 Mar 2018 18:04:06 -0400
Subject: [PATCH 100/316] add lower-constraints job

Create a tox environment for running the unit tests against the lower
bounds of the dependencies.

Create a lower-constraints.txt to be used to enforce the lower bounds
in those tests.

Add openstack-tox-lower-constraints job to the zuul configuration.

Update the dependencies needed to make the unit tests pass while
constrained to the lower bounds.

See http://lists.openstack.org/pipermail/openstack-dev/2018-March/128352.html
for more details.

Co-Authored-By: Nguyen Hai <nguyentrihai93@gmail.com>
Change-Id: I2a8f465c8b08370517cbec857933b08fca94ca38
Depends-On: https://review.openstack.org/555034
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
---
 .zuul.yaml            |  7 +++++++
 lower-constraints.txt | 46 +++++++++++++++++++++++++++++++++++++++++++
 requirements.txt      |  9 ++++++---
 setup.cfg             |  2 +-
 setup.py              | 14 +++++++++----
 test-requirements.txt | 13 ++++++------
 tox.ini               |  7 +++++++
 7 files changed, 84 insertions(+), 14 deletions(-)
 create mode 100644 .zuul.yaml
 create mode 100644 lower-constraints.txt

diff --git a/.zuul.yaml b/.zuul.yaml
new file mode 100644
index 00000000..67a39c42
--- /dev/null
+++ b/.zuul.yaml
@@ -0,0 +1,7 @@
+- project:
+    check:
+      jobs:
+        - openstack-tox-lower-constraints
+    gate:
+      jobs:
+        - openstack-tox-lower-constraints
diff --git a/lower-constraints.txt b/lower-constraints.txt
new file mode 100644
index 00000000..6488b28f
--- /dev/null
+++ b/lower-constraints.txt
@@ -0,0 +1,46 @@
+alabaster==0.7.10
+Babel==2.3.4
+certifi==2018.1.18
+chardet==3.0.4
+coverage==4.0
+docutils==0.11
+dulwich==0.15.0
+extras==1.0.0
+fixtures==3.0.0
+flake8==2.2.4
+futures==3.0.0
+hacking==0.10.0
+idna==2.6
+imagesize==0.7.1
+iso8601==0.1.8
+Jinja2==2.10
+keystoneauth1==3.4.0
+linecache2==1.0.0
+MarkupSafe==1.0
+mccabe==0.2.1
+mock==1.2.0
+netaddr==0.7.10
+openstackdocstheme==1.18.1
+oslo.config==1.2.0
+oslosphinx==4.7.0
+pbr==2.0.0
+pep8==1.5.7
+PrettyTable==0.7
+pyflakes==0.8.1
+Pygments==2.2.0
+python-keystoneclient==3.8.0
+python-mimeparse==1.6.0
+python-subunit==1.0.0
+pytz==2013.6
+PyYAML==3.12
+reno==2.5.0
+requests==2.14.2
+six==1.10.0
+snowballstemmer==1.2.1
+sphinx==1.6.2
+sphinxcontrib-websupport==1.0.1
+testrepository==0.0.18
+testtools==2.2.0
+traceback2==1.4.0
+unittest2==1.1.0
+urllib3==1.22
diff --git a/requirements.txt b/requirements.txt
index 6d31e09b..6b527918 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,3 +1,6 @@
-futures>=3.0;python_version=='2.7' or python_version=='2.6' # BSD
-requests>=1.1
-six>=1.5.2
+# The order of packages is significant, because pip processes them in the order
+# of appearance. Changing the order has an impact on the overall integration
+# process, which may cause wedges in the gate later.
+futures>=3.0.0;python_version=='2.7' or python_version=='2.6' # BSD
+requests>=2.14.2 # Apache-2.0
+six>=1.10.0 # MIT
diff --git a/setup.cfg b/setup.cfg
index e4963dba..f20bbcaf 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -34,7 +34,7 @@ data_files =
 
 [extras]
 keystone =
-    python-keystoneclient>=0.7.0
+  python-keystoneclient>=3.8.0 # Apache-2.0
 
 [entry_points]
 console_scripts =
diff --git a/setup.py b/setup.py
index 16a18f6e..518f1d34 100644
--- a/setup.py
+++ b/setup.py
@@ -17,10 +17,16 @@
 # THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT
 import setuptools, sys
 
-if sys.version_info < (2, 7):
-    sys.exit('Sorry, Python < 2.7 is not supported for'
-             ' python-swiftclient>=3.0')
+import setuptools
+
+# In python < 2.7.4, a lazy loading of package `pbr` will break
+# setuptools if some other modules registered functions in `atexit`.
+# solution from: http://bugs.python.org/issue15881#msg170215
+try:
+    import multiprocessing  # noqa
+except ImportError:
+    pass
 
 setuptools.setup(
-    setup_requires=['pbr'],
+    setup_requires=['pbr>=2.0.0'],
     pbr=True)
diff --git a/test-requirements.txt b/test-requirements.txt
index a9a0c7fb..634851e7 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -1,9 +1,10 @@
-hacking>=0.10.0,<0.11
+hacking<0.11,>=0.10.0
 
-coverage>=3.6
-mock>=1.2
+coverage!=4.4,>=4.0 # Apache-2.0
+keystoneauth1>=3.4.0  # Apache-2.0
+mock>=1.2.0 # BSD
 oslosphinx>=4.7.0  # Apache-2.0
-sphinx>=1.1.2,<1.2
+sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
 testrepository>=0.0.18
-reno>=1.8.0,!=2.3.1 # Apache-2.0
-openstackdocstheme>=1.16.0 # Apache-2.0
+reno>=2.5.0 # Apache-2.0
+openstackdocstheme>=1.18.1 # Apache-2.0
diff --git a/tox.ini b/tox.ini
index 015913c5..660248b4 100644
--- a/tox.ini
+++ b/tox.ini
@@ -70,3 +70,10 @@ commands = bindep test
 
 [testenv:releasenotes]
 commands = sphinx-build -a -W -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
+
+[testenv:lower-constraints]
+basepython = python3
+deps =
+  -c{toxinidir}/lower-constraints.txt
+  -r{toxinidir}/test-requirements.txt
+  .[keystone]

From 7a13754eebb15a3c7fa507ad1d58e3c4460e302c Mon Sep 17 00:00:00 2001
From: Pete Zaitcev <zaitcev@kotori.zaitcev.us>
Date: Fri, 4 May 2018 13:31:03 -0500
Subject: [PATCH 101/316] Use a valid default for auth_version

The valid set of values for auth_version does not include
values starting with the 'v'.

In this particular function, the auth_version variable is
only used for comparisons with v3. So, the code worked
correctly. However, let's clean this up in order to reduce
review confusion and defuse possible future landmine in case
of code changes.

Change-Id: I671016d7992a1922b786b4eb8876b3fbb2532e15
---
 swiftclient/client.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index ab0fde80..e92e3ca7 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -565,7 +565,7 @@ def get_auth_keystone(auth_url, user, key, os_options, **kwargs):
 
     # Legacy default if not set
     if auth_version is None:
-        auth_version = 'v2.0'
+        auth_version = '2'
     ksclient, exceptions = _import_keystone_client(auth_version)
 
     try:

From 1971ef880ff225379d4a91f00f89f323a1605eeb Mon Sep 17 00:00:00 2001
From: Erik Olof Gunnar Andersson <eandersson@blizzard.com>
Date: Wed, 16 May 2018 16:03:57 -0700
Subject: [PATCH 102/316] Make swiftclient respect region_name when using
 sessions

Change-Id: I94aca6f1120c34616562be7345f0e5aa51a69499
---
 swiftclient/client.py | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index ab0fde80..59617446 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -644,8 +644,10 @@ def get_auth(auth_url, user, key, **kwargs):
     if session:
         service_type = os_options.get('service_type', 'object-store')
         interface = os_options.get('endpoint_type', 'public')
+        region_name = os_options.get('region_name')
         storage_url = session.get_endpoint(service_type=service_type,
-                                           interface=interface)
+                                           interface=interface,
+                                           region_name=region_name)
         token = session.get_token()
     elif auth_version in AUTH_VERSIONS_V1:
         storage_url, token = get_auth_1_0(auth_url,

From 78b839007294b7c9e7fd0402801775283a4045bc Mon Sep 17 00:00:00 2001
From: Nguyen Hai <nguyentrihai93@gmail.com>
Date: Fri, 16 Mar 2018 00:28:01 +0900
Subject: [PATCH 103/316] Switch from oslosphinx to openstackdocstheme

openstackdocstheme is a theme and extension support for
Sphinx documentation that is published to docs.openstack.org
and developer.openstack.org.

Change-Id: I37d1d50fb88b35e72b017d5dfbf148c35ac7e323
---
 doc/source/conf.py | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/doc/source/conf.py b/doc/source/conf.py
index 3505f13c..f56b643f 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -31,8 +31,11 @@
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo',
-              'sphinx.ext.coverage', 'oslosphinx']
+extensions = ['sphinx.ext.autodoc',
+              'sphinx.ext.doctest',
+              'sphinx.ext.todo',
+              'sphinx.ext.coverage',
+              'openstackdocstheme']
 
 autoclass_content = 'both'
 autodoc_default_flags = ['members', 'undoc-members', 'show-inheritance']
@@ -104,7 +107,7 @@
 
 # The theme to use for HTML and HTML Help pages.  Major themes that come with
 # Sphinx are currently 'default' and 'sphinxdoc'.
-#html_theme = 'nature'
+html_theme = 'openstackdocs'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

From 2312182241d36c716e624a23acd51f2b0252e4aa Mon Sep 17 00:00:00 2001
From: Chen <dstbtgagt@foxmail.com>
Date: Thu, 7 Jun 2018 22:38:41 +0800
Subject: [PATCH 104/316] Remove PyPI downloads

According to official site,
https://packaging.python.org/guides/analyzing-pypi-package-downloads/
PyPI package download statistics is no longer maintained and thus
should be removed.

Change-Id: I05e7d48d191bdaaf029f0ad1373a9c7c8b22e81e
---
 README.rst | 4 ----
 1 file changed, 4 deletions(-)

diff --git a/README.rst b/README.rst
index bc06f544..f41e5b79 100644
--- a/README.rst
+++ b/README.rst
@@ -14,10 +14,6 @@ Python bindings to the OpenStack Object Storage API
     :target: https://pypi.org/project/python-swiftclient/
     :alt: Latest Version
 
-.. image:: https://img.shields.io/pypi/dm/python-swiftclient.svg
-    :target: https://pypi.org/project/python-swiftclient/
-    :alt: Downloads
-
 This is a python client for the Swift API. There's a Python API (the
 ``swiftclient`` module), and a command-line script (``swift``).
 

From 33ad9fd4cc0ade9f0800a2815ee0ef514ae8f264 Mon Sep 17 00:00:00 2001
From: Alistair Coles <alistairncoles@gmail.com>
Date: Mon, 11 Jun 2018 13:19:05 +0100
Subject: [PATCH 105/316] Add option for user to enter password

Add the --prompt option for the CLI which will cause the user to be
prompted to enter a password. Any password otherwise specified by
--key, --os-password or an environment variable will be ignored.

The swift client will exit with a warning if the password cannot be
entered without its value being echoed.

Closes-Bug: #1357562
Change-Id: I513647eed460007617f129691069c6fb1bfe62d7
---
 doc/source/cli/index.rst |  4 +++
 swiftclient/shell.py     | 37 ++++++++++++++++++++++++++
 tests/unit/test_shell.py | 57 +++++++++++++++++++++++++++++++++++++---
 3 files changed, 95 insertions(+), 3 deletions(-)

diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst
index 4aa3bfcd..88fafa1d 100644
--- a/doc/source/cli/index.rst
+++ b/doc/source/cli/index.rst
@@ -139,6 +139,10 @@ swift optional arguments
   compression should be disabled by default by the
   system SSL library.
 
+``--prompt``
+  Prompt user to enter a password which overrides any password supplied via
+  ``--key``, ``--os-password`` or environment variables.
+
 Authentication
 ~~~~~~~~~~~~~~
 
diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index c15d7cfc..e91a16ff 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -17,11 +17,13 @@
 from __future__ import print_function, unicode_literals
 
 import argparse
+import getpass
 import io
 import json
 import logging
 import signal
 import socket
+import warnings
 
 from os import environ, walk, _exit as os_exit
 from os.path import isfile, isdir, join
@@ -1410,6 +1412,30 @@ def _get_default_metavar_for_positional(self, action):
         return action.dest
 
 
+def prompt_for_password():
+    """
+    Prompt the user for a password.
+
+    :raise SystemExit: if a password cannot be entered without it being echoed
+        to the terminal.
+    :return: the entered password.
+    """
+    with warnings.catch_warnings():
+        warnings.filterwarnings('error', category=getpass.GetPassWarning,
+                                append=True)
+        try:
+            # temporarily set signal handling back to default to avoid user
+            # Ctrl-c leaving terminal in weird state
+            signal.signal(signal.SIGINT, signal.SIG_DFL)
+            return getpass.getpass()
+        except EOFError:
+            return None
+        except getpass.GetPassWarning:
+            exit('Input stream incompatible with --prompt option')
+        finally:
+            signal.signal(signal.SIGINT, immediate_exit)
+
+
 def parse_args(parser, args, enforce_requires=True):
     options, args = parser.parse_known_args(args or ['-h'])
     options = vars(options)
@@ -1435,6 +1461,10 @@ def parse_args(parser, args, enforce_requires=True):
     if args and args[0] == 'tempurl':
         return options, args
 
+    # do this before process_options sets default auth version
+    if enforce_requires and options['prompt']:
+        options['key'] = options['os_password'] = prompt_for_password()
+
     # Massage auth version; build out os_options subdict
     process_options(options)
 
@@ -1506,6 +1536,7 @@ def main(arguments=None):
              [--os-key <client-certificate-key-file>]
              [--no-ssl-compression]
              [--force-auth-retry]
+             [--prompt]
              <subcommand> [--help] [<subcommand options>]
 
 Command-line interface to the OpenStack Swift API.
@@ -1620,6 +1651,12 @@ def main(arguments=None):
                         default=False,
                         help='Force a re-auth attempt on '
                              'any error other than 401 unauthorized')
+    parser.add_argument('--prompt',
+                        action='store_true', dest='prompt',
+                        default=False,
+                        help='Prompt user to enter a password which overrides '
+                             'any password supplied via --key, --os-password '
+                             'or environment variables.')
 
     os_grp = parser.add_argument_group("OpenStack authentication options")
     os_grp.add_argument('--os-username',
diff --git a/tests/unit/test_shell.py b/tests/unit/test_shell.py
index 110fb01f..3db48a48 100644
--- a/tests/unit/test_shell.py
+++ b/tests/unit/test_shell.py
@@ -13,8 +13,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 from __future__ import unicode_literals
+
 from genericpath import getmtime
 
+import getpass
 import hashlib
 import json
 import logging
@@ -2283,17 +2285,66 @@ def test_insufficient_args_v3(self):
         os_opts = {"password": "secret",
                    "auth_url": "http://example.com:5000/v3"}
         args = _make_args("stat", opts, os_opts)
-        self.assertRaises(SystemExit, swiftclient.shell.main, args)
+        with self.assertRaises(SystemExit) as cm:
+            swiftclient.shell.main(args)
+        self.assertIn(
+            'Auth version 3 requires either OS_USERNAME or OS_USER_ID',
+            str(cm.exception))
 
         os_opts = {"username": "user",
                    "auth_url": "http://example.com:5000/v3"}
         args = _make_args("stat", opts, os_opts)
-        self.assertRaises(SystemExit, swiftclient.shell.main, args)
+        with self.assertRaises(SystemExit) as cm:
+            swiftclient.shell.main(args)
+        self.assertIn('Auth version 3 requires OS_PASSWORD', str(cm.exception))
 
         os_opts = {"username": "user",
                    "password": "secret"}
         args = _make_args("stat", opts, os_opts)
-        self.assertRaises(SystemExit, swiftclient.shell.main, args)
+        with self.assertRaises(SystemExit) as cm:
+            swiftclient.shell.main(args)
+        self.assertIn('Auth version 3 requires OS_AUTH_URL', str(cm.exception))
+
+    def test_password_prompt(self):
+        def do_test(opts, os_opts, auth_version):
+            args = _make_args("stat", opts, os_opts)
+            result = [None, None]
+            fake_command = self._make_fake_command(result)
+            with mock.patch('swiftclient.shell.st_stat', fake_command):
+                with mock.patch('getpass.getpass',
+                                return_value='input_pwd') as mock_getpass:
+                    swiftclient.shell.main(args)
+            mock_getpass.assert_called_once_with()
+            self.assertEqual('input_pwd', result[0]['key'])
+            self.assertEqual('input_pwd', result[0]['os_password'])
+
+            # ctrl-D
+            with self.assertRaises(SystemExit) as cm:
+                with mock.patch('swiftclient.shell.st_stat', fake_command):
+                    with mock.patch('getpass.getpass',
+                                    side_effect=EOFError) as mock_getpass:
+                        swiftclient.shell.main(args)
+            mock_getpass.assert_called_once_with()
+            self.assertIn(
+                'Auth version %s requires' % auth_version, str(cm.exception))
+
+            # force getpass to think it needs to use raw input
+            with self.assertRaises(SystemExit) as cm:
+                with mock.patch('getpass.getpass', getpass.fallback_getpass):
+                    swiftclient.shell.main(args)
+            self.assertIn(
+                'Input stream incompatible', str(cm.exception))
+
+        opts = {"prompt": None, "user": "bob", "key": "secret",
+                "auth": "http://example.com:8080/auth/v1.0"}
+        do_test(opts, {}, '1.0')
+        os_opts = {"username": "user",
+                   "password": "secret",
+                   "auth_url": "http://example.com:5000/v3"}
+        opts = {"auth_version": "2.0", "prompt": None}
+        do_test(opts, os_opts, '2.0')
+        opts = {"auth_version": "3", "prompt": None}
+        do_test(opts, os_opts, '3')
 
     def test_no_tenant_name_or_id_v2(self):
         os_opts = {"password": "secret",

From 11908250549fed549169519d411394296fb4a57b Mon Sep 17 00:00:00 2001
From: Clay Gerrard <clay.gerrard@gmail.com>
Date: Tue, 13 Jun 2017 11:14:52 -0700
Subject: [PATCH 106/316] Make OS_AUTH_URL work in DevStack by default

An earlier change added support for versionless authurls, but the
huristic to detect them didn't work for some configurations I've
encountered.

Now we use a little bit tighter pattern matching and support auth_url
values with more than one path component.

Change-Id: I5a99c7b4e957ee7c8a5b5470477db49ab2ddba4b
Related-Change-Id: If7ecb67776cb77828f93ad8278cc5040015216b7
---
 swiftclient/client.py          |  7 ++++-
 tests/unit/test_swiftclient.py | 47 ++++++++++++++++++++++++++++++++++
 2 files changed, 53 insertions(+), 1 deletion(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index 45188083..cc2a124b 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -17,6 +17,7 @@
 OpenStack Swift client library used internally
 """
 import socket
+import re
 import requests
 import logging
 import warnings
@@ -38,6 +39,7 @@
 # Default is 100, increase to 256
 http_client._MAXHEADERS = 256
 
+VERSIONFUL_AUTH_PATH = re.compile('v[2-3](?:\.0)?$')
 AUTH_VERSIONS_V1 = ('1.0', '1', 1)
 AUTH_VERSIONS_V2 = ('2.0', '2', 2)
 AUTH_VERSIONS_V3 = ('3.0', '3', 3)
@@ -555,7 +557,10 @@ def get_auth_keystone(auth_url, user, key, os_options, **kwargs):
 
     # Add the version suffix in case of versionless Keystone endpoints. If
     # auth_version is also unset it is likely that it is v3
-    if len(urlparse(auth_url).path) <= 1:
+    if not VERSIONFUL_AUTH_PATH.match(
+            urlparse(auth_url).path.rstrip('/').rsplit('/', 1)[-1]):
+        # Normalize auth_url to end in a slash because urljoin
+        auth_url = auth_url.rstrip('/') + '/'
         if auth_version and auth_version in AUTH_VERSIONS_V2:
             auth_url = urljoin(auth_url, "v2.0")
         else:
diff --git a/tests/unit/test_swiftclient.py b/tests/unit/test_swiftclient.py
index 52153dca..009a026d 100644
--- a/tests/unit/test_swiftclient.py
+++ b/tests/unit/test_swiftclient.py
@@ -597,6 +597,53 @@ def test_get_auth_keystone_versionless_auth_version_set(self):
         self.assertEqual('http://auth_url/v2.0',
                          fake_ks.calls[0].get('auth_url'))
 
+    def test_get_auth_keystone_versionful(self):
+        fake_ks = FakeKeystone(endpoint='http://some_url', token='secret')
+
+        with mock.patch('swiftclient.client._import_keystone_client',
+                        _make_fake_import_keystone_client(fake_ks)):
+            c.get_auth_keystone('http://auth_url/v3', 'user', 'key',
+                                {}, auth_version='3')
+        self.assertEqual(1, len(fake_ks.calls))
+        self.assertEqual('http://auth_url/v3',
+                         fake_ks.calls[0].get('auth_url'))
+
+    def test_get_auth_keystone_devstack_versionful(self):
+        fake_ks = FakeKeystone(
+            endpoint='http://storage.example.com/v1/AUTH_user', token='secret')
+        with mock.patch('swiftclient.client._import_keystone_client',
+                        _make_fake_import_keystone_client(fake_ks)):
+            c.get_auth_keystone('https://192.168.8.8/identity/v3',
+                                'user', 'key', {}, auth_version='3')
+        self.assertEqual(1, len(fake_ks.calls))
+        self.assertEqual('https://192.168.8.8/identity/v3',
+                         fake_ks.calls[0].get('auth_url'))
+
+    def test_get_auth_keystone_devstack_versionless(self):
+        fake_ks = FakeKeystone(
+            endpoint='http://storage.example.com/v1/AUTH_user', token='secret')
+        with mock.patch('swiftclient.client._import_keystone_client',
+                        _make_fake_import_keystone_client(fake_ks)):
+            c.get_auth_keystone('https://192.168.8.8/identity',
+                                'user', 'key', {}, auth_version='3')
+        self.assertEqual(1, len(fake_ks.calls))
+        self.assertEqual('https://192.168.8.8/identity/v3',
+                         fake_ks.calls[0].get('auth_url'))
+
+    def test_auth_keystone_url_some_junk_nonsense(self):
+        fake_ks = FakeKeystone(
+            endpoint='http://storage.example.com/v1/AUTH_user',
+            token='secret')
+        with mock.patch('swiftclient.client._import_keystone_client',
+                        _make_fake_import_keystone_client(fake_ks)):
+            c.get_auth_keystone('http://blah.example.com/v2moo',
+                                'user', 'key', {}, auth_version='3')
+        self.assertEqual(1, len(fake_ks.calls))
+        # v2 looks sorta version-y, but it's not an exact match, so this is
+        # probably about just as bad as anything else we might guess at
+        self.assertEqual('http://blah.example.com/v2moo/v3',
+                         fake_ks.calls[0].get('auth_url'))
+
     def test_auth_with_session(self):
         mock_session = mock.MagicMock()
         mock_session.get_endpoint.return_value = 'http://storagehost/v1/acct'

From 85bb28eab4fab97e834ebfd2ef29bb3f4fc9bf5f Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 22 Jun 2018 16:23:57 -0700
Subject: [PATCH 107/316] Remove some pointless code

Change-Id: I3163834c330c5ea44c1096e83127588c88f0d761
---
 tests/functional/test_swiftclient.py | 6 ------
 1 file changed, 6 deletions(-)

diff --git a/tests/functional/test_swiftclient.py b/tests/functional/test_swiftclient.py
index d60ae063..0380d961 100644
--- a/tests/functional/test_swiftclient.py
+++ b/tests/functional/test_swiftclient.py
@@ -485,9 +485,6 @@ def _get_connection(self):
             self.auth_url, username, password, auth_version=self.auth_version,
             os_options=os_options)
 
-    def setUp(self):
-        super(TestUsingKeystone, self).setUp()
-
 
 class TestUsingKeystoneV3(TestFunctional):
     """
@@ -514,6 +511,3 @@ def _get_connection(self):
         return swiftclient.Connection(self.auth_url, username, password,
                                       auth_version=self.auth_version,
                                       os_options=os_options)
-
-    def setUp(self):
-        super(TestUsingKeystoneV3, self).setUp()

From c1e896c8612dfcf91235d3a67d0c17595777764c Mon Sep 17 00:00:00 2001
From: "wu.chunyang" <wu.chunyang@99cloud.net>
Date: Thu, 28 Jun 2018 14:07:09 +0800
Subject: [PATCH 108/316] Add release note link in README

Change-Id: Ie282f4a731e333b5d21490a8fb59e1c7e8640821
---
 README.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/README.rst b/README.rst
index f41e5b79..b105094a 100644
--- a/README.rst
+++ b/README.rst
@@ -37,6 +37,7 @@ __ https://github.com/openstack/swift
 * `Source`_
 * `Specs`_
 * `How to Contribute`_
+* `Release Notes`_
 
 .. _PyPI: https://pypi.org/project/python-swiftclient
 .. _Online Documentation: https://docs.openstack.org/python-swiftclient/latest/
@@ -46,7 +47,7 @@ __ https://github.com/openstack/swift
 .. _Source: https://git.openstack.org/cgit/openstack/python-swiftclient
 .. _How to Contribute: https://docs.openstack.org/infra/manual/developers.html
 .. _Specs: https://specs.openstack.org/openstack/swift-specs/
-
+.. _Release Notes: https://docs.openstack.org/releasenotes/python-swiftclient
 
 .. contents:: Contents:
    :local:

From 47fb18c41b4851ba6071f0215e96e222b8ccef29 Mon Sep 17 00:00:00 2001
From: mmcardle <mark.mcardle@sohonet.com>
Date: Tue, 10 Jul 2018 14:45:32 +0100
Subject: [PATCH 109/316] Add ability to generate a temporary URL with an IP
 range restriction

Change-Id: I4734599886e4f4a563162390d0ff3bb1ef639db4
---
 swiftclient/shell.py     | 11 ++++++++-
 swiftclient/utils.py     | 25 ++++++++++++++++++---
 tests/unit/test_shell.py | 30 ++++++++++++++++++++-----
 tests/unit/test_utils.py | 48 ++++++++++++++++++++++++++++++++++++++++
 4 files changed, 105 insertions(+), 9 deletions(-)

diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index e91a16ff..74a47b70 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -1325,6 +1325,8 @@ def st_auth(parser, args, thread_manager):
                         generated.
   --iso8601             If present, the generated temporary URL will contain an
                         ISO 8601 UTC timestamp instead of a Unix timestamp.
+  --ip-range            If present, the temporary URL will be restricted to the
+                        given ip or ip range.
 '''.strip('\n')
 
 
@@ -1348,6 +1350,12 @@ def st_tempurl(parser, args, thread_manager):
         help=("If present, the temporary URL will contain an ISO 8601 UTC "
               "timestamp instead of a Unix timestamp."),
     )
+    parser.add_argument(
+        '--ip-range', action='store',
+        default=None,
+        help=("If present, the temporary URL will be restricted to the "
+              "given ip or ip range."),
+    )
 
     (options, args) = parse_args(parser, args)
     args = args[1:]
@@ -1367,7 +1375,8 @@ def st_tempurl(parser, args, thread_manager):
         path = generate_temp_url(parsed.path, timestamp, key, method,
                                  absolute=options['absolute_expiry'],
                                  iso8601=options['iso8601'],
-                                 prefix=options['prefix_based'])
+                                 prefix=options['prefix_based'],
+                                 ip_range=options['ip_range'])
     except ValueError as err:
         thread_manager.error(err)
         return
diff --git a/swiftclient/utils.py b/swiftclient/utils.py
index 8afcde97..5c17c613 100644
--- a/swiftclient/utils.py
+++ b/swiftclient/utils.py
@@ -69,7 +69,7 @@ def prt_bytes(num_bytes, human_flag):
 
 
 def generate_temp_url(path, seconds, key, method, absolute=False,
-                      prefix=False, iso8601=False):
+                      prefix=False, iso8601=False, ip_range=None):
     """Generates a temporary URL that gives unauthenticated access to the
     Swift object.
 
@@ -92,6 +92,8 @@ def generate_temp_url(path, seconds, key, method, absolute=False,
     :param prefix: if True then a prefix-based temporary URL will be generated.
     :param iso8601: if True, a URL containing an ISO 8601 UTC timestamp
         instead of a UNIX timestamp will be created.
+    :param ip_range: if a valid ip range, restricts the temporary URL to the
+        range of ips.
     :raises ValueError: if timestamp or path is not in valid format.
     :return: the path portion of a temporary URL
     """
@@ -155,8 +157,21 @@ def generate_temp_url(path, seconds, key, method, absolute=False,
         expiration = int(time.time() + timestamp)
     else:
         expiration = timestamp
-    hmac_body = u'\n'.join([method.upper(), str(expiration),
-                            ('prefix:' if prefix else '') + path_for_body])
+
+    hmac_parts = [method.upper(), str(expiration),
+                  ('prefix:' if prefix else '') + path_for_body]
+
+    if ip_range:
+        if isinstance(ip_range, six.binary_type):
+            try:
+                ip_range = ip_range.decode('utf-8')
+            except UnicodeDecodeError:
+                raise ValueError(
+                    'ip_range must be representable as UTF-8'
+                )
+        hmac_parts.insert(0, "ip=%s" % ip_range)
+
+    hmac_body = u'\n'.join(hmac_parts)
 
     # Encode to UTF-8 for py3 compatibility
     if not isinstance(key, six.binary_type):
@@ -169,6 +184,10 @@ def generate_temp_url(path, seconds, key, method, absolute=False,
 
     temp_url = u'{path}?temp_url_sig={sig}&temp_url_expires={exp}'.format(
         path=path_for_body, sig=sig, exp=expiration)
+
+    if ip_range:
+        temp_url += u'&temp_url_ip_range={}'.format(ip_range)
+
     if prefix:
         temp_url += u'&temp_url_prefix={}'.format(parts[4])
     # Have return type match path from caller
diff --git a/tests/unit/test_shell.py b/tests/unit/test_shell.py
index 3db48a48..8c995e5d 100644
--- a/tests/unit/test_shell.py
+++ b/tests/unit/test_shell.py
@@ -1667,7 +1667,7 @@ def test_temp_url(self, temp_url):
         swiftclient.shell.main(argv)
         temp_url.assert_called_with(
             '/v1/AUTH_account/c/o', "60", 'secret_key', 'GET', absolute=False,
-            iso8601=False, prefix=False)
+            iso8601=False, prefix=False, ip_range=None)
 
     @mock.patch('swiftclient.shell.generate_temp_url', return_value='')
     def test_temp_url_prefix_based(self, temp_url):
@@ -1676,7 +1676,7 @@ def test_temp_url_prefix_based(self, temp_url):
         swiftclient.shell.main(argv)
         temp_url.assert_called_with(
             '/v1/AUTH_account/c/', "60", 'secret_key', 'GET', absolute=False,
-            iso8601=False, prefix=True)
+            iso8601=False, prefix=True, ip_range=None)
 
     @mock.patch('swiftclient.shell.generate_temp_url', return_value='')
     def test_temp_url_iso8601_in(self, temp_url):
@@ -1688,7 +1688,7 @@ def test_temp_url_iso8601_in(self, temp_url):
             swiftclient.shell.main(argv)
             temp_url.assert_called_with(
                 '/v1/AUTH_account/c/', d, 'secret_key', 'GET', absolute=False,
-                iso8601=False, prefix=False)
+                iso8601=False, prefix=False, ip_range=None)
 
     @mock.patch('swiftclient.shell.generate_temp_url', return_value='')
     def test_temp_url_iso8601_out(self, temp_url):
@@ -1697,7 +1697,7 @@ def test_temp_url_iso8601_out(self, temp_url):
         swiftclient.shell.main(argv)
         temp_url.assert_called_with(
             '/v1/AUTH_account/c/', "60", 'secret_key', 'GET', absolute=False,
-            iso8601=True, prefix=False)
+            iso8601=True, prefix=False, ip_range=None)
 
     @mock.patch('swiftclient.shell.generate_temp_url', return_value='')
     def test_absolute_expiry_temp_url(self, temp_url):
@@ -1706,7 +1706,16 @@ def test_absolute_expiry_temp_url(self, temp_url):
         swiftclient.shell.main(argv)
         temp_url.assert_called_with(
             '/v1/AUTH_account/c/o', "60", 'secret_key', 'GET', absolute=True,
-            iso8601=False, prefix=False)
+            iso8601=False, prefix=False, ip_range=None)
+
+    @mock.patch('swiftclient.shell.generate_temp_url', return_value='')
+    def test_temp_url_with_ip_range(self, temp_url):
+        argv = ["", "tempurl", "GET", "60", "/v1/AUTH_account/c/o",
+                "secret_key", "--ip-range", "1.2.3.4"]
+        swiftclient.shell.main(argv)
+        temp_url.assert_called_with(
+            '/v1/AUTH_account/c/o', "60", 'secret_key', 'GET', absolute=False,
+            iso8601=False, prefix=False, ip_range='1.2.3.4')
 
     def test_temp_url_output(self):
         argv = ["", "tempurl", "GET", "60", "/v1/a/c/o",
@@ -1769,6 +1778,17 @@ def test_temp_url_output(self):
             swiftclient.shell.main(argv)
             self.assertEqual(expected, output.out)
 
+        argv = ["", "tempurl", "GET", "60", "/v1/a/c/o",
+                "secret_key", "--absolute", "--ip-range", "1.2.3.4"]
+        with CaptureOutput(suppress_systemexit=True) as output:
+            swiftclient.shell.main(argv)
+        sig = "6a6ec8efa4be53904ecba8d055d841e24a937c98"
+        expected = (
+            "/v1/a/c/o?temp_url_sig=%s&temp_url_expires=60"
+            "&temp_url_ip_range=1.2.3.4\n" % sig
+        )
+        self.assertEqual(expected, output.out)
+
     def test_temp_url_error_output(self):
         expected = 'path must be full path to an object e.g. /v1/a/c/o\n'
         for bad_path in ('/v1/a/c', 'v1/a/c/o', '/v1/a/c/', '/v1/a//o',
diff --git a/tests/unit/test_utils.py b/tests/unit/test_utils.py
index adead005..e54b90c7 100644
--- a/tests/unit/test_utils.py
+++ b/tests/unit/test_utils.py
@@ -151,6 +151,54 @@ def test_generate_temp_url(self, time_mock, hmac_mock):
         ])
         self.assertIsInstance(url, type(self.url))
 
+    @mock.patch('hmac.HMAC')
+    @mock.patch('time.time', return_value=1400000000)
+    def test_generate_temp_url_ip_range(self, time_mock, hmac_mock):
+        hmac_mock().hexdigest.return_value = 'temp_url_signature'
+        ip_ranges = [
+            '1.2.3.4', '1.2.3.4/24', '2001:db8::',
+            b'1.2.3.4', b'1.2.3.4/24', b'2001:db8::',
+        ]
+        path = '/v1/AUTH_account/c/o/'
+        expected_url = path + ('?temp_url_sig=temp_url_signature'
+                               '&temp_url_expires=1400003600'
+                               '&temp_url_ip_range=')
+        for ip_range in ip_ranges:
+            hmac_mock.reset_mock()
+            url = u.generate_temp_url(path, self.seconds,
+                                      self.key, self.method,
+                                      ip_range=ip_range)
+            key = self.key
+            if not isinstance(key, six.binary_type):
+                key = key.encode('utf-8')
+
+            if isinstance(ip_range, six.binary_type):
+                ip_range_expected_url = (
+                    expected_url + ip_range.decode('utf-8')
+                )
+                expected_body = '\n'.join([
+                    'ip=' + ip_range.decode('utf-8'),
+                    self.method,
+                    '1400003600',
+                    path,
+                ]).encode('utf-8')
+            else:
+                ip_range_expected_url = expected_url + ip_range
+                expected_body = '\n'.join([
+                    'ip=' + ip_range,
+                    self.method,
+                    '1400003600',
+                    path,
+                ]).encode('utf-8')
+
+            self.assertEqual(url, ip_range_expected_url)
+
+            self.assertEqual(hmac_mock.mock_calls, [
+                mock.call(key, expected_body, sha1),
+                mock.call().hexdigest(),
+            ])
+            self.assertIsInstance(url, type(path))
+
     @mock.patch('hmac.HMAC')
     def test_generate_temp_url_iso8601_argument(self, hmac_mock):
         hmac_mock().hexdigest.return_value = 'temp_url_signature'

From da362a653e9c70cb6ae17a7c3764887b4fd3fcf2 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Wed, 16 May 2018 17:33:40 +0000
Subject: [PATCH 110/316] Back out some version bumps

I'm giving up on trying to back out all of the test-requirements
up-revs, but let's try to stay compatibile with old requests/six.

As part of that, only disable some requests warnings on new-enough requests.

Note that we should now be compatible with distro packages back to
Ubuntu 16.04 and CentOS 6. Our six is still too new for Trusty, but
hey, there's less than a year left on that anyway, right?

Change-Id: Iccb23638393616f9ec3da660dd5e39ea4ea94220
Related-Change: I2a8f465c8b08370517cbec857933b08fca94ca38
---
 lower-constraints.txt    |  6 +++---
 requirements.txt         |  7 ++-----
 setup.cfg                |  2 +-
 setup.py                 | 14 ++++----------
 swiftclient/shell.py     | 11 ++++++++---
 tests/unit/test_shell.py | 35 ++++++++++++++++++++++++++---------
 6 files changed, 44 insertions(+), 31 deletions(-)

diff --git a/lower-constraints.txt b/lower-constraints.txt
index 6488b28f..9aae7927 100644
--- a/lower-constraints.txt
+++ b/lower-constraints.txt
@@ -28,14 +28,14 @@ pep8==1.5.7
 PrettyTable==0.7
 pyflakes==0.8.1
 Pygments==2.2.0
-python-keystoneclient==3.8.0
+python-keystoneclient==0.7.0
 python-mimeparse==1.6.0
 python-subunit==1.0.0
 pytz==2013.6
 PyYAML==3.12
 reno==2.5.0
-requests==2.14.2
-six==1.10.0
+requests==1.1.0
+six==1.9.0
 snowballstemmer==1.2.1
 sphinx==1.6.2
 sphinxcontrib-websupport==1.0.1
diff --git a/requirements.txt b/requirements.txt
index 6b527918..1c2ce33d 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,6 +1,3 @@
-# The order of packages is significant, because pip processes them in the order
-# of appearance. Changing the order has an impact on the overall integration
-# process, which may cause wedges in the gate later.
 futures>=3.0.0;python_version=='2.7' or python_version=='2.6' # BSD
-requests>=2.14.2 # Apache-2.0
-six>=1.10.0 # MIT
+requests>=1.1.0
+six>=1.9.0
diff --git a/setup.cfg b/setup.cfg
index f20bbcaf..e4963dba 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -34,7 +34,7 @@ data_files =
 
 [extras]
 keystone =
-  python-keystoneclient>=3.8.0 # Apache-2.0
+    python-keystoneclient>=0.7.0
 
 [entry_points]
 console_scripts =
diff --git a/setup.py b/setup.py
index 518f1d34..16a18f6e 100644
--- a/setup.py
+++ b/setup.py
@@ -17,16 +17,10 @@
 # THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT
 import setuptools, sys
 
-import setuptools
-
-# In python < 2.7.4, a lazy loading of package `pbr` will break
-# setuptools if some other modules registered functions in `atexit`.
-# solution from: http://bugs.python.org/issue15881#msg170215
-try:
-    import multiprocessing  # noqa
-except ImportError:
-    pass
+if sys.version_info < (2, 7):
+    sys.exit('Sorry, Python < 2.7 is not supported for'
+             ' python-swiftclient>=3.0')
 
 setuptools.setup(
-    setup_requires=['pbr>=2.0.0'],
+    setup_requires=['pbr'],
     pbr=True)
diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index e91a16ff..3f66d5f6 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -1819,9 +1819,14 @@ def main(arguments=None):
         parser.usage = globals()['st_%s_help' % args[0]]
         if options['insecure']:
             import requests
-            from requests.packages.urllib3.exceptions import \
-                InsecureRequestWarning
-            requests.packages.urllib3.disable_warnings(InsecureRequestWarning)
+            try:
+                from requests.packages.urllib3.exceptions import \
+                    InsecureRequestWarning
+            except ImportError:
+                pass
+            else:
+                requests.packages.urllib3.disable_warnings(
+                    InsecureRequestWarning)
         try:
             globals()['st_%s' % args[0]](parser, argv[1:], output)
         except ClientException as err:
diff --git a/tests/unit/test_shell.py b/tests/unit/test_shell.py
index 3db48a48..54238591 100644
--- a/tests/unit/test_shell.py
+++ b/tests/unit/test_shell.py
@@ -14,8 +14,8 @@
 # limitations under the License.
 from __future__ import unicode_literals
 
+import contextlib
 from genericpath import getmtime
-
 import getpass
 import hashlib
 import json
@@ -27,7 +27,6 @@
 import textwrap
 from time import localtime, mktime, strftime, strptime
 
-from requests.packages.urllib3.exceptions import InsecureRequestWarning
 import six
 import sys
 
@@ -44,6 +43,10 @@
     EMPTY_ETAG, EXPIRES_ISO8601_FORMAT,
     SHORT_EXPIRES_ISO8601_FORMAT, TIME_ERRMSG)
 
+try:
+    from requests.packages.urllib3.exceptions import InsecureRequestWarning
+except ImportError:
+    InsecureRequestWarning = None
 
 if six.PY2:
     BUILTIN_OPEN = '__builtin__.open'
@@ -114,6 +117,20 @@ def _make_cmd(cmd, opts, os_opts, use_env=False, flags=None, cmd_args=None):
     return args, env
 
 
+@contextlib.contextmanager
+def patch_disable_warnings():
+    if InsecureRequestWarning is None:
+        # If InsecureRequestWarning isn't available, disbale_warnings won't
+        # be either; they both came in with
+        # https://github.com/requests/requests/commit/811ee4e and left again
+        # in https://github.com/requests/requests/commit/8e17600
+        yield None
+    else:
+        with mock.patch('requests.packages.urllib3.disable_warnings') \
+                as patched:
+            yield patched
+
+
 @mock.patch.dict(os.environ, mocked_os_environ)
 class TestShell(unittest.TestCase):
     def setUp(self):
@@ -2509,8 +2526,7 @@ def _test_options_passed_to_keystone(self, cmd, opts, os_opts,
                         _make_fake_import_keystone_client(fake_ks)), \
                 mock.patch('swiftclient.client.http_connection', fake_conn), \
                 mock.patch.dict(os.environ, env, clear=True), \
-                mock.patch('requests.packages.urllib3.disable_warnings') as \
-                mock_disable_warnings:
+                patch_disable_warnings() as mock_disable_warnings:
             try:
                 swiftclient.shell.main(args)
             except SystemExit as e:
@@ -2518,11 +2534,12 @@ def _test_options_passed_to_keystone(self, cmd, opts, os_opts,
             except SwiftError as err:
                 self.fail('Unexpected SwiftError: %s' % err)
 
-        if 'insecure' in flags:
-            self.assertEqual([mock.call(InsecureRequestWarning)],
-                             mock_disable_warnings.mock_calls)
-        else:
-            self.assertEqual([], mock_disable_warnings.mock_calls)
+        if InsecureRequestWarning is not None:
+            if 'insecure' in flags:
+                self.assertEqual([mock.call(InsecureRequestWarning)],
+                                 mock_disable_warnings.mock_calls)
+            else:
+                self.assertEqual([], mock_disable_warnings.mock_calls)
 
         if no_auth:
             # check that keystone client was not used and terminate tests

From 45ed21c6c433e2f5979df2820424bf5b44c478db Mon Sep 17 00:00:00 2001
From: Matthew Oliver <matt@oliver.net.au>
Date: Fri, 29 Jun 2018 11:07:00 +1000
Subject: [PATCH 111/316] Add bash_completion to swiftclient

This patch basically follows the bash completion
model that other OpenStack clients use. It creates
a new command to swiftclient called `bash_completion`.

The `bash_completion` command by default will print
all base flags and exsiting commands. If you pass
it a command, it'll print out all base flags and
any flags that command accepts. So as you type out
your swift command and auto-complete, only the current
available flags are offered to you.

This is used by the swift.bash_completion script to
allow swift commands to be bash completed.

To make it work, place the swift.bash_completion file
into /etc/bash_completion.d and source it:

  cp tools/swift.bash_completion /etc/bash_completion.d/swift
  source /etc/bash_completion.d/swift

Because swiftclient itself is creating this flag/command output
it should automatically add anything we add to the swiftclient
CLI.

Change-Id: I5609a19018269762b4640403daae5827bb9ad724
---
 swiftclient/shell.py        | 312 ++++++++++++++++++++++++------------
 tools/swift.bash_completion |  32 ++++
 2 files changed, 245 insertions(+), 99 deletions(-)
 create mode 100644 tools/swift.bash_completion

diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 74a47b70..ff5b2be5 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -51,7 +51,7 @@
 
 BASENAME = 'swift'
 commands = ('delete', 'download', 'list', 'post', 'copy', 'stat', 'upload',
-            'capabilities', 'info', 'tempurl', 'auth')
+            'capabilities', 'info', 'tempurl', 'auth', 'bash_completion')
 
 
 def immediate_exit(signum, frame):
@@ -90,7 +90,7 @@ def immediate_exit(signum, frame):
 '''.strip("\n")
 
 
-def st_delete(parser, args, output_manager):
+def st_delete(parser, args, output_manager, return_parser=False):
     parser.add_argument(
         '-a', '--all', action='store_true', dest='yes_all',
         default=False, help='Delete all containers and objects.')
@@ -114,6 +114,11 @@ def st_delete(parser, args, output_manager):
         '--container-threads', type=int,
         default=10, help='Number of threads to use for deleting containers. '
         'Its value must be a positive integer. Default is 10.')
+
+    # We return the parser to build up the bash_completion
+    if return_parser:
+        return parser
+
     (options, args) = parse_args(parser, args)
     args = args[1:]
     if (not args and not options['yes_all']) or (args and options['yes_all']):
@@ -281,7 +286,7 @@ def st_delete(parser, args, output_manager):
 '''.strip("\n")
 
 
-def st_download(parser, args, output_manager):
+def st_download(parser, args, output_manager, return_parser=False):
     parser.add_argument(
         '-a', '--all', action='store_true', dest='yes_all',
         default=False, help='Indicates that you really want to download '
@@ -344,6 +349,11 @@ def st_download(parser, args, output_manager):
         'to store the access and modified timestamp for the downloaded file. '
         'With this option, the header is ignored and the timestamps are '
         'created freshly.')
+
+    # We return the parser to build up the bash_completion
+    if return_parser:
+        return parser
+
     (options, args) = parse_args(parser, args)
     args = args[1:]
     if options['out_file'] == '-':
@@ -494,7 +504,7 @@ def st_download(parser, args, output_manager):
 '''.strip('\n')
 
 
-def st_list(parser, args, output_manager):
+def st_list(parser, args, output_manager, return_parser=False):
 
     def _print_stats(options, stats, human):
         total_count = total_bytes = 0
@@ -571,6 +581,11 @@ def _print_stats(options, stats, human):
         '-H', '--header', action='append', dest='header',
         default=[],
         help='Adds a custom request header to use for listing.')
+
+    # We return the parser to build up the bash_completion
+    if return_parser:
+        return parser
+
     options, args = parse_args(parser, args)
     args = args[1:]
     if options['delimiter'] and not args:
@@ -629,7 +644,7 @@ def _print_stats(options, stats, human):
 '''.strip('\n')
 
 
-def st_stat(parser, args, output_manager):
+def st_stat(parser, args, output_manager, return_parser=False):
     parser.add_argument(
         '--lh', dest='human', action='store_true', default=False,
         help='Report sizes in human readable format similar to ls -lh.')
@@ -638,6 +653,10 @@ def st_stat(parser, args, output_manager):
         default=[],
         help='Adds a custom request header to use for stat.')
 
+    # We return the parser to build up the bash_completion
+    if return_parser:
+        return parser
+
     options, args = parse_args(parser, args)
     args = args[1:]
 
@@ -725,7 +744,7 @@ def st_stat(parser, args, output_manager):
 '''.strip('\n')
 
 
-def st_post(parser, args, output_manager):
+def st_post(parser, args, output_manager, return_parser=False):
     parser.add_argument(
         '-r', '--read-acl', dest='read_acl', help='Read ACL for containers. '
         'Quick summary of ACL syntax: .r:*, .r:-.example.com, '
@@ -750,6 +769,11 @@ def st_post(parser, args, output_manager):
         'This option may be repeated. '
         'Example: -H "content-type:text/plain" '
         '-H "Content-Length: 4000"')
+
+    # We return the parser to build up the bash_completion
+    if return_parser:
+        return parser
+
     (options, args) = parse_args(parser, args)
     args = args[1:]
     if (options['read_acl'] or options['write_acl'] or options['sync_to'] or
@@ -822,7 +846,7 @@ def st_post(parser, args, output_manager):
 '''.strip('\n')
 
 
-def st_copy(parser, args, output_manager):
+def st_copy(parser, args, output_manager, return_parser=False):
     parser.add_argument(
         '-d', '--destination', help='The container and name of the '
         'destination object')
@@ -839,6 +863,11 @@ def st_copy(parser, args, output_manager):
         'This option may be repeated. '
         'Example: -H "content-type:text/plain" '
         '-H "Content-Length: 4000"')
+
+    # We return the parser to build up the bash_completion
+    if return_parser:
+        return parser
+
     (options, args) = parse_args(parser, args)
     args = args[1:]
 
@@ -948,7 +977,7 @@ def st_copy(parser, args, output_manager):
 '''.strip('\n')
 
 
-def st_upload(parser, args, output_manager):
+def st_upload(parser, args, output_manager, return_parser=False):
     DEFAULT_STDIN_SEGMENT = 10 * 1024 * 1024
 
     parser.add_argument(
@@ -1006,6 +1035,11 @@ def st_upload(parser, args, output_manager):
     parser.add_argument(
         '--ignore-checksum', dest='checksum', default=True,
         action='store_false', help='Turn off checksum validation for uploads.')
+
+    # We return the parser to build up the bash_completion
+    if return_parser:
+        return parser
+
     options, args = parse_args(parser, args)
     args = args[1:]
     if len(args) < 2:
@@ -1185,7 +1219,7 @@ def st_upload(parser, args, output_manager):
 st_info_help = st_capabilities_help
 
 
-def st_capabilities(parser, args, output_manager):
+def st_capabilities(parser, args, output_manager, return_parser=False):
     def _print_compo_cap(name, capabilities):
         for feature, options in sorted(capabilities.items(),
                                        key=lambda x: x[0]):
@@ -1198,6 +1232,11 @@ def _print_compo_cap(name, capabilities):
 
     parser.add_argument('--json', action='store_true',
                         help='print capability information in json')
+
+    # We return the parser to build up the bash_completion
+    if return_parser:
+        return parser
+
     (options, args) = parse_args(parser, args)
     if args and len(args) > 2:
         output_manager.error('Usage: %s capabilities %s\n%s',
@@ -1246,7 +1285,12 @@ def _print_compo_cap(name, capabilities):
 '''.strip('\n')
 
 
-def st_auth(parser, args, thread_manager):
+def st_auth(parser, args, thread_manager, return_parser=False):
+
+    # We return the parser to build up the bash_completion
+    if return_parser:
+        return parser
+
     (options, args) = parse_args(parser, args)
     if options['verbose'] > 1:
         if options['auth_version'] in ('1', '1.0'):
@@ -1330,7 +1374,7 @@ def st_auth(parser, args, thread_manager):
 '''.strip('\n')
 
 
-def st_tempurl(parser, args, thread_manager):
+def st_tempurl(parser, args, thread_manager, return_parser=False):
     parser.add_argument(
         '--absolute', action='store_true',
         dest='absolute_expiry', default=False,
@@ -1357,6 +1401,10 @@ def st_tempurl(parser, args, thread_manager):
               "given ip or ip range."),
     )
 
+    # We return the parser to build up the bash_completion
+    if return_parser:
+        return parser
+
     (options, args) = parse_args(parser, args)
     args = args[1:]
     if len(args) < 4:
@@ -1388,6 +1436,65 @@ def st_tempurl(parser, args, thread_manager):
     thread_manager.print_msg(url)
 
 
+st_bash_completion_help = '''Retrieve command specific flags used by bash_completion.
+
+Optional positional arguments:
+  <command>           Swift client command to filter the flags by.
+'''.strip('\n')
+
+
+st_bash_completion_options = '''[command]
+'''
+
+
+def st_bash_completion(parser, args, thread_manager, return_parser=False):
+    if return_parser:
+        return parser
+
+    global commands
+    com = args[1] if len(args) > 1 else None
+
+    if com:
+        if com in commands:
+            fn_commands = ["st_%s" % com]
+        else:
+            print("")
+            return
+    else:
+        fn_commands = [fn for fn in globals().keys()
+                       if fn.startswith('st_') and not fn.endswith('_options')
+                       and not fn.endswith('_help')]
+
+    subparsers = parser.add_subparsers()
+    subcommands = {}
+    if not com:
+        subcommands['base'] = parser
+    for command in fn_commands:
+        cmd = command[3:]
+        if com:
+            subparser = subparsers.add_parser(
+                cmd, help=globals()['%s_help' % command])
+            add_default_args(subparser)
+            subparser = globals()[command](
+                subparser, args, thread_manager, True)
+            subcommands[cmd] = subparser
+        else:
+            subcommands[cmd] = None
+
+    cmds = set()
+    opts = set()
+    for sc_str, sc in list(subcommands.items()):
+        cmds.add(sc_str)
+        if sc:
+            for option in sc._optionals._option_string_actions:
+                opts.add(option)
+
+    for cmd_to_remove in (com, 'bash_completion', 'base'):
+        if cmd_to_remove in cmds:
+            cmds.remove(cmd_to_remove)
+    print(' '.join(cmds | opts))
+
+
 class HelpFormatter(argparse.HelpFormatter):
     def _format_action_invocation(self, action):
         if not action.option_strings:
@@ -1508,94 +1615,7 @@ def parse_args(parser, args, enforce_requires=True):
     return options, args
 
 
-def main(arguments=None):
-    argv = sys_argv if arguments is None else arguments
-
-    argv = [a if isinstance(a, text_type) else a.decode('utf-8') for a in argv]
-
-    version = client_version
-    parser = argparse.ArgumentParser(
-        add_help=False, formatter_class=HelpFormatter, usage='''
-%(prog)s [--version] [--help] [--os-help] [--snet] [--verbose]
-             [--debug] [--info] [--quiet] [--auth <auth_url>]
-             [--auth-version <auth_version> |
-                 --os-identity-api-version <auth_version> ]
-             [--user <username>]
-             [--key <api_key>] [--retries <num_retries>]
-             [--os-username <auth-user-name>]
-             [--os-password <auth-password>]
-             [--os-user-id <auth-user-id>]
-             [--os-user-domain-id <auth-user-domain-id>]
-             [--os-user-domain-name <auth-user-domain-name>]
-             [--os-tenant-id <auth-tenant-id>]
-             [--os-tenant-name <auth-tenant-name>]
-             [--os-project-id <auth-project-id>]
-             [--os-project-name <auth-project-name>]
-             [--os-project-domain-id <auth-project-domain-id>]
-             [--os-project-domain-name <auth-project-domain-name>]
-             [--os-auth-url <auth-url>]
-             [--os-auth-token <auth-token>]
-             [--os-storage-url <storage-url>]
-             [--os-region-name <region-name>]
-             [--os-service-type <service-type>]
-             [--os-endpoint-type <endpoint-type>]
-             [--os-cacert <ca-certificate>]
-             [--insecure]
-             [--os-cert <client-certificate-file>]
-             [--os-key <client-certificate-key-file>]
-             [--no-ssl-compression]
-             [--force-auth-retry]
-             [--prompt]
-             <subcommand> [--help] [<subcommand options>]
-
-Command-line interface to the OpenStack Swift API.
-
-Positional arguments:
-  <subcommand>
-    delete               Delete a container or objects within a container.
-    download             Download objects from containers.
-    list                 Lists the containers for the account or the objects
-                         for a container.
-    post                 Updates meta information for the account, container,
-                         or object; creates containers if not present.
-    copy                 Copies object, optionally adds meta
-    stat                 Displays information for the account, container,
-                         or object.
-    upload               Uploads files or directories to the given container.
-    capabilities         List cluster capabilities.
-    tempurl              Create a temporary URL.
-    auth                 Display auth related environment variables.
-
-Examples:
-  %(prog)s download --help
-
-  %(prog)s -A https://api.example.com/v1.0 \\
-      -U user -K api_key stat -v
-
-  %(prog)s --os-auth-url https://api.example.com/v2.0 \\
-      --os-tenant-name tenant \\
-      --os-username user --os-password password list
-
-  %(prog)s --os-auth-url https://api.example.com/v3 --auth-version 3\\
-      --os-project-name project1 --os-project-domain-name domain1 \\
-      --os-username user --os-user-domain-name domain1 \\
-      --os-password password list
-
-  %(prog)s --os-auth-url https://api.example.com/v3 --auth-version 3\\
-      --os-project-id 0123456789abcdef0123456789abcdef \\
-      --os-user-id abcdef0123456789abcdef0123456789 \\
-      --os-password password list
-
-  %(prog)s --os-auth-token 6ee5eb33efad4e45ab46806eac010566 \\
-      --os-storage-url https://10.1.5.2:8080/v1/AUTH_ced809b6a4baea7aeab61a \\
-      list
-
-  %(prog)s list --lh
-'''.strip('\n'))
-    parser.add_argument('--version', action='version',
-                        version='python-swiftclient %s' % version)
-    parser.add_argument('-h', '--help', action='store_true')
-
+def add_default_args(parser):
     default_auth_version = '1.0'
     for k in ('ST_AUTH_VERSION', 'OS_AUTH_VERSION', 'OS_IDENTITY_API_VERSION'):
         try:
@@ -1808,6 +1828,100 @@ def main(arguments=None):
                         default=environ.get('OS_KEY'),
                         help='Specify a client certificate key file (for '
                         'client auth). Defaults to env[OS_KEY].')
+
+
+def main(arguments=None):
+    argv = sys_argv if arguments is None else arguments
+
+    argv = [a if isinstance(a, text_type) else a.decode('utf-8') for a in argv]
+
+    parser = argparse.ArgumentParser(
+        add_help=False, formatter_class=HelpFormatter, usage='''
+%(prog)s [--version] [--help] [--os-help] [--snet] [--verbose]
+             [--debug] [--info] [--quiet] [--auth <auth_url>]
+             [--auth-version <auth_version> |
+                 --os-identity-api-version <auth_version> ]
+             [--user <username>]
+             [--key <api_key>] [--retries <num_retries>]
+             [--os-username <auth-user-name>]
+             [--os-password <auth-password>]
+             [--os-user-id <auth-user-id>]
+             [--os-user-domain-id <auth-user-domain-id>]
+             [--os-user-domain-name <auth-user-domain-name>]
+             [--os-tenant-id <auth-tenant-id>]
+             [--os-tenant-name <auth-tenant-name>]
+             [--os-project-id <auth-project-id>]
+             [--os-project-name <auth-project-name>]
+             [--os-project-domain-id <auth-project-domain-id>]
+             [--os-project-domain-name <auth-project-domain-name>]
+             [--os-auth-url <auth-url>]
+             [--os-auth-token <auth-token>]
+             [--os-storage-url <storage-url>]
+             [--os-region-name <region-name>]
+             [--os-service-type <service-type>]
+             [--os-endpoint-type <endpoint-type>]
+             [--os-cacert <ca-certificate>]
+             [--insecure]
+             [--os-cert <client-certificate-file>]
+             [--os-key <client-certificate-key-file>]
+             [--no-ssl-compression]
+             [--force-auth-retry]
+             <subcommand> [--help] [<subcommand options>]
+
+Command-line interface to the OpenStack Swift API.
+
+Positional arguments:
+  <subcommand>
+    delete               Delete a container or objects within a container.
+    download             Download objects from containers.
+    list                 Lists the containers for the account or the objects
+                         for a container.
+    post                 Updates meta information for the account, container,
+                         or object; creates containers if not present.
+    copy                 Copies object, optionally adds meta
+    stat                 Displays information for the account, container,
+                         or object.
+    upload               Uploads files or directories to the given container.
+    capabilities         List cluster capabilities.
+    tempurl              Create a temporary URL.
+    auth                 Display auth related environment variables.
+    bash_completion      Outputs option and flag cli data ready for
+                         bash_completion.
+
+Examples:
+  %(prog)s download --help
+
+  %(prog)s -A https://api.example.com/v1.0 \\
+      -U user -K api_key stat -v
+
+  %(prog)s --os-auth-url https://api.example.com/v2.0 \\
+      --os-tenant-name tenant \\
+      --os-username user --os-password password list
+
+  %(prog)s --os-auth-url https://api.example.com/v3 --auth-version 3\\
+      --os-project-name project1 --os-project-domain-name domain1 \\
+      --os-username user --os-user-domain-name domain1 \\
+      --os-password password list
+
+  %(prog)s --os-auth-url https://api.example.com/v3 --auth-version 3\\
+      --os-project-id 0123456789abcdef0123456789abcdef \\
+      --os-user-id abcdef0123456789abcdef0123456789 \\
+      --os-password password list
+
+  %(prog)s --os-auth-token 6ee5eb33efad4e45ab46806eac010566 \\
+      --os-storage-url https://10.1.5.2:8080/v1/AUTH_ced809b6a4baea7aeab61a \\
+      list
+
+  %(prog)s list --lh
+'''.strip('\n'))
+
+    version = client_version
+    parser.add_argument('--version', action='version',
+                        version='python-swiftclient %s' % version)
+    parser.add_argument('-h', '--help', action='store_true')
+
+    add_default_args(parser)
+
     options, args = parse_args(parser, argv[1:], enforce_requires=False)
 
     if options['help'] or options['os_help']:
diff --git a/tools/swift.bash_completion b/tools/swift.bash_completion
new file mode 100644
index 00000000..2f98a6b5
--- /dev/null
+++ b/tools/swift.bash_completion
@@ -0,0 +1,32 @@
+declare -a _swift_opts # lazy init
+
+_swift_get_current_opt()
+{
+    local opt
+    for opt in ${_swift_opts[@]} ; do
+        if [[ $(echo ${COMP_WORDS[*]} |grep -c " $opt\$") > 0 ]] || [[ $(echo ${COMP_WORDS[*]} |grep -c " $opt ") > 0 ]] ; then
+            echo $opt
+            return 0
+        fi
+    done
+    echo ""
+    return 0
+}
+
+_swift()
+{
+    local opt cur prev sflags
+    COMPREPLY=()
+    cur="${COMP_WORDS[COMP_CWORD]}"
+    prev="${COMP_WORDS[COMP_CWORD-1]}"
+
+    if [ "x$_swift_opts" == "x" ] ; then
+                _swift_opts=(`swift bash_completion "$sbc" | sed -e "s/-[-A-Za-z0-9_]*//g" -e "s/  */ /g"`)
+    fi
+
+    opt="$(_swift_get_current_opt)"
+    COMPREPLY=($(compgen -W "$(swift bash_completion $opt)" -- ${cur}))
+
+    return 0
+}
+complete -F _swift swift

From 02b08aaa10b3655aee95e6069b5116db0524a268 Mon Sep 17 00:00:00 2001
From: Timur Alperovich <timuralp@swiftstack.com>
Date: Mon, 22 Jan 2018 18:22:04 -0800
Subject: [PATCH 112/316] Add close() to _RetryBody.

Allows clients to give up on reading the rest of the server response,
if they so choose.

Change-Id: Iccc95b1b5e7d066470966ee0c62a3beb260846e5
---
 swiftclient/client.py | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index 8cbdf452..8d28ffb6 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -273,6 +273,9 @@ def next(self):
     def __next__(self):
         return self.next()
 
+    def close(self):
+        self.resp.close()
+
 
 class _RetryBody(_ObjectBody):
     """

From f4a2b16c2cc65410765abdff7a45532305a4548f Mon Sep 17 00:00:00 2001
From: Timur Alperovich <timur@timuralp.com>
Date: Tue, 17 Apr 2018 14:36:57 -0700
Subject: [PATCH 113/316] Properly handle unicode headers.

Fix unicode handling in Python 3 and Python 2. There are currently two
failure modes. In python 2, swiftclient fails to log in debug mode if
the account name has a non-ASCII character. This is because the account
name will appear in the storage URL, which we attempt to pass to the
logger as a byte string (whereas it should be a unicode string). This
patch changes the behavior to convert the path strings into unicode by
calling the parse_header_string() function.

The second failure mode is with Python 3, where http_lib returns headers
that are latin-1 encoded, but swiftclient expects UTF-8. The patch
automatically converts headers from latin-1 (iso-8859-1) to UTF-8, so
that we can properly handle non-ASCII headers in responses.

Change-Id: Ifa7f3d5af71bde8127129f1f8603772d80d063c1
---
 swiftclient/client.py          | 29 +++++++++++++---
 tests/unit/test_swiftclient.py | 61 ++++++++++++++++++++++++++++++++++
 2 files changed, 85 insertions(+), 5 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index 8cbdf452..a518d321 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -151,7 +151,7 @@ def http_log(args, kwargs, resp, body):
         elif element in ('GET', 'POST', 'PUT'):
             string_parts.append(' -X %s' % element)
         else:
-            string_parts.append(' %s' % element)
+            string_parts.append(' %s' % parse_header_string(element))
     if 'headers' in kwargs:
         headers = scrub_headers(kwargs['headers'])
         for element in headers:
@@ -455,11 +455,23 @@ def getresponse(self):
         self.resp.status = self.resp.status_code
         old_getheader = self.resp.raw.getheader
 
+        def _decode_header(string):
+            if string is None or six.PY2:
+                return string
+            return string.encode('iso-8859-1').decode('utf-8')
+
+        def _encode_header(string):
+            if string is None or six.PY2:
+                return string
+            return string.encode('utf-8').decode('iso-8859-1')
+
         def getheaders():
-            return self.resp.headers.items()
+            return [(_decode_header(k), _decode_header(v))
+                    for k, v in self.resp.headers.items()]
 
         def getheader(k, v=None):
-            return old_getheader(k.lower(), v)
+            return _decode_header(old_getheader(
+                _encode_header(k.lower()), _encode_header(v)))
 
         def releasing_read(*args, **kwargs):
             chunk = self.resp.raw.read(*args, **kwargs)
@@ -513,8 +525,11 @@ def get_auth_1_0(url, user, key, snet, **kwargs):
         netloc = parsed[1]
         parsed[1] = 'snet-' + netloc
         url = urlunparse(parsed)
-    return url, resp.getheader('x-storage-token',
-                               resp.getheader('x-auth-token'))
+
+    auth_token = resp.getheader('x-auth-token')
+    if auth_token is not None:
+        auth_token = parse_header_string(auth_token)
+    return url, resp.getheader('x-storage-token', auth_token)
 
 
 def get_keystoneclient_2_0(auth_url, user, key, os_options, **kwargs):
@@ -694,10 +709,14 @@ def get_auth(auth_url, user, key, **kwargs):
         raise ClientException('Unknown auth_version %s specified and no '
                               'session found.' % auth_version)
 
+    if token is not None:
+        token = parse_header_string(token)
     # Override storage url, if necessary
     if os_options.get('object_storage_url'):
         return os_options['object_storage_url'], token
     else:
+        if storage_url is not None:
+            return parse_header_string(storage_url), token
         return storage_url, token
 
 
diff --git a/tests/unit/test_swiftclient.py b/tests/unit/test_swiftclient.py
index b6d68568..3303372d 100644
--- a/tests/unit/test_swiftclient.py
+++ b/tests/unit/test_swiftclient.py
@@ -1896,6 +1896,57 @@ def test_response_connection_released(self):
         self.assertFalse(resp.read())
         self.assertTrue(resp.closed)
 
+    @unittest.skipIf(six.PY3, 'python2 specific test')
+    def test_response_python2_headers(self):
+        '''Test utf-8 headers in Python 2.
+        '''
+        _, conn = c.http_connection(u'http://www.test.com/')
+        conn.resp = MockHttpResponse(
+            status=200,
+            headers={
+                '\xd8\xaa-unicode': '\xd8\xaa-value',
+                'empty-header': ''
+            }
+        )
+
+        resp = conn.getresponse()
+        self.assertEqual(
+            '\xd8\xaa-value', resp.getheader('\xd8\xaa-unicode'))
+        self.assertEqual(
+            '\xd8\xaa-value', resp.getheader('\xd8\xaa-UNICODE'))
+        self.assertEqual('', resp.getheader('empty-header'))
+        self.assertEqual(
+            dict([('\xd8\xaa-unicode', '\xd8\xaa-value'),
+                  ('empty-header', ''),
+                  ('etag', '"%s"' % EMPTY_ETAG)]),
+            dict(resp.getheaders()))
+
+    @unittest.skipIf(six.PY2, 'python3 specific test')
+    def test_response_python3_headers(self):
+        '''Test latin1-encoded headers in Python 3.
+        '''
+        _, conn = c.http_connection(u'http://www.test.com/')
+        conn.resp = MockHttpResponse(
+            status=200,
+            headers={
+                b'\xd8\xaa-unicode'.decode('iso-8859-1'):
+                b'\xd8\xaa-value'.decode('iso-8859-1'),
+                'empty-header': ''
+            }
+        )
+
+        resp = conn.getresponse()
+        self.assertEqual(
+            '\u062a-value', resp.getheader('\u062a-unicode'))
+        self.assertEqual(
+            '\u062a-value', resp.getheader('\u062a-UNICODE'))
+        self.assertEqual('', resp.getheader('empty-header'))
+        self.assertEqual(
+            dict([('\u062a-unicode', '\u062a-value'),
+                  ('empty-header', ''),
+                  ('etag', ('"%s"' % EMPTY_ETAG))]),
+            dict(resp.getheaders()))
+
 
 class TestConnection(MockHttpTest):
 
@@ -2839,6 +2890,16 @@ def test_show_token(self):
             self.assertIn('X-Storage-Token', output)
             self.assertIn(unicode_token_value, output)
 
+    @mock.patch('swiftclient.client.logger.debug')
+    def test_unicode_path(self, mock_log):
+        path = u'http://swift/v1/AUTH_account-\u062a'.encode('utf-8')
+        c.http_log(['GET', path], {},
+                   MockHttpResponse(status=200, headers=[]), '')
+        request_log_line = mock_log.mock_calls[0]
+        self.assertEqual('REQ: %s', request_log_line[1][0])
+        self.assertEqual(u'curl -i -X GET %s' % path.decode('utf-8'),
+                         request_log_line[1][1])
+
 
 class TestCloseConnection(MockHttpTest):
 

From 172a09a4019dc637e525d14aef76f10e812385dd Mon Sep 17 00:00:00 2001
From: John Dickinson <me@not.mn>
Date: Thu, 19 Jul 2018 10:54:48 -0700
Subject: [PATCH 114/316] authors/changelog update for 3.6.0

Change-Id: I471d3d56d98915804aaf848f7ff98d91f586d572
---
 .mailmap                                      |  3 +-
 AUTHORS                                       | 10 ++++-
 ChangeLog                                     | 33 +++++++++++++++
 .../notes/360_notes-1ec385df13a3a735.yaml     | 40 +++++++++++++++++++
 4 files changed, 84 insertions(+), 2 deletions(-)
 create mode 100644 releasenotes/notes/360_notes-1ec385df13a3a735.yaml

diff --git a/.mailmap b/.mailmap
index 9e53d387..ecbcad1f 100644
--- a/.mailmap
+++ b/.mailmap
@@ -58,7 +58,8 @@ Madhuri Kumari <madhuri.rai07@gmail.com> madhuri <madhuri@madhuri-VirtualBox.(no
 Morgan Fainberg <morgan.fainberg@gmail.com> <m@metacloud.com>
 Hua Zhang <zhuadl@cn.ibm.com> <zhuadl@cn.ibm.com>
 Yummy Bian <yummy.bian@gmail.com> <yummy.bian@gmail.com>
-Alistair Coles <alistair.coles@hpe.com> <alistair.coles@hp.com>
+Alistair Coles <alistairncoles@gmail.com> <alistair.coles@hp.com>
+Alistair Coles <alistairncoles@gmail.com> <alistair.coles@hpe.com>
 Tong Li <litong01@us.ibm.com> <litong01@us.ibm.com>
 Paul Luse <paul.e.luse@intel.com> <paul.e.luse@intel.com>
 Yuan Zhou <yuan.zhou@intel.com> <yuan.zhou@intel.com>
diff --git a/AUTHORS b/AUTHORS
index 388d8700..abc21e98 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -2,7 +2,7 @@ Alessandro Pilotti (ap@pilotti.it)
 Alex Gaynor (alex.gaynor@gmail.com)
 Alexandra Settle (alexandra.settle@rackspace.com)
 Alexis Lee (lxsli@hpe.com)
-Alistair Coles (alistair.coles@hpe.com)
+Alistair Coles (alistairncoles@gmail.com)
 Andreas Jaeger (aj@suse.de)
 Andrew Welleck (awellec@us.ibm.com)
 Andy McCrae (andy.mccrae@gmail.com)
@@ -12,6 +12,7 @@ Ben McCann (ben@benmccann.com)
 Cedric Brandily (zzelle@gmail.com)
 Chaozhe.Chen (chaozhe.chen@easystack.cn)
 Charles Hsu (charles0126@gmail.com)
+Chen (dstbtgagt@foxmail.com)
 Cheng Li (shcli@cn.ibm.com)
 Chmouel Boudjnah (chmouel@enovance.com)
 Chris Buccella (chris.buccella@antallagon.com)
@@ -35,6 +36,7 @@ Dirk Mueller (dirk@dmllr.de)
 Donagh McCabe (donagh.mccabe@hpe.com)
 Doug Hellmann (doug@doughellmann.com)
 EdLeafe (ed@leafe.com)
+Erik Olof Gunnar Andersson (eandersson@blizzard.com)
 Fabien Boucher (fabien.boucher@enovance.com)
 Feng Liu (mefengliu23@gmail.com)
 Flavio Percoco (flaper87@gmail.com)
@@ -71,6 +73,7 @@ Kota Tsuyuzaki (tsuyuzaki.kota@lab.ntt.co.jp)
 Kun Huang (gareth@unitedstack.com)
 Leah Klearman (lklrmn@gmail.com)
 Li Riqiang (lrqrun@gmail.com)
+lingyongxu (lyxu@fiberhome.com)
 liuyamin (liuyamin@fiberhome.com)
 Luis de Bethencourt (luis@debethencourt.com)
 M V P Nitesh (m.nitesh@nectechnologies.in)
@@ -83,10 +86,12 @@ Matthew Oliver (matt@oliver.net.au)
 Matthieu Huin (mhu@enovance.com)
 Mike Widman (mwidman@endurancewindpower.com)
 Min Min Ren (rminmin@cn.ibm.com)
+mmcardle (mark.mcardle@sohonet.com)
 Mohit Motiani (mohit.motiani@intel.com)
 Monty Taylor (mordred@inaugust.com)
 Nandini Tata (nandini.tata@intel.com)
 Nelson Marcos (nelsonmarcos@gmail.com)
+Nguyen Hai (nguyentrihai93@gmail.com)
 Nguyen Hung Phuong (phuongnh@vn.fujitsu.com)
 Nick Craig-Wood (nick@craig-wood.com)
 Ondrej Novy (ondrej.novy@firma.seznam.cz)
@@ -110,6 +115,7 @@ Sean Dague (sean@dague.net)
 Sergey Gotliv (sgotliv@redhat.com)
 Sergio Cazzolato (sergio.j.cazzolato@intel.com)
 Shane Wang (shane.wang@intel.com)
+shangxiaobj (shangxiaobj@inspur.com)
 Shashi Kant (shashi.kant@nectechnologies.in)
 Shashirekha Gundur (shashirekha.j.gundur@intel.com)
 shu-mutou (shu-mutou@rf.jp.nec.com)
@@ -129,11 +135,13 @@ Tim Burke (tim.burke@gmail.com)
 Timur Alperovich (timuralp@swiftstack.com)
 Tong Li (litong01@us.ibm.com)
 Tony Breeds (tony@bakeyournoodle.com)
+Tovin Seven (vinhnt@vn.fujitsu.com)
 Tristan Cacqueray (tristan.cacqueray@enovance.com)
 Vasyl Khomenko (vasiliyk@yahoo-inc.com)
 venkatamahesh (venkatamaheshkotha@gmail.com)
 Victor Stinner (victor.stinner@enovance.com)
 Vitaly Gridnev (vgridnev@mirantis.com)
+wangqi (wang.qi@99cloud.net)
 wangxiyuan (wangxiyuan@huawei.com)
 Wu Wenxiang (wu.wenxiang@99cloud.net)
 YangLei (yanglyy@cn.ibm.com)
diff --git a/ChangeLog b/ChangeLog
index efa7e8a8..a37a6db0 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,36 @@
+3.6.0
+-----
+
+* Add the `--prompt` option for the CLI which will cause the user to be
+  prompted to enter a password. Any password otherwise specified by
+  `--key`, `--os-password` or an environment variable will be ignored.
+
+* Added bash completion support to the `swift` CLI. Enable this by sourcing
+  the included `tools/swift.bash_completion` file. Make it permanent by
+  including this file in the system's `/etc/bash_completion.d` directory.
+
+* Add ability to generate a temporary URL with an IP range restriction.
+  TempURLs with IP restrictions are supported in Swift 2.19.0 or later.
+
+* The client.py SDK now supports a `query_string` option on the
+  `head_object()` method. This is useful for finding information on
+  SLO/DLO manifests without fetching the entire manifest.
+
+* The client.py SDK now respects `region_name` when using sessions.
+
+* Added a `.close()` method to an object response, allowing clients to give
+  up on reading the rest of the response body, if they so choose.
+
+* Fixed a bug where using `--debug` in the CLI with unicode account names
+  would cause a client crash.
+
+* Make OS_AUTH_URL work in DevStack (for testing) by default.
+
+* Dropped Python 3.4 testing.
+
+* Various other minor bug fixes and improvements.
+
+
 3.5.0
 -----
 
diff --git a/releasenotes/notes/360_notes-1ec385df13a3a735.yaml b/releasenotes/notes/360_notes-1ec385df13a3a735.yaml
new file mode 100644
index 00000000..8d82b063
--- /dev/null
+++ b/releasenotes/notes/360_notes-1ec385df13a3a735.yaml
@@ -0,0 +1,40 @@
+---
+features:
+  - |
+    Add the ``--prompt`` option for the CLI which will cause the user to be
+    prompted to enter a password. Any password otherwise specified by
+    ``--key`` , ``--os-password`` or an environment variable will be ignored.
+
+  - |
+    Added bash completion support to the ``swift`` CLI. Enable this by sourcing
+    the included ``tools/swift.bash_completion`` file. Make it permanent by
+    including this file in the system's ``/etc/bash_completion.d`` directory.
+
+  - |
+    Add ability to generate a temporary URL with an IP range restriction.
+    TempURLs with IP restrictions are supported are Swift 2.19.0 or later.
+
+  - |
+    The client.py SDK now supports a ``query_string`` option on the
+    ``head_object()`` method. This is useful for finding information on
+    SLO/DLO manifests without fetching the entire manifest.
+
+  - |
+    The client.py SDK now respects ``region_name`` when using sessions.
+
+  - |
+    Added a ``.close()`` method to an object response, allowing clients to give
+    up on reading the rest of the response body, if they so choose.
+
+  - |
+    Fixed a bug where using ``--debug`` in the CLI with unicode account names
+    would cause a client crash.
+
+  - |
+    Make OS_AUTH_URL work in DevStack (for testing) by default.
+
+  - |
+    Dropped Python 3.4 testing.
+
+  - |
+    Various other minor bug fixes and improvements.

From e28b12a1f2156b2e8a790290ae6da08adde3875f Mon Sep 17 00:00:00 2001
From: Timur Alperovich <timur@timuralp.com>
Date: Tue, 24 Jul 2018 11:53:25 -0700
Subject: [PATCH 115/316] Remove unnecessary calls to parse_header_string().

Since we define the getheader() method on the response from
HTTPConnection, we don't have to call parse_header_string, as the values
will already be converted properly.

Change-Id: Ia81e8674b828b3ff1f014454126b469e41adfc23
---
 swiftclient/client.py | 10 ++--------
 1 file changed, 2 insertions(+), 8 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index 410a0012..71801c62 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -529,10 +529,8 @@ def get_auth_1_0(url, user, key, snet, **kwargs):
         parsed[1] = 'snet-' + netloc
         url = urlunparse(parsed)
 
-    auth_token = resp.getheader('x-auth-token')
-    if auth_token is not None:
-        auth_token = parse_header_string(auth_token)
-    return url, resp.getheader('x-storage-token', auth_token)
+    token = resp.getheader('x-storage-token', resp.getheader('x-auth-token'))
+    return url, token
 
 
 def get_keystoneclient_2_0(auth_url, user, key, os_options, **kwargs):
@@ -712,14 +710,10 @@ def get_auth(auth_url, user, key, **kwargs):
         raise ClientException('Unknown auth_version %s specified and no '
                               'session found.' % auth_version)
 
-    if token is not None:
-        token = parse_header_string(token)
     # Override storage url, if necessary
     if os_options.get('object_storage_url'):
         return os_options['object_storage_url'], token
     else:
-        if storage_url is not None:
-            return parse_header_string(storage_url), token
         return storage_url, token
 
 

From 79e00ea0d62d9c6e9a53ba8d80fcf27b7e2c79c8 Mon Sep 17 00:00:00 2001
From: zhubx007 <zhu.boxiang@99cloud.net>
Date: Fri, 10 Aug 2018 17:42:19 +0800
Subject: [PATCH 116/316] Add .idea into .gitignore

Generated by IDE PyCharm

Change-Id: Ifc99b34aae581221ae4b8d2533adfc21e91cd291
---
 .gitignore | 1 +
 1 file changed, 1 insertion(+)

diff --git a/.gitignore b/.gitignore
index f2699820..16da5895 100644
--- a/.gitignore
+++ b/.gitignore
@@ -16,3 +16,4 @@ cover/
 coverage.xml
 doc/build
 doc/source/api/
+.idea

From bd6a12c7518f40f80100396147c143caf133215c Mon Sep 17 00:00:00 2001
From: Nguyen Hai <nguyentrihai93@gmail.com>
Date: Fri, 24 Aug 2018 16:37:43 +0900
Subject: [PATCH 117/316] import zuul job settings from project-config

This is a mechanically generated patch to complete step 1 of moving
the zuul job settings out of project-config and into each project
repository.

Because there will be a separate patch on each branch, the branch
specifiers for branch-specific jobs have been removed.

Because this patch is generated by a script, there may be some
cosmetic changes to the layout of the YAML file(s) as the contents are
normalized.

See the python3-first goal document for details:
https://governance.openstack.org/tc/goals/stein/python3-first.html

Change-Id: I59f4cbc0a21b8be3a1cae28a64f90d5adcf6be24
Story: #2002586
Task: #24337
---
 .zuul.yaml | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/.zuul.yaml b/.zuul.yaml
index 67a39c42..414e3c05 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -1,7 +1,28 @@
 - project:
+    templates:
+      - openstack-python-jobs
+      - openstack-python35-jobs
+      - publish-openstack-sphinx-docs
+      - check-requirements
+      - openstack-pypy-jobs-nonvoting
+      - lib-forward-testing
+      - release-notes-jobs
     check:
       jobs:
         - openstack-tox-lower-constraints
+        - legacy-swift-dsvm-functional
+        - legacy-swift-dsvm-functional-identity-v3-only:
+            voting: false
+        - legacy-swiftclient-dsvm-functional
+        - legacy-swiftclient-dsvm-functional-identity-v3-only:
+            voting: false
+        - openstack-tox-py36:
+            voting: false
     gate:
       jobs:
         - openstack-tox-lower-constraints
+        - legacy-swift-dsvm-functional
+        - legacy-swiftclient-dsvm-functional
+    post:
+      jobs:
+        - openstack-tox-cover

From 420be0c99e4161c56947413a15a39575d4e3724e Mon Sep 17 00:00:00 2001
From: Nguyen Hai <nguyentrihai93@gmail.com>
Date: Fri, 24 Aug 2018 16:38:24 +0900
Subject: [PATCH 118/316] switch documentation job to new PTI

This is a mechanically generated patch to switch the documentation
jobs to use the new PTI versions of the jobs as part of the
python3-first goal.

See the python3-first goal document for details:
https://governance.openstack.org/tc/goals/stein/python3-first.html

Change-Id: I510e70f2222006df661c6a3d9e26af57b68be835
Story: #2002586
Task: #24337
---
 .zuul.yaml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index 414e3c05..d4ef79ac 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -2,11 +2,11 @@
     templates:
       - openstack-python-jobs
       - openstack-python35-jobs
-      - publish-openstack-sphinx-docs
+      - publish-openstack-docs-pti
       - check-requirements
       - openstack-pypy-jobs-nonvoting
       - lib-forward-testing
-      - release-notes-jobs
+      - release-notes-jobs-python3
     check:
       jobs:
         - openstack-tox-lower-constraints

From 5aee0732ffc045c725ad3af601ebef6ddd3a63ce Mon Sep 17 00:00:00 2001
From: Nguyen Hai <nguyentrihai93@gmail.com>
Date: Fri, 24 Aug 2018 16:38:25 +0900
Subject: [PATCH 119/316] add python 3.6 unit test job

This is a mechanically generated patch to add a unit test job running
under Python 3.6 as part of the python3-first goal.

See the python3-first goal document for details:
https://governance.openstack.org/tc/goals/stein/python3-first.html

Change-Id: I6fd051fd0b01a308d16734c5b12e11a12a38c3be
Story: #2002586
Task: #24337
---
 .zuul.yaml | 1 +
 1 file changed, 1 insertion(+)

diff --git a/.zuul.yaml b/.zuul.yaml
index d4ef79ac..affe46cf 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -2,6 +2,7 @@
     templates:
       - openstack-python-jobs
       - openstack-python35-jobs
+      - openstack-python36-jobs
       - publish-openstack-docs-pti
       - check-requirements
       - openstack-pypy-jobs-nonvoting

From edbc5d8e21af689ffac09e9a1a434c09364cbcdb Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 31 Aug 2018 16:37:41 +0000
Subject: [PATCH 120/316] Make py36 unit test job voting

Change-Id: I42cd4e19bba89c9dd4d7d20c75ee59217b9ea75d
---
 .zuul.yaml | 2 --
 1 file changed, 2 deletions(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index affe46cf..7541e014 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -17,8 +17,6 @@
         - legacy-swiftclient-dsvm-functional
         - legacy-swiftclient-dsvm-functional-identity-v3-only:
             voting: false
-        - openstack-tox-py36:
-            voting: false
     gate:
       jobs:
         - openstack-tox-lower-constraints

From 37ee6459cd2bb0197637f6d38e454bfe59192637 Mon Sep 17 00:00:00 2001
From: Doug Hellmann <doug@doughellmann.com>
Date: Wed, 6 Jun 2018 17:58:19 -0400
Subject: [PATCH 121/316] fix tox python3 overrides

We want to default to running all tox environments under python 3, so
set the basepython value in each environment.

We do not want to specify a minor version number, because we do not
want to have to update the file every time we upgrade python.

We do not want to set the override once in testenv, because that
breaks the more specific versions used in default environments like
py35 and py36.

Change-Id: I86d24104033b490a35178fc504d88c1e4a566628
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
---
 tox.ini | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/tox.ini b/tox.ini
index 660248b4..ec7d3442 100644
--- a/tox.ini
+++ b/tox.ini
@@ -22,17 +22,21 @@ whitelist_externals = sh
 passenv = SWIFT_* *_proxy
 
 [testenv:pep8]
+basepython = python3
 commands =
     python -m flake8 swiftclient tests
 
 [testenv:venv]
+basepython = python3
 commands = {posargs}
 
 [testenv:cover]
+basepython = python3
 commands = python setup.py testr --coverage
            coverage report
 
 [testenv:func]
+basepython = python3
 setenv = OS_TEST_PATH=tests.functional
 whitelist_externals =
     coverage
@@ -43,6 +47,7 @@ commands =
     rm -f .coverage
 
 [testenv:docs]
+basepython = python3
 commands=
     python setup.py build_sphinx
 
@@ -60,6 +65,7 @@ show-source = True
 exclude = .venv,.tox,dist,doc,*egg
 
 [testenv:bindep]
+basepython = python3
 # Do not install any requirements. We want this to be fast and work even if
 # system dependencies are missing, since it's used to tell you what system
 # dependencies are missing! This also means that bindep must be installed
@@ -69,6 +75,7 @@ deps = bindep
 commands = bindep test
 
 [testenv:releasenotes]
+basepython = python3
 commands = sphinx-build -a -W -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
 
 [testenv:lower-constraints]

From 70e20b62e6719c97267aa0e5a80dae2e31dfba76 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Mon, 13 Aug 2018 22:02:38 +0000
Subject: [PATCH 122/316] Use Swift's in-tree DSVM test

While we're at it, make a new job that inherits from it to bring the
legacy-swiftclient-dsvm-functional testing in-tree, too.

For naming, follow naming policy and remove "dsvm" from names.

Remove legacy jobs, they are not needed anymore.

Change-Id: I919c0b77ac4888350194f55a9c12e0742845024f
Depends-On: https://review.openstack.org/589270
---
 .zuul.yaml | 38 ++++++++++++++++++++++++++++++--------
 1 file changed, 30 insertions(+), 8 deletions(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index 7541e014..6c37f8c1 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -1,3 +1,29 @@
+- job:
+    name: swiftclient-swift-functional
+    parent: swift-dsvm-functional
+    description: |
+      Run swift's functional tests with python-swiftclient
+      installed from source instead as package from PyPI.
+    # Ensure that we install python-swiftclient from git and
+    # do not install from pypi. This is needed since the parent
+    # job sets zuul_work_dir to the swift directory and uses tox
+    # for installation.
+    required-projects:
+      - git.openstack.org/openstack/python-swiftclient
+
+- job:
+    name: swiftclient-functional
+    parent: swift-dsvm-functional
+    description: |
+      Run functional tests of python-swiftclient with
+      python-swiftclient installed from source instead as package from
+      PyPI.
+    required-projects:
+      - git.openstack.org/openstack/python-swiftclient
+    vars:
+      # Override value from parent job to use swiftclient tests
+      zuul_work_dir: "{{ zuul.projects['git.openstack.org/openstack/python-swiftclient'].src_dir }}"
+
 - project:
     templates:
       - openstack-python-jobs
@@ -10,18 +36,14 @@
       - release-notes-jobs-python3
     check:
       jobs:
+        - swiftclient-swift-functional
+        - swiftclient-functional
         - openstack-tox-lower-constraints
-        - legacy-swift-dsvm-functional
-        - legacy-swift-dsvm-functional-identity-v3-only:
-            voting: false
-        - legacy-swiftclient-dsvm-functional
-        - legacy-swiftclient-dsvm-functional-identity-v3-only:
-            voting: false
     gate:
       jobs:
+        - swiftclient-swift-functional
+        - swiftclient-functional
         - openstack-tox-lower-constraints
-        - legacy-swift-dsvm-functional
-        - legacy-swiftclient-dsvm-functional
     post:
       jobs:
         - openstack-tox-cover

From d1e1f8d8d6a8890c71eea8a3c2a488af30a8147b Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 7 Sep 2018 16:50:10 -0700
Subject: [PATCH 123/316] Stop lazy importing keystoneclient

There were two basic problems:

  - We'd try to import on every attempt at getting auth, even when we
    already know keystoneclient isn't available.
  - Sometimes devs would hit some crazy import race involving (some
    combination of?) greenthreads and OS threads.

So let's just try the imports *once*, at import time, and have None
sentinels if it fails. Try both versions separately to decouple
failures; this should let us support a wider range of keystoneclient
versions.

Change-Id: I2367310aac74f1b7c5ea0cb1a822a491e4ba8e68
---
 swiftclient/client.py          | 53 +++++++++++++++-------------
 tests/unit/test_shell.py       | 63 ++++++++++++++++------------------
 tests/unit/test_swiftclient.py | 26 +++++---------
 tests/unit/utils.py            |  8 -----
 4 files changed, 68 insertions(+), 82 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index 71801c62..d843aecc 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -60,6 +60,19 @@ def emit(self, record):
         def createLock(self):
             self.lock = None
 
+ksexceptions = ksclient_v2 = ksclient_v3 = None
+try:
+    from keystoneclient import exceptions as ksexceptions
+    # prevent keystoneclient warning us that it has no log handlers
+    logging.getLogger('keystoneclient').addHandler(NullHandler())
+    from keystoneclient.v2_0 import client as ksclient_v2
+except ImportError:
+    pass
+try:
+    from keystoneclient.v3 import client as ksclient_v3
+except ImportError:
+    pass
+
 # requests version 1.2.3 try to encode headers in ascii, preventing
 # utf-8 encoded header to be 'prepared'
 if StrictVersion(requests.__version__) < StrictVersion('2.0.0'):
@@ -540,25 +553,6 @@ def get_keystoneclient_2_0(auth_url, user, key, os_options, **kwargs):
     return get_auth_keystone(auth_url, user, key, os_options, **kwargs)
 
 
-def _import_keystone_client(auth_version):
-    # the attempted imports are encapsulated in this function to allow
-    # mocking for tests
-    try:
-        if auth_version in AUTH_VERSIONS_V3:
-            from keystoneclient.v3 import client as ksclient
-        else:
-            from keystoneclient.v2_0 import client as ksclient
-        from keystoneclient import exceptions
-        # prevent keystoneclient warning us that it has no log handlers
-        logging.getLogger('keystoneclient').addHandler(NullHandler())
-        return ksclient, exceptions
-    except ImportError:
-        raise ClientException('''
-Auth versions 2.0 and 3 require python-keystoneclient, install it or use Auth
-version 1.0 which requires ST_AUTH, ST_USER, and ST_KEY environment
-variables to be set or overridden with -A, -U, or -K.''')
-
-
 def get_auth_keystone(auth_url, user, key, os_options, **kwargs):
     """
     Authenticate against a keystone server.
@@ -587,7 +581,20 @@ def get_auth_keystone(auth_url, user, key, os_options, **kwargs):
     # Legacy default if not set
     if auth_version is None:
         auth_version = '2'
-    ksclient, exceptions = _import_keystone_client(auth_version)
+
+    ksclient = None
+    if auth_version in AUTH_VERSIONS_V3:
+        if ksclient_v3 is not None:
+            ksclient = ksclient_v3
+    else:
+        if ksclient_v2 is not None:
+            ksclient = ksclient_v2
+
+    if ksclient is None:
+        raise ClientException('''
+Auth versions 2.0 and 3 require python-keystoneclient, install it or use Auth
+version 1.0 which requires ST_AUTH, ST_USER, and ST_KEY environment
+variables to be set or overridden with -A, -U, or -K.''')
 
     try:
         _ksclient = ksclient.Client(
@@ -608,13 +615,13 @@ def get_auth_keystone(auth_url, user, key, os_options, **kwargs):
             cert=kwargs.get('cert'),
             key=kwargs.get('cert_key'),
             auth_url=auth_url, insecure=insecure, timeout=timeout)
-    except exceptions.Unauthorized:
+    except ksexceptions.Unauthorized:
         msg = 'Unauthorized. Check username, password and tenant name/id.'
         if auth_version in AUTH_VERSIONS_V3:
             msg = ('Unauthorized. Check username/id, password, '
                    'tenant name/id and user/tenant domain name/id.')
         raise ClientException(msg)
-    except exceptions.AuthorizationFailure as err:
+    except ksexceptions.AuthorizationFailure as err:
         raise ClientException('Authorization Failure. %s' % err)
     service_type = os_options.get('service_type') or 'object-store'
     endpoint_type = os_options.get('endpoint_type') or 'publicURL'
@@ -627,7 +634,7 @@ def get_auth_keystone(auth_url, user, key, os_options, **kwargs):
             service_type=service_type,
             endpoint_type=endpoint_type,
             **filter_kwargs)
-    except exceptions.EndpointNotFound:
+    except ksexceptions.EndpointNotFound:
         raise ClientException('Endpoint for %s not found - '
                               'have you specified a region?' % service_type)
     return endpoint, _ksclient.auth_token
diff --git a/tests/unit/test_shell.py b/tests/unit/test_shell.py
index 91496b84..9ef46859 100644
--- a/tests/unit/test_shell.py
+++ b/tests/unit/test_shell.py
@@ -37,7 +37,7 @@
 
 from os.path import basename, dirname
 from .utils import (
-    CaptureOutput, fake_get_auth_keystone, _make_fake_import_keystone_client,
+    CaptureOutput, fake_get_auth_keystone,
     FakeKeystone, StubResponse, MockHttpTest)
 from swiftclient.utils import (
     EMPTY_ETAG, EXPIRES_ISO8601_FORMAT,
@@ -2534,7 +2534,17 @@ def _test_options_passed_to_keystone(self, cmd, opts, os_opts,
                               cmd_args=cmd_args)
         ks_endpoint = 'http://example.com:8080/v1/AUTH_acc'
         ks_token = 'fake_auth_token'
+        # check correct auth version gets used
+        key = 'auth-version'
         fake_ks = FakeKeystone(endpoint=ks_endpoint, token=ks_token)
+        if no_auth:
+            fake_ks2 = fake_ks3 = None
+        elif opts.get(key, self.defaults.get(key)) == '2.0':
+            fake_ks2 = fake_ks
+            fake_ks3 = None
+        else:
+            fake_ks2 = None
+            fake_ks3 = fake_ks
         # fake_conn will check that storage_url and auth_token are as expected
         endpoint = os_opts.get('storage-url', ks_endpoint)
         token = os_opts.get('auth-token', ks_token)
@@ -2542,8 +2552,8 @@ def _test_options_passed_to_keystone(self, cmd, opts, os_opts,
                                               storage_url=endpoint,
                                               auth_token=token)
 
-        with mock.patch('swiftclient.client._import_keystone_client',
-                        _make_fake_import_keystone_client(fake_ks)), \
+        with mock.patch('swiftclient.client.ksclient_v2', fake_ks2), \
+                mock.patch('swiftclient.client.ksclient_v3', fake_ks3), \
                 mock.patch('swiftclient.client.http_connection', fake_conn), \
                 mock.patch.dict(os.environ, env, clear=True), \
                 patch_disable_warnings() as mock_disable_warnings:
@@ -2562,16 +2572,11 @@ def _test_options_passed_to_keystone(self, cmd, opts, os_opts,
                 self.assertEqual([], mock_disable_warnings.mock_calls)
 
         if no_auth:
-            # check that keystone client was not used and terminate tests
-            self.assertIsNone(getattr(fake_ks, 'auth_version'))
-            self.assertEqual(len(fake_ks.calls), 0)
+            # We patched out both keystoneclient versions to be None;
+            # they *can't* have been used and if we tried to, we would
+            # have raised ClientExceptions
             return
 
-        # check correct auth version was passed to _import_keystone_client
-        key = 'auth-version'
-        expected = opts.get(key, self.defaults.get(key))
-        self.assertEqual(expected, fake_ks.auth_version)
-
         # check args passed to keystone Client __init__
         self.assertEqual(len(fake_ks.calls), 1)
         actual_args = fake_ks.calls[0]
@@ -2942,9 +2947,9 @@ def setUp(self):
         self.account = 'AUTH_alice'
 
         # keystone returns endpoint for another account
-        fake_ks = FakeKeystone(endpoint='http://example.com:8080/v1/AUTH_bob',
-                               token='bob_token')
-        self.fake_ks_import = _make_fake_import_keystone_client(fake_ks)
+        self.fake_ks = FakeKeystone(
+            endpoint='http://example.com:8080/v1/AUTH_bob',
+            token='bob_token')
 
         self.cont = 'c1'
         self.cont_path = '/v1/%s/%s' % (self.account, self.cont)
@@ -3023,8 +3028,7 @@ def test_upload_with_read_write_access(self):
 
         args, env = self._make_cmd('upload', cmd_args=[self.cont, self.obj,
                                                        '--leave-segments'])
-        with mock.patch('swiftclient.client._import_keystone_client',
-                        self.fake_ks_import):
+        with mock.patch('swiftclient.client.ksclient_v3', self.fake_ks):
             with mock.patch('swiftclient.client.http_connection', fake_conn):
                 with mock.patch.dict(os.environ, env):
                     with CaptureOutput() as out:
@@ -3046,8 +3050,7 @@ def test_upload_with_write_only_access(self):
                                               on_request=req_handler)
         args, env = self._make_cmd('upload', cmd_args=[self.cont, self.obj,
                                                        '--leave-segments'])
-        with mock.patch('swiftclient.client._import_keystone_client',
-                        self.fake_ks_import):
+        with mock.patch('swiftclient.client.ksclient_v3', self.fake_ks):
             with mock.patch('swiftclient.client.http_connection', fake_conn):
                 with mock.patch.dict(os.environ, env):
                     with CaptureOutput() as out:
@@ -3073,8 +3076,7 @@ def test_segment_upload_with_write_only_access(self):
                                              '--segment-size=10',
                                              '--segment-container=%s'
                                              % self.cont])
-        with mock.patch('swiftclient.client._import_keystone_client',
-                        self.fake_ks_import):
+        with mock.patch('swiftclient.client.ksclient_v3', self.fake_ks):
             with mock.patch('swiftclient.client.http_connection', fake_conn):
                 with mock.patch.dict(os.environ, env):
                     with CaptureOutput() as out:
@@ -3112,8 +3114,7 @@ def test_segment_upload_with_write_only_access_segments_container(self):
                                    cmd_args=[self.cont, self.obj,
                                              '--leave-segments',
                                              '--segment-size=10'])
-        with mock.patch('swiftclient.client._import_keystone_client',
-                        self.fake_ks_import):
+        with mock.patch('swiftclient.client.ksclient_v3', self.fake_ks):
             with mock.patch('swiftclient.client.http_connection', fake_conn):
                 with mock.patch.dict(os.environ, env):
                     with CaptureOutput() as out:
@@ -3149,8 +3150,7 @@ def test_upload_with_no_access(self):
 
         args, env = self._make_cmd('upload', cmd_args=[self.cont, self.obj,
                                                        '--leave-segments'])
-        with mock.patch('swiftclient.client._import_keystone_client',
-                        self.fake_ks_import):
+        with mock.patch('swiftclient.client.ksclient_v3', self.fake_ks):
             with mock.patch('swiftclient.client.http_connection', fake_conn):
                 with mock.patch.dict(os.environ, env):
                     with CaptureOutput() as out:
@@ -3207,8 +3207,7 @@ def test_download_with_read_write_access(self):
         args, env = self._make_cmd('download', cmd_args=[self.cont,
                                                          self.obj.lstrip('/'),
                                                          '--no-download'])
-        with mock.patch('swiftclient.client._import_keystone_client',
-                        self.fake_ks_import):
+        with mock.patch('swiftclient.client.ksclient_v3', self.fake_ks):
             with mock.patch('swiftclient.client.http_connection', fake_conn):
                 with mock.patch.dict(os.environ, env):
                     with CaptureOutput() as out:
@@ -3229,8 +3228,7 @@ def test_download_with_read_only_access(self):
         args, env = self._make_cmd('download', cmd_args=[self.cont,
                                                          self.obj.lstrip('/'),
                                                          '--no-download'])
-        with mock.patch('swiftclient.client._import_keystone_client',
-                        self.fake_ks_import):
+        with mock.patch('swiftclient.client.ksclient_v3', self.fake_ks):
             with mock.patch('swiftclient.client.http_connection', fake_conn):
                 with mock.patch.dict(os.environ, env):
                     with CaptureOutput() as out:
@@ -3248,8 +3246,7 @@ def test_download_with_no_access(self):
         args, env = self._make_cmd('download', cmd_args=[self.cont,
                                                          self.obj.lstrip('/'),
                                                          '--no-download'])
-        with mock.patch('swiftclient.client._import_keystone_client',
-                        self.fake_ks_import):
+        with mock.patch('swiftclient.client.ksclient_v3', self.fake_ks):
             with mock.patch('swiftclient.client.http_connection', fake_conn):
                 with mock.patch.dict(os.environ, env):
                     with CaptureOutput() as out:
@@ -3273,8 +3270,7 @@ def test_list_with_read_access(self):
         fake_conn = self.fake_http_connection(resp, on_request=req_handler)
 
         args, env = self._make_cmd('download', cmd_args=[self.cont])
-        with mock.patch('swiftclient.client._import_keystone_client',
-                        self.fake_ks_import):
+        with mock.patch('swiftclient.client.ksclient_v3', self.fake_ks):
             with mock.patch('swiftclient.client.http_connection', fake_conn):
                 with mock.patch.dict(os.environ, env):
                     with CaptureOutput() as out:
@@ -3291,8 +3287,7 @@ def test_list_with_no_access(self):
         fake_conn = self.fake_http_connection(403)
 
         args, env = self._make_cmd('download', cmd_args=[self.cont])
-        with mock.patch('swiftclient.client._import_keystone_client',
-                        self.fake_ks_import):
+        with mock.patch('swiftclient.client.ksclient_v3', self.fake_ks):
             with mock.patch('swiftclient.client.http_connection', fake_conn):
                 with mock.patch.dict(os.environ, env):
                     with CaptureOutput() as out:
diff --git a/tests/unit/test_swiftclient.py b/tests/unit/test_swiftclient.py
index 3303372d..f1147748 100644
--- a/tests/unit/test_swiftclient.py
+++ b/tests/unit/test_swiftclient.py
@@ -29,7 +29,7 @@
 from requests.exceptions import RequestException
 
 from .utils import (MockHttpTest, fake_get_auth_keystone, StubResponse,
-                    FakeKeystone, _make_fake_import_keystone_client)
+                    FakeKeystone)
 
 from swiftclient.utils import EMPTY_ETAG
 from swiftclient.exceptions import ClientException
@@ -322,8 +322,7 @@ def test_auth_v2_timeout(self):
         # TestConnection.test_timeout_passed_down but is required to check that
         # get_auth does the right thing when it is not passed a timeout arg
         fake_ks = FakeKeystone(endpoint='http://some_url', token='secret')
-        with mock.patch('swiftclient.client._import_keystone_client',
-                        _make_fake_import_keystone_client(fake_ks)):
+        with mock.patch('swiftclient.client.ksclient_v2', fake_ks):
             c.get_auth('http://www.test.com', 'asdf', 'asdf',
                        os_options=dict(tenant_name='tenant'),
                        auth_version="2.0", timeout=42.0)
@@ -580,8 +579,7 @@ def test_get_keystone_client_2_0(self):
     def test_get_auth_keystone_versionless(self):
         fake_ks = FakeKeystone(endpoint='http://some_url', token='secret')
 
-        with mock.patch('swiftclient.client._import_keystone_client',
-                        _make_fake_import_keystone_client(fake_ks)):
+        with mock.patch('swiftclient.client.ksclient_v3', fake_ks):
             c.get_auth_keystone('http://authurl', 'user', 'key', {})
         self.assertEqual(1, len(fake_ks.calls))
         self.assertEqual('http://authurl/v3', fake_ks.calls[0].get('auth_url'))
@@ -589,8 +587,7 @@ def test_get_auth_keystone_versionless(self):
     def test_get_auth_keystone_versionless_auth_version_set(self):
         fake_ks = FakeKeystone(endpoint='http://some_url', token='secret')
 
-        with mock.patch('swiftclient.client._import_keystone_client',
-                        _make_fake_import_keystone_client(fake_ks)):
+        with mock.patch('swiftclient.client.ksclient_v2', fake_ks):
             c.get_auth_keystone('http://auth_url', 'user', 'key',
                                 {}, auth_version='2.0')
         self.assertEqual(1, len(fake_ks.calls))
@@ -600,8 +597,7 @@ def test_get_auth_keystone_versionless_auth_version_set(self):
     def test_get_auth_keystone_versionful(self):
         fake_ks = FakeKeystone(endpoint='http://some_url', token='secret')
 
-        with mock.patch('swiftclient.client._import_keystone_client',
-                        _make_fake_import_keystone_client(fake_ks)):
+        with mock.patch('swiftclient.client.ksclient_v3', fake_ks):
             c.get_auth_keystone('http://auth_url/v3', 'user', 'key',
                                 {}, auth_version='3')
         self.assertEqual(1, len(fake_ks.calls))
@@ -611,8 +607,7 @@ def test_get_auth_keystone_versionful(self):
     def test_get_auth_keystone_devstack_versionful(self):
         fake_ks = FakeKeystone(
             endpoint='http://storage.example.com/v1/AUTH_user', token='secret')
-        with mock.patch('swiftclient.client._import_keystone_client',
-                        _make_fake_import_keystone_client(fake_ks)):
+        with mock.patch('swiftclient.client.ksclient_v3', fake_ks):
             c.get_auth_keystone('https://192.168.8.8/identity/v3',
                                 'user', 'key', {}, auth_version='3')
         self.assertEqual(1, len(fake_ks.calls))
@@ -622,8 +617,7 @@ def test_get_auth_keystone_devstack_versionful(self):
     def test_get_auth_keystone_devstack_versionless(self):
         fake_ks = FakeKeystone(
             endpoint='http://storage.example.com/v1/AUTH_user', token='secret')
-        with mock.patch('swiftclient.client._import_keystone_client',
-                        _make_fake_import_keystone_client(fake_ks)):
+        with mock.patch('swiftclient.client.ksclient_v3', fake_ks):
             c.get_auth_keystone('https://192.168.8.8/identity',
                                 'user', 'key', {}, auth_version='3')
         self.assertEqual(1, len(fake_ks.calls))
@@ -634,8 +628,7 @@ def test_auth_keystone_url_some_junk_nonsense(self):
         fake_ks = FakeKeystone(
             endpoint='http://storage.example.com/v1/AUTH_user',
             token='secret')
-        with mock.patch('swiftclient.client._import_keystone_client',
-                        _make_fake_import_keystone_client(fake_ks)):
+        with mock.patch('swiftclient.client.ksclient_v3', fake_ks):
             c.get_auth_keystone('http://blah.example.com/v2moo',
                                 'user', 'key', {}, auth_version='3')
         self.assertEqual(1, len(fake_ks.calls))
@@ -2456,8 +2449,7 @@ def shim_connection(*a, **kw):
             'http://auth.example.com', 'user', 'password', timeout=33.0,
             os_options=os_options, auth_version=2.0)
         fake_ks = FakeKeystone(endpoint='http://some_url', token='secret')
-        with mock.patch('swiftclient.client._import_keystone_client',
-                        _make_fake_import_keystone_client(fake_ks)):
+        with mock.patch('swiftclient.client.ksclient_v2', fake_ks):
             with mock.patch.multiple('swiftclient.client',
                                      http_connection=shim_connection,
                                      sleep=mock.DEFAULT):
diff --git a/tests/unit/utils.py b/tests/unit/utils.py
index 2def73f5..aab3b59c 100644
--- a/tests/unit/utils.py
+++ b/tests/unit/utils.py
@@ -542,14 +542,6 @@ class EndpointNotFound(Exception):
         pass
 
 
-def _make_fake_import_keystone_client(fake_import):
-    def _fake_import_keystone_client(auth_version):
-        fake_import.auth_version = auth_version
-        return fake_import, fake_import
-
-    return _fake_import_keystone_client
-
-
 class FakeStream(object):
     def __init__(self, size):
         self.bytes_read = 0

From a6baf00e245275634175d827552ffde7d655ad4d Mon Sep 17 00:00:00 2001
From: John Dickinson <me@not.mn>
Date: Wed, 26 Sep 2018 18:29:18 -0700
Subject: [PATCH 124/316] py2 functional testing

Change-Id: I24ff8fb28969a0b074313bc9491b299afac3b49c
---
 .zuul.yaml | 10 ++++++++++
 tox.ini    |  6 ++++++
 2 files changed, 16 insertions(+)

diff --git a/.zuul.yaml b/.zuul.yaml
index 6c37f8c1..9eb1752f 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -24,6 +24,14 @@
       # Override value from parent job to use swiftclient tests
       zuul_work_dir: "{{ zuul.projects['git.openstack.org/openstack/python-swiftclient'].src_dir }}"
 
+- job:
+    name: swiftclient-functional-py2
+    parent: swiftclient-functional
+    description: |
+      Run functional tests of python-swiftclient under Python 2
+    vars:
+      tox_envlist: py2func
+
 - project:
     templates:
       - openstack-python-jobs
@@ -38,11 +46,13 @@
       jobs:
         - swiftclient-swift-functional
         - swiftclient-functional
+        - swiftclient-functional-py2
         - openstack-tox-lower-constraints
     gate:
       jobs:
         - swiftclient-swift-functional
         - swiftclient-functional
+        - swiftclient-functional-py2
         - openstack-tox-lower-constraints
     post:
       jobs:
diff --git a/tox.ini b/tox.ini
index ec7d3442..ed8d772e 100644
--- a/tox.ini
+++ b/tox.ini
@@ -46,6 +46,12 @@ commands =
     coverage report -m
     rm -f .coverage
 
+[testenv:py2func]
+basepython=python2
+setenv = {[testenv:func]setenv}
+whitelist_externals = {[testenv:func]whitelist_externals}
+commands = {[testenv:func]commands}
+
 [testenv:docs]
 basepython = python3
 commands=

From 9acdfe0b460048420551bb84fb3cf41fb1e4a67e Mon Sep 17 00:00:00 2001
From: Vu Cong Tuan <tuanvc@vn.fujitsu.com>
Date: Wed, 11 Jul 2018 14:33:41 +0700
Subject: [PATCH 125/316] Switch to stestr

According to Openstack summit session [1],
stestr is maintained project to which all Openstack projects should migrate.
Let's switch to stestr as other projects have already moved to it.

[1] https://etherpad.openstack.org/p/YVR-python-pti

Change-Id: Ic098f8560599554e0b6bb16ae326d4d30a8a5504
---
 .gitignore            |  1 +
 .stestr.conf          |  4 ++++
 .testr.conf           |  4 ----
 lower-constraints.txt |  2 +-
 test-requirements.txt |  2 +-
 tox.ini               | 23 +++++++++++++++++------
 6 files changed, 24 insertions(+), 12 deletions(-)
 create mode 100644 .stestr.conf
 delete mode 100644 .testr.conf

diff --git a/.gitignore b/.gitignore
index 16da5895..af50ddda 100644
--- a/.gitignore
+++ b/.gitignore
@@ -7,6 +7,7 @@ dist/
 .DS_Store
 *.log
 .testrepository
+.stestr/
 subunit.log
 build
 swiftclient/versioninfo
diff --git a/.stestr.conf b/.stestr.conf
new file mode 100644
index 00000000..5228f209
--- /dev/null
+++ b/.stestr.conf
@@ -0,0 +1,4 @@
+[DEFAULT]
+test_path=${OS_TEST_PATH:-./tests/unit}
+top_dir=./
+
diff --git a/.testr.conf b/.testr.conf
deleted file mode 100644
index f3fca908..00000000
--- a/.testr.conf
+++ /dev/null
@@ -1,4 +0,0 @@
-[DEFAULT]
-test_command=${PYTHON:-python} -m subunit.run discover -t ./ ${OS_TEST_PATH:-./tests/unit} $LISTOPT $IDOPTION
-test_id_option=--load-list $IDFILE
-test_list_option=--list
diff --git a/lower-constraints.txt b/lower-constraints.txt
index 9aae7927..fefb90ac 100644
--- a/lower-constraints.txt
+++ b/lower-constraints.txt
@@ -39,7 +39,7 @@ six==1.9.0
 snowballstemmer==1.2.1
 sphinx==1.6.2
 sphinxcontrib-websupport==1.0.1
-testrepository==0.0.18
+stestr==2.0.0
 testtools==2.2.0
 traceback2==1.4.0
 unittest2==1.1.0
diff --git a/test-requirements.txt b/test-requirements.txt
index 634851e7..9e6b84a9 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -5,6 +5,6 @@ keystoneauth1>=3.4.0  # Apache-2.0
 mock>=1.2.0 # BSD
 oslosphinx>=4.7.0  # Apache-2.0
 sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
-testrepository>=0.0.18
+stestr>=2.0.0 # Apache-2.0
 reno>=2.5.0 # Apache-2.0
 openstackdocstheme>=1.18.1 # Apache-2.0
diff --git a/tox.ini b/tox.ini
index ed8d772e..26f8767e 100644
--- a/tox.ini
+++ b/tox.ini
@@ -16,8 +16,8 @@ deps = -r{toxinidir}/requirements.txt
        .[keystone]
 commands = sh -c '(find . -not \( -type d -name .?\* -prune \) \
            \( -type d -name "__pycache__" -or -type f -name "*.py[co]" \) \
-           -print0; find . -name "*.dbm*" -print0) | xargs -0 rm -rf'
-           python setup.py testr --testr-args="{posargs}"
+           -print0) | xargs -0 rm -rf'
+           stestr run {posargs}
 whitelist_externals = sh
 passenv = SWIFT_* *_proxy
 
@@ -32,17 +32,28 @@ commands = {posargs}
 
 [testenv:cover]
 basepython = python3
-commands = python setup.py testr --coverage
-           coverage report
+setenv =
+    PYTHON=coverage run --source swiftclient --parallel-mode
+commands =
+    stestr run
+    coverage combine
+    coverage html -d cover
+    coverage xml -o cover/coverage.xml
+    coverage report
 
 [testenv:func]
 basepython = python3
-setenv = OS_TEST_PATH=tests.functional
+setenv =
+    OS_TEST_PATH=tests.functional
+    PYTHON=coverage run --source swiftclient --parallel-mode
 whitelist_externals =
     coverage
     rm
 commands =
-    python setup.py testr --coverage --testr-args="--concurrency=1"
+    stestr run --concurrency=1
+    coverage combine
+    coverage html -d cover
+    coverage xml -o cover/coverage.xml
     coverage report -m
     rm -f .coverage
 

From 5e988c5cded09135f7e130704f169a1353730703 Mon Sep 17 00:00:00 2001
From: Nguyen Hai Truong <truongnh@vn.fujitsu.com>
Date: Tue, 6 Nov 2018 23:17:30 +0700
Subject: [PATCH 126/316] Add python 3.6 unit test job

This is a mechanically generated patch to add a unit test job running
under Python 3.6 as part of the python3-first goal.

See the python3-first goal document for details:
https://governance.openstack.org/tc/goals/stein/python3-first.html

Change-Id: Iae4acab507e45a379c8af129912e13621a2a553b
---
 tox.ini | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tox.ini b/tox.ini
index 26f8767e..53fb0a75 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,5 +1,5 @@
 [tox]
-envlist = py27,py35,pypy,pep8
+envlist = py36,py35,py27,pypy,pep8
 minversion = 2.0
 skipsdist = True
 

From 411ef48e5bca1ed66a2e4dd7ecd8695e2bf6c94e Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 22 Jun 2018 16:49:03 -0700
Subject: [PATCH 127/316] Stop leaking quite so many connections

While investigating the failures when you move func tests to py3, I
noticed a whole bunch of

   ResourceWarning: unclosed <socket.socket ...>

noise. This should fix it.

While we're at it, make get_capabilities less stupid.

Change-Id: I3913e9334090b04a78143e0b70f621aad30fc642
Related-Change: I86d24104033b490a35178fc504d88c1e4a566628
---
 swiftclient/client.py                | 28 ++++++++++++++++------------
 tests/functional/test_swiftclient.py |  1 +
 tests/unit/test_swiftclient.py       |  8 +++++++-
 tests/unit/utils.py                  | 11 +++++++++--
 4 files changed, 33 insertions(+), 15 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index d843aecc..049b4afc 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -402,6 +402,7 @@ def __init__(self, url, proxy=None, cacert=None, insecure=False,
         self.request_session = requests.Session()
         # Don't use requests's default headers
         self.request_session.headers = None
+        self.resp = None
         if self.parsed_url.scheme not in ('http', 'https'):
             raise ClientException('Unsupported scheme "%s" in url "%s"'
                                   % (self.parsed_url.scheme, url))
@@ -506,6 +507,11 @@ def releasing_read(*args, **kwargs):
 
         return self.resp
 
+    def close(self):
+        if self.resp:
+            self.resp.close()
+        self.request_session.close()
+
 
 def http_connection(*arg, **kwarg):
     """:returns: tuple of (parsed url, connection object)"""
@@ -527,6 +533,8 @@ def get_auth_1_0(url, user, key, snet, **kwargs):
     conn.request(method, parsed.path, '', headers)
     resp = conn.getresponse()
     body = resp.read()
+    resp.close()
+    conn.close()
     http_log((url, method,), headers, resp, body)
     url = resp.getheader('x-storage-url')
 
@@ -1651,11 +1659,8 @@ def close(self):
         if (self.http_conn and isinstance(self.http_conn, tuple)
                 and len(self.http_conn) > 1):
             conn = self.http_conn[1]
-            if hasattr(conn, 'close') and callable(conn.close):
-                # XXX: Our HTTPConnection object has no close, should be
-                # trying to close the requests.Session here?
-                conn.close()
-                self.http_conn = None
+            conn.close()
+            self.http_conn = None
 
     def get_auth(self):
         self.url, self.token = get_auth(self.authurl, self.user, self.key,
@@ -1715,10 +1720,10 @@ def _retry(self, reset_func, func, *args, **kwargs):
             try:
                 if not self.url or not self.token:
                     self.url, self.token = self.get_auth()
-                    self.http_conn = None
+                    self.close()
                 if self.service_auth and not self.service_token:
                     self.url, self.service_token = self.get_service_auth()
-                    self.http_conn = None
+                    self.close()
                 self.auth_end_time = time()
                 if not self.http_conn:
                     self.http_conn = self.http_connection()
@@ -1908,8 +1913,7 @@ def get_capabilities(self, url=None):
         url = url or self.url
         if not url:
             url, _ = self.get_auth()
-        scheme = urlparse(url).scheme
-        netloc = urlparse(url).netloc
-        url = scheme + '://' + netloc + '/info'
-        http_conn = self.http_connection(url)
-        return get_capabilities(http_conn)
+        parsed = urlparse(urljoin(url, '/info'))
+        if not self.http_conn:
+            self.http_conn = self.http_connection(url)
+        return get_capabilities((parsed, self.http_conn[1]))
diff --git a/tests/functional/test_swiftclient.py b/tests/functional/test_swiftclient.py
index 0380d961..1d76a8d1 100644
--- a/tests/functional/test_swiftclient.py
+++ b/tests/functional/test_swiftclient.py
@@ -108,6 +108,7 @@ def tearDown(self):
                 self.conn.delete_container(container)
             except swiftclient.ClientException:
                 pass
+        self.conn.close()
 
     def _check_account_headers(self, headers):
         headers_to_check = [
diff --git a/tests/unit/test_swiftclient.py b/tests/unit/test_swiftclient.py
index f1147748..62875a5d 100644
--- a/tests/unit/test_swiftclient.py
+++ b/tests/unit/test_swiftclient.py
@@ -2532,6 +2532,9 @@ def getheaders(self):
             def read(self, *args, **kwargs):
                 return ''
 
+            def close(self):
+                pass
+
         def local_http_connection(url, proxy=None, cacert=None,
                                   insecure=False, cert=None, cert_key=None,
                                   ssl_compression=True, timeout=None):
@@ -2901,6 +2904,9 @@ def test_close_none(self):
         self.assertIsNone(conn.http_conn)
         conn.close()
         self.assertIsNone(conn.http_conn)
+        # Can re-close
+        conn.close()
+        self.assertIsNone(conn.http_conn)
 
     def test_close_ok(self):
         url = 'http://www.test.com'
@@ -2911,7 +2917,7 @@ def test_close_ok(self):
         self.assertEqual(len(conn.http_conn), 2)
         http_conn_obj = conn.http_conn[1]
         self.assertIsInstance(http_conn_obj, c.HTTPConnection)
-        self.assertFalse(hasattr(http_conn_obj, 'close'))
+        self.assertTrue(hasattr(http_conn_obj, 'close'))
         conn.close()
 
 
diff --git a/tests/unit/utils.py b/tests/unit/utils.py
index aab3b59c..8081501f 100644
--- a/tests/unit/utils.py
+++ b/tests/unit/utils.py
@@ -78,6 +78,10 @@ def __init__(self, status=200, body='', headers=None):
         self.body = body
         self.headers = headers or {}
 
+    def __repr__(self):
+        return '%s(%r, %r, %r)' % (self.__class__.__name__, self.status,
+                                   self.body, self.headers)
+
 
 def fake_http_connect(*code_iter, **kwargs):
     """
@@ -102,7 +106,6 @@ def __init__(self, status, etag=None, body='', timestamp='1',
             self.etag = etag
             self.content = self.body = body
             self.timestamp = timestamp
-            self._is_closed = True
             self.headers = headers or {}
             self.request = None
 
@@ -162,6 +165,9 @@ def send(self, amt=None):
         def getheader(self, name, default=None):
             return dict(self.getheaders()).get(name.lower(), default)
 
+        def close(self):
+            pass
+
     timestamps_iter = iter(kwargs.get('timestamps') or ['1'] * len(code_iter))
     etag_iter = iter(kwargs.get('etags') or [None] * len(code_iter))
     x = kwargs.get('missing_container', [False] * len(code_iter))
@@ -228,7 +234,8 @@ def wrapper(url, proxy=None, cacert=None, insecure=False,
                 parsed, _conn = _orig_http_connection(url, proxy=proxy)
 
                 class RequestsWrapper(object):
-                    pass
+                    def close(self):
+                        pass
                 conn = RequestsWrapper()
 
                 def request(method, path, *args, **kwargs):

From 0197a0f9ca406a7314650d9c46b300ece3eba6b6 Mon Sep 17 00:00:00 2001
From: OpenStack Release Bot <infra-root@openstack.org>
Date: Wed, 25 Jul 2018 16:51:52 +0000
Subject: [PATCH 128/316] Update reno for stable/rocky

Change-Id: I840f4363dfdb3b485dbaf768c71fbcc5227c330f
---
 releasenotes/source/index.rst | 1 +
 releasenotes/source/rocky.rst | 6 ++++++
 tox.ini                       | 2 +-
 3 files changed, 8 insertions(+), 1 deletion(-)
 create mode 100644 releasenotes/source/rocky.rst

diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst
index a5240ea2..92da0e8f 100644
--- a/releasenotes/source/index.rst
+++ b/releasenotes/source/index.rst
@@ -6,6 +6,7 @@
    :maxdepth: 1
 
    current
+   rocky
    queens
    pike
    ocata
diff --git a/releasenotes/source/rocky.rst b/releasenotes/source/rocky.rst
new file mode 100644
index 00000000..40dd517b
--- /dev/null
+++ b/releasenotes/source/rocky.rst
@@ -0,0 +1,6 @@
+===================================
+ Rocky Series Release Notes
+===================================
+
+.. release-notes::
+   :branch: stable/rocky
diff --git a/tox.ini b/tox.ini
index 660248b4..46d24f9f 100644
--- a/tox.ini
+++ b/tox.ini
@@ -8,7 +8,7 @@ usedevelop = True
 install_command = python -m pip install -U {opts} {packages}
 list_dependencies_command = python -m pip freeze
 setenv =
-  LANG=en_US.utf8
+  LANG=en_US.utf-8
   VIRTUAL_ENV={envdir}
 
 deps = -r{toxinidir}/requirements.txt

From fc128672f63fe663950e13da105e084321937fe5 Mon Sep 17 00:00:00 2001
From: Thiago da Silva <thiagodasilva@gmail.com>
Date: Sat, 24 Nov 2018 08:11:26 -0500
Subject: [PATCH 129/316] update .functests to run stestr

Updated .functests script to run similar to how it's defined
in tox.ini

Change-Id: I17df28d8cbe0e10e48b26c2f9737308552ea88db
---
 .functests | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/.functests b/.functests
index 16c9e5de..d199ec84 100755
--- a/.functests
+++ b/.functests
@@ -2,9 +2,13 @@
 set -e
 
 export OS_TEST_PATH='tests.functional'
-python setup.py testr --coverage --testr-args="--concurrency=1"
+export PYTHON='coverage run --source swiftclient --parallel-mode'
+stestr run --concurrency=1
 
 RET=$?
+coverage combine
+coverage html -d cover
+coverage xml -o cover/coverage.xml
 coverage report -m
 rm -f .coverage
 exit $RET

From 8a4228146899534f906f8e10ec9040ab3f1ee970 Mon Sep 17 00:00:00 2001
From: qingszhao <zhao.daqing@99cloud.net>
Date: Fri, 30 Nov 2018 07:31:51 +0000
Subject: [PATCH 130/316] Add Python 3.6 classifier to setup.cfg

Change-Id: If3b2cdcd009136286d68fe07b14e06261b3069a0
---
 setup.cfg | 1 +
 1 file changed, 1 insertion(+)

diff --git a/setup.cfg b/setup.cfg
index ddb64a07..531458fa 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -18,6 +18,7 @@ classifier =
     Programming Language :: Python :: 2.7
     Programming Language :: Python :: 3
     Programming Language :: Python :: 3.5
+    Programming Language :: Python :: 3.6
 
 [global]
 setup-hooks =

From edfeae372312b3370dc12deea8cd8028ecba6bd6 Mon Sep 17 00:00:00 2001
From: Timur Alperovich <timur@timuralp.com>
Date: Fri, 23 Nov 2018 22:47:15 -0800
Subject: [PATCH 131/316] Add delimiter to get_account().

Exposes the delimiter parameter, which the Swift API supports for
container listings.

Change-Id: Id8dfce01a9b64de9d1222aab9a4a682ce9e0f2b7
---
 swiftclient/client.py                | 19 ++++++++++++-------
 tests/functional/test_swiftclient.py | 12 ++++++++++++
 tests/unit/test_swiftclient.py       | 12 ++++++++++++
 3 files changed, 36 insertions(+), 7 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index 049b4afc..c9efc79b 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -757,7 +757,7 @@ def store_response(resp, response_dict):
 
 def get_account(url, token, marker=None, limit=None, prefix=None,
                 end_marker=None, http_conn=None, full_listing=False,
-                service_token=None, headers=None):
+                service_token=None, headers=None, delimiter=None):
     """
     Get a listing of containers for the account.
 
@@ -773,6 +773,7 @@ def get_account(url, token, marker=None, limit=None, prefix=None,
                          of 10000 listings
     :param service_token: service auth token
     :param headers: additional headers to include in the request
+    :param delimiter: delimiter query
     :returns: a tuple of (response headers, a list of containers) The response
               headers will be a dict and all header names will be lowercase.
     :raises ClientException: HTTP GET request failed
@@ -786,14 +787,14 @@ def get_account(url, token, marker=None, limit=None, prefix=None,
     if not http_conn:
         http_conn = http_connection(url)
     if full_listing:
-        rv = get_account(url, token, marker, limit, prefix,
-                         end_marker, http_conn, headers=req_headers)
+        rv = get_account(url, token, marker, limit, prefix, end_marker,
+                         http_conn, headers=req_headers, delimiter=delimiter)
         listing = rv[1]
         while listing:
             marker = listing[-1]['name']
             listing = get_account(url, token, marker, limit, prefix,
-                                  end_marker, http_conn,
-                                  headers=req_headers)[1]
+                                  end_marker, http_conn, headers=req_headers,
+                                  delimiter=delimiter)[1]
             if listing:
                 rv[1].extend(listing)
         return rv
@@ -805,6 +806,8 @@ def get_account(url, token, marker=None, limit=None, prefix=None,
         qs += '&limit=%d' % limit
     if prefix:
         qs += '&prefix=%s' % quote(prefix)
+    if delimiter:
+        qs += '&delimiter=%s' % quote(delimiter)
     if end_marker:
         qs += '&end_marker=%s' % quote(end_marker)
     full_path = '%s?%s' % (parsed.path, qs)
@@ -1779,14 +1782,16 @@ def head_account(self, headers=None):
         return self._retry(None, head_account, headers=headers)
 
     def get_account(self, marker=None, limit=None, prefix=None,
-                    end_marker=None, full_listing=False, headers=None):
+                    end_marker=None, full_listing=False, headers=None,
+                    delimiter=None):
         """Wrapper for :func:`get_account`"""
         # TODO(unknown): With full_listing=True this will restart the entire
         # listing with each retry. Need to make a better version that just
         # retries where it left off.
         return self._retry(None, get_account, marker=marker, limit=limit,
                            prefix=prefix, end_marker=end_marker,
-                           full_listing=full_listing, headers=headers)
+                           full_listing=full_listing, headers=headers,
+                           delimiter=delimiter)
 
     def post_account(self, headers, response_dict=None,
                      query_string=None, data=None):
diff --git a/tests/functional/test_swiftclient.py b/tests/functional/test_swiftclient.py
index 1d76a8d1..b4f275b2 100644
--- a/tests/functional/test_swiftclient.py
+++ b/tests/functional/test_swiftclient.py
@@ -154,6 +154,18 @@ def test_list_account(self):
         self.assertTrue(len(containers) >= 1)
         self.assertEqual(self.containername_2, containers[0].get('name'))
 
+        # Test prefix
+        _, containers = self.conn.get_account(prefix='dne')
+        self.assertEqual(0, len(containers))
+
+        # Test delimiter
+        _, containers = self.conn.get_account(
+            prefix=self.containername, delimiter='_')
+        self.assertEqual(2, len(containers))
+        self.assertEqual(self.containername, containers[0].get('name'))
+        self.assertTrue(
+            self.containername_2.startswith(containers[1].get('subdir')))
+
     def _check_container_headers(self, headers):
         self.assertTrue(headers.get('content-length'))
         self.assertTrue(headers.get('x-container-object-count'))
diff --git a/tests/unit/test_swiftclient.py b/tests/unit/test_swiftclient.py
index 62875a5d..2d45deb8 100644
--- a/tests/unit/test_swiftclient.py
+++ b/tests/unit/test_swiftclient.py
@@ -704,6 +704,18 @@ def test_param_end_marker(self):
                 'x-auth-token': 'asdf'}),
         ])
 
+    def test_param_delimiter(self):
+        c.http_connection = self.fake_http_connection(
+            204,
+            query_string="format=json&delimiter=-")
+        c.get_account('http://www.test.com/v1/acct', 'asdf',
+                      delimiter='-')
+        self.assertRequests([
+            ('GET', '/v1/acct?format=json&delimiter=-', '', {
+                'accept-encoding': 'gzip',
+                'x-auth-token': 'asdf'}),
+        ])
+
 
 class TestHeadAccount(MockHttpTest):
 

From 0e6c63dfd49fcc18108cc248df0c1731ae0f1197 Mon Sep 17 00:00:00 2001
From: sunjia <sunjia@inspur.com>
Date: Mon, 3 Dec 2018 22:01:15 -0500
Subject: [PATCH 132/316] Change openstack-dev to openstack-discuss

Mailinglists have been updated. Openstack-discuss replaces openstack-dev.

Change-Id: I3193f2d12f75c36b59881a51b605d25274b335e0
---
 setup.cfg | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/setup.cfg b/setup.cfg
index 531458fa..cdf10b48 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -4,7 +4,7 @@ summary = OpenStack Object Storage API Client Library
 description-file =
     README.rst
 author = OpenStack
-author-email = openstack-dev@lists.openstack.org
+author-email = openstack-discuss@lists.openstack.org
 home-page = https://docs.openstack.org/python-swiftclient/latest/
 classifier =
     Environment :: OpenStack

From 9da26369125c91632964abccf00fa8288d91315c Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Thu, 20 Dec 2018 21:52:45 +0100
Subject: [PATCH 133/316] Use template for lower-constraints

Small cleanups:

* Use openstack-lower-constraints-jobs template, remove individual
  jobs.
* Sort list of templates

Change-Id: Idb31ca14478641cba6f896af35fa766d7bdb9e1e
Needed-By: https://review.openstack.org/623229
---
 .zuul.yaml | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index 9eb1752f..56c9faaf 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -34,26 +34,25 @@
 
 - project:
     templates:
+      - check-requirements
+      - lib-forward-testing
+      - openstack-lower-constraints-jobs
+      - openstack-pypy-jobs-nonvoting
       - openstack-python-jobs
       - openstack-python35-jobs
       - openstack-python36-jobs
       - publish-openstack-docs-pti
-      - check-requirements
-      - openstack-pypy-jobs-nonvoting
-      - lib-forward-testing
       - release-notes-jobs-python3
     check:
       jobs:
         - swiftclient-swift-functional
         - swiftclient-functional
         - swiftclient-functional-py2
-        - openstack-tox-lower-constraints
     gate:
       jobs:
         - swiftclient-swift-functional
         - swiftclient-functional
         - swiftclient-functional-py2
-        - openstack-tox-lower-constraints
     post:
       jobs:
         - openstack-tox-cover

From 2ff36fde575fa6987ee5954f526ad6c9460633a5 Mon Sep 17 00:00:00 2001
From: ZhijunWei <wzj334965317@outlook.com>
Date: Fri, 28 Dec 2018 23:04:37 +0800
Subject: [PATCH 134/316] Update hacking version

1. update hacking version to latest
2. fix pep8 failed

Change-Id: Ifc3bfeff4038c93d8c8cf2c9d7814c3003e73504
---
 swiftclient/client.py    | 14 +++++++-------
 swiftclient/service.py   | 26 +++++++++++++-------------
 swiftclient/shell.py     |  5 +++--
 test-requirements.txt    |  2 +-
 tests/unit/test_shell.py | 12 ++++++------
 tox.ini                  |  2 +-
 6 files changed, 31 insertions(+), 30 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index c9efc79b..6a2b43b2 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -248,8 +248,8 @@ def encode_meta_headers(headers):
         value = encode_utf8(value)
         header = header.lower()
 
-        if (isinstance(header, six.string_types)
-                and header.startswith(USER_METADATA_TYPE)):
+        if (isinstance(header, six.string_types) and
+                header.startswith(USER_METADATA_TYPE)):
             header = encode_utf8(header)
 
         ret[header] = value
@@ -706,9 +706,9 @@ def get_auth(auth_url, user, key, **kwargs):
         if kwargs.get('tenant_name'):
             os_options['tenant_name'] = kwargs['tenant_name']
 
-        if not (os_options.get('tenant_name') or os_options.get('tenant_id')
-                or os_options.get('project_name')
-                or os_options.get('project_id')):
+        if not (os_options.get('tenant_name') or os_options.get('tenant_id') or
+                os_options.get('project_name') or
+                os_options.get('project_id')):
             if auth_version in AUTH_VERSIONS_V2:
                 raise ClientException('No tenant specified')
             raise ClientException('No project name or project id specified.')
@@ -1659,8 +1659,8 @@ def __init__(self, authurl=None, user=None, key=None, retries=5,
         self.force_auth_retry = force_auth_retry
 
     def close(self):
-        if (self.http_conn and isinstance(self.http_conn, tuple)
-                and len(self.http_conn) > 1):
+        if (self.http_conn and isinstance(self.http_conn, tuple) and
+                len(self.http_conn) > 1):
             conn = self.http_conn[1]
             conn.close()
             self.http_conn = None
diff --git a/swiftclient/service.py b/swiftclient/service.py
index eedad46e..71c36ec6 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -424,8 +424,8 @@ def _check_contents(self):
                                  '{1} != {2}'.format(
                                      self._path, etag, self._expected_md5))
 
-        if (self._content_length is not None
-                and self._actual_read != self._content_length):
+        if (self._content_length is not None and
+                self._actual_read != self._content_length):
             raise SwiftError('Error downloading {0}: read_length != '
                              'content_length, {1:d} != {2:d}'.format(
                                  self._path, self._actual_read,
@@ -1244,8 +1244,8 @@ def _download_object_job(self, conn, container, obj, options):
                 bytes_read = obj_body.bytes_read()
                 if fp is not None:
                     fp.close()
-                    if ('x-object-meta-mtime' in headers and not no_file
-                            and not options['ignore_mtime']):
+                    if ('x-object-meta-mtime' in headers and not no_file and
+                            not options['ignore_mtime']):
                         try:
                             mtime = float(headers['x-object-meta-mtime'])
                         except ValueError:
@@ -2036,8 +2036,8 @@ def _upload_object_job(self, conn, container, source, obj, options,
             new_slo_manifest_paths = set()
             segment_size = int(0 if options['segment_size'] is None
                                else options['segment_size'])
-            if (options['changed'] or options['skip_identical']
-                    or not options['leave_segments']):
+            if (options['changed'] or options['skip_identical'] or
+                    not options['leave_segments']):
                 try:
                     headers = conn.head_object(container, obj)
                     is_slo = config_true_value(
@@ -2058,9 +2058,9 @@ def _upload_object_job(self, conn, container, source, obj, options,
 
                     cl = int(headers.get('content-length'))
                     mt = headers.get('x-object-meta-mtime')
-                    if (path is not None and options['changed']
-                            and cl == getsize(path)
-                            and mt == put_headers['x-object-meta-mtime']):
+                    if (path is not None and options['changed'] and
+                            cl == getsize(path) and
+                            mt == put_headers['x-object-meta-mtime']):
                         res.update({
                             'success': True,
                             'status': 'skipped-changed'
@@ -2095,8 +2095,8 @@ def _upload_object_job(self, conn, container, source, obj, options,
             # a segment job if we're reading from a stream - we may fail if we
             # go over the single object limit, but this gives us a nice way
             # to create objects from memory
-            if (path is not None and segment_size
-                    and (getsize(path) > segment_size)):
+            if (path is not None and segment_size and
+                    (getsize(path) > segment_size)):
                 res['large_object'] = True
                 seg_container = container + '_segments'
                 if options['segment_container']:
@@ -2425,8 +2425,8 @@ def delete(self, container=None, objects=None, options=None):
 
                             # Cancel the remaining container deletes, but yield
                             # any pending results
-                            if (not cancelled and options['fail_fast']
-                                    and not res['success']):
+                            if (not cancelled and options['fail_fast'] and
+                                    not res['success']):
                                 cancelled = True
 
     def _bulk_delete_page_size(self, objects):
diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 9ca28b1e..9ea5e952 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -1462,8 +1462,9 @@ def st_bash_completion(parser, args, thread_manager, return_parser=False):
             return
     else:
         fn_commands = [fn for fn in globals().keys()
-                       if fn.startswith('st_') and not fn.endswith('_options')
-                       and not fn.endswith('_help')]
+                       if fn.startswith('st_') and
+                       not fn.endswith('_options') and
+                       not fn.endswith('_help')]
 
     subparsers = parser.add_subparsers()
     subcommands = {}
diff --git a/test-requirements.txt b/test-requirements.txt
index 9e6b84a9..13cf1e93 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -1,4 +1,4 @@
-hacking<0.11,>=0.10.0
+hacking>=1.1.0,<1.2.0 # Apache-2.0
 
 coverage!=4.4,>=4.0 # Apache-2.0
 keystoneauth1>=3.4.0  # Apache-2.0
diff --git a/tests/unit/test_shell.py b/tests/unit/test_shell.py
index 9ef46859..f5d2f15b 100644
--- a/tests/unit/test_shell.py
+++ b/tests/unit/test_shell.py
@@ -1996,8 +1996,8 @@ def _remove_swift_env_vars(self):
         self._environ_vars = {}
         keys = list(os.environ.keys())
         for k in keys:
-            if (k in ('ST_KEY', 'ST_USER', 'ST_AUTH')
-                    or k.startswith('OS_')):
+            if (k in ('ST_KEY', 'ST_USER', 'ST_AUTH') or
+                    k.startswith('OS_')):
                 self._environ_vars[k] = os.environ.pop(k)
 
     def _replace_swift_env_vars(self):
@@ -2979,12 +2979,12 @@ def on_request(method, path, *args, **kwargs):
             Modify response code to 200 if cross account permissions match.
             """
             status = 403
-            if (path.startswith('/v1/%s/%s' % (self.account, self.cont))
-                    and read_ok and method in ('GET', 'HEAD')):
+            if (path.startswith('/v1/%s/%s' % (self.account, self.cont)) and
+                    read_ok and method in ('GET', 'HEAD')):
                 status = 200
             elif (path.startswith('/v1/%s/%s%s'
-                                  % (self.account, self.cont, self.obj))
-                    and write_ok and method in ('PUT', 'POST', 'DELETE')):
+                                  % (self.account, self.cont, self.obj)) and
+                    write_ok and method in ('PUT', 'POST', 'DELETE')):
                 status = 200
             return status
         return on_request
diff --git a/tox.ini b/tox.ini
index bd20632a..fb639d00 100644
--- a/tox.ini
+++ b/tox.ini
@@ -77,7 +77,7 @@ commands=
 # H403: multi line docstrings should end on a new line
 # H404: multi line docstring should start without a leading new line
 # H405: multi line docstring summary not separated with an empty line
-ignore = H101,H301,H306,H401,H403,H404,H405
+ignore = E731,H101,H301,H306,H401,H403,H404,H405
 show-source = True
 exclude = .venv,.tox,dist,doc,*egg
 

From 0ee7c8272e0de2d8c44fd98306d54fc290d74f38 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Thu, 21 Feb 2019 09:26:10 -0800
Subject: [PATCH 135/316] Make proper functions instead of assigning lambdas

Change-Id: I89255f6923c649c7b9d3d36e96c09f8bc4f51a3c
---
 swiftclient/client.py  | 4 +++-
 swiftclient/service.py | 4 +++-
 tox.ini                | 2 +-
 3 files changed, 7 insertions(+), 3 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index 6a2b43b2..44066891 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -1885,7 +1885,9 @@ def _default_reset(*args, **kwargs):
                 reset = getattr(contents, 'reset', None)
                 if tell and seek:
                     orig_pos = tell()
-                    reset_func = lambda *a, **k: seek(orig_pos)
+
+                    def reset_func(*a, **kw):
+                        seek(orig_pos)
                 elif reset:
                     reset_func = reset
         return self._retry(reset_func, put_object, container, obj, contents,
diff --git a/swiftclient/service.py b/swiftclient/service.py
index 71c36ec6..8f3648ee 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -451,7 +451,9 @@ def __init__(self, options=None):
                 **_default_local_options
             )
         process_options(self._options)
-        create_connection = lambda: get_conn(self._options)
+
+        def create_connection():
+            return get_conn(self._options)
         self.thread_manager = MultiThreadingManager(
             create_connection,
             segment_threads=self._options['segment_threads'],
diff --git a/tox.ini b/tox.ini
index fb639d00..bd20632a 100644
--- a/tox.ini
+++ b/tox.ini
@@ -77,7 +77,7 @@ commands=
 # H403: multi line docstrings should end on a new line
 # H404: multi line docstring should start without a leading new line
 # H405: multi line docstring summary not separated with an empty line
-ignore = E731,H101,H301,H306,H401,H403,H404,H405
+ignore = H101,H301,H306,H401,H403,H404,H405
 show-source = True
 exclude = .venv,.tox,dist,doc,*egg
 

From fd6e76029dc725ad48ae4e250f1c70a58740cad7 Mon Sep 17 00:00:00 2001
From: wangzhenyu <wangzy@fiberhome.com>
Date: Tue, 27 Jun 2017 18:15:51 +0800
Subject: [PATCH 136/316] Enable some off-by-default checks
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Some of the available checks are disabled by default, like:
[H106] Don’t put vim configuration in source files
[H203] Use assertIs(Not)None to check for None

Change-Id: I36a6997fdb806b4d0a9d064107cc1451c766c987
---
 tox.ini | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/tox.ini b/tox.ini
index bd20632a..49de93dc 100644
--- a/tox.ini
+++ b/tox.ini
@@ -78,6 +78,9 @@ commands=
 # H404: multi line docstring should start without a leading new line
 # H405: multi line docstring summary not separated with an empty line
 ignore = H101,H301,H306,H401,H403,H404,H405
+# H106: Don’t put vim configuration in source files
+# H203: Use assertIs(Not)None to check for None
+enable-extensions=H106,H203
 show-source = True
 exclude = .venv,.tox,dist,doc,*egg
 

From d32deaadddeaf5e5364acfb3a7f727594d1bc581 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Wed, 27 Feb 2019 11:08:28 -0800
Subject: [PATCH 137/316] Add py37 check/gate jobs; add py37 to default tox env
 list

Change-Id: Ifbc6dc731df20b4bba905a110e71ea5c9cc52c0f
---
 .zuul.yaml | 1 +
 setup.cfg  | 1 +
 tox.ini    | 2 +-
 3 files changed, 3 insertions(+), 1 deletion(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index 56c9faaf..f9c22665 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -41,6 +41,7 @@
       - openstack-python-jobs
       - openstack-python35-jobs
       - openstack-python36-jobs
+      - openstack-python37-jobs
       - publish-openstack-docs-pti
       - release-notes-jobs-python3
     check:
diff --git a/setup.cfg b/setup.cfg
index cdf10b48..d3b13a6b 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -19,6 +19,7 @@ classifier =
     Programming Language :: Python :: 3
     Programming Language :: Python :: 3.5
     Programming Language :: Python :: 3.6
+    Programming Language :: Python :: 3.7
 
 [global]
 setup-hooks =
diff --git a/tox.ini b/tox.ini
index 22ef5266..613e3f86 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,5 +1,5 @@
 [tox]
-envlist = py36,py35,py27,pypy,pep8
+envlist = py37,py36,py35,py27,pypy,pep8
 minversion = 2.0
 skipsdist = True
 

From 344711771db6f3bbeaf85cbb1aa787b89d8d08e3 Mon Sep 17 00:00:00 2001
From: John Dickinson <me@not.mn>
Date: Tue, 26 Feb 2019 16:51:49 -0800
Subject: [PATCH 138/316] authors/changelog updates for release

Change-Id: Ic14916c314043155a5ec3c5b29331862c6aded43
---
 .mailmap                                           |  2 ++
 AUTHORS                                            |  9 ++++++++-
 ChangeLog                                          | 12 ++++++++++++
 releasenotes/notes/361_notes-59e020e68bcdd709.yaml | 12 ++++++++++++
 4 files changed, 34 insertions(+), 1 deletion(-)
 create mode 100644 releasenotes/notes/361_notes-59e020e68bcdd709.yaml

diff --git a/.mailmap b/.mailmap
index ecbcad1f..bc092300 100644
--- a/.mailmap
+++ b/.mailmap
@@ -95,3 +95,5 @@ Andreas Jaeger <aj@suse.de> <aj@suse.com>
 Shashi Kant <shashi.kant@nectechnologies.in>
 Nandini Tata <nandini.tata@intel.com> <nandini.tata.15@gmail.com>
 Flavio Percoco <flaper87@gmail.com>
+Timur Alperovich <timuralp@swiftstack.com> <timur@timuralp.com>
+Thiago da Silva <thiagodasilva@gmail.com> <thiago@redhat.com>
diff --git a/AUTHORS b/AUTHORS
index abc21e98..1fcf65d4 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -92,6 +92,7 @@ Monty Taylor (mordred@inaugust.com)
 Nandini Tata (nandini.tata@intel.com)
 Nelson Marcos (nelsonmarcos@gmail.com)
 Nguyen Hai (nguyentrihai93@gmail.com)
+Nguyen Hai Truong (truongnh@vn.fujitsu.com)
 Nguyen Hung Phuong (phuongnh@vn.fujitsu.com)
 Nick Craig-Wood (nick@craig-wood.com)
 Ondrej Novy (ondrej.novy@firma.seznam.cz)
@@ -103,6 +104,7 @@ Peter Lisak (peter.lisak@firma.seznam.cz)
 Petr Kovar (pkovar@redhat.com)
 Pradeep Kumar Singh (pradeep.singh@nectechnologies.in)
 Pratik Mallya (pratik.mallya@gmail.com)
+qingszhao (zhao.daqing@99cloud.net)
 Qiu Yu (qiuyu@ebaysf.com)
 Ray Chen (oldsharp@163.com)
 ricolin (rico.l@inwinstack.com)
@@ -124,11 +126,12 @@ Stanislaw Pitucha (stanislaw.pitucha@hpe.com)
 Steve Martinelli (stevemar@ca.ibm.com)
 Steven Hardy (shardy@redhat.com)
 Stuart McLaren (stuart.mclaren@hpe.com)
+sunjia (sunjia@inspur.com)
 Sushil Kumar (sushil.kumar2@globallogic.com)
 tanlin (lin.tan@intel.com)
 Taurus Cheung (Taurus.Cheung@harmonicinc.com)
 TheSriram (sriram@klusterkloud.com)
-Thiago da Silva (thiago@redhat.com)
+Thiago da Silva (thiagodasilva@gmail.com)
 Thomas Goirand (thomas@goirand.fr)
 Tihomir Trifonov (t.trifonov@gmail.com)
 Tim Burke (tim.burke@gmail.com)
@@ -141,9 +144,11 @@ Vasyl Khomenko (vasiliyk@yahoo-inc.com)
 venkatamahesh (venkatamaheshkotha@gmail.com)
 Victor Stinner (victor.stinner@enovance.com)
 Vitaly Gridnev (vgridnev@mirantis.com)
+Vu Cong Tuan (tuanvc@vn.fujitsu.com)
 wangqi (wang.qi@99cloud.net)
 wangxiyuan (wangxiyuan@huawei.com)
 Wu Wenxiang (wu.wenxiang@99cloud.net)
+wu.chunyang (wu.chunyang@99cloud.net)
 YangLei (yanglyy@cn.ibm.com)
 yangxurong (yangxurong@huawei.com)
 You Yamagata (bi.yamagata@gmail.com)
@@ -157,3 +162,5 @@ zhang-jinnan (ben.os@99cloud.net)
 zhangyanxian (zhangyanxianmail@163.com)
 zheng yin (yin.zheng@easystack.cn)
 Zhenguo Niu (zhenguo@unitedstack.com)
+ZhijunWei (wzj334965317@outlook.com)
+zhubx007 (zhu.boxiang@99cloud.net)
diff --git a/ChangeLog b/ChangeLog
index a37a6db0..26b46eaa 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,15 @@
+3.6.1
+-----
+
+* Added the delimiter keyword parameter to `get_account()` to match the
+  functionality of `get_container()`.
+
+* Fixed an issue in the client module where socket connections weren't
+  closed properly before being dereferenced.
+
+* Various other minor bug fixes and improvements.
+
+
 3.6.0
 -----
 
diff --git a/releasenotes/notes/361_notes-59e020e68bcdd709.yaml b/releasenotes/notes/361_notes-59e020e68bcdd709.yaml
new file mode 100644
index 00000000..f6b48927
--- /dev/null
+++ b/releasenotes/notes/361_notes-59e020e68bcdd709.yaml
@@ -0,0 +1,12 @@
+---
+fixes:
+  - |
+    Added the delimiter keyword parameter to ``get_account()`` to match the
+    functionality of ``get_container()``.
+
+  - |
+    Fixed an issue in the client module where socket connections weren't
+    closed properly before being dereferenced.
+
+  - |
+    Various other minor bug fixes and improvements.

From 991a6cebb900f9ece5279f1c3c2bf33bcbb74086 Mon Sep 17 00:00:00 2001
From: Thiago da Silva <thiagodasilva@gmail.com>
Date: Mon, 4 Mar 2019 11:55:46 -0500
Subject: [PATCH 139/316] Update release to 3.7.0

Due to Openstack Release policies, the next release needs
to be a minor release, thus bumping to 3.7.0.

Change-Id: If52d48908cfd47c5b94265ebd9ab8e3289c7b19c
---
 ChangeLog | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/ChangeLog b/ChangeLog
index 26b46eaa..6f6bf8bb 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,4 +1,4 @@
-3.6.1
+3.7.0
 -----
 
 * Added the delimiter keyword parameter to `get_account()` to match the

From 5333f3e98ab446e24faf9e421d83b8b04f3fccba Mon Sep 17 00:00:00 2001
From: Dirk Mueller <dirk@dmllr.de>
Date: Sat, 23 Mar 2019 23:19:45 +0100
Subject: [PATCH 140/316] Remove oslosphinx usage

The client actually uses the newer openstackdocstheme.

Change-Id: If78d5fba58cf9e611253259fcdff2191ad3b8709
---
 lower-constraints.txt | 1 -
 test-requirements.txt | 1 -
 2 files changed, 2 deletions(-)

diff --git a/lower-constraints.txt b/lower-constraints.txt
index fefb90ac..ab45e39d 100644
--- a/lower-constraints.txt
+++ b/lower-constraints.txt
@@ -22,7 +22,6 @@ mock==1.2.0
 netaddr==0.7.10
 openstackdocstheme==1.18.1
 oslo.config==1.2.0
-oslosphinx==4.7.0
 pbr==2.0.0
 pep8==1.5.7
 PrettyTable==0.7
diff --git a/test-requirements.txt b/test-requirements.txt
index 13cf1e93..d8222142 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -3,7 +3,6 @@ hacking>=1.1.0,<1.2.0 # Apache-2.0
 coverage!=4.4,>=4.0 # Apache-2.0
 keystoneauth1>=3.4.0  # Apache-2.0
 mock>=1.2.0 # BSD
-oslosphinx>=4.7.0  # Apache-2.0
 sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
 stestr>=2.0.0 # Apache-2.0
 reno>=2.5.0 # Apache-2.0

From 7563d9cb5642c85a31708fd863e2737f9d6c9419 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Mon, 25 Mar 2019 09:35:47 -0700
Subject: [PATCH 141/316] docs: Clean up formatting

Change-Id: I0bcaf15c54dd3b3c590a543569699fe8ec5b0c7c
---
 doc/source/cli/index.rst    | 40 +++++++----------
 doc/source/index.rst        | 20 ++++-----
 doc/source/introduction.rst | 90 ++++++++++++++++++-------------------
 doc/source/service-api.rst  | 54 +++++++++++-----------
 4 files changed, 99 insertions(+), 105 deletions(-)

diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst
index 88fafa1d..d6841d55 100644
--- a/doc/source/cli/index.rst
+++ b/doc/source/cli/index.rst
@@ -245,13 +245,10 @@ storage URL options shown below:
           --os-storage-url https://10.1.5.2:8080/v1/AUTH_ced809b6a4baea7aeab61a \
           list
 
-.. We need the backslash below in order to indent the note
-\
+.. note::
 
-  .. note::
-
-     Leftover environment variables are a common source of confusion when
-     authorization fails.
+   Leftover environment variables are a common source of confusion when
+   authorization fails.
 
 CLI commands
 ~~~~~~~~~~~~
@@ -739,15 +736,15 @@ is passed, the Unix timestamp when the temporary URL will expire.
 But beyond that, ``time`` can also be specified as an ISO 8601 timestamp
 in one of following formats:
 
-    i) Complete date: YYYY-MM-DD (eg 1997-07-16)
+i) Complete date: YYYY-MM-DD (e.g. 1997-07-16)
 
-    ii) Complete date plus hours, minutes and seconds:
-        YYYY-MM-DDThh:mm:ss
-        (eg 1997-07-16T19:20:30)
+ii) Complete date plus hours, minutes and seconds:
+    YYYY-MM-DDThh:mm:ss
+    (e.g. 1997-07-16T19:20:30)
 
-    iii) Complete date plus hours, minutes and seconds with UTC designator:
-        YYYY-MM-DDThh:mm:ssZ
-        (eg 1997-07-16T19:20:30Z)
+iii) Complete date plus hours, minutes and seconds with UTC designator:
+     YYYY-MM-DDThh:mm:ssZ
+     (e.g. 1997-07-16T19:20:30Z)
 
 Please be aware that if you don't provide the UTC designator (i.e., Z)
 the timestamp is generated using your local timezone. If only a date is
@@ -881,17 +878,14 @@ Download an object from a container:
 
     testSwift.txt [auth 0.028s, headers 0.045s, total 0.045s, 0.002 MB/s]
 
-.. We need the backslash below in order to indent the note
-\
-
-  .. note::
+.. note::
 
-     To upload an object to a container, your current working directory must be
-     where the file is located or you must provide the complete path to the file.
-     In other words, the --object-name <object-name> is an option that will upload
-     file and name object to <object-name> or upload directory and use <object-name> as
-     object prefix. In the case that you provide the complete path of the file,
-     that complete path will be the name of the uploaded object.
+   To upload an object to a container, your current working directory must be
+   where the file is located or you must provide the complete path to the file.
+   In other words, the --object-name <object-name> is an option that will upload
+   file and name object to <object-name> or upload directory and use <object-name> as
+   object prefix. In the case that you provide the complete path of the file,
+   that complete path will be the name of the uploaded object.
 
 For example:
 
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 3c2cb1eb..ab05c6bd 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -39,17 +39,17 @@ Indices and tables
 License
 ~~~~~~~
 
-    Copyright 2013 OpenStack, LLC.
+Copyright 2013 OpenStack, LLC.
 
-    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
+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
+* 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.
+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.
 
diff --git a/doc/source/introduction.rst b/doc/source/introduction.rst
index 926b1b90..d6f98195 100644
--- a/doc/source/introduction.rst
+++ b/doc/source/introduction.rst
@@ -16,41 +16,41 @@ Use Cases
 Alongside the command line tool, the ``python-swiftclient`` includes two
 levels of API:
 
- * A low level client API that provides simple Python wrappers around the
-   various authentication mechanisms and the individual HTTP requests.
- * A high level service API that provides methods for performing common
-   operations in parallel on a thread pool.
+* A low level client API that provides simple Python wrappers around the
+  various authentication mechanisms and the individual HTTP requests.
+* A high level service API that provides methods for performing common
+  operations in parallel on a thread pool.
 
 Example use cases:
 
-  * Uploading and retrieving data
-      Use the command line tool if you are simply uploading and downloading
-      files and directories to and from your filesystem. The command line tool
-      can be integrated into a shell script to automate tasks.
-
-  * Integrating into an automated Python workflow
-      Use the ``SwiftService`` API to perform operations offered by the CLI
-      if your use case requires integration with a Python-based workflow.
-      This method offers greater control and flexibility over individual object
-      operations, such as the metadata set on each object. The ``SwiftService``
-      class provides methods to perform multiple sets of operations against a
-      swift object store using a configurable shared thread pool. A single
-      instance of the ``SwiftService`` class can be shared between multiple
-      threads in your own code.
-
-  * Developing an application in Python to access a swift object store
-      Use the ``SwiftService`` API to develop Python applications that use
-      swift to store and retrieve objects. A ``SwiftService`` instance provides
-      a configurable thread pool for performing all operations supported by the
-      CLI.
-
-  * Fine-grained control over threading or the requests being performed
-      Use the ``Connection`` API if your use case requires fine grained control
-      over advanced features or you wish to use your own existing threading
-      model. Examples of advanced features requiring the use of the
-      ``Connection`` API include creating an SLO manifest that references
-      already existing objects, or fine grained control over the query strings
-      supplied with each HTTP request.
+* Uploading and retrieving data
+    Use the command line tool if you are simply uploading and downloading
+    files and directories to and from your filesystem. The command line tool
+    can be integrated into a shell script to automate tasks.
+
+* Integrating into an automated Python workflow
+    Use the ``SwiftService`` API to perform operations offered by the CLI
+    if your use case requires integration with a Python-based workflow.
+    This method offers greater control and flexibility over individual object
+    operations, such as the metadata set on each object. The ``SwiftService``
+    class provides methods to perform multiple sets of operations against a
+    swift object store using a configurable shared thread pool. A single
+    instance of the ``SwiftService`` class can be shared between multiple
+    threads in your own code.
+
+* Developing an application in Python to access a swift object store
+    Use the ``SwiftService`` API to develop Python applications that use
+    swift to store and retrieve objects. A ``SwiftService`` instance provides
+    a configurable thread pool for performing all operations supported by the
+    CLI.
+
+* Fine-grained control over threading or the requests being performed
+    Use the ``Connection`` API if your use case requires fine grained control
+    over advanced features or you wish to use your own existing threading
+    model. Examples of advanced features requiring the use of the
+    ``Connection`` API include creating an SLO manifest that references
+    already existing objects, or fine grained control over the query strings
+    supplied with each HTTP request.
 
 Important considerations
 ~~~~~~~~~~~~~~~~~~~~~~~~
@@ -66,19 +66,19 @@ the proper use case, and not treat the storage like a traditional filesystem.
 There are two main restrictions to bear in mind when designing an application
 that uses an object store:
 
-    * You cannot rename objects. Due to fact that the name of an object is one
-      of the factors that determines where the object and its replicas are stored,
-      renaming would require multiple copies of the data to be moved between
-      physical storage devices. If you want to rename an object you must upload
-      to the new location, or make a server side copy request to the new location,
-      and then delete the original.
-
-    * You cannot modify objects. Objects are stored in multiple locations and
-      are checked for integrity based on the MD5 sum calculated during
-      upload. In order to modify the contents of an object, the entire desired
-      contents must be re-uploaded. In certain special cases it is possible to
-      work around this restriction using large objects, but no general
-      file-like access is available to modify a stored object.
+* You cannot rename objects. Due to fact that the name of an object is one
+  of the factors that determines where the object and its replicas are stored,
+  renaming would require multiple copies of the data to be moved between
+  physical storage devices. If you want to rename an object you must upload
+  to the new location, or make a server side copy request to the new location,
+  and then delete the original.
+
+* You cannot modify objects. Objects are stored in multiple locations and
+  are checked for integrity based on the MD5 sum calculated during
+  upload. In order to modify the contents of an object, the entire desired
+  contents must be re-uploaded. In certain special cases it is possible to
+  work around this restriction using large objects, but no general
+  file-like access is available to modify a stored object.
 
 Objects cannot be locked
 ------------------------
diff --git a/doc/source/service-api.rst b/doc/source/service-api.rst
index 8efd43a0..cc4dcc26 100644
--- a/doc/source/service-api.rst
+++ b/doc/source/service-api.rst
@@ -26,10 +26,10 @@ the auth version based on the combination of options specified, but
 supplying options from multiple different auth versions can cause unexpected
 behaviour.
 
-  .. note::
+.. note::
 
-     Leftover environment variables are a common source of confusion when
-     authorization fails.
+   Leftover environment variables are a common source of confusion when
+   authorization fails.
 
 Keystone V3
 ~~~~~~~~~~~
@@ -109,17 +109,17 @@ in this dictionary are described below, along with their defaults:
 Options
 ~~~~~~~
 
-    ``retries``: ``5``
+``retries``: ``5``
         The number of times that the library should attempt to retry HTTP
         actions before giving up and reporting a failure.
 
-    ``container_threads``: ``10``
+``container_threads``: ``10``
 
-    ``object_dd_threads``: ``10``
+``object_dd_threads``: ``10``
 
-    ``object_uu_threads``: ``10``
+``object_uu_threads``: ``10``
 
-    ``segment_threads``: ``10``
+``segment_threads``: ``10``
         The above options determine the size of the available thread pools for
         performing swift operations. Container operations (such as listing a
         container) operate in the container threads, and a similar pattern
@@ -131,86 +131,86 @@ Options
            ``uu`` and ``dd``. This stands for "upload/update" and "download/delete",
            and the corresponding actions will be run on separate threads pools.
 
-    ``segment_size``: ``None``
+``segment_size``: ``None``
         If specified, this option enables uploading of large objects. Should the
         object being uploaded be larger than 5G in size, this option is
         mandatory otherwise the upload will fail. This option should be
         specified as a size in bytes.
 
-    ``use_slo``: ``False``
+``use_slo``: ``False``
         Used in combination with the above option, ``use_slo`` will upload large
         objects as static rather than dynamic. Only static large objects provide
         error checking for the downloaded object, so we recommend this option.
 
-    ``segment_container``: ``None``
+``segment_container``: ``None``
         Allows the user to select the container into which large object segments
         will be uploaded. We do not recommend changing this value as it could make
         locating orphaned segments more difficult in the case of errors.
 
-    ``leave_segments``: ``False``
+``leave_segments``: ``False``
         Setting this option to true means that when deleting or overwriting a large
         object, its segments will be left in the object store and must be cleaned
         up manually. This option can be useful when sharing large object segments
         between multiple objects in more advanced scenarios, but must be treated
         with care, as it could lead to ever increasing storage usage.
 
-    ``changed``: ``None``
+``changed``: ``None``
         This option affects uploads and simply means that those objects which
         already exist in the object store will not be overwritten if the ``mtime``
         and size of the source is the same as the existing object.
 
-    ``skip_identical``: ``False``
+``skip_identical``: ``False``
         A slightly more thorough case of the above, but rather than ``mtime`` and size
         uses an object's ``MD5 sum``.
 
-    ``yes_all``: ``False``
+``yes_all``: ``False``
         This options affects only download and delete, and in each case must be
         specified in order to download/delete the entire contents of an account.
         This option has no effect on any other calls.
 
-    ``no_download``: ``False``
+``no_download``: ``False``
         This option only affects download and means that all operations proceed as
         normal with the exception that no data is written to disk.
 
-    ``header``: ``[]``
+``header``: ``[]``
         Used with upload and post operations to set headers on objects. Headers
         are specified as colon separated strings, e.g. "content-type:text/plain".
 
-    ``meta``: ``[]``
+``meta``: ``[]``
         Used to set metadata on an object similarly to headers.
 
         .. note::
            Setting metadata is a destructive operation, so when updating one
            of many metadata values all desired metadata for an object must be re-applied.
 
-    ``long``: ``False``
+``long``: ``False``
         Affects only list operations, and results in more metrics being made
         available in the results at the expense of lower performance.
 
-    ``fail_fast``: ``False``
+``fail_fast``: ``False``
         Applies to delete and upload operations, and attempts to abort queued
         tasks in the event of errors.
 
-    ``prefix``: ``None``
+``prefix``: ``None``
         Affects list operations; only objects with the given prefix will be
         returned/affected. It is not advisable to set at the service level, as
         those operations that call list to discover objects on which they should
         operate will also be affected.
 
-    ``delimiter``: ``None``
+``delimiter``: ``None``
         Affects list operations, and means that listings only contain results up
         to the first instance of the delimiter in the object name. This is useful
         for working with objects containing '/' in their names to simulate folder
         structures.
 
-    ``dir_marker``: ``False``
+``dir_marker``: ``False``
         Affects uploads, and allows empty 'pseudofolder' objects to be created
         when the source of an upload is ``None``.
 
-    ``checksum``: ``True``
+``checksum``: ``True``
         Affects uploads and downloads. If set check md5 sum for the transfer.
 
-    ``shuffle``: ``False``
+``shuffle``: ``False``
         When downloading objects, the default behaviour of the CLI is to shuffle
         lists of objects in order to spread the load on storage drives when multiple
         clients are downloading the same files to multiple locations (e.g. in the
@@ -220,12 +220,12 @@ Options
         are downloaded in lexically-sorted order. Setting this option to ``True``
         gives the same shuffling behaviour as the CLI.
 
-    ``destination``: ``None``
+``destination``: ``None``
         When copying objects, this specifies the destination where the object
         will be copied to.  The default of None means copy will be the same as
         source.
 
-    ``fresh_metadata``: ``None``
+``fresh_metadata``: ``None``
         When copying objects, this specifies that the object metadata on the
         source will *not* be applied to the destination object - the
         destination object will have a new fresh set of metadata that includes

From 7e9717c04c570d6cab9890265ec67fea1d937596 Mon Sep 17 00:00:00 2001
From: OpenStack Release Bot <infra-root@openstack.org>
Date: Mon, 18 Mar 2019 14:55:40 +0000
Subject: [PATCH 142/316] Update master for stable/stein

Add file to the reno documentation build to show release notes for
stable/stein.

Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/stein.

Change-Id: I05c44e97e766aa4130b72f6d8d1a6a111ccafd12
Sem-Ver: feature
---
 releasenotes/source/index.rst | 1 +
 releasenotes/source/stein.rst | 6 ++++++
 2 files changed, 7 insertions(+)
 create mode 100644 releasenotes/source/stein.rst

diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst
index 92da0e8f..27f675ee 100644
--- a/releasenotes/source/index.rst
+++ b/releasenotes/source/index.rst
@@ -6,6 +6,7 @@
    :maxdepth: 1
 
    current
+   stein
    rocky
    queens
    pike
diff --git a/releasenotes/source/stein.rst b/releasenotes/source/stein.rst
new file mode 100644
index 00000000..efaceb66
--- /dev/null
+++ b/releasenotes/source/stein.rst
@@ -0,0 +1,6 @@
+===================================
+ Stein Series Release Notes
+===================================
+
+.. release-notes::
+   :branch: stable/stein

From af4bac31fadf1fb15271f49791f16581219d74a2 Mon Sep 17 00:00:00 2001
From: OpenDev Sysadmins <openstack-infra@lists.openstack.org>
Date: Fri, 19 Apr 2019 19:32:30 +0000
Subject: [PATCH 143/316] OpenDev Migration Patch

This commit was bulk generated and pushed by the OpenDev sysadmins
as a part of the Git hosting and code review systems migration
detailed in these mailing list posts:

http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html
http://lists.openstack.org/pipermail/openstack-discuss/2019-April/004920.html

Attempts have been made to correct repository namespaces and
hostnames based on simple pattern matching, but it's possible some
were updated incorrectly or missed entirely. Please reach out to us
via the contact information listed at https://opendev.org/ with any
questions you may have.
---
 .gitreview | 2 +-
 .zuul.yaml | 6 +++---
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/.gitreview b/.gitreview
index 0387a741..6cf44857 100644
--- a/.gitreview
+++ b/.gitreview
@@ -1,4 +1,4 @@
 [gerrit]
-host=review.openstack.org
+host=review.opendev.org
 port=29418
 project=openstack/python-swiftclient.git
diff --git a/.zuul.yaml b/.zuul.yaml
index f9c22665..ac1d9668 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -9,7 +9,7 @@
     # job sets zuul_work_dir to the swift directory and uses tox
     # for installation.
     required-projects:
-      - git.openstack.org/openstack/python-swiftclient
+      - opendev.org/openstack/python-swiftclient
 
 - job:
     name: swiftclient-functional
@@ -19,10 +19,10 @@
       python-swiftclient installed from source instead as package from
       PyPI.
     required-projects:
-      - git.openstack.org/openstack/python-swiftclient
+      - opendev.org/openstack/python-swiftclient
     vars:
       # Override value from parent job to use swiftclient tests
-      zuul_work_dir: "{{ zuul.projects['git.openstack.org/openstack/python-swiftclient'].src_dir }}"
+      zuul_work_dir: "{{ zuul.projects['opendev.org/openstack/python-swiftclient'].src_dir }}"
 
 - job:
     name: swiftclient-functional-py2

From 7103da3467c555e6ab44fc9de5036540fba15c95 Mon Sep 17 00:00:00 2001
From: jacky06 <zhang.min@99cloud.net>
Date: Tue, 23 Apr 2019 13:44:51 +0800
Subject: [PATCH 144/316] Replace git.openstack.org URLs with opendev.org URLs

Change-Id: I0991c93fbf5b015b68dd94f3fe805ec705014f06
---
 README.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.rst b/README.rst
index b105094a..5243dd6b 100644
--- a/README.rst
+++ b/README.rst
@@ -44,7 +44,7 @@ __ https://github.com/openstack/swift
 .. _Launchpad project: https://launchpad.net/python-swiftclient
 .. _Blueprints: https://blueprints.launchpad.net/python-swiftclient
 .. _Bugs: https://bugs.launchpad.net/python-swiftclient
-.. _Source: https://git.openstack.org/cgit/openstack/python-swiftclient
+.. _Source: https://opendev.org/openstack/python-swiftclient
 .. _How to Contribute: https://docs.openstack.org/infra/manual/developers.html
 .. _Specs: https://specs.openstack.org/openstack/swift-specs/
 .. _Release Notes: https://docs.openstack.org/releasenotes/python-swiftclient

From 113eacf3b80f61d366b3e95b558b40f82ff728a4 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Tue, 25 Jun 2019 15:43:29 -0700
Subject: [PATCH 145/316] Isolate docs requirements

...since modern sphinx won't install on py27.

While we're at it, clean up some warnings and treat warnings as errors.

Also, fix up how we parse test configs so we can run func tests.

Related-Change: Id3c2ed87230c5918c18e2c01d086df8157f036b1
Change-Id: I3718f69610545b0dbcb0a2ab45b400da3a45682c
---
 doc/requirements.txt                 |  5 ++++
 doc/source/_static/.gitignore        |  0
 swiftclient/multithreading.py        |  8 ++++++
 swiftclient/utils.py                 |  2 +-
 test-requirements.txt                |  3 --
 tests/functional/test_swiftclient.py | 42 ++++++++++++++++++----------
 tox.ini                              |  6 +++-
 7 files changed, 47 insertions(+), 19 deletions(-)
 create mode 100644 doc/requirements.txt
 create mode 100644 doc/source/_static/.gitignore

diff --git a/doc/requirements.txt b/doc/requirements.txt
new file mode 100644
index 00000000..d8f432ee
--- /dev/null
+++ b/doc/requirements.txt
@@ -0,0 +1,5 @@
+keystoneauth1>=3.4.0  # Apache-2.0
+sphinx!=1.6.6,!=1.6.7,<2.0.0,>=1.6.2;python_version=='2.7' # BSD
+sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD
+reno>=2.5.0 # Apache-2.0
+openstackdocstheme>=1.18.1 # Apache-2.0
diff --git a/doc/source/_static/.gitignore b/doc/source/_static/.gitignore
new file mode 100644
index 00000000..e69de29b
diff --git a/swiftclient/multithreading.py b/swiftclient/multithreading.py
index 5e03ed79..fcf0ed95 100644
--- a/swiftclient/multithreading.py
+++ b/swiftclient/multithreading.py
@@ -175,6 +175,14 @@ def __init__(self, create_connection, max_workers):
         super(ConnectionThreadPoolExecutor, self).__init__(max_workers)
 
     def submit(self, fn, *args, **kwargs):
+        """
+        Schedules the callable, `fn`, to be executed
+
+        :param fn: the callable to be invoked
+        :param args: the positional arguments for the callable
+        :param kwargs: the keyword arguments for the callable
+        :returns: a Future object representing the execution of the callable
+        """
         def conn_fn():
             priority = None
             conn = None
diff --git a/swiftclient/utils.py b/swiftclient/utils.py
index 5c17c613..87a43902 100644
--- a/swiftclient/utils.py
+++ b/swiftclient/utils.py
@@ -74,7 +74,7 @@ def generate_temp_url(path, seconds, key, method, absolute=False,
     Swift object.
 
     :param path: The full path to the Swift object or prefix if
-         a prefix-based temporary URL should be generated. Example:
+        a prefix-based temporary URL should be generated. Example:
         /v1/AUTH_account/c/o or /v1/AUTH_account/c/prefix.
     :param seconds: time in seconds or ISO 8601 timestamp.
         If absolute is False and this is the string representation of an
diff --git a/test-requirements.txt b/test-requirements.txt
index d8222142..b3ca5f89 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -3,7 +3,4 @@ hacking>=1.1.0,<1.2.0 # Apache-2.0
 coverage!=4.4,>=4.0 # Apache-2.0
 keystoneauth1>=3.4.0  # Apache-2.0
 mock>=1.2.0 # BSD
-sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
 stestr>=2.0.0 # Apache-2.0
-reno>=2.5.0 # Apache-2.0
-openstackdocstheme>=1.18.1 # Apache-2.0
diff --git a/tests/functional/test_swiftclient.py b/tests/functional/test_swiftclient.py
index b4f275b2..bae30444 100644
--- a/tests/functional/test_swiftclient.py
+++ b/tests/functional/test_swiftclient.py
@@ -46,11 +46,34 @@ def _get_config(self):
         config.read(config_file)
         self.config = config
         if config.has_section('func_test'):
-            auth_host = config.get('func_test', 'auth_host')
-            auth_port = config.getint('func_test', 'auth_port')
-            auth_ssl = config.getboolean('func_test', 'auth_ssl')
-            auth_prefix = config.get('func_test', 'auth_prefix')
-            self.auth_version = config.get('func_test', 'auth_version')
+            if config.has_option('func_test', 'auth_uri'):
+                self.auth_url = config.get('func_test', 'auth_uri')
+                try:
+                    self.auth_version = config.get('func_test', 'auth_version')
+                except configparser.NoOptionError:
+                    last_piece = self.auth_url.rstrip('/').rsplit('/', 1)[1]
+                    if last_piece.endswith('.0'):
+                        last_piece = last_piece[:-2]
+                    if last_piece in ('1', '2', '3'):
+                        self.auth_version = last_piece
+                    else:
+                        raise
+            else:
+                auth_host = config.get('func_test', 'auth_host')
+                auth_port = config.getint('func_test', 'auth_port')
+                auth_ssl = config.getboolean('func_test', 'auth_ssl')
+                auth_prefix = config.get('func_test', 'auth_prefix')
+                self.auth_version = config.get('func_test', 'auth_version')
+                self.auth_url = ""
+                if auth_ssl:
+                    self.auth_url += "https://"
+                else:
+                    self.auth_url += "http://"
+                self.auth_url += "%s:%s%s" % (
+                    auth_host, auth_port, auth_prefix)
+                if self.auth_version == "1":
+                    self.auth_url += 'v1.0'
+
             try:
                 self.account_username = config.get('func_test',
                                                    'account_username')
@@ -59,15 +82,6 @@ def _get_config(self):
                 username = config.get('func_test', 'username')
                 self.account_username = "%s:%s" % (account, username)
             self.password = config.get('func_test', 'password')
-            self.auth_url = ""
-            if auth_ssl:
-                self.auth_url += "https://"
-            else:
-                self.auth_url += "http://"
-            self.auth_url += "%s:%s%s" % (auth_host, auth_port, auth_prefix)
-            if self.auth_version == "1":
-                self.auth_url += 'v1.0'
-
         else:
             self.skip_tests = True
 
diff --git a/tox.ini b/tox.ini
index 46354918..84a54197 100644
--- a/tox.ini
+++ b/tox.ini
@@ -65,8 +65,10 @@ commands = {[testenv:func]commands}
 
 [testenv:docs]
 basepython = python3
+usedevelop = False
+deps = -r{toxinidir}/doc/requirements.txt
 commands=
-    python setup.py build_sphinx
+    python setup.py build_sphinx -W
 
 [flake8]
 # it's not a bug that we aren't using all of hacking, ignore:
@@ -96,6 +98,8 @@ commands = bindep test
 
 [testenv:releasenotes]
 basepython = python3
+usedevelop = False
+deps = -r{toxinidir}/doc/requirements.txt
 commands = sphinx-build -a -W -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
 
 [testenv:lower-constraints]

From 3b21157a844be5b71fba2216486c3ef412e7ae1a Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Tue, 25 Jun 2019 15:25:53 -0700
Subject: [PATCH 146/316] Clean up warnings from newer flake8

Change-Id: I18a6327b3acdd4db5ae80097080c043f7c20c353
---
 swiftclient/client.py    | 2 +-
 swiftclient/service.py   | 1 +
 swiftclient/shell.py     | 1 +
 tests/unit/test_shell.py | 4 ++--
 tox.ini                  | 3 ++-
 5 files changed, 7 insertions(+), 4 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index 44066891..f0711822 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -39,7 +39,7 @@
 # Default is 100, increase to 256
 http_client._MAXHEADERS = 256
 
-VERSIONFUL_AUTH_PATH = re.compile('v[2-3](?:\.0)?$')
+VERSIONFUL_AUTH_PATH = re.compile(r'v[2-3](?:\.0)?$')
 AUTH_VERSIONS_V1 = ('1.0', '1', 1)
 AUTH_VERSIONS_V2 = ('2.0', '2', 2)
 AUTH_VERSIONS_V3 = ('3.0', '3', 3)
diff --git a/swiftclient/service.py b/swiftclient/service.py
index 8f3648ee..2663ace4 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -173,6 +173,7 @@ def _build_default_global_options():
         'container_threads': 10
     }
 
+
 _default_global_options = _build_default_global_options()
 
 _default_local_options = {
diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 9ea5e952..0459533d 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -58,6 +58,7 @@ def immediate_exit(signum, frame):
     stderr.write(" Aborted\n")
     os_exit(2)
 
+
 st_delete_options = '''[--all] [--leave-segments]
                     [--object-threads <threads>]
                     [--container-threads <threads>]
diff --git a/tests/unit/test_shell.py b/tests/unit/test_shell.py
index f5d2f15b..7c8faa29 100644
--- a/tests/unit/test_shell.py
+++ b/tests/unit/test_shell.py
@@ -1822,7 +1822,7 @@ def test_temp_url_error_output(self):
         argv = ["", "tempurl", "GET", "60", '/v1/a/c',
                     "secret_key", "--absolute", '--prefix-based']
         with CaptureOutput(suppress_systemexit=True) as output:
-                swiftclient.shell.main(argv)
+            swiftclient.shell.main(argv)
         self.assertEqual(expected, output.err,
                          'Expected %r but got %r for path %r' %
                          (expected, output.err, '/v1/a/c'))
@@ -1832,7 +1832,7 @@ def test_temp_url_error_output(self):
             argv = ["", "tempurl", "GET", bad_time, '/v1/a/c/o',
                         "secret_key", "--absolute"]
             with CaptureOutput(suppress_systemexit=True) as output:
-                    swiftclient.shell.main(argv)
+                swiftclient.shell.main(argv)
             self.assertEqual(expected, output.err,
                              'Expected %r but got %r for time %r' %
                              (expected, output.err, bad_time))
diff --git a/tox.ini b/tox.ini
index 84a54197..e029efd9 100644
--- a/tox.ini
+++ b/tox.ini
@@ -79,7 +79,8 @@ commands=
 # H403: multi line docstrings should end on a new line
 # H404: multi line docstring should start without a leading new line
 # H405: multi line docstring summary not separated with an empty line
-ignore = H101,H301,H306,H401,H403,H404,H405
+# W504: line break after binary operator
+ignore = H101,H301,H306,H401,H403,H404,H405,W504
 # H106: Don’t put vim configuration in source files
 # H203: Use assertIs(Not)None to check for None
 enable-extensions=H106,H203

From 9021a58c240e156f54ffafdc4609868f348d3ebc Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Wed, 10 Apr 2019 16:22:27 -0700
Subject: [PATCH 147/316] Fix SLO re-upload

Previously, if you uploaded a file as an SLO then re-uploaded it
with the same segment size and mtime, the second upload would
go delete the segments it just (re)uploaded. This was due to
us tracking old_slo_manifest_paths and new_slo_manifest_paths
in different formats; one would have a leading slash while the
other would not.

Now, normalize to the stripped-slash version so we stop deleting
segments we just uploaded.

Change-Id: Ibcbed3df4febe81cdf13855656e2daaca8d521b4
---
 swiftclient/service.py   | 30 +++++++++++++--------------
 swiftclient/utils.py     |  8 ++++++++
 tests/unit/test_shell.py | 44 ++++++++++++++++++++++++++++++++++++++--
 3 files changed, 64 insertions(+), 18 deletions(-)

diff --git a/swiftclient/service.py b/swiftclient/service.py
index 8f3648ee..3ea7f614 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -17,6 +17,7 @@
 
 import os
 
+from collections import defaultdict
 from concurrent.futures import as_completed, CancelledError, TimeoutError
 from copy import deepcopy
 from errno import EEXIST, ENOENT
@@ -44,7 +45,7 @@
 from swiftclient.utils import (
     config_true_value, ReadableToIterable, LengthWrapper, EMPTY_ETAG,
     parse_api_response, report_traceback, n_groups, split_request_headers,
-    n_at_a_time
+    n_at_a_time, normalize_manifest_path
 )
 from swiftclient.exceptions import ClientException
 from swiftclient.multithreading import MultiThreadingManager
@@ -2071,11 +2072,9 @@ def _upload_object_job(self, conn, container, source, obj, options,
                     if not options['leave_segments']:
                         old_manifest = headers.get('x-object-manifest')
                         if is_slo:
-                            for old_seg in chunk_data:
-                                seg_path = old_seg['name'].lstrip('/')
-                                if isinstance(seg_path, text_type):
-                                    seg_path = seg_path.encode('utf-8')
-                                old_slo_manifest_paths.append(seg_path)
+                            old_slo_manifest_paths.extend(
+                                normalize_manifest_path(old_seg['name'])
+                                for old_seg in chunk_data)
                 except ClientException as err:
                     if err.http_status != 404:
                         traceback, err_time = report_traceback()
@@ -2165,8 +2164,9 @@ def _upload_object_job(self, conn, container, source, obj, options,
                     response = self._upload_slo_manifest(
                         conn, segment_results, container, obj, put_headers)
                     res['manifest_response_dict'] = response
-                    new_slo_manifest_paths = {
-                        seg['segment_location'] for seg in segment_results}
+                    new_slo_manifest_paths.update(
+                        normalize_manifest_path(new_seg['segment_location'])
+                        for new_seg in segment_results)
                 else:
                     new_object_manifest = '%s/%s/%s/%s/%s/' % (
                         quote(seg_container.encode('utf8')),
@@ -2223,8 +2223,9 @@ def _upload_object_job(self, conn, container, source, obj, options,
                     response = self._upload_slo_manifest(
                         conn, results, container, obj, put_headers)
                     res['manifest_response_dict'] = response
-                    new_slo_manifest_paths = {
-                        r['segment_location'] for r in results}
+                    new_slo_manifest_paths.update(
+                        normalize_manifest_path(new_seg['segment_location'])
+                        for new_seg in results)
                     res['large_object'] = True
                 else:
                     res['response_dict'] = ret
@@ -2264,11 +2265,10 @@ def _upload_object_job(self, conn, container, source, obj, options,
                         fp.close()
             if old_manifest or old_slo_manifest_paths:
                 drs = []
-                delobjsmap = {}
+                delobjsmap = defaultdict(list)
                 if old_manifest:
                     scontainer, sprefix = old_manifest.split('/', 1)
                     sprefix = sprefix.rstrip('/') + '/'
-                    delobjsmap[scontainer] = []
                     for part in self.list(scontainer, {'prefix': sprefix}):
                         if not part["success"]:
                             raise part["error"]
@@ -2280,10 +2280,8 @@ def _upload_object_job(self, conn, container, source, obj, options,
                         if seg_to_delete in new_slo_manifest_paths:
                             continue
                         scont, sobj = \
-                            seg_to_delete.split(b'/', 1)
-                        delobjs_cont = delobjsmap.get(scont, [])
-                        delobjs_cont.append(sobj)
-                        delobjsmap[scont] = delobjs_cont
+                            seg_to_delete.split('/', 1)
+                        delobjsmap[scont].append(sobj)
 
                 del_segs = []
                 for dscont, dsobjs in delobjsmap.items():
diff --git a/swiftclient/utils.py b/swiftclient/utils.py
index 87a43902..2b208b9f 100644
--- a/swiftclient/utils.py
+++ b/swiftclient/utils.py
@@ -395,3 +395,11 @@ def n_at_a_time(seq, n):
 def n_groups(seq, n):
     items_per_group = ((len(seq) - 1) // n) + 1
     return n_at_a_time(seq, items_per_group)
+
+
+def normalize_manifest_path(path):
+    if six.PY2 and isinstance(path, six.text_type):
+        path = path.encode('utf-8')
+    if path.startswith('/'):
+        return path[1:]
+    return path
diff --git a/tests/unit/test_shell.py b/tests/unit/test_shell.py
index f5d2f15b..88e2c478 100644
--- a/tests/unit/test_shell.py
+++ b/tests/unit/test_shell.py
@@ -799,11 +799,11 @@ def test_upload_delete_slo_segments(self, connection):
             response_dict={})
         expected_delete_calls = [
             mock.call(
-                b'container1', b'old_seg1',
+                'container1', 'old_seg1',
                 response_dict={}
             ),
             mock.call(
-                b'container2', b'old_seg2',
+                'container2', 'old_seg2',
                 response_dict={}
             )
         ]
@@ -834,6 +834,46 @@ def test_upload_leave_slo_segments(self, connection):
             response_dict={})
         self.assertFalse(connection.return_value.delete_object.mock_calls)
 
+    @mock.patch('swiftclient.service.Connection')
+    def test_reupload_leaves_slo_segments(self, connection):
+        with open(self.tmpfile, "wb") as fh:
+            fh.write(b'12345678901234567890')
+        mtime = '{:.6f}'.format(os.path.getmtime(self.tmpfile))
+        expected_segments = [
+            'container_segments/{}/slo/{}/20/10/{:08d}'.format(
+                self.tmpfile[1:], mtime, i)
+            for i in range(2)
+        ]
+
+        # Test re-upload overwriting a manifest doesn't remove
+        # segments it just wrote
+        connection.return_value.head_container.return_value = {
+            'x-storage-policy': 'one'}
+        connection.return_value.attempts = 0
+        argv = ["", "upload", "container", self.tmpfile,
+                "--use-slo", "-S", "10"]
+        connection.return_value.head_object.side_effect = [
+            {'x-static-large-object': 'true',  # For the upload call
+             'content-length': '20'}]
+        connection.return_value.get_object.return_value = (
+            {},
+            # we've already *got* the expected manifest!
+            json.dumps([
+                {'name': seg} for seg in expected_segments
+            ]).encode('ascii')
+        )
+        connection.return_value.put_object.return_value = (
+            'd41d8cd98f00b204e9800998ecf8427e')
+        swiftclient.shell.main(argv)
+        connection.return_value.put_object.assert_called_with(
+            'container',
+            self.tmpfile[1:],  # drop leading /
+            mock.ANY,
+            headers={'x-object-meta-mtime': mtime},
+            query_string='multipart-manifest=put',
+            response_dict={})
+        self.assertFalse(connection.return_value.delete_object.mock_calls)
+
     @mock.patch('swiftclient.service.Connection')
     def test_upload_delete_dlo_segments(self, connection):
         # Upload delete existing segments

From 591c3e23804519f405a6645232c2246b173b5e75 Mon Sep 17 00:00:00 2001
From: pengyuesheng <pengyuesheng@gohighsec.com>
Date: Wed, 3 Jul 2019 15:01:30 +0800
Subject: [PATCH 148/316] Bump the openstackdocstheme extension to 1.20

Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.

Change-Id: I0573c7feaea991e6b33bdee6dc358c9206a9bfd8
---
 doc/requirements.txt        |  2 +-
 doc/source/conf.py          |  9 ---------
 lower-constraints.txt       |  2 +-
 releasenotes/source/conf.py | 12 ------------
 4 files changed, 2 insertions(+), 23 deletions(-)

diff --git a/doc/requirements.txt b/doc/requirements.txt
index d8f432ee..6cdad2ab 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -2,4 +2,4 @@ keystoneauth1>=3.4.0  # Apache-2.0
 sphinx!=1.6.6,!=1.6.7,<2.0.0,>=1.6.2;python_version=='2.7' # BSD
 sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD
 reno>=2.5.0 # Apache-2.0
-openstackdocstheme>=1.18.1 # Apache-2.0
+openstackdocstheme>=1.20.0 # Apache-2.0
diff --git a/doc/source/conf.py b/doc/source/conf.py
index f56b643f..85dd81ef 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -53,17 +53,8 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'Swiftclient'
 copyright = u'2013-2016 OpenStack, LLC.'
 
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-import swiftclient.version
-release = swiftclient.version.version_string
-version = swiftclient.version.version_string
-
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 # language = None
diff --git a/lower-constraints.txt b/lower-constraints.txt
index ab45e39d..ae619488 100644
--- a/lower-constraints.txt
+++ b/lower-constraints.txt
@@ -20,7 +20,7 @@ MarkupSafe==1.0
 mccabe==0.2.1
 mock==1.2.0
 netaddr==0.7.10
-openstackdocstheme==1.18.1
+openstackdocstheme==1.20.0
 oslo.config==1.2.0
 pbr==2.0.0
 pep8==1.5.7
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index b27aa963..c71f41d4 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -65,15 +65,8 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'Swift Client Release Notes'
 copyright = u'%d, OpenStack Foundation' % datetime.datetime.now().year
 
-# Release notes are version independent.
-# The short X.Y version.
-version = ''
-# The full version, including alpha/beta/rc tags.
-release = ''
-
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #
@@ -173,11 +166,6 @@
 #
 # html_extra_path = []
 
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-# html_last_updated_fmt = '%b %d, %Y'
-html_last_updated_fmt = '%Y-%m-%d %H:%M'
-
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
 #

From efe3d084ded690a68b21947c6d0a96a5f74144c8 Mon Sep 17 00:00:00 2001
From: Corey Bryant <corey.bryant@canonical.com>
Date: Fri, 5 Jul 2019 12:02:26 -0400
Subject: [PATCH 149/316] Add Python 3 Train unit tests

This is a mechanically generated patch to ensure unit testing is in place
for all of the Tested Runtimes for Train.

See the Train python3-updates goal document for details:
https://governance.openstack.org/tc/goals/train/python3-updates.html

Change-Id: I764b9765484e1d8217d56796d984f910aa5f9c5a
Story: #2005924
Task: #34249
---
 .zuul.yaml | 4 +---
 setup.cfg  | 1 -
 tox.ini    | 2 +-
 3 files changed, 2 insertions(+), 5 deletions(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index ac1d9668..4a878bae 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -39,9 +39,7 @@
       - openstack-lower-constraints-jobs
       - openstack-pypy-jobs-nonvoting
       - openstack-python-jobs
-      - openstack-python35-jobs
-      - openstack-python36-jobs
-      - openstack-python37-jobs
+      - openstack-python3-train-jobs
       - publish-openstack-docs-pti
       - release-notes-jobs-python3
     check:
diff --git a/setup.cfg b/setup.cfg
index d3b13a6b..5653bf30 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -17,7 +17,6 @@ classifier =
     Programming Language :: Python :: 2
     Programming Language :: Python :: 2.7
     Programming Language :: Python :: 3
-    Programming Language :: Python :: 3.5
     Programming Language :: Python :: 3.6
     Programming Language :: Python :: 3.7
 
diff --git a/tox.ini b/tox.ini
index e029efd9..a2b63b3f 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,5 +1,5 @@
 [tox]
-envlist = py37,py36,py35,py27,pypy,pep8
+envlist = py27,py37,pypy,pep8
 minversion = 2.0
 skipsdist = True
 

From 936631eac617c83bec1f1c44b1adcaa51d36329c Mon Sep 17 00:00:00 2001
From: Clay Gerrard <clay.gerrard@gmail.com>
Date: Tue, 2 Jul 2019 11:23:22 -0500
Subject: [PATCH 150/316] Optionally display listings in raw json

Symlinks have recently added some new keys to container listings.  It's
very convenient to be able to see and reason about the extra information
in container listings.

Allowing raw json output is similar with what the client already does
for the info command, and it's forward compatible with any listing
enhancements added by future middleware development.

Change-Id: I88fb38529342ac4e4198aeccd2f10c69c7396704
---
 swiftclient/shell.py     | 19 ++++++++++++++++++-
 swiftclient/utils.py     | 22 ++++++++++++++++++++++
 tests/unit/test_shell.py | 20 ++++++++++++++++++++
 tests/unit/test_utils.py | 39 +++++++++++++++++++++++++++++++++++++++
 4 files changed, 99 insertions(+), 1 deletion(-)

diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 0459533d..2be85aff 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -33,7 +33,8 @@
 from time import gmtime, strftime
 
 from swiftclient import RequestException
-from swiftclient.utils import config_true_value, generate_temp_url, prt_bytes
+from swiftclient.utils import config_true_value, generate_temp_url, \
+    prt_bytes, JSONableIterable
 from swiftclient.multithreading import OutputManager
 from swiftclient.exceptions import ClientException
 from swiftclient import __version__ as client_version
@@ -578,6 +579,8 @@ def _print_stats(options, stats, human):
         help='Roll up items with the given delimiter. For containers '
              'only. See OpenStack Swift API documentation for '
              'what this means.')
+    parser.add_argument('-j', '--json', action='store_true',
+                        help='print listing information in json')
     parser.add_argument(
         '-H', '--header', action='append', dest='header',
         default=[],
@@ -616,6 +619,20 @@ def _print_stats(options, stats, human):
                 else:
                     stats_parts_gen = swift.list(container=container)
 
+            if options.get('json', False):
+                def listing(stats_parts_gen=stats_parts_gen):
+                    for stats in stats_parts_gen:
+                        if stats["success"]:
+                            for item in stats['listing']:
+                                yield item
+                        else:
+                            raise stats["error"]
+
+                json.dump(
+                    JSONableIterable(listing()), output_manager.print_stream,
+                    sort_keys=True, indent=2)
+                output_manager.print_msg('')
+                return
             for stats in stats_parts_gen:
                 if stats["success"]:
                     _print_stats(options, stats, human)
diff --git a/swiftclient/utils.py b/swiftclient/utils.py
index 2b208b9f..9e43237c 100644
--- a/swiftclient/utils.py
+++ b/swiftclient/utils.py
@@ -403,3 +403,25 @@ def normalize_manifest_path(path):
     if path.startswith('/'):
         return path[1:]
     return path
+
+
+class JSONableIterable(list):
+    def __init__(self, iterable):
+        self._iterable = iter(iterable)
+        try:
+            self._peeked = next(self._iterable)
+            self._has_items = True
+        except StopIteration:
+            self._peeked = None
+            self._has_items = False
+
+    def __bool__(self):
+        return self._has_items
+
+    __nonzero__ = __bool__
+
+    def __iter__(self):
+        if self._has_items:
+            yield self._peeked
+        for item in self._iterable:
+            yield item
diff --git a/tests/unit/test_shell.py b/tests/unit/test_shell.py
index f729c250..d9ddb3ee 100644
--- a/tests/unit/test_shell.py
+++ b/tests/unit/test_shell.py
@@ -297,6 +297,26 @@ def test_stat_object_with_headers(self, connection):
             mock.call('container', 'object',
                       headers={'Skip-Middleware': 'Test'})])
 
+    @mock.patch('swiftclient.service.Connection')
+    def test_list_json(self, connection):
+        connection.return_value.get_account.side_effect = [
+            [None, [{'name': 'container'}]],
+            [None, [{'name': u'\u263A', 'some-custom-key': 'and value'}]],
+            [None, []],
+        ]
+
+        argv = ["", "list", "--json"]
+        with CaptureOutput(suppress_systemexit=True) as output:
+            swiftclient.shell.main(argv)
+        calls = [mock.call(marker='', prefix=None, headers={}),
+                 mock.call(marker='container', prefix=None, headers={})]
+        connection.return_value.get_account.assert_has_calls(calls)
+
+        listing = [{'name': 'container'},
+                   {'name': u'\u263A', 'some-custom-key': 'and value'}]
+        expected = json.dumps(listing, sort_keys=True, indent=2) + '\n'
+        self.assertEqual(output.out, expected)
+
     @mock.patch('swiftclient.service.Connection')
     def test_list_account(self, connection):
         # Test account listing
diff --git a/tests/unit/test_utils.py b/tests/unit/test_utils.py
index e54b90c7..97abc444 100644
--- a/tests/unit/test_utils.py
+++ b/tests/unit/test_utils.py
@@ -14,6 +14,7 @@
 # limitations under the License.
 
 import gzip
+import json
 import unittest
 import mock
 import six
@@ -638,3 +639,41 @@ def test_gzipped_body(self):
             {'content-encoding': 'gzip'},
             buf.getvalue())
         self.assertEqual({'test': u'\u2603'}, result)
+
+
+class JSONTracker(object):
+    def __init__(self, data):
+        self.data = data
+        self.calls = []
+
+    def __iter__(self):
+        for item in self.data:
+            self.calls.append(('read', item))
+            yield item
+
+    def write(self, s):
+        self.calls.append(('write', s))
+
+
+class TestJSONableIterable(unittest.TestCase):
+    def test_json_dump_iterencodes(self):
+        t = JSONTracker([1, 'fish', 2, 'fish'])
+        json.dump(u.JSONableIterable(t), t)
+        self.assertEqual(t.calls, [
+            ('read', 1),
+            ('write', '[1'),
+            ('read', 'fish'),
+            ('write', ', "fish"'),
+            ('read', 2),
+            ('write', ', 2'),
+            ('read', 'fish'),
+            ('write', ', "fish"'),
+            ('write', ']'),
+        ])
+
+    def test_json_dump_empty_iter(self):
+        t = JSONTracker([])
+        json.dump(u.JSONableIterable(t), t)
+        self.assertEqual(t.calls, [
+            ('write', '[]'),
+        ])

From 47d5f44c3dbb5b9172a6ac7e894bf2b940ad5707 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 28 Jun 2019 16:43:32 -0700
Subject: [PATCH 151/316] Authors/changelog for 3.8.0

Change-Id: I5de701c6282ffb4a3776009aeb16531f29162306
---
 AUTHORS                                              |  3 +++
 ChangeLog                                            | 12 ++++++++++++
 .../notes/3_8_0_release-bd867fbdb8c895d3.yaml        |  9 +++++++++
 3 files changed, 24 insertions(+)
 create mode 100644 releasenotes/notes/3_8_0_release-bd867fbdb8c895d3.yaml

diff --git a/AUTHORS b/AUTHORS
index 1fcf65d4..16dfcf9c 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -52,6 +52,7 @@ Hiroshi Miura (miurahr@nttdata.co.jp)
 howardlee (lihongweibj@inspur.com)
 Hu Bing (hubingsh@cn.ibm.com)
 Ian Cordasco (ian.cordasco@rackspace.com)
+jacky06 (zhang.min@99cloud.net)
 Jaivish Kothari (jaivish.kothari@nectechnologies.in)
 Jakub Krajcovic (jakub.krajcovic@gmail.com)
 James Nzomo (james@tdt.rocks)
@@ -99,6 +100,7 @@ Ondrej Novy (ondrej.novy@firma.seznam.cz)
 Pallavi (pallavi.s@nectechnologies.in)
 Paul Belanger (pabelanger@redhat.com)
 Paulo Ewerton (pauloewerton@lsd.ufcg.edu.br)
+pengyuesheng (pengyuesheng@gohighsec.com)
 Pete Zaitcev (zaitcev@kotori.zaitcev.us)
 Peter Lisak (peter.lisak@firma.seznam.cz)
 Petr Kovar (pkovar@redhat.com)
@@ -147,6 +149,7 @@ Vitaly Gridnev (vgridnev@mirantis.com)
 Vu Cong Tuan (tuanvc@vn.fujitsu.com)
 wangqi (wang.qi@99cloud.net)
 wangxiyuan (wangxiyuan@huawei.com)
+wangzhenyu (wangzy@fiberhome.com)
 Wu Wenxiang (wu.wenxiang@99cloud.net)
 wu.chunyang (wu.chunyang@99cloud.net)
 YangLei (yanglyy@cn.ibm.com)
diff --git a/ChangeLog b/ChangeLog
index 6f6bf8bb..253a3cc1 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,15 @@
+3.8.0
+-----
+
+* Added a new `--json` option to `swift list`.
+
+* Fixed an issue introduced in 3.5.0 where re-uploading an SLO with
+  the same size, mtime, and segment size would delete all of the
+  just-uploaded segments.
+
+* Various other minor bug fixes and improvements.
+
+
 3.7.0
 -----
 
diff --git a/releasenotes/notes/3_8_0_release-bd867fbdb8c895d3.yaml b/releasenotes/notes/3_8_0_release-bd867fbdb8c895d3.yaml
new file mode 100644
index 00000000..85ae2c0c
--- /dev/null
+++ b/releasenotes/notes/3_8_0_release-bd867fbdb8c895d3.yaml
@@ -0,0 +1,9 @@
+---
+features:
+  - |
+    Added a new ``--json`` option to ``swift list``.
+fixes:
+  - |
+    Fixed an issue introduced in 3.5.0 where re-uploading an SLO with
+    the same size, mtime, and segment size would delete all of the
+    just-uploaded segments.

From 5bd66947fc3d8987d4b24d5119a346031004229e Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Thu, 25 Jul 2019 14:21:27 -0700
Subject: [PATCH 152/316] Drag forward prettytable in lower-constraints

Apparently version 0.7 got unpublished recently.

Change-Id: I8669130f8477a577781e17c6d428aacff53cab92
---
 lower-constraints.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lower-constraints.txt b/lower-constraints.txt
index ae619488..88d28650 100644
--- a/lower-constraints.txt
+++ b/lower-constraints.txt
@@ -24,7 +24,7 @@ openstackdocstheme==1.20.0
 oslo.config==1.2.0
 pbr==2.0.0
 pep8==1.5.7
-PrettyTable==0.7
+PrettyTable==0.7.1
 pyflakes==0.8.1
 Pygments==2.2.0
 python-keystoneclient==0.7.0

From 7175069b3e95c38070bb4373019f78c87ab103d0 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Thu, 25 Jul 2019 11:21:29 -0700
Subject: [PATCH 153/316] Fix up requests so we can send non-RFC-compliant
 headers on py3

Change-Id: I3dac826c1f208569c5f40431f59a2045e5744415
---
 swiftclient/client.py                |  6 ++++--
 tests/functional/test_swiftclient.py | 17 +++++++++++++++++
 2 files changed, 21 insertions(+), 2 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index f0711822..4be2e2d6 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -74,8 +74,10 @@ def createLock(self):
     pass
 
 # requests version 1.2.3 try to encode headers in ascii, preventing
-# utf-8 encoded header to be 'prepared'
-if StrictVersion(requests.__version__) < StrictVersion('2.0.0'):
+# utf-8 encoded header to be 'prepared'. This also affects all
+# (or at least most) versions of requests on py3
+if StrictVersion(requests.__version__) < StrictVersion('2.0.0') \
+        or not six.PY2:
     from requests.structures import CaseInsensitiveDict
 
     def prepare_unicode_headers(self, headers):
diff --git a/tests/functional/test_swiftclient.py b/tests/functional/test_swiftclient.py
index bae30444..9a74c63f 100644
--- a/tests/functional/test_swiftclient.py
+++ b/tests/functional/test_swiftclient.py
@@ -18,6 +18,7 @@
 import time
 from io import BytesIO
 
+import six
 from six.moves import configparser
 
 import swiftclient
@@ -446,6 +447,22 @@ def test_post_object(self):
         self.assertEqual('45.67', headers.get('x-object-meta-float'))
         self.assertEqual('False', headers.get('x-object-meta-bool'))
 
+    def test_post_object_unicode_header_name(self):
+        self.conn.post_object(self.containername,
+                              self.objectname,
+                              {u'x-object-meta-\U0001f44d': u'\U0001f44d'})
+
+        # Note that we can't actually read this header back on py3; see
+        # https://bugs.python.org/issue37093
+        # We'll have to settle for just testing that the POST doesn't blow up
+        # with a UnicodeDecodeError
+        if six.PY2:
+            headers = self.conn.head_object(
+                self.containername, self.objectname)
+            self.assertIn(u'x-object-meta-\U0001f44d', headers)
+            self.assertEqual(u'\U0001f44d',
+                             headers.get(u'x-object-meta-\U0001f44d'))
+
     def test_copy_object(self):
         self.conn.put_object(
             self.containername, self.objectname, self.test_data)

From 78753987468cb6b04d0b4e06b432e22f5a7189bd Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 26 Jul 2019 22:56:08 -0700
Subject: [PATCH 154/316] Delete/overwrite symlinks better

Previously, when deleting a symlink that points to an xLO, we'd clean
up the xLO's segments then delete the symlink, leaving the xLO itself
busted.

Similar trouble would come from overwriting a symlink pointing to an
xLO. Check for a Content-Location in the HEAD response and leave such
segments.

Co-Authored-By: Clay Gerrard <clay.gerrard@gmail.com>
Change-Id: I45b210cf380a68bd88187c91fa2d63a8b2bb709b
---
 swiftclient/service.py     |  6 ++++--
 tests/unit/test_service.py | 15 ++++++++-------
 tests/unit/test_shell.py   | 29 +++++++++++++++++++++++++++++
 3 files changed, 41 insertions(+), 9 deletions(-)

diff --git a/swiftclient/service.py b/swiftclient/service.py
index 06de091e..5292dc5a 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -2070,7 +2070,8 @@ def _upload_object_job(self, conn, container, source, obj, options,
                             'status': 'skipped-changed'
                         })
                         return res
-                    if not options['leave_segments']:
+                    if not options['leave_segments'] and not headers.get(
+                            'content-location'):
                         old_manifest = headers.get('x-object-manifest')
                         if is_slo:
                             old_slo_manifest_paths.extend(
@@ -2515,7 +2516,8 @@ def _delete_object(self, conn, container, obj, options,
             if not options['leave_segments']:
                 try:
                     headers = conn.head_object(container, obj,
-                                               headers=_headers)
+                                               headers=_headers,
+                                               query_string='symlink=get')
                     old_manifest = headers.get('x-object-manifest')
                     if config_true_value(headers.get('x-static-large-object')):
                         query_string = 'multipart-manifest=delete'
diff --git a/tests/unit/test_service.py b/tests/unit/test_service.py
index 12fbaa00..b7603522 100644
--- a/tests/unit/test_service.py
+++ b/tests/unit/test_service.py
@@ -312,8 +312,8 @@ def test_delete_object(self):
         s = SwiftService()
         r = s._delete_object(mock_conn, 'test_c', 'test_o', self.opts, mock_q)
 
-        mock_conn.head_object.assert_called_once_with('test_c', 'test_o',
-                                                      headers={})
+        mock_conn.head_object.assert_called_once_with(
+            'test_c', 'test_o', query_string='symlink=get', headers={})
         mock_conn.delete_object.assert_called_once_with(
             'test_c', 'test_o', query_string=None, response_dict={},
             headers={}
@@ -335,7 +335,8 @@ def test_delete_object_with_headers(self):
         r = s._delete_object(mock_conn, 'test_c', 'test_o', opt_c, mock_q)
 
         mock_conn.head_object.assert_called_once_with(
-            'test_c', 'test_o', headers={'Skip-Middleware': 'Test'})
+            'test_c', 'test_o', headers={'Skip-Middleware': 'Test'},
+            query_string='symlink=get')
         mock_conn.delete_object.assert_called_once_with(
             'test_c', 'test_o', query_string=None, response_dict={},
             headers={'Skip-Middleware': 'Test'}
@@ -362,8 +363,8 @@ def test_delete_object_exception(self):
         r = s._delete_object(mock_conn, 'test_c', 'test_o', self.opts, mock_q)
         after = time.time()
 
-        mock_conn.head_object.assert_called_once_with('test_c', 'test_o',
-                                                      headers={})
+        mock_conn.head_object.assert_called_once_with(
+            'test_c', 'test_o', query_string='symlink=get', headers={})
         mock_conn.delete_object.assert_called_once_with(
             'test_c', 'test_o', query_string=None, response_dict={},
             headers={}
@@ -389,8 +390,8 @@ def test_delete_object_slo_support(self):
         s = SwiftService()
         r = s._delete_object(mock_conn, 'test_c', 'test_o', self.opts, mock_q)
 
-        mock_conn.head_object.assert_called_once_with('test_c', 'test_o',
-                                                      headers={})
+        mock_conn.head_object.assert_called_once_with(
+            'test_c', 'test_o', query_string='symlink=get', headers={})
         mock_conn.delete_object.assert_called_once_with(
             'test_c', 'test_o',
             query_string='multipart-manifest=delete',
diff --git a/tests/unit/test_shell.py b/tests/unit/test_shell.py
index d9ddb3ee..c9722815 100644
--- a/tests/unit/test_shell.py
+++ b/tests/unit/test_shell.py
@@ -832,6 +832,35 @@ def test_upload_delete_slo_segments(self, connection):
             sorted(connection.return_value.delete_object.mock_calls)
         )
 
+    @mock.patch('swiftclient.service.Connection')
+    def test_upload_over_symlink_to_slo(self, connection):
+        # Upload delete existing segments
+        connection.return_value.head_container.return_value = {
+            'x-storage-policy': 'one'}
+        connection.return_value.attempts = 0
+        connection.return_value.head_object.side_effect = [
+            {'x-static-large-object': 'true',
+             'content-location': '/v1/a/c/manifest',
+             'content-length': '2'},
+        ]
+        connection.return_value.get_object.return_value = (
+            {'content-location': '/v1/a/c/manifest'},
+            b'[{"name": "container1/old_seg1"},'
+            b' {"name": "container2/old_seg2"}]'
+        )
+        connection.return_value.put_object.return_value = EMPTY_ETAG
+        connection.return_value.delete_object.return_value = None
+        argv = ["", "upload", "container", self.tmpfile]
+        swiftclient.shell.main(argv)
+        connection.return_value.put_object.assert_called_with(
+            'container',
+            self.tmpfile.lstrip('/'),
+            mock.ANY,
+            content_length=0,
+            headers={'x-object-meta-mtime': mock.ANY},
+            response_dict={})
+        self.assertEqual([], connection.return_value.delete_object.mock_calls)
+
     @mock.patch('swiftclient.service.Connection')
     def test_upload_leave_slo_segments(self, connection):
         # Test upload overwriting a manifest respects --leave-segments

From a0f0aedb41ba790266cca678fc3bd91696888835 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Wed, 4 Sep 2019 11:21:04 -0700
Subject: [PATCH 155/316] docs: Fix warning treated as error

Change-Id: I669533334419e94ca925e859f2b0d5d2afe9f7f1
---
 swiftclient/multithreading.py | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/swiftclient/multithreading.py b/swiftclient/multithreading.py
index fcf0ed95..f128790e 100644
--- a/swiftclient/multithreading.py
+++ b/swiftclient/multithreading.py
@@ -168,6 +168,12 @@ class ConnectionThreadPoolExecutor(ThreadPoolExecutor):
     We will only create as many connections as are required concurrently.
     """
     def __init__(self, create_connection, max_workers):
+        """
+        Initializes a new ThreadPoolExecutor instance.
+
+        :param create_connection: callable to use to create new connections
+        :param max_workers: the maximum number of threads that can be used
+        """
         self._connections = PriorityQueue()
         self._create_connection = create_connection
         for p in range(0, max_workers):

From 14095c109fe35bdbbaf7703328edf8bfe759700b Mon Sep 17 00:00:00 2001
From: Matthew Oliver <matt@oliver.net.au>
Date: Wed, 4 Sep 2019 14:39:40 +1000
Subject: [PATCH 156/316] PDF Documentation Build tox target

This patch adds a `pdf-docs` tox target that will build
PDF versions of our docs. As per the Train community goal:

  https://governance.openstack.org/tc/goals/selected/train/pdf-doc-generation.html

Story: 2006122
Task: 35514
Change-Id: I7e0ee410ac603774e4b03f859ac3aa20e5afc9b8
---
 doc/source/conf.py | 4 +++-
 tox.ini            | 9 +++++++++
 2 files changed, 12 insertions(+), 1 deletion(-)

diff --git a/doc/source/conf.py b/doc/source/conf.py
index 85dd81ef..a8ad3ad7 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -181,7 +181,7 @@
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual])
 latex_documents = [
-    ('index', 'SwiftClient.tex', u'SwiftClient Documentation',
+    ('index', 'doc-python-swiftclient.tex', u'SwiftClient Documentation',
      u'OpenStack, LLC.', 'manual'),
 ]
 
@@ -201,3 +201,5 @@
 
 # If false, no module index is generated.
 # latex_use_modindex = True
+
+latex_use_xindy = False
diff --git a/tox.ini b/tox.ini
index a2b63b3f..7dd864b3 100644
--- a/tox.ini
+++ b/tox.ini
@@ -109,3 +109,12 @@ deps =
   -c{toxinidir}/lower-constraints.txt
   -r{toxinidir}/test-requirements.txt
   .[keystone]
+
+[testenv:pdf-docs]
+basepython = python3
+deps = {[testenv:docs]deps}
+whitelist_externals =
+  make
+commands =
+  sphinx-build -W -b latex doc/source doc/build/pdf
+  make -C doc/build/pdf

From 72b90fed4c62cf75497a7d66714f5fb0aa91f18b Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Thu, 12 Sep 2019 16:28:40 -0700
Subject: [PATCH 157/316] Authors/changelog for 3.8.1

Change-Id: I4f178c30723e0da6ba1ec8c8c171137ada631496
---
 AUTHORS                                           |  1 +
 ChangeLog                                         | 15 +++++++++++++++
 .../notes/3_8_1_release-cb5648c3ae69bde1.yaml     | 14 ++++++++++++++
 3 files changed, 30 insertions(+)
 create mode 100644 releasenotes/notes/3_8_1_release-cb5648c3ae69bde1.yaml

diff --git a/AUTHORS b/AUTHORS
index 16dfcf9c..da8e44bb 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -24,6 +24,7 @@ Clark Boylan (clark.boylan@gmail.com)
 Claudiu Belu (cbelu@cloudbasesolutions.com)
 Clay Gerrard (clay.gerrard@gmail.com)
 Clint Byrum (clint@fewbar.com)
+Corey Bryant (corey.bryant@canonical.com)
 Dan Prince (dprince@redhat.com)
 Daniel Wakefield (daniel.wakefield@hp.com)
 Darrell Bishop (darrell@swiftstack.com)
diff --git a/ChangeLog b/ChangeLog
index 253a3cc1..501491bf 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,18 @@
+3.8.1
+-----
+
+* Deleting or overwriting a symlink to an SLO or DLO will no longer attempt
+  to clean up the large object's segments.
+
+* Fixed an issue sending non-ASCII metadata keys on Python 3.
+  Note that receiving such metadata on py3 is still broken;
+  see https://bugs.python.org/issue37093
+
+* Documentation can now be rendered as a PDF.
+
+* Dropped Python 3.5 testing.
+
+
 3.8.0
 -----
 
diff --git a/releasenotes/notes/3_8_1_release-cb5648c3ae69bde1.yaml b/releasenotes/notes/3_8_1_release-cb5648c3ae69bde1.yaml
new file mode 100644
index 00000000..7985d373
--- /dev/null
+++ b/releasenotes/notes/3_8_1_release-cb5648c3ae69bde1.yaml
@@ -0,0 +1,14 @@
+---
+fixes:
+  - |
+    Deleting or overwriting a symlink to an SLO or DLO will no longer attempt
+    to clean up the large object's segments.
+  - |
+    Fixed an issue sending non-ASCII metadata keys on Python 3.
+    Note that *receiving* such metadata on py3 is `still broken
+    <https://bugs.python.org/issue37093>`__.
+other:
+  - |
+    Documentation can now be rendered as a PDF.
+  - |
+    Dropped Python 3.5 testing.

From 606951c736cde79418e9ebcd790c4af3686a2170 Mon Sep 17 00:00:00 2001
From: OpenStack Release Bot <infra-root@openstack.org>
Date: Fri, 13 Sep 2019 21:34:49 +0000
Subject: [PATCH 158/316] Update master for stable/train

Add file to the reno documentation build to show release notes for
stable/train.

Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/train.

Change-Id: I8831476757575fd54fc07154450c6d545fbe6463
Sem-Ver: feature
---
 releasenotes/source/index.rst | 1 +
 releasenotes/source/train.rst | 6 ++++++
 2 files changed, 7 insertions(+)
 create mode 100644 releasenotes/source/train.rst

diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst
index 27f675ee..662c6f6d 100644
--- a/releasenotes/source/index.rst
+++ b/releasenotes/source/index.rst
@@ -6,6 +6,7 @@
    :maxdepth: 1
 
    current
+   train
    stein
    rocky
    queens
diff --git a/releasenotes/source/train.rst b/releasenotes/source/train.rst
new file mode 100644
index 00000000..58390039
--- /dev/null
+++ b/releasenotes/source/train.rst
@@ -0,0 +1,6 @@
+==========================
+Train Series Release Notes
+==========================
+
+.. release-notes::
+   :branch: stable/train

From 9527d0497f19487114e158de6387fb5483cf3182 Mon Sep 17 00:00:00 2001
From: kangyufei <kangyf@inspur.com>
Date: Tue, 22 Oct 2019 14:33:13 +0800
Subject: [PATCH 159/316] Switch to Ussuri jobs

Change-Id: Ibf51928ce55e4a96f0d674c693559b2bf9256f11
---
 .zuul.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index 4a878bae..4f288d79 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -39,7 +39,7 @@
       - openstack-lower-constraints-jobs
       - openstack-pypy-jobs-nonvoting
       - openstack-python-jobs
-      - openstack-python3-train-jobs
+      - openstack-python3-ussuri-jobs
       - publish-openstack-docs-pti
       - release-notes-jobs-python3
     check:

From 1eda8f9f3eac55953b3d54e32754e2ec312ab348 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Wed, 9 Oct 2019 21:05:47 -0700
Subject: [PATCH 160/316] Rename "tests" directory to be "test" like in the
 swift repo

In addition to being less confusing for devs, this lets us actually run
tempauth tests in swiftclient dsvm jobs.

The job definition (over in the swift repo) specifies test/sample.conf,
which does not exist in this repo. As a result, those tests would skip
with

    SKIPPING FUNCTIONAL TESTS DUE TO NO CONFIG

Change-Id: I558dbf9a657d442e6e19468e543bbec855129eeb
---
 .functests                                     | 2 +-
 .stestr.conf                                   | 2 +-
 .unittests                                     | 2 +-
 {tests => test}/__init__.py                    | 0
 {tests => test}/functional/__init__.py         | 0
 {tests => test}/functional/test_swiftclient.py | 0
 {tests => test}/sample.conf                    | 0
 {tests => test}/unit/__init__.py               | 0
 {tests => test}/unit/test_authv1.py            | 0
 {tests => test}/unit/test_command_helpers.py   | 0
 {tests => test}/unit/test_multithreading.py    | 0
 {tests => test}/unit/test_service.py           | 8 ++++----
 {tests => test}/unit/test_shell.py             | 0
 {tests => test}/unit/test_swiftclient.py       | 0
 {tests => test}/unit/test_utils.py             | 0
 {tests => test}/unit/utils.py                  | 0
 tox.ini                                        | 4 ++--
 17 files changed, 9 insertions(+), 9 deletions(-)
 rename {tests => test}/__init__.py (100%)
 rename {tests => test}/functional/__init__.py (100%)
 rename {tests => test}/functional/test_swiftclient.py (100%)
 rename {tests => test}/sample.conf (100%)
 rename {tests => test}/unit/__init__.py (100%)
 rename {tests => test}/unit/test_authv1.py (100%)
 rename {tests => test}/unit/test_command_helpers.py (100%)
 rename {tests => test}/unit/test_multithreading.py (100%)
 rename {tests => test}/unit/test_service.py (99%)
 rename {tests => test}/unit/test_shell.py (100%)
 rename {tests => test}/unit/test_swiftclient.py (100%)
 rename {tests => test}/unit/test_utils.py (100%)
 rename {tests => test}/unit/utils.py (100%)

diff --git a/.functests b/.functests
index d199ec84..288c9e61 100755
--- a/.functests
+++ b/.functests
@@ -1,7 +1,7 @@
 #!/bin/bash
 set -e
 
-export OS_TEST_PATH='tests.functional'
+export OS_TEST_PATH='test.functional'
 export PYTHON='coverage run --source swiftclient --parallel-mode'
 stestr run --concurrency=1
 
diff --git a/.stestr.conf b/.stestr.conf
index 5228f209..90f5b813 100644
--- a/.stestr.conf
+++ b/.stestr.conf
@@ -1,4 +1,4 @@
 [DEFAULT]
-test_path=${OS_TEST_PATH:-./tests/unit}
+test_path=${OS_TEST_PATH:-./test/unit}
 top_dir=./
 
diff --git a/.unittests b/.unittests
index 5d935b1a..3a7ffe9b 100755
--- a/.unittests
+++ b/.unittests
@@ -1,7 +1,7 @@
 #!/bin/bash
 set -e
 
-python setup.py testr --coverage  --testr-args="tests.unit"
+python setup.py testr --coverage  --testr-args="test.unit"
 RET=$?
 coverage report -m
 rm -f .coverage
diff --git a/tests/__init__.py b/test/__init__.py
similarity index 100%
rename from tests/__init__.py
rename to test/__init__.py
diff --git a/tests/functional/__init__.py b/test/functional/__init__.py
similarity index 100%
rename from tests/functional/__init__.py
rename to test/functional/__init__.py
diff --git a/tests/functional/test_swiftclient.py b/test/functional/test_swiftclient.py
similarity index 100%
rename from tests/functional/test_swiftclient.py
rename to test/functional/test_swiftclient.py
diff --git a/tests/sample.conf b/test/sample.conf
similarity index 100%
rename from tests/sample.conf
rename to test/sample.conf
diff --git a/tests/unit/__init__.py b/test/unit/__init__.py
similarity index 100%
rename from tests/unit/__init__.py
rename to test/unit/__init__.py
diff --git a/tests/unit/test_authv1.py b/test/unit/test_authv1.py
similarity index 100%
rename from tests/unit/test_authv1.py
rename to test/unit/test_authv1.py
diff --git a/tests/unit/test_command_helpers.py b/test/unit/test_command_helpers.py
similarity index 100%
rename from tests/unit/test_command_helpers.py
rename to test/unit/test_command_helpers.py
diff --git a/tests/unit/test_multithreading.py b/test/unit/test_multithreading.py
similarity index 100%
rename from tests/unit/test_multithreading.py
rename to test/unit/test_multithreading.py
diff --git a/tests/unit/test_service.py b/test/unit/test_service.py
similarity index 99%
rename from tests/unit/test_service.py
rename to test/unit/test_service.py
index b7603522..ed3a2d6e 100644
--- a/tests/unit/test_service.py
+++ b/test/unit/test_service.py
@@ -36,7 +36,7 @@
     SwiftService, SwiftError, SwiftUploadObject
 )
 
-from tests.unit import utils as test_utils
+from test.unit import utils as test_utils
 
 
 clean_os_environ = {}
@@ -1060,11 +1060,11 @@ def test_upload_with_bad_segment_size(self):
     @mock.patch('swiftclient.service.getsize', return_value=4)
     def test_upload_with_relative_path(self, *args, **kwargs):
         service = SwiftService({})
-        objects = [{'path': "./test",
+        objects = [{'path': "./testobj",
                     'strt_indx': 2},
-                   {'path': os.path.join(os.getcwd(), "test"),
+                   {'path': os.path.join(os.getcwd(), "testobj"),
                     'strt_indx': 1},
-                   {'path': ".\\test",
+                   {'path': ".\\testobj",
                     'strt_indx': 2}]
         for obj in objects:
             with mock.patch('swiftclient.service.Connection') as mock_conn, \
diff --git a/tests/unit/test_shell.py b/test/unit/test_shell.py
similarity index 100%
rename from tests/unit/test_shell.py
rename to test/unit/test_shell.py
diff --git a/tests/unit/test_swiftclient.py b/test/unit/test_swiftclient.py
similarity index 100%
rename from tests/unit/test_swiftclient.py
rename to test/unit/test_swiftclient.py
diff --git a/tests/unit/test_utils.py b/test/unit/test_utils.py
similarity index 100%
rename from tests/unit/test_utils.py
rename to test/unit/test_utils.py
diff --git a/tests/unit/utils.py b/test/unit/utils.py
similarity index 100%
rename from tests/unit/utils.py
rename to test/unit/utils.py
diff --git a/tox.ini b/tox.ini
index 7dd864b3..002d24c5 100644
--- a/tox.ini
+++ b/tox.ini
@@ -24,7 +24,7 @@ passenv = SWIFT_* *_proxy
 [testenv:pep8]
 basepython = python3
 commands =
-    python -m flake8 swiftclient tests
+    python -m flake8 swiftclient test
 
 [testenv:venv]
 basepython = python3
@@ -44,7 +44,7 @@ commands =
 [testenv:func]
 basepython = python3
 setenv =
-    OS_TEST_PATH=tests.functional
+    OS_TEST_PATH=test.functional
     PYTHON=coverage run --source swiftclient --parallel-mode
 whitelist_externals =
     coverage

From c4bef14fc1975f2e115a6ec8560e674e8aa5b1bf Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Wed, 9 Oct 2019 16:59:23 -0700
Subject: [PATCH 161/316] v1auth: support endpoint_data_for() api

...so we can be used with openstacksdk.

Also, add a few functests that use openstacksdk.

Change-Id: Ie6987f5de48914ec8932254cde79a973a0264877
---
 lower-constraints.txt                |  1 +
 swiftclient/authv1.py                | 12 +++-
 test-requirements.txt                |  1 +
 test/functional/__init__.py          | 93 ++++++++++++++++++++++++++++
 test/functional/test_openstacksdk.py | 92 +++++++++++++++++++++++++++
 test/functional/test_swiftclient.py  | 85 +++++++------------------
 6 files changed, 221 insertions(+), 63 deletions(-)
 create mode 100644 test/functional/test_openstacksdk.py

diff --git a/lower-constraints.txt b/lower-constraints.txt
index 88d28650..ead02791 100644
--- a/lower-constraints.txt
+++ b/lower-constraints.txt
@@ -21,6 +21,7 @@ mccabe==0.2.1
 mock==1.2.0
 netaddr==0.7.10
 openstackdocstheme==1.20.0
+openstacksdk==0.11.0
 oslo.config==1.2.0
 pbr==2.0.0
 pep8==1.5.7
diff --git a/swiftclient/authv1.py b/swiftclient/authv1.py
index 55469acf..d70acac3 100644
--- a/swiftclient/authv1.py
+++ b/swiftclient/authv1.py
@@ -45,6 +45,7 @@
 # Note that while we import keystoneauth1 here, we *don't* need to add it to
 # requirements.txt -- this entire module only makes sense (and should only be
 # loaded) if keystoneauth is already installed.
+from keystoneauth1 import discover
 from keystoneauth1 import plugin
 from keystoneauth1 import exceptions
 from keystoneauth1 import loading
@@ -110,11 +111,20 @@ def catalog(self):
         ]
 
     def url_for(self, **kwargs):
+        return self.endpoint_data_for(**kwargs).url
+
+    def endpoint_data_for(self, **kwargs):
         kwargs.setdefault('interface', 'public')
         kwargs.setdefault('service_type', None)
 
         if kwargs['service_type'] == 'object-store':
-            return self.storage_url
+            return discover.EndpointData(
+                service_type='object-store',
+                service_name='swift',
+                interface=kwargs['interface'],
+                region_name='default',
+                catalog_url=self.storage_url,
+            )
 
         # Although our "catalog" includes an identity entry, nothing that uses
         # url_for() (including `openstack endpoint list`) will know what to do
diff --git a/test-requirements.txt b/test-requirements.txt
index b3ca5f89..13732533 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -4,3 +4,4 @@ coverage!=4.4,>=4.0 # Apache-2.0
 keystoneauth1>=3.4.0  # Apache-2.0
 mock>=1.2.0 # BSD
 stestr>=2.0.0 # Apache-2.0
+openstacksdk>=0.11.0 # Apache-2.0
diff --git a/test/functional/__init__.py b/test/functional/__init__.py
index e69de29b..248875a6 100644
--- a/test/functional/__init__.py
+++ b/test/functional/__init__.py
@@ -0,0 +1,93 @@
+# Copyright (c) 2014 Christian Schwede <christian.schwede@enovance.com>
+#
+# 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 os
+from six.moves import configparser
+
+TEST_CONFIG = None
+
+
+def _load_config(force_reload=False):
+    global TEST_CONFIG
+    if not force_reload and TEST_CONFIG is not None:
+        return TEST_CONFIG
+
+    config_file = os.environ.get('SWIFT_TEST_CONFIG_FILE',
+                                 '/etc/swift/test.conf')
+    parser = configparser.ConfigParser({'auth_version': '1'})
+    parser.read(config_file)
+    conf = {}
+    if parser.has_section('func_test'):
+        if parser.has_option('func_test', 'auth_uri'):
+            conf['auth_url'] = parser.get('func_test', 'auth_uri')
+            try:
+                conf['auth_version'] = parser.get('func_test', 'auth_version')
+            except configparser.NoOptionError:
+                last_piece = conf['auth_url'].rstrip('/').rsplit('/', 1)[1]
+                if last_piece.endswith('.0'):
+                    last_piece = last_piece[:-2]
+                if last_piece in ('1', '2', '3'):
+                    conf['auth_version'] = last_piece
+                else:
+                    raise
+        else:
+            auth_host = parser.get('func_test', 'auth_host')
+            auth_port = parser.getint('func_test', 'auth_port')
+            auth_ssl = parser.getboolean('func_test', 'auth_ssl')
+            auth_prefix = parser.get('func_test', 'auth_prefix')
+            conf['auth_version'] = parser.get('func_test', 'auth_version')
+            if auth_ssl:
+                auth_url = "https://"
+            else:
+                auth_url = "http://"
+            auth_url += "%s:%s%s" % (auth_host, auth_port, auth_prefix)
+            if conf['auth_version'] == "1":
+                auth_url += 'v1.0'
+            conf['auth_url'] = auth_url
+
+        try:
+            conf['account_username'] = parser.get('func_test',
+                                                  'account_username')
+        except configparser.NoOptionError:
+            conf['account'] = parser.get('func_test', 'account')
+            conf['username'] = parser.get('func_test', 'username')
+            conf['account_username'] = "%s:%s" % (conf['account'],
+                                                  conf['username'])
+        else:
+            # Still try to get separate account/usernames for keystone tests
+            try:
+                conf['account'] = parser.get('func_test', 'account')
+                conf['username'] = parser.get('func_test', 'username')
+            except configparser.NoOptionError:
+                pass
+
+        conf['password'] = parser.get('func_test', 'password')
+
+        # For keystone v3
+        try:
+            conf['account4'] = parser.get('func_test', 'account4')
+            conf['username4'] = parser.get('func_test', 'username4')
+            conf['domain4'] = parser.get('func_test', 'domain4')
+            conf['password4'] = parser.get('func_test', 'password4')
+        except configparser.NoOptionError:
+            pass
+
+        TEST_CONFIG = conf
+
+
+try:
+    _load_config()
+except configparser.NoOptionError:
+    TEST_CONFIG = None  # sentinel used in test setup
diff --git a/test/functional/test_openstacksdk.py b/test/functional/test_openstacksdk.py
new file mode 100644
index 00000000..cee7f4e9
--- /dev/null
+++ b/test/functional/test_openstacksdk.py
@@ -0,0 +1,92 @@
+# Copyright (c) 2019 Tim Burke <tim@swiftstack.com>
+#
+# 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 unittest
+import uuid
+
+import openstack
+
+from . import TEST_CONFIG
+
+PREFIX = 'test-swiftclient-'
+
+
+class TestOpenStackSDK(unittest.TestCase):
+    @classmethod
+    def setUpClass(cls):
+        # NB: Only runs for v1 auth, to exercise our keystoneauth plugin
+        cls.skip_tests = (TEST_CONFIG is None or
+                          TEST_CONFIG['auth_version'] != '1')
+        if not cls.skip_tests:
+            cls.conn = openstack.connect(
+                auth_type='v1password',
+                auth_url=TEST_CONFIG['auth_url'],
+                username=TEST_CONFIG['account_username'],
+                password=TEST_CONFIG['password'],
+            )
+            cls.object_store = cls.conn.object_store
+
+    def setUp(self):
+        if self.skip_tests:
+            raise unittest.SkipTest('SKIPPING V1-AUTH TESTS')
+
+    def tearDown(self):
+        if self.skip_tests:
+            return
+        for c in self.object_store.containers():
+            if c.name.startswith(PREFIX):
+                for o in self.object_store.objects(c.name):
+                    self.object_store.delete_object(
+                        o.name, container=c.name)
+                self.object_store.delete_container(c.name)
+
+    def test_containers(self):
+        meta = self.object_store.get_account_metadata()
+        count_before = meta.account_container_count
+        containers = sorted(PREFIX + str(uuid.uuid4())
+                            for _ in range(10))
+        for c in containers:
+            self.object_store.create_container(c)
+        self.assertEqual([
+            c.name for c in self.object_store.containers()
+            if c.name.startswith(PREFIX)
+        ], containers)
+        meta = self.object_store.get_account_metadata()
+        self.assertEqual(count_before + len(containers),
+                         meta.account_container_count)
+
+    def test_objects(self):
+        container = PREFIX + str(uuid.uuid4())
+        self.object_store.create_container(container)
+        objects = sorted(str(uuid.uuid4()) for _ in range(10))
+        for o in objects:
+            self.object_store.create_object(container, o, data=b'x')
+        self.assertEqual([
+            o.name for o in self.object_store.objects(container)
+        ], objects)
+        meta = self.object_store.get_container_metadata(container)
+        self.assertEqual(len(objects), meta.object_count)
+
+    def test_object_metadata(self):
+        container = PREFIX + str(uuid.uuid4())
+        self.object_store.create_container(container)
+        obj = str(uuid.uuid4())
+        obj_meta = {str(uuid.uuid4()): str(uuid.uuid4()) for _ in range(10)}
+        # NB: as of 0.36.0, create_object() doesn't play well with passing
+        # both data and metadata, so we do a PUT then POST
+        self.object_store.create_object(container, obj, data=b'x')
+        self.object_store.set_object_metadata(obj, container, **obj_meta)
+        meta = self.object_store.get_object_metadata(obj, container)
+        self.assertEqual(obj_meta, meta.metadata)
diff --git a/test/functional/test_swiftclient.py b/test/functional/test_swiftclient.py
index 9a74c63f..54c514de 100644
--- a/test/functional/test_swiftclient.py
+++ b/test/functional/test_swiftclient.py
@@ -13,23 +13,23 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import os
 import unittest
 import time
 from io import BytesIO
 
 import six
-from six.moves import configparser
 
 import swiftclient
+from . import TEST_CONFIG
 
 
 class TestFunctional(unittest.TestCase):
 
     def __init__(self, *args, **kwargs):
         super(TestFunctional, self).__init__(*args, **kwargs)
-        self.skip_tests = False
-        self._get_config()
+        self.skip_tests = (TEST_CONFIG is None)
+        if not self.skip_tests:
+            self._get_config()
 
         self.test_data = b'42' * 10
         self.etag = '2704306ec982238d85d4b235c925d58e'
@@ -41,50 +41,10 @@ def __init__(self, *args, **kwargs):
         self.objectname_2 = self.objectname + '_second'
 
     def _get_config(self):
-        config_file = os.environ.get('SWIFT_TEST_CONFIG_FILE',
-                                     '/etc/swift/test.conf')
-        config = configparser.ConfigParser({'auth_version': '1'})
-        config.read(config_file)
-        self.config = config
-        if config.has_section('func_test'):
-            if config.has_option('func_test', 'auth_uri'):
-                self.auth_url = config.get('func_test', 'auth_uri')
-                try:
-                    self.auth_version = config.get('func_test', 'auth_version')
-                except configparser.NoOptionError:
-                    last_piece = self.auth_url.rstrip('/').rsplit('/', 1)[1]
-                    if last_piece.endswith('.0'):
-                        last_piece = last_piece[:-2]
-                    if last_piece in ('1', '2', '3'):
-                        self.auth_version = last_piece
-                    else:
-                        raise
-            else:
-                auth_host = config.get('func_test', 'auth_host')
-                auth_port = config.getint('func_test', 'auth_port')
-                auth_ssl = config.getboolean('func_test', 'auth_ssl')
-                auth_prefix = config.get('func_test', 'auth_prefix')
-                self.auth_version = config.get('func_test', 'auth_version')
-                self.auth_url = ""
-                if auth_ssl:
-                    self.auth_url += "https://"
-                else:
-                    self.auth_url += "http://"
-                self.auth_url += "%s:%s%s" % (
-                    auth_host, auth_port, auth_prefix)
-                if self.auth_version == "1":
-                    self.auth_url += 'v1.0'
-
-            try:
-                self.account_username = config.get('func_test',
-                                                   'account_username')
-            except configparser.NoOptionError:
-                account = config.get('func_test', 'account')
-                username = config.get('func_test', 'username')
-                self.account_username = "%s:%s" % (account, username)
-            self.password = config.get('func_test', 'password')
-        else:
-            self.skip_tests = True
+        self.auth_url = TEST_CONFIG['auth_url']
+        self.auth_version = TEST_CONFIG['auth_version']
+        self.account_username = TEST_CONFIG['account_username']
+        self.password = TEST_CONFIG['password']
 
     def _get_connection(self):
         """
@@ -514,20 +474,20 @@ class TestUsingKeystone(TestFunctional):
     """
 
     def _get_connection(self):
-        account = username = password = None
+        account = username = None
         if self.auth_version not in ('2', '3'):
             self.skipTest('SKIPPING KEYSTONE-SPECIFIC FUNCTIONAL TESTS')
         try:
-            account = self.config.get('func_test', 'account')
-            username = self.config.get('func_test', 'username')
-            password = self.config.get('func_test', 'password')
-        except Exception:
+            account = TEST_CONFIG['account']
+            username = TEST_CONFIG['username']
+        except KeyError:
             self.skipTest('SKIPPING KEYSTONE-SPECIFIC FUNCTIONAL TESTS' +
                           ' - NO CONFIG')
-        os_options = {'tenant_name': account}
+
         return swiftclient.Connection(
-            self.auth_url, username, password, auth_version=self.auth_version,
-            os_options=os_options)
+            self.auth_url, username, self.password,
+            auth_version=self.auth_version,
+            os_options={'tenant_name': account})
 
 
 class TestUsingKeystoneV3(TestFunctional):
@@ -539,13 +499,14 @@ def _get_connection(self):
         account = username = password = project_domain = user_domain = None
         if self.auth_version != '3':
             self.skipTest('SKIPPING KEYSTONE-V3-SPECIFIC FUNCTIONAL TESTS')
+
         try:
-            account = self.config.get('func_test', 'account4')
-            username = self.config.get('func_test', 'username4')
-            user_domain = self.config.get('func_test', 'domain4')
-            project_domain = self.config.get('func_test', 'domain4')
-            password = self.config.get('func_test', 'password4')
-        except Exception:
+            account = TEST_CONFIG['account4']
+            username = TEST_CONFIG['username4']
+            user_domain = TEST_CONFIG['domain4']
+            project_domain = TEST_CONFIG['domain4']
+            password = TEST_CONFIG['password4']
+        except KeyError:
             self.skipTest('SKIPPING KEYSTONE-V3-SPECIFIC FUNCTIONAL TESTS' +
                           ' - NO CONFIG')
 

From 709ab385c6eb3d3c7b313bc48c959e9ace606ae5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Blaisot?= <sebastien@blaisot.org>
Date: Fri, 15 Nov 2019 22:37:38 +0100
Subject: [PATCH 162/316] Fix printed object names on successful bulk-delete

Replace the 1 always concatenated to printed object names for each
successfully deleted object in bulk-delete with an optional [after x
attempts] if x > 1

Change-Id: If4af9141fe4f3436a4e9e0e2dfc24c6ec7292996
Closes-Bug: 1852808
---
 swiftclient/shell.py | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index cc4f325a..5e23bc46 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -169,7 +169,8 @@ def st_delete(parser, args, output_manager, return_parser=False):
             for r in del_iter:
                 c = r.get('container', '')
                 o = r.get('object', '')
-                a = r.get('attempts')
+                a = (' [after {0} attempts]'.format(r.get('attempts'))
+                     if r.get('attempts') > 1 else '')
 
                 if r['action'] == 'bulk_delete':
                     if r['success']:
@@ -202,9 +203,6 @@ def st_delete(parser, args, output_manager, return_parser=False):
                 else:
                     if r['success']:
                         if options['verbose']:
-                            a = (' [after {0} attempts]'.format(a)
-                                 if a > 1 else '')
-
                             if r['action'] == 'delete_object':
                                 if options['yes_all']:
                                     p = '{0}/{1}'.format(c, o)

From e83cd32e2af26ecb9ac9520ac2958f186ba1888c Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 15 Nov 2019 22:08:51 +0000
Subject: [PATCH 163/316] Add test for bulk-delete-attempt-counter fix

Change-Id: Ifdeefeb4a5a3fc6895bd6cda695684de02f8c602
Related-Change: If4af9141fe4f3436a4e9e0e2dfc24c6ec7292996
Related-Bug: #1852808
---
 swiftclient/shell.py    |  2 +-
 test/unit/test_shell.py | 22 +++++++++++++++++++++-
 2 files changed, 22 insertions(+), 2 deletions(-)

diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 5e23bc46..d18fc9e7 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -170,7 +170,7 @@ def st_delete(parser, args, output_manager, return_parser=False):
                 c = r.get('container', '')
                 o = r.get('object', '')
                 a = (' [after {0} attempts]'.format(r.get('attempts'))
-                     if r.get('attempts') > 1 else '')
+                     if r.get('attempts', 1) > 1 else '')
 
                 if r['action'] == 'bulk_delete':
                     if r['success']:
diff --git a/test/unit/test_shell.py b/test/unit/test_shell.py
index c9722815..1fa0db40 100644
--- a/test/unit/test_shell.py
+++ b/test/unit/test_shell.py
@@ -1420,12 +1420,32 @@ def test_delete_bulk_object(self, connection):
             b'{"Number Not Found": 0, "Response Status": "200 OK", '
             b'"Errors": [], "Number Deleted": 1, "Response Body": ""}')
         connection.return_value.attempts = 0
-        swiftclient.shell.main(argv)
+        with CaptureOutput() as out:
+            swiftclient.shell.main(argv)
+        connection.return_value.post_account.assert_called_with(
+            query_string='bulk-delete', data=b'/container/object\n',
+            headers={'Content-Type': 'text/plain',
+                     'Accept': 'application/json'},
+            response_dict={})
+        self.assertEqual('object\n', out.out)
+
+    @mock.patch.object(swiftclient.service.SwiftService,
+                       '_bulk_delete_page_size', lambda *a: 10)
+    @mock.patch('swiftclient.service.Connection')
+    def test_delete_bulk_object_with_retry(self, connection):
+        argv = ["", "delete", "container", "object"]
+        connection.return_value.post_account.return_value = {}, (
+            b'{"Number Not Found": 0, "Response Status": "200 OK", '
+            b'"Errors": [], "Number Deleted": 1, "Response Body": ""}')
+        connection.return_value.attempts = 3
+        with CaptureOutput() as out:
+            swiftclient.shell.main(argv)
         connection.return_value.post_account.assert_called_with(
             query_string='bulk-delete', data=b'/container/object\n',
             headers={'Content-Type': 'text/plain',
                      'Accept': 'application/json'},
             response_dict={})
+        self.assertEqual('object [after 3 attempts]\n', out.out)
 
     def test_delete_verbose_output(self):
         del_obj_res = {'success': True, 'response_dict': {}, 'attempts': 2,

From 1f26c5736949e1c3b57c024a315e33fc419f126e Mon Sep 17 00:00:00 2001
From: Alex Schultz <aschultz@redhat.com>
Date: Fri, 2 Aug 2019 08:20:56 -0600
Subject: [PATCH 164/316] Cleanup session on delete

If an external http connection was not passed into the client, we
create one with a requests.Session() on our own. Once this is used,
it may still have an open socket when the connection is closed. We need
to handle the closing of the requests.Session() ourselves if we created
one. If you do not close it, a ResourceWarning may be reported about the
socket that is left open.

Change-Id: I200ad0cdc8b7999c3f5521b9a822122bd18714bf
Closes-Bug: #1838775
---
 swiftclient/client.py | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index 4be2e2d6..448bb468 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -438,6 +438,15 @@ def __init__(self, url, proxy=None, cacert=None, insecure=False,
         if timeout:
             self.requests_args['timeout'] = timeout
 
+    def __del__(self):
+        """Cleanup resources other than memory"""
+        if self.request_session:
+            # The session we create must be closed to free up file descriptors
+            try:
+                self.request_session.close()
+            finally:
+                self.request_session = None
+
     def _request(self, *arg, **kwarg):
         """Final wrapper before requests call, to be patched in tests"""
         return self.request_session.request(*arg, **kwarg)

From 13970ac5fa2361a97fd2565bde9f08e23262d6fd Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Mon, 20 Jan 2020 21:20:12 -0800
Subject: [PATCH 165/316] packaging: Properly flag universal wheel

I'm not sure we've *ever* done this properly; see the PyPA docs:
https://packaging.python.org/guides/distributing-packages-using-setuptools/#universal-wheels

Change-Id: I8bb9e05f386076aa652b3955f0abf757d229afed
---
 setup.cfg | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/setup.cfg b/setup.cfg
index 5653bf30..bcb4d223 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -51,7 +51,7 @@ all_files = 1
 [upload_sphinx]
 upload-dir = doc/build/html
 
-[wheel]
+[bdist_wheel]
 universal = 1
 
 [pbr]

From 0bbc2cdbec2ffa6482c40fc45af22140f48d2670 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Wed, 22 Jan 2020 08:31:23 -0800
Subject: [PATCH 166/316] Make py38 job voting

Depends-On: https://review.opendev.org/#/c/693401/
Change-Id: Ifb4e466eda0c45b49c16e63b0c77023f65b039b8
---
 .zuul.yaml | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/.zuul.yaml b/.zuul.yaml
index 4f288d79..edf0d28e 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -47,11 +47,15 @@
         - swiftclient-swift-functional
         - swiftclient-functional
         - swiftclient-functional-py2
+        - openstack-tox-py38:
+            voting: true
     gate:
       jobs:
         - swiftclient-swift-functional
         - swiftclient-functional
         - swiftclient-functional-py2
+        - openstack-tox-py38:
+            voting: true
     post:
       jobs:
         - openstack-tox-cover

From 259b98f69dd0b9929ee9e04ccb37183d2666d227 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Wed, 12 Feb 2020 17:34:25 -0800
Subject: [PATCH 167/316] Authors/changelog for 3.9.0

Change-Id: I661503e0d6bb7934f7e7a28b094264a2ee73a419
---
 AUTHORS                                              |  3 +++
 ChangeLog                                            | 11 +++++++++++
 .../notes/3_9_0_release-3c293d277f14ec22.yaml        | 12 ++++++++++++
 3 files changed, 26 insertions(+)
 create mode 100644 releasenotes/notes/3_9_0_release-3c293d277f14ec22.yaml

diff --git a/AUTHORS b/AUTHORS
index da8e44bb..165e9d07 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -1,5 +1,6 @@
 Alessandro Pilotti (ap@pilotti.it)
 Alex Gaynor (alex.gaynor@gmail.com)
+Alex Schultz (aschultz@redhat.com)
 Alexandra Settle (alexandra.settle@rackspace.com)
 Alexis Lee (lxsli@hpe.com)
 Alistair Coles (alistairncoles@gmail.com)
@@ -70,6 +71,7 @@ Josh Gachnang (josh@pcsforeducation.com)
 Juan J. Martinez (juan@memset.com)
 Jude Job (judeopenstack@gmail.com)
 Julien Danjou (julien@danjou.info)
+kangyufei (kangyf@inspur.com)
 Kazufumi Noto (noto.kazufumi@gmail.com)
 Kota Tsuyuzaki (tsuyuzaki.kota@lab.ntt.co.jp)
 Kun Huang (gareth@unitedstack.com)
@@ -117,6 +119,7 @@ SaiKiran (saikiranveeravarapu@gmail.com)
 Sam Morrison (sorrison@gmail.com)
 Samuel Merritt (sam@swiftstack.com)
 Sean Dague (sean@dague.net)
+Sébastien Blaisot (sebastien@blaisot.org)
 Sergey Gotliv (sgotliv@redhat.com)
 Sergio Cazzolato (sergio.j.cazzolato@intel.com)
 Shane Wang (shane.wang@intel.com)
diff --git a/ChangeLog b/ChangeLog
index 501491bf..cecee2da 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,14 @@
+3.9.0
+-----
+
+* Now tested under Python 3.8.
+
+* Better clean up connections when using the low-level client.py API.
+
+* Fixed a display issue when `swift delete` made multiple attempts to bulk
+  delete objects.
+
+
 3.8.1
 -----
 
diff --git a/releasenotes/notes/3_9_0_release-3c293d277f14ec22.yaml b/releasenotes/notes/3_9_0_release-3c293d277f14ec22.yaml
new file mode 100644
index 00000000..6286b616
--- /dev/null
+++ b/releasenotes/notes/3_9_0_release-3c293d277f14ec22.yaml
@@ -0,0 +1,12 @@
+---
+features:
+  - |
+    Now tested under Python 3.8.
+
+fixes:
+  - |
+    Better clean up connections when using the low-level ``client.py`` API.
+
+  - |
+    Fixed a display issue when ``swift delete`` made multiple attempts to
+    bulk delete objects.

From 02e8f4f228c006927fe87f8a350c281b9cfccd98 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Tue, 7 Apr 2020 22:44:50 -0700
Subject: [PATCH 168/316] Blacklist stestr 3.0.0

It claims py2 support, but that's a lie.

Also, switch our tempest job to the py3 variant, now that glance (at
least) is py3-only and tempest-full is broken.

Change-Id: Ic30fe82ff72fe4d138ec4823d36f2a1cc56f1ac7
---
 .zuul.yaml            | 2 +-
 test-requirements.txt | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index edf0d28e..f0bd82c5 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -35,7 +35,7 @@
 - project:
     templates:
       - check-requirements
-      - lib-forward-testing
+      - lib-forward-testing-python3
       - openstack-lower-constraints-jobs
       - openstack-pypy-jobs-nonvoting
       - openstack-python-jobs
diff --git a/test-requirements.txt b/test-requirements.txt
index 13732533..5dba1a60 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -3,5 +3,5 @@ hacking>=1.1.0,<1.2.0 # Apache-2.0
 coverage!=4.4,>=4.0 # Apache-2.0
 keystoneauth1>=3.4.0  # Apache-2.0
 mock>=1.2.0 # BSD
-stestr>=2.0.0 # Apache-2.0
+stestr>=2.0.0,!=3.0.0 # Apache-2.0
 openstacksdk>=0.11.0 # Apache-2.0

From 78edffa46c591fdc53f253b343e1ea144e24089d Mon Sep 17 00:00:00 2001
From: Clay Gerrard <clay.gerrard@gmail.com>
Date: Tue, 29 Oct 2019 09:59:03 -0500
Subject: [PATCH 169/316] object versioning features

 * add --versions to list
 * add --versions to delete
 * add --version-id to stat
 * add --version-id to delete
 * add --version-id to download

Change-Id: I89802064921778fee7efe57c7d60c976cdde3a27
---
 swiftclient/client.py          |  24 ++-
 swiftclient/command_helpers.py |   6 +-
 swiftclient/service.py         | 122 +++++++++++++---
 swiftclient/shell.py           |  39 ++++-
 test/unit/test_service.py      | 259 ++++++++++++++++++++++++++++++---
 test/unit/test_shell.py        | 220 ++++++++++++++++++++++++++--
 6 files changed, 611 insertions(+), 59 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index 448bb468..449b6cd3 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -921,7 +921,7 @@ def post_account(url, token, headers, http_conn=None, response_dict=None,
 
 def get_container(url, token, container, marker=None, limit=None,
                   prefix=None, delimiter=None, end_marker=None,
-                  path=None, http_conn=None,
+                  version_marker=None, path=None, http_conn=None,
                   full_listing=False, service_token=None, headers=None,
                   query_string=None):
     """
@@ -935,6 +935,7 @@ def get_container(url, token, container, marker=None, limit=None,
     :param prefix: prefix query
     :param delimiter: string to delimit the queries on
     :param end_marker: marker query
+    :param version_marker: version marker query
     :param path: path query (equivalent: "delimiter=/" and "prefix=path/")
     :param http_conn: a tuple of (parsed url, HTTPConnection object),
                       (If None, it will create the conn object)
@@ -951,17 +952,20 @@ def get_container(url, token, container, marker=None, limit=None,
         http_conn = http_connection(url)
     if full_listing:
         rv = get_container(url, token, container, marker, limit, prefix,
-                           delimiter, end_marker, path, http_conn,
-                           service_token=service_token, headers=headers)
+                           delimiter, end_marker, version_marker, path=path,
+                           http_conn=http_conn, service_token=service_token,
+                           headers=headers)
         listing = rv[1]
         while listing:
             if not delimiter:
                 marker = listing[-1]['name']
             else:
                 marker = listing[-1].get('name', listing[-1].get('subdir'))
+            version_marker = listing[-1].get('version_id')
             listing = get_container(url, token, container, marker, limit,
-                                    prefix, delimiter, end_marker, path,
-                                    http_conn, service_token=service_token,
+                                    prefix, delimiter, end_marker,
+                                    version_marker, path, http_conn,
+                                    service_token=service_token,
                                     headers=headers)[1]
             if listing:
                 rv[1].extend(listing)
@@ -979,6 +983,8 @@ def get_container(url, token, container, marker=None, limit=None,
         qs += '&delimiter=%s' % quote(delimiter)
     if end_marker:
         qs += '&end_marker=%s' % quote(end_marker)
+    if version_marker:
+        qs += '&version_marker=%s' % quote(version_marker)
     if path:
         qs += '&path=%s' % quote(path)
     if query_string:
@@ -1816,15 +1822,17 @@ def head_container(self, container, headers=None):
         return self._retry(None, head_container, container, headers=headers)
 
     def get_container(self, container, marker=None, limit=None, prefix=None,
-                      delimiter=None, end_marker=None, path=None,
-                      full_listing=False, headers=None, query_string=None):
+                      delimiter=None, end_marker=None, version_marker=None,
+                      path=None, full_listing=False, headers=None,
+                      query_string=None):
         """Wrapper for :func:`get_container`"""
         # TODO(unknown): With full_listing=True this will restart the entire
         # listing with each retry. Need to make a better version that just
         # retries where it left off.
         return self._retry(None, get_container, container, marker=marker,
                            limit=limit, prefix=prefix, delimiter=delimiter,
-                           end_marker=end_marker, path=path,
+                           end_marker=end_marker,
+                           version_marker=version_marker, path=path,
                            full_listing=full_listing, headers=headers,
                            query_string=query_string)
 
diff --git a/swiftclient/command_helpers.py b/swiftclient/command_helpers.py
index 49ccad1d..f37040f8 100644
--- a/swiftclient/command_helpers.py
+++ b/swiftclient/command_helpers.py
@@ -143,7 +143,11 @@ def print_container_stats(items, headers, output_manager):
 def stat_object(conn, options, container, obj):
     req_headers = split_request_headers(options.get('header', []))
 
-    headers = conn.head_object(container, obj, headers=req_headers)
+    query_string = None
+    if options.get('version_id') is not None:
+        query_string = 'version-id=%s' % options['version_id']
+    headers = conn.head_object(container, obj, headers=req_headers,
+                               query_string=query_string)
     items = []
     if options['verbose'] > 1:
         path = '%s/%s/%s' % (conn.url, container, obj)
diff --git a/swiftclient/service.py b/swiftclient/service.py
index 5292dc5a..fb334fde 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -86,6 +86,9 @@ def __str__(self):
             value += " segment:%s" % self.segment
         return value
 
+    def __repr__(self):
+        return str(self)
+
 
 def process_options(options):
     # tolerate sloppy auth_version
@@ -186,6 +189,7 @@ def _build_default_global_options():
     'leave_segments': False,
     'changed': None,
     'skip_identical': False,
+    'version_id': None,
     'yes_all': False,
     'read_acl': None,
     'write_acl': None,
@@ -200,6 +204,7 @@ def _build_default_global_options():
     'meta': [],
     'prefix': None,
     'delimiter': None,
+    'versions': False,
     'fail_fast': False,
     'human': False,
     'dir_marker': False,
@@ -336,6 +341,20 @@ def __init__(self, object_name, options=None):
         self.options = options
 
 
+class SwiftDeleteObject(object):
+    """
+    Class for specifying an object delete, allowing the headers/metadata to be
+    specified separately for each individual object.
+    """
+    def __init__(self, object_name, options=None):
+        if not (isinstance(object_name, string_types) and object_name):
+            raise SwiftError(
+                "Object names must be specified as non-empty strings"
+            )
+        self.object_name = object_name
+        self.options = options
+
+
 class SwiftCopyObject(object):
     """
     Class for specifying an object copy,
@@ -489,6 +508,7 @@ def stat(self, container=None, objects=None, options=None):
 
                             {
                                 'human': False,
+                                'version_id': None,
                                 'header': []
                             }
 
@@ -871,6 +891,7 @@ def list(self, container=None, options=None):
                                 'long': False,
                                 'prefix': None,
                                 'delimiter': None,
+                                'versions': False,
                                 'header': []
                             }
 
@@ -967,13 +988,19 @@ def _list_account_job(conn, options, result_queue):
     @staticmethod
     def _list_container_job(conn, container, options, result_queue):
         marker = options.get('marker', '')
+        version_marker = options.get('version_marker', '')
         error = None
         req_headers = split_headers(options.get('header', []))
+        if options.get('versions', False):
+            query_string = 'versions=true'
+        else:
+            query_string = None
         try:
             while True:
                 _, items = conn.get_container(
-                    container, marker=marker, prefix=options['prefix'],
-                    delimiter=options['delimiter'], headers=req_headers
+                    container, marker=marker, version_marker=version_marker,
+                    prefix=options['prefix'], delimiter=options['delimiter'],
+                    headers=req_headers, query_string=query_string
                 )
 
                 if not items:
@@ -991,6 +1018,7 @@ def _list_container_job(conn, container, options, result_queue):
                 result_queue.put(res)
 
                 marker = items[-1].get('name', items[-1].get('subdir'))
+                version_marker = items[-1].get('version_id', '')
         except ClientException as err:
             traceback, err_time = report_traceback()
             logger.exception(err)
@@ -1016,6 +1044,7 @@ def _list_container_job(conn, container, options, result_queue):
             'prefix': options['prefix'],
             'success': False,
             'marker': marker,
+            'version_marker': version_marker,
             'error': error[0],
             'traceback': error[1],
             'error_timestamp': error[2]
@@ -1042,6 +1071,7 @@ def download(self, container=None, objects=None, options=None):
                                 'no_download': False,
                                 'header': [],
                                 'skip_identical': False,
+                                'version_id': None,
                                 'out_directory': None,
                                 'checksum': True,
                                 'out_file': None,
@@ -1151,6 +1181,9 @@ def _download_object_job(self, conn, container, obj, options):
             get_args = {'resp_chunk_size': DISK_BUFFER,
                         'headers': req_headers,
                         'response_dict': results_dict}
+            if options.get('version_id') is not None:
+                get_args['query_string'] = (
+                    'version-id=%s' % options['version_id'])
             if options['skip_identical']:
                 # Assume the file is a large object; if we're wrong, the query
                 # string is ignored and the If-None-Match header will trigger
@@ -2337,14 +2370,28 @@ def delete(self, container=None, objects=None, options=None):
         of objects.
 
         :param container: The container to delete or delete from.
-        :param objects: The list of objects to delete.
+        :param objects: A list of object names (strings) or SwiftDeleteObject
+                        instances containing an object name, and an
+                        options dict (can be None) to override the options for
+                        that individual delete operation::
+
+                            [
+                                'object_name',
+                                SwiftDeleteObject('object_name',
+                                                  options={...}),
+                                ...
+                            ]
+
+                        The options dict is described below.
         :param options: A dictionary containing options to override the global
                         options specified during the service object creation::
 
                             {
                                 'yes_all': False,
                                 'leave_segments': False,
+                                'version_id': None,
                                 'prefix': None,
+                                'versions': False,
                                 'header': [],
                             }
 
@@ -2364,23 +2411,28 @@ def delete(self, container=None, objects=None, options=None):
 
         if container is not None:
             if objects is not None:
+                delete_objects = self._make_delete_objects(objects)
                 if options['prefix']:
-                    objects = [obj for obj in objects
-                               if obj.startswith(options['prefix'])]
+                    delete_objects = [
+                        obj for obj in delete_objects
+                        if obj.object_name.startswith(options['prefix'])]
                 rq = Queue()
                 obj_dels = {}
 
-                bulk_page_size = self._bulk_delete_page_size(objects)
+                bulk_page_size = self._bulk_delete_page_size(delete_objects)
                 if bulk_page_size > 1:
-                    page_at_a_time = n_at_a_time(objects, bulk_page_size)
+                    page_at_a_time = n_at_a_time(delete_objects,
+                                                 bulk_page_size)
                     for page_slice in page_at_a_time:
                         for obj_slice in n_groups(
                                 page_slice,
                                 self._options['object_dd_threads']):
-                            self._bulk_delete(container, obj_slice, options,
+                            object_names = [
+                                obj.object_name for obj in obj_slice]
+                            self._bulk_delete(container, object_names, options,
                                               obj_dels)
                 else:
-                    self._per_item_delete(container, objects, options,
+                    self._per_item_delete(container, delete_objects, options,
                                           obj_dels, rq)
 
                 # Start a thread to watch for delete results
@@ -2445,6 +2497,11 @@ def _bulk_delete_page_size(self, objects):
             # Not many objects; may as well delete one-by-one
             return 1
 
+        if any(obj.options for obj in objects
+               if isinstance(obj, SwiftDeleteObject)):
+            # we can't do per option deletes for bulk
+            return 1
+
         try:
             cap_result = self.capabilities()
             if not cap_result['success']:
@@ -2463,9 +2520,11 @@ def _bulk_delete_page_size(self, objects):
             return 1
 
     def _per_item_delete(self, container, objects, options, rdict, rq):
-        for obj in objects:
+        for delete_obj in objects:
+            obj = delete_obj.object_name
+            obj_options = dict(options, **delete_obj.options or {})
             obj_del = self.thread_manager.object_dd_pool.submit(
-                self._delete_object, container, obj, options,
+                self._delete_object, container, obj, obj_options,
                 results_queue=rq
             )
             obj_details = {'container': container, 'object': obj}
@@ -2500,6 +2559,24 @@ def _delete_segment(conn, container, obj, results_queue=None):
             results_queue.put(res)
         return res
 
+    @staticmethod
+    def _make_delete_objects(objects):
+        delete_objects = []
+
+        for o in objects:
+            if isinstance(o, string_types):
+                obj = SwiftDeleteObject(o)
+                delete_objects.append(obj)
+            elif isinstance(o, SwiftDeleteObject):
+                delete_objects.append(o)
+            else:
+                raise SwiftError(
+                    "The delete operation takes only strings or "
+                    "SwiftDeleteObjects as input",
+                    obj=o)
+
+        return delete_objects
+
     def _delete_object(self, conn, container, obj, options,
                        results_queue=None):
         _headers = {}
@@ -2511,7 +2588,7 @@ def _delete_object(self, conn, container, obj, options,
         }
         try:
             old_manifest = None
-            query_string = None
+            query_params = {}
 
             if not options['leave_segments']:
                 try:
@@ -2520,11 +2597,15 @@ def _delete_object(self, conn, container, obj, options,
                                                query_string='symlink=get')
                     old_manifest = headers.get('x-object-manifest')
                     if config_true_value(headers.get('x-static-large-object')):
-                        query_string = 'multipart-manifest=delete'
+                        query_params['multipart-manifest'] = 'delete'
                 except ClientException as err:
                     if err.http_status != 404:
                         raise
 
+            if options.get('version_id') is not None:
+                query_params['version-id'] = options['version_id']
+            query_string = '&'.join('%s=%s' % (k, v) for (k, v)
+                                    in sorted(query_params.items()))
             results_dict = {}
             conn.delete_object(container, obj,
                                headers=_headers,
@@ -2611,12 +2692,17 @@ def _delete_container(self, container, options):
         try:
             for part in self.list(container=container, options=options):
                 if not part["success"]:
-
                     raise part["error"]
-
+                delete_objects = []
+                for item in part['listing']:
+                    delete_opts = {}
+                    if options.get('versions', False) and 'version_id' in item:
+                        delete_opts['version_id'] = item['version_id']
+                    delete_obj = SwiftDeleteObject(item['name'], delete_opts)
+                    delete_objects.append(delete_obj)
                 for res in self.delete(
                         container=container,
-                        objects=[o['name'] for o in part['listing']],
+                        objects=delete_objects,
                         options=options):
                     yield res
             if options['prefix']:
@@ -2679,7 +2765,9 @@ def _bulkdelete(conn, container, objects, options):
                         'No content received on account POST. '
                         'Is the bulk operations middleware enabled?')})
         except Exception as e:
-            res.update({'success': False, 'error': e})
+            traceback, err_time = report_traceback()
+            logger.exception(e)
+            res.update({'success': False, 'error': e, 'traceback': traceback})
 
         res.update({
             'action': 'bulk_delete',
diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index d18fc9e7..03a8fa64 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -65,7 +65,8 @@ def immediate_exit(signum, frame):
                     [--container-threads <threads>]
                     [--header <header:value>]
                     [--prefix <prefix>]
-                    [<container> [<object>] [...]]
+                    [--versions]
+                    [<container> [<object>] [--version-id <version_id>] [...]]
 '''
 
 st_delete_help = '''
@@ -78,6 +79,7 @@ def immediate_exit(signum, frame):
 
 Optional arguments:
   -a, --all             Delete all containers and objects.
+  --versions            Delete all versions
   --leave-segments      Do not delete segments of manifest objects.
   -H, --header <header:value>
                         Adds a custom request header to use for deleting
@@ -89,6 +91,8 @@ def immediate_exit(signum, frame):
                         Number of threads to use for deleting containers.
                         Default is 10.
   --prefix <prefix>     Only delete objects beginning with <prefix>.
+  --version-id <version-id>
+                        Delete specific version of a versioned object.
 '''.strip("\n")
 
 
@@ -96,9 +100,14 @@ def st_delete(parser, args, output_manager, return_parser=False):
     parser.add_argument(
         '-a', '--all', action='store_true', dest='yes_all',
         default=False, help='Delete all containers and objects.')
+    parser.add_argument('--versions', action='store_true',
+                        help='delete all versions')
     parser.add_argument(
         '-p', '--prefix', dest='prefix',
         help='Only delete items beginning with <prefix>.')
+    parser.add_argument(
+        '--version-id', action='store', default=None,
+        help='Delete a specific version of a versioned object')
     parser.add_argument(
         '-H', '--header', action='append', dest='header',
         default=[],
@@ -128,6 +137,10 @@ def st_delete(parser, args, output_manager, return_parser=False):
                              BASENAME, st_delete_options,
                              st_delete_help)
         return
+    if options['versions'] and len(args) >= 2:
+        exit('--versions option not allowed for object deletes')
+    if options['version_id'] and len(args) < 2:
+        exit('--version-id option only allowed for object deletes')
 
     if options['object_threads'] <= 0:
         output_manager.error(
@@ -227,6 +240,7 @@ def st_delete(parser, args, output_manager, return_parser=False):
                       [--object-threads <threads>] [--ignore-checksum]
                       [--container-threads <threads>] [--no-download]
                       [--skip-identical] [--remove-prefix]
+                      [--version-id <version_id>]
                       [--header <header:value>] [--no-shuffle]
                       [<container> [<object>] [...]]
 '''
@@ -271,6 +285,8 @@ def st_delete(parser, args, output_manager, return_parser=False):
                         Example: --header "content-type:text/plain"
   --skip-identical      Skip downloading files that are identical on both
                         sides.
+  --version-id <version-id>
+                        Download specific version of a versioned object.
   --ignore-checksum     Turn off checksum validation for downloads.
   --no-shuffle          By default, when downloading a complete account or
                         container, download order is randomised in order to
@@ -332,6 +348,9 @@ def st_download(parser, args, output_manager, return_parser=False):
         '--skip-identical', action='store_true', dest='skip_identical',
         default=False, help='Skip downloading files that are identical on '
         'both sides.')
+    parser.add_argument(
+        '--version-id', action='store', default=None,
+        help='Download a specific version of a versioned object')
     parser.add_argument(
         '--ignore-checksum', action='store_false', dest='checksum',
         default=True, help='Turn off checksum validation for downloads.')
@@ -372,6 +391,8 @@ def st_download(parser, args, output_manager, return_parser=False):
         output_manager.error('Usage: %s download %s\n%s', BASENAME,
                              st_download_options, st_download_help)
         return
+    if options['version_id'] and len(args) < 2:
+        exit('--version-id option only allowed for object downloads')
 
     if options['object_threads'] <= 0:
         output_manager.error(
@@ -479,7 +500,7 @@ def st_download(parser, args, output_manager, return_parser=False):
 
 st_list_options = '''[--long] [--lh] [--totals] [--prefix <prefix>]
                   [--delimiter <delimiter>] [--header <header:value>]
-                  [<container>]
+                  [--versions] [<container>]
 '''
 
 st_list_help = '''
@@ -499,6 +520,8 @@ def st_download(parser, args, output_manager, return_parser=False):
                         Roll up items with the given delimiter. For containers
                         only. See OpenStack Swift API documentation for what
                         this means.
+  -j, --json            Display listing information in json
+  --versions            Display listing information for all versions
   -H, --header <header:value>
                         Adds a custom request header to use for listing.
 '''.strip('\n')
@@ -579,6 +602,8 @@ def _print_stats(options, stats, human):
              'what this means.')
     parser.add_argument('-j', '--json', action='store_true',
                         help='print listing information in json')
+    parser.add_argument('--versions', action='store_true',
+                        help='display all versions')
     parser.add_argument(
         '-H', '--header', action='append', dest='header',
         default=[],
@@ -592,6 +617,8 @@ def _print_stats(options, stats, human):
     args = args[1:]
     if options['delimiter'] and not args:
         exit('-d option only allowed for container listings')
+    if options['versions'] and not args:
+        exit('--versions option only allowed for container listings')
 
     human = options.pop('human')
     if human:
@@ -642,6 +669,7 @@ def listing(stats_parts_gen=stats_parts_gen):
 
 
 st_stat_options = '''[--lh] [--header <header:value>]
+                  [--version-id <version_id>]
                   [<container> [<object>]]
 '''
 
@@ -655,6 +683,8 @@ def listing(stats_parts_gen=stats_parts_gen):
 Optional arguments:
   --lh                  Report sizes in human readable format similar to
                         ls -lh.
+  --version-id <version-id>
+                        Report stat of specific version of a versioned object.
   -H, --header <header:value>
                         Adds a custom request header to use for stat.
 '''.strip('\n')
@@ -664,6 +694,9 @@ def st_stat(parser, args, output_manager, return_parser=False):
     parser.add_argument(
         '--lh', dest='human', action='store_true', default=False,
         help='Report sizes in human readable format similar to ls -lh.')
+    parser.add_argument(
+        '--version-id', action='store', default=None,
+        help='Report stat of a specific version of a versioned object')
     parser.add_argument(
         '-H', '--header', action='append', dest='header',
         default=[],
@@ -675,6 +708,8 @@ def st_stat(parser, args, output_manager, return_parser=False):
 
     options, args = parse_args(parser, args)
     args = args[1:]
+    if options['version_id'] and len(args) < 2:
+        exit('--version-id option only allowed for object stats')
 
     with SwiftService(options=options) as swift:
         try:
diff --git a/test/unit/test_service.py b/test/unit/test_service.py
index ed3a2d6e..e86a4ff1 100644
--- a/test/unit/test_service.py
+++ b/test/unit/test_service.py
@@ -21,6 +21,7 @@
 import tempfile
 import unittest
 import time
+import json
 
 from concurrent.futures import Future
 from hashlib import md5
@@ -33,7 +34,7 @@
 import swiftclient.utils as utils
 from swiftclient.client import Connection, ClientException
 from swiftclient.service import (
-    SwiftService, SwiftError, SwiftUploadObject
+    SwiftService, SwiftError, SwiftUploadObject, SwiftDeleteObject
 )
 
 from test.unit import utils as test_utils
@@ -315,11 +316,39 @@ def test_delete_object(self):
         mock_conn.head_object.assert_called_once_with(
             'test_c', 'test_o', query_string='symlink=get', headers={})
         mock_conn.delete_object.assert_called_once_with(
-            'test_c', 'test_o', query_string=None, response_dict={},
+            'test_c', 'test_o', query_string='', response_dict={},
             headers={}
         )
         self.assertEqual(expected_r, r)
 
+    @mock.patch('swiftclient.service.Connection')
+    def test_delete_object_version(self, mock_connection_class):
+        mock_conn = mock_connection_class.return_value
+        mock_conn.url = 'http://saio/v1/AUTH_test'
+        mock_conn.attempts = 0
+        mock_conn.head_object.return_value = {}
+        mock_conn.delete_object.return_value = {}
+        expected = {
+            'action': 'delete_object',
+            'attempts': 0,
+            'container': 'c',
+            'object': 'o',
+            'response_dict': {},
+            'success': True}
+        with SwiftService() as swift:
+            delete_results = swift.delete(
+                container='c', objects='o', options={
+                    'version_id': '234567.8'})
+            for delete_result in delete_results:
+                self.assertEqual(delete_result, expected)
+        self.assertEqual(mock_conn.mock_calls, [
+            mock.call.head_object('c', 'o', headers={},
+                                  query_string='symlink=get'),
+            mock.call.delete_object('c', 'o', headers={},
+                                    query_string='version-id=234567.8',
+                                    response_dict={}),
+        ])
+
     def test_delete_object_with_headers(self):
         mock_q = Queue()
         mock_conn = self._get_mock_connection()
@@ -338,7 +367,7 @@ def test_delete_object_with_headers(self):
             'test_c', 'test_o', headers={'Skip-Middleware': 'Test'},
             query_string='symlink=get')
         mock_conn.delete_object.assert_called_once_with(
-            'test_c', 'test_o', query_string=None, response_dict={},
+            'test_c', 'test_o', query_string='', response_dict={},
             headers={'Skip-Middleware': 'Test'}
         )
         self.assertEqual(expected_r, r)
@@ -366,7 +395,7 @@ def test_delete_object_exception(self):
         mock_conn.head_object.assert_called_once_with(
             'test_c', 'test_o', query_string='symlink=get', headers={})
         mock_conn.delete_object.assert_called_once_with(
-            'test_c', 'test_o', query_string=None, response_dict={},
+            'test_c', 'test_o', query_string='', response_dict={},
             headers={}
         )
         self.assertEqual(expected_r, r)
@@ -431,7 +460,7 @@ def get_mock_list_conn(options):
 
         self.assertEqual(expected_r, r)
         expected = [
-            mock.call('test_c', 'test_o', query_string=None, response_dict={},
+            mock.call('test_c', 'test_o', query_string='', response_dict={},
                       headers={}),
             mock.call('manifest_c', 'test_seg_1', response_dict={}),
             mock.call('manifest_c', 'test_seg_2', response_dict={})]
@@ -529,6 +558,63 @@ def test_bulk_delete_page_size(self):
         if errors:
             self.fail('_bulk_delete_page_size() failed\n' + '\n'.join(errors))
 
+    @mock.patch('swiftclient.service.Connection')
+    def test_bulk_delete(self, mock_connection_class):
+        mock_conn = mock_connection_class.return_value
+        mock_conn.attempts = 0
+        mock_conn.get_capabilities.return_value = {
+            'bulk_delete': {}}
+        stub_headers = {}
+        stub_resp = []
+        mock_conn.post_account.return_value = (
+            stub_headers, json.dumps(stub_resp).encode('utf8'))
+        obj_list = ['x%02d' % i for i in range(100)]
+        expected = [{
+            'action': u'bulk_delete',
+            'attempts': 0,
+            'container': 'c',
+            'objects': list(objs),
+            'response_dict': {},
+            'result': [],
+            'success': True,
+        } for objs in zip(*[iter(obj_list)] * 10)]
+        found_result = []
+        with SwiftService(options={'object_dd_threads': 10}) as swift:
+            delete_results = swift.delete(container='c', objects=obj_list)
+            for delete_result in delete_results:
+                found_result.append(delete_result)
+        self.assertEqual(sorted(found_result, key=lambda r: r['objects'][0]),
+                         expected)
+
+    @mock.patch('swiftclient.service.Connection')
+    def test_bulk_delete_versions(self, mock_connection_class):
+        mock_conn = mock_connection_class.return_value
+        mock_conn.attempts = 0
+        mock_conn.get_capabilities.return_value = {
+            'bulk_delete': {}}
+        mock_conn.head_object.return_value = {}
+        stub_headers = {}
+        stub_resp = []
+        mock_conn.post_account.return_value = (
+            stub_headers, json.dumps(stub_resp))
+        obj_list = [SwiftDeleteObject('x%02d' % i, options={'version_id': i})
+                    for i in range(100)]
+        expected = [{
+            'action': u'delete_object',
+            'attempts': 0,
+            'container': 'c',
+            'object': obj.object_name,
+            'response_dict': {},
+            'success': True,
+        } for obj in obj_list]
+        found_result = []
+        with SwiftService(options={'object_dd_threads': 10}) as swift:
+            delete_results = swift.delete(container='c', objects=obj_list)
+            for delete_result in delete_results:
+                found_result.append(delete_result)
+        self.assertEqual(sorted(found_result, key=lambda r: r['object']),
+                         expected)
+
 
 class TestSwiftError(unittest.TestCase):
 
@@ -938,9 +1024,11 @@ def test_list_container_with_headers(self):
         self.assertIsNone(self._get_queue(mock_q))
         self.assertEqual(mock_conn.get_container.mock_calls, [
             mock.call('test_c', headers={'Skip-Middleware': 'Test'},
-                      delimiter='', marker='', prefix=None),
+                      delimiter='', marker='', prefix=None,
+                      query_string=None, version_marker=''),
             mock.call('test_c', headers={'Skip-Middleware': 'Test'},
-                      delimiter='', marker='test_o', prefix=None)])
+                      delimiter='', marker='test_o', prefix=None,
+                      query_string=None, version_marker='')])
 
     def test_list_container_exception(self):
         mock_q = Queue()
@@ -952,6 +1040,7 @@ def test_list_container_exception(self):
             'success': False,
             'error': self.exc,
             'marker': '',
+            'version_marker': '',
             'error_timestamp': mock.ANY,
             'traceback': mock.ANY
         })
@@ -961,11 +1050,61 @@ def test_list_container_exception(self):
         )
 
         mock_conn.get_container.assert_called_once_with(
-            'test_c', marker='', delimiter='', prefix=None, headers={}
+            'test_c', marker='', delimiter='', prefix=None, headers={},
+            query_string=None, version_marker='',
         )
         self.assertEqual(expected_r, self._get_queue(mock_q))
         self.assertIsNone(self._get_queue(mock_q))
 
+    @mock.patch('swiftclient.service.Connection')
+    def test_list_container_versions(self, mock_connection_class):
+        mock_conn = mock_connection_class.return_value
+        mock_conn.url = 'http://saio/v1/AUTH_test'
+        resp_headers = {}
+        items = [{
+            "bytes": 9,
+            "content_type": "application/octet-stream",
+            "hash": "e55cedc11adb39c404b7365f7d6291fa",
+            "is_latest": True,
+            "last_modified": "2019-11-08T05:00:15.115360",
+            "name": "test",
+            "version_id": "1573189215.11536"
+        }, {
+            "bytes": 8,
+            "content_type": "application/octet-stream",
+            "hash": "70c1db56f301c9e337b0099bd4174b28",
+            "is_latest": False,
+            "last_modified": "2019-11-08T05:00:14.730240",
+            "name": "test",
+            "version_id": "1573184903.06720"
+        }]
+        mock_conn.get_container.side_effect = [
+            (resp_headers, items),
+            (resp_headers, []),
+        ]
+        expected = {
+            'action': 'list_container_part',
+            'container': 'c',
+            'listing': items,
+            'marker': '',
+            'prefix': None,
+            'success': True,
+        }
+        with SwiftService() as swift:
+            list_result_gen = swift.list(container='c', options={
+                'versions': True})
+            self.maxDiff = None
+            for result in list_result_gen:
+                self.assertEqual(result, expected)
+        self.assertEqual(mock_conn.get_container.mock_calls, [
+            mock.call('c', delimiter=None, headers={}, marker='',
+                      prefix=None, query_string='versions=true',
+                      version_marker=''),
+            mock.call('c', delimiter=None, headers={}, marker='test',
+                      prefix=None, query_string='versions=true',
+                      version_marker='1573184903.06720'),
+        ])
+
     @mock.patch('swiftclient.service.get_conn')
     def test_list_queue_size(self, mock_get_conn):
         mock_conn = self._get_mock_connection()
@@ -1042,6 +1181,67 @@ def test_list_queue_size(self, mock_get_conn):
         self.assertEqual(observed_listing, expected_listing)
 
 
+class TestServiceStat(_TestServiceBase):
+
+    maxDiff = None
+
+    @mock.patch('swiftclient.service.Connection')
+    def test_stat_object(self, mock_connection_class):
+        mock_conn = mock_connection_class.return_value
+        mock_conn.url = 'http://saio/v1/AUTH_test'
+        mock_conn.head_object.return_value = {}
+        expected = {
+            'action': 'stat_object',
+            'container': 'c',
+            'object': 'o',
+            'headers': {},
+            'items': [('Account', 'AUTH_test'),
+                      ('Container', 'c'),
+                      ('Object', 'o'),
+                      ('Content Type', None),
+                      ('Content Length', '0'),
+                      ('Last Modified', None),
+                      ('ETag', None),
+                      ('Manifest', None)],
+            'success': True}
+        with SwiftService() as swift:
+            stat_results = swift.stat(container='c', objects='o')
+            for stat_result in stat_results:
+                self.assertEqual(stat_result, expected)
+        self.assertEqual(mock_conn.head_object.mock_calls, [
+            mock.call('c', 'o', headers={}, query_string=None),
+        ])
+
+    @mock.patch('swiftclient.service.Connection')
+    def test_stat_versioned_object(self, mock_connection_class):
+        mock_conn = mock_connection_class.return_value
+        mock_conn.url = 'http://saio/v1/AUTH_test'
+        mock_conn.head_object.return_value = {}
+        expected = {
+            'action': 'stat_object',
+            'container': 'c',
+            'object': 'o',
+            'headers': {},
+            'items': [('Account', 'AUTH_test'),
+                      ('Container', 'c'),
+                      ('Object', 'o'),
+                      ('Content Type', None),
+                      ('Content Length', '0'),
+                      ('Last Modified', None),
+                      ('ETag', None),
+                      ('Manifest', None)],
+            'success': True}
+        with SwiftService() as swift:
+            stat_results = swift.stat(container='c', objects='o', options={
+                'version_id': '234567.8'})
+            for stat_result in stat_results:
+                self.assertEqual(stat_result, expected)
+        self.assertEqual(mock_conn.head_object.mock_calls, [
+            mock.call('c', 'o', headers={},
+                      query_string='version-id=234567.8'),
+        ])
+
+
 class TestService(unittest.TestCase):
 
     def test_upload_with_bad_segment_size(self):
@@ -1791,13 +1991,14 @@ def test_upload_object_job_identical_dlo(self):
             mock_conn.head_object.assert_called_with('test_c', 'test_o')
             expected = [
                 mock.call('test_c_segments', prefix='test_o/prefix',
-                          marker='', delimiter=None, headers={}),
+                          marker='', delimiter=None, headers={},
+                          query_string=None, version_marker=''),
                 mock.call('test_c_segments', prefix='test_o/prefix',
                           marker="test_o/prefix/01", delimiter=None,
-                          headers={}),
+                          headers={}, query_string=None, version_marker=''),
                 mock.call('test_c_segments', prefix='test_o/prefix',
                           marker="test_o/prefix/02", delimiter=None,
-                          headers={}),
+                          headers={}, query_string=None, version_marker=''),
             ]
             mock_conn.get_container.assert_has_calls(expected)
 
@@ -2332,6 +2533,29 @@ def test_download(self):
         self.assertEqual(resp['object'], 'test')
         self.assertEqual(resp['path'], 'test')
 
+    def test_download_version_id(self):
+        self.opts['version_id'] = '23456.7'
+        with mock.patch('swiftclient.service.Connection') as mock_conn:
+            header = {'content-length': self.obj_len,
+                      'etag': self.obj_etag}
+            mock_conn.get_object.return_value = header, self._readbody()
+
+            resp = SwiftService()._download_object_job(mock_conn,
+                                                       'c',
+                                                       'test',
+                                                       self.opts)
+
+        self.assertIsNone(resp.get('error'))
+        self.assertIs(True, resp['success'])
+        self.assertEqual(resp['action'], 'download_object')
+        self.assertEqual(resp['object'], 'test')
+        self.assertEqual(resp['path'], 'test')
+        self.assertEqual(mock_conn.get_object.mock_calls, [
+            mock.call(
+                'c', 'test', headers={}, query_string='version-id=23456.7',
+                resp_chunk_size=65536, response_dict={}),
+        ])
+
     @mock.patch('swiftclient.service.interruptable_as_completed')
     @mock.patch('swiftclient.service.SwiftService._download_container')
     @mock.patch('swiftclient.service.SwiftService._download_object_job')
@@ -2545,17 +2769,17 @@ def test_download_object_job_skip_identical_dlo(self):
                           delimiter=None,
                           prefix='test_o/prefix',
                           marker='',
-                          headers={}),
+                          headers={}, query_string=None, version_marker=''),
                 mock.call('test_c_segments',
                           delimiter=None,
                           prefix='test_o/prefix',
                           marker='test_o/prefix/2',
-                          headers={}),
+                          headers={}, query_string=None, version_marker=''),
                 mock.call('test_c_segments',
                           delimiter=None,
                           prefix='test_o/prefix',
                           marker='test_o/prefix/3',
-                          headers={})])
+                          headers={}, query_string=None, version_marker='')])
 
     def test_download_object_job_skip_identical_nested_slo(self):
         with tempfile.NamedTemporaryFile() as f:
@@ -2682,6 +2906,7 @@ def test_download_object_job_skip_identical_diff_dlo(self):
                         obj='test_o',
                         options=options)
 
+            self.maxDiff = None
             self.assertEqual(r, expected_r)
 
             self.assertEqual(mock_conn.get_container.mock_calls, [
@@ -2689,17 +2914,17 @@ def test_download_object_job_skip_identical_diff_dlo(self):
                           delimiter=None,
                           prefix='test_o/prefix',
                           marker='',
-                          headers={}),
+                          headers={}, query_string=None, version_marker=''),
                 mock.call('test_c_segments',
                           delimiter=None,
                           prefix='test_o/prefix',
                           marker='test_o/prefix/2',
-                          headers={}),
+                          headers={}, query_string=None, version_marker=''),
                 mock.call('test_c_segments',
                           delimiter=None,
                           prefix='test_o/prefix',
                           marker='test_o/prefix/3',
-                          headers={})])
+                          headers={}, query_string=None, version_marker='')])
             self.assertEqual(mock_conn.get_object.mock_calls, [
                 mock.call('test_c',
                           'test_o',
diff --git a/test/unit/test_shell.py b/test/unit/test_shell.py
index 1fa0db40..b94cdcff 100644
--- a/test/unit/test_shell.py
+++ b/test/unit/test_shell.py
@@ -241,6 +241,30 @@ def test_stat_container_with_headers(self, connection):
         self.assertEqual(connection.return_value.head_container.mock_calls, [
             mock.call('container', headers={'Skip-Middleware': 'Test'})])
 
+    @mock.patch('swiftclient.service.Connection')
+    def test_stat_version_id(self, connection):
+        argv = ["", "stat", "--version-id", "1"]
+        with self.assertRaises(SystemExit) as caught:
+            swiftclient.shell.main(argv)
+        self.assertEqual(str(caught.exception),
+                         "--version-id option only allowed for "
+                         "object stats")
+
+        argv = ["", "stat", "--version-id", "1", "container"]
+        with self.assertRaises(SystemExit) as caught:
+            swiftclient.shell.main(argv)
+        self.assertEqual(str(caught.exception),
+                         "--version-id option only allowed for "
+                         "object stats")
+
+        argv = ["", "stat", "--version-id", "1", "container", "object"]
+        connection.return_value.head_object.return_value = {}
+        with CaptureOutput():
+            swiftclient.shell.main(argv)
+        self.assertEqual([mock.call('container', 'object', headers={},
+                                    query_string='version-id=1')],
+                         connection.return_value.head_object.mock_calls)
+
     @mock.patch('swiftclient.service.Connection')
     def test_stat_object(self, connection):
         return_headers = {
@@ -295,7 +319,45 @@ def test_stat_object_with_headers(self, connection):
                              '      Manifest: manifest\n')
         self.assertEqual(connection.return_value.head_object.mock_calls, [
             mock.call('container', 'object',
-                      headers={'Skip-Middleware': 'Test'})])
+                      headers={'Skip-Middleware': 'Test'},
+                      query_string=None)])
+
+    def test_list_account_with_delimiter(self):
+        argv = ["", "list", "--delimiter", "foo"]
+        with self.assertRaises(SystemExit) as caught:
+            swiftclient.shell.main(argv)
+        self.assertEqual(str(caught.exception),
+                         "-d option only allowed for "
+                         "container listings")
+
+    @mock.patch('swiftclient.service.Connection')
+    def test_list_container_with_versions(self, connection):
+        connection.return_value.get_container.side_effect = [
+            [None, [
+                {'name': 'foo', 'version_id': '2'},
+                {'name': 'foo', 'version_id': '1'},
+            ]],
+            [None, []],
+        ]
+        argv = ["", "list", "container", "--versions"]
+        with CaptureOutput(suppress_systemexit=True) as output:
+            swiftclient.shell.main(argv)
+        calls = [mock.call('container', delimiter=None, headers={}, marker='',
+                           prefix=None, query_string='versions=true',
+                           version_marker=''),
+                 mock.call('container', delimiter=None, headers={},
+                           marker='foo', prefix=None,
+                           query_string='versions=true', version_marker='1')]
+        connection.return_value.get_container.assert_has_calls(calls)
+        self.assertEqual(output.out, 'foo\nfoo\n')
+
+    def test_list_account_with_versions(self):
+        argv = ["", "list", "--versions"]
+        with self.assertRaises(SystemExit) as caught:
+            swiftclient.shell.main(argv)
+        self.assertEqual(str(caught.exception),
+                         "--versions option only allowed for "
+                         "container listings")
 
     @mock.patch('swiftclient.service.Connection')
     def test_list_json(self, connection):
@@ -431,9 +493,11 @@ def test_list_container(self, connection):
             swiftclient.shell.main(argv)
             calls = [
                 mock.call('container', marker='',
-                          delimiter=None, prefix=None, headers={}),
+                          delimiter=None, prefix=None, headers={},
+                          query_string=None, version_marker=''),
                 mock.call('container', marker='object_a',
-                          delimiter=None, prefix=None, headers={})]
+                          delimiter=None, prefix=None, headers={},
+                          query_string=None, version_marker='')]
             connection.return_value.get_container.assert_has_calls(calls)
 
             self.assertEqual(output.out, 'object_a\n')
@@ -450,9 +514,11 @@ def test_list_container(self, connection):
             swiftclient.shell.main(argv)
             calls = [
                 mock.call('container', marker='',
-                          delimiter=None, prefix=None, headers={}),
+                          delimiter=None, prefix=None, headers={},
+                          query_string=None, version_marker=''),
                 mock.call('container', marker='object_a',
-                          delimiter=None, prefix=None, headers={})]
+                          delimiter=None, prefix=None, headers={},
+                          query_string=None, version_marker='')]
             connection.return_value.get_container.assert_has_calls(calls)
 
             self.assertEqual(output.out,
@@ -472,14 +538,44 @@ def test_list_container_with_headers(self, connection):
             calls = [
                 mock.call('container', marker='',
                           delimiter=None, prefix=None,
-                          headers={'Skip-Middleware': 'Test'}),
+                          headers={'Skip-Middleware': 'Test'},
+                          query_string=None, version_marker=''),
                 mock.call('container', marker='object_a',
                           delimiter=None, prefix=None,
-                          headers={'Skip-Middleware': 'Test'})]
+                          headers={'Skip-Middleware': 'Test'},
+                          query_string=None, version_marker='')]
             connection.return_value.get_container.assert_has_calls(calls)
 
             self.assertEqual(output.out, 'object_a\n')
 
+    @mock.patch('swiftclient.service.Connection')
+    def test_download_version_id(self, connection):
+        argv = ["", "download", "--yes-all", "--version-id", "5"]
+        with self.assertRaises(SystemExit) as caught:
+            swiftclient.shell.main(argv)
+        self.assertEqual(str(caught.exception),
+                         "--version-id option only allowed for "
+                         "object downloads")
+
+        argv = ["", "download", "--version-id", "2", "container"]
+        with self.assertRaises(SystemExit) as caught:
+            swiftclient.shell.main(argv)
+        self.assertEqual(str(caught.exception),
+                         "--version-id option only allowed for "
+                         "object downloads")
+
+        argv = ["", "download", "--version-id", "1", "container", "object"]
+        connection.return_value.head_object.return_value = {}
+        connection.return_value.get_object.return_value = {}, ''
+        connection.return_value.attempts = 0
+        with CaptureOutput():
+            swiftclient.shell.main(argv)
+        self.assertEqual([mock.call('container', 'object', headers={},
+                                    query_string='version-id=1',
+                                    resp_chunk_size=65536,
+                                    response_dict={})],
+                         connection.return_value.get_object.mock_calls)
+
     @mock.patch('swiftclient.service.makedirs')
     @mock.patch('swiftclient.service.Connection')
     def test_download(self, connection, makedirs):
@@ -1085,6 +1181,33 @@ def check_good(argv):
         check_good(["--object-threads", "1"])
         check_good(["--container-threads", "1"])
 
+    @mock.patch('swiftclient.service.Connection')
+    def test_delete_version_id(self, connection):
+        argv = ["", "delete", "--yes-all", "--version-id", "3"]
+        with self.assertRaises(SystemExit) as caught:
+            swiftclient.shell.main(argv)
+        self.assertEqual(str(caught.exception),
+                         "--version-id option only allowed for "
+                         "object deletes")
+
+        argv = ["", "delete", "--version-id", "1", "container"]
+        with self.assertRaises(SystemExit) as caught:
+            swiftclient.shell.main(argv)
+        self.assertEqual(str(caught.exception),
+                         "--version-id option only allowed for "
+                         "object deletes")
+
+        argv = ["", "delete", "--version-id", "1", "container", "object"]
+        connection.return_value.head_object.return_value = {}
+        connection.return_value.delete_object.return_value = None
+        connection.return_value.attempts = 0
+        with CaptureOutput():
+            swiftclient.shell.main(argv)
+        self.assertEqual([mock.call('container', 'object', headers={},
+                                    query_string='version-id=1',
+                                    response_dict={})],
+                         connection.return_value.delete_object.mock_calls)
+
     @mock.patch.object(swiftclient.service.SwiftService,
                        '_bulk_delete_page_size', lambda *a: 1)
     @mock.patch('swiftclient.service.Connection')
@@ -1094,10 +1217,12 @@ def test_delete_account(self, connection):
             [None, [{'name': 'empty_container'}]],
             [None, []],
         ]
+        # N.B: missing --versions flag, version-id gets ignored
+        # only latest object is deleted
         connection.return_value.get_container.side_effect = [
             [None, [{'name': 'object'}, {'name': 'obj\xe9ct2'}]],
             [None, []],
-            [None, [{'name': 'object'}]],
+            [None, [{'name': 'object', 'version_id': 1}]],
             [None, []],
             [None, []],
         ]
@@ -1107,11 +1232,48 @@ def test_delete_account(self, connection):
         connection.return_value.delete_object.return_value = None
         swiftclient.shell.main(argv)
         connection.return_value.delete_object.assert_has_calls([
-            mock.call('container', 'object', query_string=None,
+            mock.call('container', 'object', query_string='',
                       response_dict={}, headers={}),
-            mock.call('container', 'obj\xe9ct2', query_string=None,
+            mock.call('container', 'obj\xe9ct2', query_string='',
                       response_dict={}, headers={}),
-            mock.call('container2', 'object', query_string=None,
+            mock.call('container2', 'object', query_string='',
+                      response_dict={}, headers={})], any_order=True)
+        self.assertEqual(3, connection.return_value.delete_object.call_count,
+                         'Expected 3 calls but found\n%r'
+                         % connection.return_value.delete_object.mock_calls)
+        self.assertEqual(
+            connection.return_value.delete_container.mock_calls, [
+                mock.call('container', response_dict={}, headers={}),
+                mock.call('container2', response_dict={}, headers={}),
+                mock.call('empty_container', response_dict={}, headers={})])
+
+    @mock.patch.object(swiftclient.service.SwiftService,
+                       '_bulk_delete_page_size', lambda *a: 1)
+    @mock.patch('swiftclient.service.Connection')
+    def test_delete_account_versions(self, connection):
+        connection.return_value.get_account.side_effect = [
+            [None, [{'name': 'container'}, {'name': 'container2'}]],
+            [None, [{'name': 'empty_container'}]],
+            [None, []],
+        ]
+        connection.return_value.get_container.side_effect = [
+            [None, [{'name': 'object'}, {'name': 'obj\xe9ct2'}]],
+            [None, []],
+            [None, [{'name': 'obj', 'version_id': 1}]],
+            [None, []],
+            [None, []],
+        ]
+        connection.return_value.attempts = 0
+        argv = ["", "delete", "--all", "--versions"]
+        connection.return_value.head_object.return_value = {}
+        connection.return_value.delete_object.return_value = None
+        swiftclient.shell.main(argv)
+        connection.return_value.delete_object.assert_has_calls([
+            mock.call('container', 'object', query_string='',
+                      response_dict={}, headers={}),
+            mock.call('container', 'obj\xe9ct2', query_string='',
+                      response_dict={}, headers={}),
+            mock.call('container2', 'obj', query_string='version-id=1',
                       response_dict={}, headers={})], any_order=True)
         self.assertEqual(3, connection.return_value.delete_object.call_count,
                          'Expected 3 calls but found\n%r'
@@ -1323,9 +1485,39 @@ def test_delete_container(self, connection):
         connection.return_value.delete_container.assert_called_with(
             'container', response_dict={}, headers={})
         connection.return_value.delete_object.assert_called_with(
-            'container', 'object', query_string=None, response_dict={},
+            'container', 'object', query_string='', response_dict={},
             headers={})
 
+    @mock.patch.object(swiftclient.service.SwiftService,
+                       '_bulk_delete_page_size', lambda *a: 1)
+    @mock.patch('swiftclient.service.Connection')
+    def test_delete_container_versions(self, connection):
+        argv = ["", "delete", "--versions", "container", "obj"]
+        with self.assertRaises(SystemExit) as caught:
+            swiftclient.shell.main(argv)
+        self.assertEqual(str(caught.exception),
+                         "--versions option not allowed for object deletes")
+
+        connection.return_value.get_container.side_effect = [
+            [None, [{'name': 'object', 'version_id': 2},
+                    {'name': 'object', 'version_id': 1}]],
+            [None, []],
+        ]
+        connection.return_value.attempts = 0
+        argv = ["", "delete", "--versions", "container"]
+        connection.return_value.head_object.return_value = {}
+        swiftclient.shell.main(argv)
+        connection.return_value.delete_container.assert_called_with(
+            'container', response_dict={}, headers={})
+        expected_calls = [
+            mock.call('container', 'object', query_string='version-id=2',
+                      response_dict={}, headers={}),
+            mock.call('container', 'object', query_string='version-id=1',
+                      response_dict={}, headers={})]
+
+        self.assertEqual(connection.return_value.delete_object.mock_calls,
+                         expected_calls)
+
     @mock.patch.object(swiftclient.service.SwiftService,
                        '_bulk_delete_page_size', lambda *a: 1)
     @mock.patch('swiftclient.service.Connection')
@@ -1342,7 +1534,7 @@ def test_delete_container_headers(self, connection):
             'container', response_dict={},
             headers={'Skip-Middleware': 'Test'})
         connection.return_value.delete_object.assert_called_with(
-            'container', 'object', query_string=None, response_dict={},
+            'container', 'object', query_string='', response_dict={},
             headers={'Skip-Middleware': 'Test'})
 
     @mock.patch.object(swiftclient.service.SwiftService,
@@ -1408,7 +1600,7 @@ def test_delete_per_object(self, connection):
         connection.return_value.attempts = 0
         swiftclient.shell.main(argv)
         connection.return_value.delete_object.assert_called_with(
-            'container', 'object', query_string=None, response_dict={},
+            'container', 'object', query_string='', response_dict={},
             headers={})
 
     @mock.patch.object(swiftclient.service.SwiftService,

From 9b0da49c0b337585e24825de2ad670a0798179ac Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 10 Apr 2020 17:16:11 -0700
Subject: [PATCH 170/316] Improve `list --versions` output

Have `--versions` imply `--long` and add a new column for version_id.

Also, have version-aware listings show all versions as "null" on old
Swifts that don't support object versioning (or when object versioning
is not enabled).

Change-Id: I0e009bce2471d1c140ac9b83700591cb355fee3f
---
 swiftclient/shell.py    | 15 ++++++++----
 test/unit/test_shell.py | 53 +++++++++++++++++++++++++++++++++++++----
 2 files changed, 59 insertions(+), 9 deletions(-)

diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 03a8fa64..1b34c084 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -534,7 +534,7 @@ def _print_stats(options, stats, human):
         container = stats.get("container", None)
         for item in stats["listing"]:
             item_name = item.get('name')
-            if not options['long'] and not human:
+            if not options['long'] and not human and not options['versions']:
                 output_manager.print_msg(item.get('name', item.get('subdir')))
             else:
                 if not container:    # listing containers
@@ -566,9 +566,16 @@ def _print_stats(options, stats, human):
                         date = xtime = ''
                         item_name = subdir
                     if not options['totals']:
-                        output_manager.print_msg(
-                            "%s %10s %8s %24s %s",
-                            byte_str, date, xtime, content_type, item_name)
+                        if options['versions']:
+                            output_manager.print_msg(
+                                "%s %10s %8s %16s %24s %s",
+                                byte_str, date, xtime,
+                                item.get('version_id', 'null'),
+                                content_type, item_name)
+                        else:
+                            output_manager.print_msg(
+                                "%s %10s %8s %24s %s",
+                                byte_str, date, xtime, content_type, item_name)
                 total_bytes += item_bytes
 
         # report totals
diff --git a/test/unit/test_shell.py b/test/unit/test_shell.py
index b94cdcff..a63d16b2 100644
--- a/test/unit/test_shell.py
+++ b/test/unit/test_shell.py
@@ -334,8 +334,15 @@ def test_list_account_with_delimiter(self):
     def test_list_container_with_versions(self, connection):
         connection.return_value.get_container.side_effect = [
             [None, [
-                {'name': 'foo', 'version_id': '2'},
-                {'name': 'foo', 'version_id': '1'},
+                {'name': 'foo', 'version_id': '2',
+                 'content_type': 'text/plain',
+                 'last_modified': '123T456', 'bytes': 78},
+                {'name': 'foo', 'version_id': '1',
+                 'content_type': 'text/rtf',
+                 'last_modified': '123T456', 'bytes': 90},
+                {'name': 'bar', 'version_id': 'null',
+                 'content_type': 'text/plain',
+                 'last_modified': '123T456', 'bytes': 123},
             ]],
             [None, []],
         ]
@@ -346,10 +353,46 @@ def test_list_container_with_versions(self, connection):
                            prefix=None, query_string='versions=true',
                            version_marker=''),
                  mock.call('container', delimiter=None, headers={},
-                           marker='foo', prefix=None,
-                           query_string='versions=true', version_marker='1')]
+                           marker='bar', prefix=None,
+                           query_string='versions=true',
+                           version_marker='null')]
         connection.return_value.get_container.assert_has_calls(calls)
-        self.assertEqual(output.out, 'foo\nfoo\n')
+        self.assertEqual([line.split() for line in output.out.split('\n')], [
+            ['78', '123', '456', '2', 'text/plain', 'foo'],
+            ['90', '123', '456', '1', 'text/rtf', 'foo'],
+            ['123', '123', '456', 'null', 'text/plain', 'bar'],
+            [],
+        ])
+
+    @mock.patch('swiftclient.service.Connection')
+    def test_list_container_with_versions_old_swift(self, connection):
+        # Versions of swift that don't support object-versioning won't
+        # include verison_id keys in listings. We want to present that
+        # as though the container is unversioned.
+        connection.return_value.get_container.side_effect = [
+            [None, [
+                {'name': 'foo', 'content_type': 'text/plain',
+                 'last_modified': '123T456', 'bytes': 78},
+                {'name': 'bar', 'content_type': 'text/plain',
+                 'last_modified': '123T456', 'bytes': 123},
+            ]],
+            [None, []],
+        ]
+        argv = ["", "list", "container", "--versions"]
+        with CaptureOutput(suppress_systemexit=True) as output:
+            swiftclient.shell.main(argv)
+        calls = [mock.call('container', delimiter=None, headers={}, marker='',
+                           prefix=None, query_string='versions=true',
+                           version_marker=''),
+                 mock.call('container', delimiter=None, headers={},
+                           marker='bar', prefix=None,
+                           query_string='versions=true', version_marker='')]
+        connection.return_value.get_container.assert_has_calls(calls)
+        self.assertEqual([line.split() for line in output.out.split('\n')], [
+            ['78', '123', '456', 'null', 'text/plain', 'foo'],
+            ['123', '123', '456', 'null', 'text/plain', 'bar'],
+            [],
+        ])
 
     def test_list_account_with_versions(self):
         argv = ["", "list", "--versions"]

From f9f2090a025afc5e11cc889b5a31d159f78aaaa2 Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Sun, 12 Apr 2020 20:41:23 +0200
Subject: [PATCH 171/316] Drop pypy testing

The pypy job is always failing, drop it.

Change-Id: Ibc80d23846b364bfcd82043430ef71ad4b6e271b
---
 .zuul.yaml | 1 -
 tox.ini    | 2 +-
 2 files changed, 1 insertion(+), 2 deletions(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index f0bd82c5..eabae2cb 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -37,7 +37,6 @@
       - check-requirements
       - lib-forward-testing-python3
       - openstack-lower-constraints-jobs
-      - openstack-pypy-jobs-nonvoting
       - openstack-python-jobs
       - openstack-python3-ussuri-jobs
       - publish-openstack-docs-pti
diff --git a/tox.ini b/tox.ini
index 002d24c5..2b4f6e36 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,5 +1,5 @@
 [tox]
-envlist = py27,py37,pypy,pep8
+envlist = py27,py37,pep8
 minversion = 2.0
 skipsdist = True
 

From a15eaec82667aa00b1056c802aaa3e470471755e Mon Sep 17 00:00:00 2001
From: OpenStack Release Bot <infra-root@openstack.org>
Date: Mon, 13 Apr 2020 15:30:38 +0000
Subject: [PATCH 172/316] Update master for stable/ussuri

Add file to the reno documentation build to show release notes for
stable/ussuri.

Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/ussuri.

Change-Id: I75dc03a9d29c65b8d104b8d3a95915094cba6320
Sem-Ver: feature
---
 releasenotes/source/index.rst  | 1 +
 releasenotes/source/ussuri.rst | 6 ++++++
 2 files changed, 7 insertions(+)
 create mode 100644 releasenotes/source/ussuri.rst

diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst
index 662c6f6d..d46593b0 100644
--- a/releasenotes/source/index.rst
+++ b/releasenotes/source/index.rst
@@ -6,6 +6,7 @@
    :maxdepth: 1
 
    current
+   ussuri
    train
    stein
    rocky
diff --git a/releasenotes/source/ussuri.rst b/releasenotes/source/ussuri.rst
new file mode 100644
index 00000000..e21e50e0
--- /dev/null
+++ b/releasenotes/source/ussuri.rst
@@ -0,0 +1,6 @@
+===========================
+Ussuri Series Release Notes
+===========================
+
+.. release-notes::
+   :branch: stable/ussuri

From 89ae9d77cbb25493d86dd766613eecb6f6120114 Mon Sep 17 00:00:00 2001
From: OpenStack Release Bot <infra-root@openstack.org>
Date: Mon, 13 Apr 2020 15:30:41 +0000
Subject: [PATCH 173/316] Add Python3 victoria unit tests

This is an automatically generated patch to ensure unit testing
is in place for all the of the tested runtimes for victoria.

See also the PTI in governance [1].

[1]: https://governance.openstack.org/tc/reference/project-testing-interface.html

Change-Id: I2fa8505451caadbe895cc3262c0bf1470795968b
---
 .zuul.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index f0bd82c5..9cd52c16 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -39,7 +39,7 @@
       - openstack-lower-constraints-jobs
       - openstack-pypy-jobs-nonvoting
       - openstack-python-jobs
-      - openstack-python3-ussuri-jobs
+      - openstack-python3-victoria-jobs
       - publish-openstack-docs-pti
       - release-notes-jobs-python3
     check:

From 2eba2dd42a7fa9663b59486f25707c16ef3731d7 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Mon, 13 Apr 2020 22:28:53 -0700
Subject: [PATCH 174/316] Add cacert test config option

Change-Id: I3936f862e0fef176cad34f277598b136a40de1eb
---
 test/functional/__init__.py          | 5 +++++
 test/functional/test_openstacksdk.py | 1 +
 test/functional/test_swiftclient.py  | 6 ++++--
 test/sample.conf                     | 5 +++++
 4 files changed, 15 insertions(+), 2 deletions(-)

diff --git a/test/functional/__init__.py b/test/functional/__init__.py
index 248875a6..f0fea3be 100644
--- a/test/functional/__init__.py
+++ b/test/functional/__init__.py
@@ -57,6 +57,11 @@ def _load_config(force_reload=False):
                 auth_url += 'v1.0'
             conf['auth_url'] = auth_url
 
+        try:
+            conf['cacert'] = parser.get('func_test', 'cacert')
+        except configparser.NoOptionError:
+            conf['cacert'] = None
+
         try:
             conf['account_username'] = parser.get('func_test',
                                                   'account_username')
diff --git a/test/functional/test_openstacksdk.py b/test/functional/test_openstacksdk.py
index cee7f4e9..e51773ae 100644
--- a/test/functional/test_openstacksdk.py
+++ b/test/functional/test_openstacksdk.py
@@ -35,6 +35,7 @@ def setUpClass(cls):
                 auth_url=TEST_CONFIG['auth_url'],
                 username=TEST_CONFIG['account_username'],
                 password=TEST_CONFIG['password'],
+                cacert=TEST_CONFIG['cacert'],
             )
             cls.object_store = cls.conn.object_store
 
diff --git a/test/functional/test_swiftclient.py b/test/functional/test_swiftclient.py
index 54c514de..aaade879 100644
--- a/test/functional/test_swiftclient.py
+++ b/test/functional/test_swiftclient.py
@@ -42,6 +42,7 @@ def __init__(self, *args, **kwargs):
 
     def _get_config(self):
         self.auth_url = TEST_CONFIG['auth_url']
+        self.cacert = TEST_CONFIG['cacert']
         self.auth_version = TEST_CONFIG['auth_version']
         self.account_username = TEST_CONFIG['account_username']
         self.password = TEST_CONFIG['password']
@@ -52,7 +53,7 @@ def _get_connection(self):
         """
         return swiftclient.Connection(
             self.auth_url, self.account_username, self.password,
-            auth_version=self.auth_version)
+            auth_version=self.auth_version, cacert=self.cacert)
 
     def setUp(self):
         super(TestFunctional, self).setUp()
@@ -486,7 +487,7 @@ def _get_connection(self):
 
         return swiftclient.Connection(
             self.auth_url, username, self.password,
-            auth_version=self.auth_version,
+            auth_version=self.auth_version, cacert=self.cacert,
             os_options={'tenant_name': account})
 
 
@@ -515,4 +516,5 @@ def _get_connection(self):
                       'user_domain_name': user_domain}
         return swiftclient.Connection(self.auth_url, username, password,
                                       auth_version=self.auth_version,
+                                      cacert=self.cacert,
                                       os_options=os_options)
diff --git a/test/sample.conf b/test/sample.conf
index 95c1a478..2b19de4f 100644
--- a/test/sample.conf
+++ b/test/sample.conf
@@ -12,6 +12,11 @@ auth_prefix = /auth/
 #auth_ssl = no
 #auth_prefix = /v2.0/
 
+# You may want to run tests against endpoints that use development certs
+# without installing the CA system-wide. Use this to trust an extra set
+# of certificates.
+#cacert = /path/to/trusted-ca.crt
+
 # Primary functional test account (needs admin access to the account).
 # By default the tests use a swiftclient.client.Connection instance with user
 # attribute set to 'account:username' based on the options 'account' and

From 06c5c30fa462d07ef6f63935542e280cf2fd02b4 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Mon, 13 Apr 2020 22:45:25 -0700
Subject: [PATCH 175/316] Change recommended test config to use auth_uri

...instead of piecing it together from auth_host, auth_port, auth_ssl,
auth_prefix, and (sort of, sometimes) auth_version.

Change-Id: Ie9c36e778d6a03f905899074d7136b767812ea11
---
 test/sample.conf | 10 ++--------
 1 file changed, 2 insertions(+), 8 deletions(-)

diff --git a/test/sample.conf b/test/sample.conf
index 95c1a478..49bca90a 100644
--- a/test/sample.conf
+++ b/test/sample.conf
@@ -1,16 +1,10 @@
 [func_test]
 # sample config
-auth_host = 127.0.0.1
-auth_port = 8080
-auth_ssl = no
-auth_prefix = /auth/
+auth_uri = http://127.0.0.1:8080/auth/v1.0/
 ## sample config for Swift with Keystone v2 API
 # For keystone v3 change auth_version to 3 and auth_prefix to /v3/
 #auth_version = 2
-#auth_host = localhost
-#auth_port = 5000
-#auth_ssl = no
-#auth_prefix = /v2.0/
+#auth_uri = http://localhost:5000/v2.0/
 
 # Primary functional test account (needs admin access to the account).
 # By default the tests use a swiftclient.client.Connection instance with user

From 02b637cdca6963e8dcab5170422347df99606f92 Mon Sep 17 00:00:00 2001
From: Charles Hsu <charles0126@gmail.com>
Date: Wed, 18 Dec 2019 00:32:36 +0800
Subject: [PATCH 176/316] Support v3 application credentials auth.

Use keystoneauth1 application credential plugin and session to fetch
a token and endpoint catalog url.

$ swift --os-auth-url http://172.16.1.2:5000/v3 --auth-version 3\
      --os-application-credential-id THE_ID \
      --os-application-credential-secret THE_SECRET \
      --os-auth-type v3applicationcredential auth

Change-Id: I9190e5e7e24b6a741970fa0d0ac792deccf73d25
Closes-Bug: 1843901
Closes-Bug: 1856635
---
 swiftclient/client.py         | 59 +++++++++++++++++++++++++++++------
 swiftclient/service.py        | 13 ++++++++
 swiftclient/shell.py          | 54 +++++++++++++++++++++++++++++---
 test/unit/test_shell.py       | 46 +++++++++++++++++++++++++++
 test/unit/test_swiftclient.py | 57 +++++++++++++++++++++++++++++++++
 5 files changed, 215 insertions(+), 14 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index 449b6cd3..ee85a144 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -70,6 +70,9 @@ def createLock(self):
     pass
 try:
     from keystoneclient.v3 import client as ksclient_v3
+    from keystoneauth1.identity import v3
+    from keystoneauth1 import session
+    from keystoneauth1 import exceptions as ksauthexceptions
 except ImportError:
     pass
 
@@ -615,6 +618,46 @@ def get_auth_keystone(auth_url, user, key, os_options, **kwargs):
 version 1.0 which requires ST_AUTH, ST_USER, and ST_KEY environment
 variables to be set or overridden with -A, -U, or -K.''')
 
+    filter_kwargs = {}
+    service_type = os_options.get('service_type') or 'object-store'
+    endpoint_type = os_options.get('endpoint_type') or 'publicURL'
+    if os_options.get('region_name'):
+        filter_kwargs['attr'] = 'region'
+        filter_kwargs['filter_value'] = os_options['region_name']
+
+    if os_options.get('auth_type') == 'v3applicationcredential':
+        try:
+            v3
+        except NameError:
+            raise ClientException('Auth v3applicationcredential requires '
+                                  'python-keystoneclient>=2.0.0')
+
+        try:
+            auth = v3.ApplicationCredential(
+                auth_url=auth_url,
+                application_credential_secret=os_options.get(
+                    'application_credential_secret'),
+                application_credential_id=os_options.get(
+                    'application_credential_id'))
+            sses = session.Session(auth=auth)
+            token = sses.get_token()
+        except ksauthexceptions.Unauthorized:
+            msg = 'Unauthorized. Check application credential id and secret.'
+            raise ClientException(msg)
+        except ksauthexceptions.AuthorizationFailure as err:
+            raise ClientException('Authorization Failure. %s' % err)
+
+        try:
+            endpoint = sses.get_endpoint_data(service_type=service_type,
+                                              endpoint_type=endpoint_type,
+                                              **filter_kwargs)
+
+            return endpoint.catalog_url, token
+        except ksauthexceptions.EndpointNotFound:
+            raise ClientException(
+                'Endpoint for %s not found - '
+                'have you specified a region?' % service_type)
+
     try:
         _ksclient = ksclient.Client(
             username=user,
@@ -642,13 +685,8 @@ def get_auth_keystone(auth_url, user, key, os_options, **kwargs):
         raise ClientException(msg)
     except ksexceptions.AuthorizationFailure as err:
         raise ClientException('Authorization Failure. %s' % err)
-    service_type = os_options.get('service_type') or 'object-store'
-    endpoint_type = os_options.get('endpoint_type') or 'publicURL'
+
     try:
-        filter_kwargs = {}
-        if os_options.get('region_name'):
-            filter_kwargs['attr'] = 'region'
-            filter_kwargs['filter_value'] = os_options['region_name']
         endpoint = _ksclient.service_catalog.url_for(
             service_type=service_type,
             endpoint_type=endpoint_type,
@@ -717,9 +755,12 @@ def get_auth(auth_url, user, key, **kwargs):
         if kwargs.get('tenant_name'):
             os_options['tenant_name'] = kwargs['tenant_name']
 
-        if not (os_options.get('tenant_name') or os_options.get('tenant_id') or
-                os_options.get('project_name') or
-                os_options.get('project_id')):
+        if os_options.get('auth_type') == 'v3applicationcredential':
+            pass
+        elif not (os_options.get('tenant_name') or
+                  os_options.get('tenant_id') or
+                  os_options.get('project_name') or
+                  os_options.get('project_id')):
             if auth_version in AUTH_VERSIONS_V2:
                 raise ClientException('No tenant specified')
             raise ClientException('No project name or project id specified.')
diff --git a/swiftclient/service.py b/swiftclient/service.py
index fb334fde..b89399fe 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -110,6 +110,9 @@ def process_options(options):
         else:
             options['auth_version'] = '2.0'
 
+    if options.get('os_auth_type', None) == 'v3applicationcredential':
+        options['auth_version'] == '3'
+
     # Use new-style args if old ones not present
     if not options['auth'] and options['os_auth_url']:
         options['auth'] = options['os_auth_url']
@@ -134,6 +137,11 @@ def process_options(options):
         'auth_token': options['os_auth_token'],
         'object_storage_url': options['os_storage_url'],
         'region_name': options['os_region_name'],
+        'auth_type': options['os_auth_type'],
+        'application_credential_id':
+        options['os_application_credential_id'],
+        'application_credential_secret':
+        options['os_application_credential_secret'],
     }
 
 
@@ -162,6 +170,11 @@ def _build_default_global_options():
         "os_project_domain_id": environ.get('OS_PROJECT_DOMAIN_ID'),
         "os_auth_url": environ.get('OS_AUTH_URL'),
         "os_auth_token": environ.get('OS_AUTH_TOKEN'),
+        "os_auth_type": environ.get('OS_AUTH_TYPE'),
+        "os_application_credential_id":
+        environ.get('OS_APPLICATION_CREDENTIAL_ID'),
+        "os_application_credential_secret":
+        environ.get('OS_APPLICATION_CREDENTIAL_SECRET'),
         "os_storage_url": environ.get('OS_STORAGE_URL'),
         "os_region_name": environ.get('OS_REGION_NAME'),
         "os_service_type": environ.get('OS_SERVICE_TYPE'),
diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 1b34c084..0fef755f 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -1651,16 +1651,27 @@ def parse_args(parser, args, enforce_requires=True):
         return options, args
 
     if enforce_requires:
-        if options['auth_version'] == '3':
+        if options['os_auth_type'] == 'v3applicationcredential':
+            if not (options['os_application_credential_id'] and
+                    options['os_application_credential_secret']):
+                exit('Auth version 3 (application credential) requires '
+                     'OS_APPLICATION_CREDENTIAL_ID and '
+                     'OS_APPLICATION_CREDENTIAL_SECRET to be set or '
+                     'overridden with --os-application-credential-id and '
+                     '--os-application-credential-secret respectively.')
+        elif options['os_auth_type']:
+            exit('Only "v3applicationcredential" is supported for '
+                 '--os-auth-type')
+        elif options['auth_version'] == '3':
             if not options['auth']:
-                exit('Auth version 3 requires OS_AUTH_URL to be set or ' +
+                exit('Auth version 3 requires OS_AUTH_URL to be set or '
                      'overridden with --os-auth-url')
             if not (options['user'] or options['os_user_id']):
-                exit('Auth version 3 requires either OS_USERNAME or ' +
-                     'OS_USER_ID to be set or overridden with ' +
+                exit('Auth version 3 requires either OS_USERNAME or '
+                     'OS_USER_ID to be set or overridden with '
                      '--os-username or --os-user-id respectively.')
             if not options['key']:
-                exit('Auth version 3 requires OS_PASSWORD to be set or ' +
+                exit('Auth version 3 requires OS_PASSWORD to be set or '
                      'overridden with --os-password')
         elif not (options['auth'] and options['user'] and options['key']):
             exit('''
@@ -1831,6 +1842,29 @@ def add_default_args(parser):
                              'env[OS_AUTH_URL].')
     os_grp.add_argument('--os_auth_url',
                         help=argparse.SUPPRESS)
+    os_grp.add_argument('--os-auth-type',
+                        metavar='<auth-type>',
+                        default=environ.get('OS_AUTH_TYPE'),
+                        help='OpenStack auth type for v3. Defaults to '
+                             'env[OS_AUTH_TYPE].')
+    os_grp.add_argument('--os_auth_type',
+                        help=argparse.SUPPRESS)
+    os_grp.add_argument('--os-application-credential-id',
+                        metavar='<auth-application-credential-id>',
+                        default=environ.get('OS_APPLICATION_CREDENTIAL_ID'),
+                        help='OpenStack appplication credential id. '
+                             'Defaults to env[OS_APPLICATION_CREDENTIAL_ID].')
+    os_grp.add_argument('--os_application_credential_id',
+                        help=argparse.SUPPRESS)
+    os_grp.add_argument('--os-application-credential-secret',
+                        metavar='<auth-application-credential-secret>',
+                        default=environ.get(
+                            'OS_APPLICATION_CREDENTIAL_SECRET'),
+                        help='OpenStack appplication credential secret. '
+                             'Defaults to '
+                             'env[OS_APPLICATION_CREDENTIAL_SECRET].')
+    os_grp.add_argument('--os_application_credential_secret',
+                        help=argparse.SUPPRESS)
     os_grp.add_argument('--os-auth-token',
                         metavar='<auth-token>',
                         default=environ.get('OS_AUTH_TOKEN'),
@@ -1915,6 +1949,11 @@ def main(arguments=None):
              [--os-project-domain-name <auth-project-domain-name>]
              [--os-auth-url <auth-url>]
              [--os-auth-token <auth-token>]
+             [--os-auth-type <os-auth-type>]
+             [--os-application-credential-id
+                   <auth-application-credential-id>]
+             [--os-application-credential-secret
+                   <auth-application-credential-secret>]
              [--os-storage-url <storage-url>]
              [--os-region-name <region-name>]
              [--os-service-type <service-type>]
@@ -1967,6 +2006,11 @@ def main(arguments=None):
       --os-user-id abcdef0123456789abcdef0123456789 \\
       --os-password password list
 
+  %(prog)s --os-auth-url https://api.example.com/v3 --auth-version 3\\
+      --os-application-credential-id d78683c92f0e4f9b9b02a2e208039412 \\
+      --os-application-credential-secret APPLICTION_CREDENTIAL_SECRET \\
+      --os-auth-type v3applicationcredential list
+
   %(prog)s --os-auth-token 6ee5eb33efad4e45ab46806eac010566 \\
       --os-storage-url https://10.1.5.2:8080/v1/AUTH_ced809b6a4baea7aeab61a \\
       list
diff --git a/test/unit/test_shell.py b/test/unit/test_shell.py
index a63d16b2..3c082184 100644
--- a/test/unit/test_shell.py
+++ b/test/unit/test_shell.py
@@ -2395,6 +2395,8 @@ def _verify_opts(self, actual_opts, expected_opts, expected_os_opts=None,
                                  'object_storage_url', 'project_domain_id',
                                  'user_id', 'user_domain_id', 'tenant_id',
                                  'service_type', 'project_id', 'auth_token',
+                                 'auth_type', 'application_credential_id',
+                                 'application_credential_secret',
                                  'project_domain_name']
         for key in expected_os_opts_keys:
             self.assertIn(key, actual_os_opts_dict)
@@ -2686,6 +2688,50 @@ def test_insufficient_args_v3(self):
             swiftclient.shell.main(args)
         self.assertIn('Auth version 3 requires OS_AUTH_URL', str(cm.exception))
 
+    def test_command_args_v3applicationcredential(self):
+        result = [None, None]
+        fake_command = self._make_fake_command(result)
+        opts = {"auth_version": "3"}
+        os_opts = {
+            "auth_type": "v3applicationcredential",
+            "application_credential_id": "proejct_id",
+            "application_credential_secret": "secret",
+            "auth_url": "http://example.com:5000/v3"}
+
+        args = _make_args("stat", opts, os_opts)
+        with mock.patch('swiftclient.shell.st_stat', fake_command):
+            swiftclient.shell.main(args)
+            self.assertEqual(['stat'], result[1])
+        with mock.patch('swiftclient.shell.st_stat', fake_command):
+            args = args + ["container_name"]
+            swiftclient.shell.main(args)
+            self.assertEqual(["stat", "container_name"], result[1])
+
+    def test_insufficient_args_v3applicationcredential(self):
+        opts = {"auth_version": "3"}
+        os_opts = {
+            "auth_type": "v3applicationcredential",
+            "application_credential_secret": "secret",
+            "auth_url": "http://example.com:5000/v3"}
+
+        args = _make_args("stat", opts, os_opts)
+        with self.assertRaises(SystemExit) as cm:
+            swiftclient.shell.main(args)
+        self.assertIn('Auth version 3 (application credential) requires',
+                      str(cm.exception))
+
+        os_opts = {
+            "auth_type": "v3password",
+            "application_credential_id": "proejct_id",
+            "application_credential_secret": "secret",
+            "auth_url": "http://example.com:5000/v3"}
+
+        args = _make_args("stat", opts, os_opts)
+        with self.assertRaises(SystemExit) as cm:
+            swiftclient.shell.main(args)
+        self.assertIn('Only "v3applicationcredential" is supported for',
+                      str(cm.exception))
+
     def test_password_prompt(self):
         def do_test(opts, os_opts, auth_version):
             args = _make_args("stat", opts, os_opts)
diff --git a/test/unit/test_swiftclient.py b/test/unit/test_swiftclient.py
index 2d45deb8..7354bdc8 100644
--- a/test/unit/test_swiftclient.py
+++ b/test/unit/test_swiftclient.py
@@ -562,6 +562,63 @@ def test_auth_v3_with_tenant_name(self):
         self.assertTrue(url.startswith("http"))
         self.assertTrue(token)
 
+    def test_auth_v3applicationcredential(self):
+        from keystoneauth1 import exceptions as ksauthexceptions
+
+        os_options = {
+            "auth_type": "v3applicationcredential",
+            "application_credential_id": "proejct_id",
+            "application_credential_secret": "secret"}
+
+        class FakeEndpointData(object):
+            catalog_url = 'http://swift.cluster/v1/KEY_project_id'
+
+        class FakeKeystoneuth1v3Session(object):
+
+            def __init__(self, auth):
+                self.auth = auth
+                self.token = 'token'
+
+            def get_token(self):
+                if self.auth.auth_url == 'http://keystone:5000/v3':
+                    return self.token
+                elif self.auth.auth_url == 'http://keystone:9000/v3':
+                    raise ksauthexceptions.AuthorizationFailure
+                else:
+                    raise ksauthexceptions.Unauthorized
+
+            def get_endpoint_data(self, service_type, endpoint_type, **kwargs):
+                return FakeEndpointData()
+
+        mock_sess = FakeKeystoneuth1v3Session
+        with mock.patch('keystoneauth1.session.Session', mock_sess):
+            url, token = c.get_auth('http://keystone:5000', '', '',
+                                    os_options=os_options,
+                                    auth_version="3")
+
+        self.assertTrue(url.startswith("http"))
+        self.assertEqual(url, 'http://swift.cluster/v1/KEY_project_id')
+        self.assertEqual(token, 'token')
+
+        with mock.patch('keystoneauth1.session.Session', mock_sess):
+            with self.assertRaises(c.ClientException) as exc_mgr:
+                url, token = c.get_auth('http://keystone:9000', '', '',
+                                        os_options=os_options,
+                                        auth_version="3")
+
+        body = 'Unauthorized. Check application credential id and secret.'
+        body = 'Authorization Failure. Cannot authorize API client.'
+        self.assertEqual(exc_mgr.exception.__str__()[-89:], body)
+
+        with mock.patch('keystoneauth1.session.Session', mock_sess):
+            with self.assertRaises(c.ClientException) as exc_mgr:
+                url, token = c.get_auth('http://keystone:5000', '', '',
+                                        os_options=os_options,
+                                        auth_version="2")
+
+        body = 'Unauthorized. Check application credential id and secret.'
+        self.assertEqual(exc_mgr.exception.__str__()[-89:], body)
+
     def test_get_keystone_client_2_0(self):
         # check the correct auth version is passed to get_auth_keystone
         os_options = {'tenant_name': 'asdf'}

From bb3888e73e8bcbdc2340309a85a5f57a0c5bccf0 Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Sun, 19 Apr 2020 09:54:27 +0200
Subject: [PATCH 177/316] Update docs building

Update docs building:
* Switch to sphinx-build
* Update requirements for Sphinx and openstackdocstheme for
  python 3
* Remove unneeded doc and translation sections from setup.cfg
* Remove install_command, it's unneeded, the default is fine.

Change-Id: Ib9fe754b700bceb164ba0f596cbcc6d864ccbadc
---
 doc/requirements.txt  |  4 ++--
 lower-constraints.txt |  4 ++--
 setup.cfg             | 12 ------------
 tox.ini               |  3 +--
 4 files changed, 5 insertions(+), 18 deletions(-)

diff --git a/doc/requirements.txt b/doc/requirements.txt
index 6cdad2ab..3ee9fc2a 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,5 +1,5 @@
 keystoneauth1>=3.4.0  # Apache-2.0
 sphinx!=1.6.6,!=1.6.7,<2.0.0,>=1.6.2;python_version=='2.7' # BSD
-sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD
+sphinx>=2.0.0,!=2.1.0;python_version>='3.4' # BSD
 reno>=2.5.0 # Apache-2.0
-openstackdocstheme>=1.20.0 # Apache-2.0
+openstackdocstheme>=1.31.2 # Apache-2.0
diff --git a/lower-constraints.txt b/lower-constraints.txt
index ead02791..1e4ffb90 100644
--- a/lower-constraints.txt
+++ b/lower-constraints.txt
@@ -20,7 +20,7 @@ MarkupSafe==1.0
 mccabe==0.2.1
 mock==1.2.0
 netaddr==0.7.10
-openstackdocstheme==1.20.0
+openstackdocstheme==2.0.0
 openstacksdk==0.11.0
 oslo.config==1.2.0
 pbr==2.0.0
@@ -37,7 +37,7 @@ reno==2.5.0
 requests==1.1.0
 six==1.9.0
 snowballstemmer==1.2.1
-sphinx==1.6.2
+sphinx==2.0.0
 sphinxcontrib-websupport==1.0.1
 stestr==2.0.0
 testtools==2.2.0
diff --git a/setup.cfg b/setup.cfg
index bcb4d223..3ce8e637 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -20,10 +20,6 @@ classifier =
     Programming Language :: Python :: 3.6
     Programming Language :: Python :: 3.7
 
-[global]
-setup-hooks =
-    pbr.hooks.setup_hook
-
 [files]
 packages =
     swiftclient
@@ -43,14 +39,6 @@ console_scripts =
 keystoneauth1.plugin =
     v1password = swiftclient.authv1:PasswordLoader
 
-[build_sphinx]
-source-dir = doc/source
-build-dir = doc/build
-all_files = 1
-
-[upload_sphinx]
-upload-dir = doc/build/html
-
 [bdist_wheel]
 universal = 1
 
diff --git a/tox.ini b/tox.ini
index 2b4f6e36..8a50bb16 100644
--- a/tox.ini
+++ b/tox.ini
@@ -5,7 +5,6 @@ skipsdist = True
 
 [testenv]
 usedevelop = True
-install_command = python -m pip install -U {opts} {packages}
 list_dependencies_command = python -m pip freeze
 setenv =
   LANG=en_US.utf-8
@@ -68,7 +67,7 @@ basepython = python3
 usedevelop = False
 deps = -r{toxinidir}/doc/requirements.txt
 commands=
-    python setup.py build_sphinx -W
+    sphinx-build -W -b html doc/source doc/build/html -W
 
 [flake8]
 # it's not a bug that we aren't using all of hacking, ignore:

From 77993f242be5a2824cc9524836bea6fa6f77620a Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Mon, 20 Apr 2020 10:10:46 -0700
Subject: [PATCH 178/316] Add py38 classifier

Change-Id: I28bf4aeb12c1f3833d2c6501b49d184b54d36093
---
 setup.cfg | 1 +
 1 file changed, 1 insertion(+)

diff --git a/setup.cfg b/setup.cfg
index 3ce8e637..95801a88 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -19,6 +19,7 @@ classifier =
     Programming Language :: Python :: 3
     Programming Language :: Python :: 3.6
     Programming Language :: Python :: 3.7
+    Programming Language :: Python :: 3.8
 
 [files]
 packages =

From 947c09f30c6b603e3f4da060bc913407b158a0ca Mon Sep 17 00:00:00 2001
From: Ivan Kolodyazhny <e0ne@e0ne.info>
Date: Thu, 23 Apr 2020 19:01:47 +0300
Subject: [PATCH 179/316] Fixed capability discovery endpoint hardcode

It fixes get_capabilities() method to process
correctly endpoints like: 'https://<ip>:<port>/v1',
'https://<ip>:<port>/swift/v1'.

Co-Authored-By: Daniel Cech <dcech@mirantis.com>
Change-Id: Ib4037d0b49da1bce959947100629370805f510d5
Closes-bug: #1712358
---
 swiftclient/client.py         | 17 +++++++++++++++--
 test/unit/test_swiftclient.py | 32 ++++++++++++++++++++++++++++++++
 2 files changed, 47 insertions(+), 2 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index 449b6cd3..3c3abc0b 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -45,6 +45,8 @@
 AUTH_VERSIONS_V3 = ('3.0', '3', 3)
 USER_METADATA_TYPE = tuple('x-%s-meta-' % type_ for type_ in
                            ('container', 'account', 'object'))
+URI_PATTERN_INFO = re.compile(r'/info')
+URI_PATTERN_VERSION = re.compile(r'\/v\d+\.?\d*(\/.*)?')
 
 try:
     from logging import NullHandler
@@ -1935,11 +1937,22 @@ def delete_object(self, container, obj, query_string=None,
                            response_dict=response_dict,
                            headers=headers)
 
-    def get_capabilities(self, url=None):
+    def _map_url(self, url):
         url = url or self.url
         if not url:
             url, _ = self.get_auth()
-        parsed = urlparse(urljoin(url, '/info'))
+        scheme, netloc, path, params, query, fragment = urlparse(url)
+        if URI_PATTERN_VERSION.search(path):
+            path = URI_PATTERN_VERSION.sub('/info', path)
+        elif not URI_PATTERN_INFO.search(path):
+            if path.endswith('/'):
+                path += 'info'
+            else:
+                path += '/info'
+        return urlunparse((scheme, netloc, path, params, query, fragment))
+
+    def get_capabilities(self, url=None):
+        parsed = urlparse(self._map_url(url))
         if not self.http_conn:
             self.http_conn = self.http_connection(url)
         return get_capabilities((parsed, self.http_conn[1]))
diff --git a/test/unit/test_swiftclient.py b/test/unit/test_swiftclient.py
index 2d45deb8..e3d0742d 100644
--- a/test/unit/test_swiftclient.py
+++ b/test/unit/test_swiftclient.py
@@ -2035,6 +2035,38 @@ def test_storage_url_override(self):
                     self.assertEqual(request['headers']['x-auth-token'],
                                      'tToken')
 
+    def test_url_mapping(self):
+        conn = c.Connection()
+        uri_versions = {
+            'http://storage.test.com':
+                'http://storage.test.com/info',
+            'http://storage.test.com/':
+                'http://storage.test.com/info',
+            'http://storage.test.com/v1':
+                'http://storage.test.com/info',
+            'http://storage.test.com/v1/':
+                'http://storage.test.com/info',
+            'http://storage.test.com/swift':
+                'http://storage.test.com/swift/info',
+            'http://storage.test.com/swift/':
+                'http://storage.test.com/swift/info',
+            'http://storage.test.com/v1.0':
+                'http://storage.test.com/info',
+            'http://storage.test.com/swift/v1.0':
+                'http://storage.test.com/swift/info',
+            'http://storage.test.com/v111':
+                'http://storage.test.com/info',
+            'http://storage.test.com/v111/test':
+                'http://storage.test.com/info',
+            'http://storage.test.com/v1/test':
+                'http://storage.test.com/info',
+            'http://storage.test.com/swift/v1.0/test':
+                'http://storage.test.com/swift/info',
+            'http://storage.test.com/v1.0/test':
+                'http://storage.test.com/info'}
+        for uri_k, uri_v in uri_versions.items():
+            self.assertEqual(conn._map_url(uri_k), uri_v)
+
     def test_get_capabilities(self):
         conn = c.Connection()
         with mock.patch('swiftclient.client.get_capabilities') as get_cap:

From e44ca6d8af33d5f84b8c2c6c19c40b6c681c68fe Mon Sep 17 00:00:00 2001
From: Sean McGinnis <sean.mcginnis@gmail.com>
Date: Fri, 24 Apr 2020 10:25:58 -0500
Subject: [PATCH 180/316] Bump default tox env from py37 to py38

Python 3.8 is now our highest level supported python runtime.
This updates the default tox target environments to swap out
py37 for py38 to make sure local development testing is
covering this version.

This does not impact zuul jobs in any way, nor prevent local
tests against py37. It just changes the default if none is
explicitly provided.

Change-Id: I7bc7d7a49de746cc8fdb58a44619bc5ce66b7003
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
---
 tox.ini | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tox.ini b/tox.ini
index 8a50bb16..41314364 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,5 +1,5 @@
 [tox]
-envlist = py27,py37,pep8
+envlist = py27,py38,pep8
 minversion = 2.0
 skipsdist = True
 

From 6e000d11e45e6c6c4d7c236d3c42338d685b95ae Mon Sep 17 00:00:00 2001
From: Matthew Oliver <matt@oliver.net.au>
Date: Wed, 13 May 2020 15:36:22 +1000
Subject: [PATCH 181/316] Ussuri contrib docs community goal

This patch standardizes the CONTRIBUTING.rst file and adds the
required doc/source/contributor/contributing.rst

The contibuting.txt points to the Swift contributor documentation.

Change-Id: Ia6c105698dd0269479536645270d12a7c1061bc7
---
 CONTRIBUTING.rst                        | 25 +++++++++++++------------
 doc/source/contributor/contributing.rst | 14 ++++++++++++++
 doc/source/index.rst                    |  1 +
 3 files changed, 28 insertions(+), 12 deletions(-)
 create mode 100644 doc/source/contributor/contributing.rst

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 0bde9680..493a6c59 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -1,18 +1,19 @@
-If you would like to contribute to the development of OpenStack, you
-must follow the steps in this page:
+The source repository for this project can be found at:
 
-    https://docs.openstack.org/infra/manual/developers.html
+  https://opendev.org/openstack/python-swiftclient
 
-Once those steps have been completed, changes to OpenStack should be
-submitted for review via the Gerrit tool, following the workflow
-documented at:
+Pull requests submitted through GitHub are not monitored.
 
-    https://docs.openstack.org/infra/manual/developers.html#development-workflow
+To start contributing to OpenStack, follow the steps in the contribution guide
+to set up and use Gerrit:
 
-Gerrit is the review system used in the OpenStack projects. We're sorry,
-but we won't be able to respond to pull requests submitted through
-GitHub.
+  https://docs.openstack.org/contributors/code-and-documentation/quick-start.html
 
-Bugs should be filed on Launchpad, not Github:
+Bugs should be filed on Launchpad:
 
-    https://bugs.launchpad.net/python-swiftclient
+  https://bugs.launchpad.net/python-swiftclient
+
+For more specific information about contributing to this repository, see the
+swiftclient contributor guide:
+
+  https://docs.openstack.org/python-swiftclient/latest/contributor/contributing.html
diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst
new file mode 100644
index 00000000..b9f1e918
--- /dev/null
+++ b/doc/source/contributor/contributing.rst
@@ -0,0 +1,14 @@
+============================
+So You Want to Contribute...
+============================
+
+For general information on contributing to OpenStack, please check out the
+`contributor guide <https://docs.openstack.org/contributors/>`_ to get started.
+It covers all the basics that are common to all OpenStack projects: the
+accounts you need, the basics of interacting with our Gerrit review system, how
+we communicate as a community, etc.
+
+The python-swiftclient is maintained by the OpenStack Swift project.
+To understand our development process and how you can contribute to it, please
+look at the Swift project's general contributor's page:
+http://docs.openstack.org/swift/latest/contributor/contributing.html
\ No newline at end of file
diff --git a/doc/source/index.rst b/doc/source/index.rst
index ab05c6bd..ae309721 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -16,6 +16,7 @@ Developer Documentation
 .. toctree::
     :maxdepth: 2
 
+    contributor/contributing
     cli/index
     service-api
     client-api

From 9b6d1c7e88df409fdf272dd0a97e5f65c5fadd50 Mon Sep 17 00:00:00 2001
From: fuzihao <fuzihao@inspur.com>
Date: Wed, 20 May 2020 10:25:25 +0800
Subject: [PATCH 182/316] Fix pygments style

New theme of docs (Victoria+) respects pygments_style.
Since we starts using Victoria reqs while being on Ussuri,
this patch ensures proper rendering both in Ussuri and Victoria.

Change-Id: Iad418798277b9d7a1190e42e9079080a3d2707f3
---
 doc/source/conf.py          | 2 +-
 releasenotes/source/conf.py | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/source/conf.py b/doc/source/conf.py
index a8ad3ad7..5f88f5ac 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -88,7 +88,7 @@
 # show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = 'native'
 
 # A list of ignored prefixes for module index sorting.
 # modindex_common_prefix = []
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index c71f41d4..9bdbbe40 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -108,7 +108,7 @@
 # show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = 'native'
 
 # A list of ignored prefixes for module index sorting.
 # modindex_common_prefix = []

From 257a7185a8d5fdc11d91058f1735fa4273719aa9 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Wed, 13 May 2020 10:30:30 -0700
Subject: [PATCH 183/316] Application credential support follow-up

Following the recent v3applicationcredentials patch, if you have your
environment variables set up to work with python-openstackclient using
swiftclient's v1password plugin, swiftclient won't work:

   $ env | egrep '^(OS|ST)_'
   ST_KEY=testing
   ST_USER=test:tester
   OS_AUTH_URL=http://saio/auth/v1.0
   ST_AUTH=http://saio/auth/v1.0
   OS_USERNAME=test:tester
   OS_AUTH_TYPE=v1password
   OS_PASSWORD=testing

   $ openstack object store account show
   +------------+----------------------------+
   | Field      | Value                      |
   +------------+----------------------------+
   | Account    | AUTH_test                  |
   | Bytes      | 0                          |
   | Containers | 11                         |
   | Objects    | 0                          |
   +------------+----------------------------+

   $ swift stat
   Only "v3applicationcredential" is supported for --os-auth-type

We don't really want to allow (and mostly ignore) arbitrary OS_AUTH_TYPE
values, though -- there are a whole bunch of plugins we don't remotely
support. But it seems OK to allow any of the password plugins; while we
won't actually use them (currently), we provide roughly equivalent
functionality.

Handful of other drive-bys:
 * Use a None sentinel to determine whether keystoneauth1 is installed
   instead of trying to catch a NameError.
 * Clarify error state when keystoneauth1 is not installed.
 * Fix a typo: "sses" -> "sess".

Change-Id: Id7ea9c3ea8278ae86a04d057a472a8f8a87b8eae
Related-Change: I9190e5e7e24b6a741970fa0d0ac792deccf73d25
---
 swiftclient/client.py   | 29 +++++++++++++++++------------
 swiftclient/shell.py    | 10 ++++++----
 test/unit/test_shell.py |  2 +-
 3 files changed, 24 insertions(+), 17 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index 67440dd9..0aba6291 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -62,7 +62,7 @@ def emit(self, record):
         def createLock(self):
             self.lock = None
 
-ksexceptions = ksclient_v2 = ksclient_v3 = None
+ksexceptions = ksclient_v2 = ksclient_v3 = ksa_v3 = None
 try:
     from keystoneclient import exceptions as ksexceptions
     # prevent keystoneclient warning us that it has no log handlers
@@ -72,8 +72,8 @@ def createLock(self):
     pass
 try:
     from keystoneclient.v3 import client as ksclient_v3
-    from keystoneauth1.identity import v3
-    from keystoneauth1 import session
+    from keystoneauth1.identity import v3 as ksa_v3
+    from keystoneauth1 import session as ksa_session
     from keystoneauth1 import exceptions as ksauthexceptions
 except ImportError:
     pass
@@ -627,22 +627,27 @@ def get_auth_keystone(auth_url, user, key, os_options, **kwargs):
         filter_kwargs['attr'] = 'region'
         filter_kwargs['filter_value'] = os_options['region_name']
 
-    if os_options.get('auth_type') == 'v3applicationcredential':
-        try:
-            v3
-        except NameError:
+    if os_options.get('auth_type') and os_options['auth_type'] not in (
+            'password', 'v2password', 'v3password',
+            'v3applicationcredential'):
+        raise ClientException(
+            'Swiftclient currently only supports v3applicationcredential '
+            'for auth_type')
+    elif os_options.get('auth_type') == 'v3applicationcredential':
+        if ksa_v3 is None:
             raise ClientException('Auth v3applicationcredential requires '
-                                  'python-keystoneclient>=2.0.0')
+                                  'keystoneauth1 package; consider upgrading '
+                                  'to python-keystoneclient>=2.0.0')
 
         try:
-            auth = v3.ApplicationCredential(
+            auth = ksa_v3.ApplicationCredential(
                 auth_url=auth_url,
                 application_credential_secret=os_options.get(
                     'application_credential_secret'),
                 application_credential_id=os_options.get(
                     'application_credential_id'))
-            sses = session.Session(auth=auth)
-            token = sses.get_token()
+            sess = ksa_session.Session(auth=auth)
+            token = sess.get_token()
         except ksauthexceptions.Unauthorized:
             msg = 'Unauthorized. Check application credential id and secret.'
             raise ClientException(msg)
@@ -650,7 +655,7 @@ def get_auth_keystone(auth_url, user, key, os_options, **kwargs):
             raise ClientException('Authorization Failure. %s' % err)
 
         try:
-            endpoint = sses.get_endpoint_data(service_type=service_type,
+            endpoint = sess.get_endpoint_data(service_type=service_type,
                                               endpoint_type=endpoint_type,
                                               **filter_kwargs)
 
diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 0fef755f..b129d637 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -1651,7 +1651,12 @@ def parse_args(parser, args, enforce_requires=True):
         return options, args
 
     if enforce_requires:
-        if options['os_auth_type'] == 'v3applicationcredential':
+        if options['os_auth_type'] and options['os_auth_type'] not in (
+                'password', 'v1password', 'v2password', 'v3password',
+                'v3applicationcredential'):
+            exit('Only "v3applicationcredential" is supported for '
+                 '--os-auth-type')
+        elif options['os_auth_type'] == 'v3applicationcredential':
             if not (options['os_application_credential_id'] and
                     options['os_application_credential_secret']):
                 exit('Auth version 3 (application credential) requires '
@@ -1659,9 +1664,6 @@ def parse_args(parser, args, enforce_requires=True):
                      'OS_APPLICATION_CREDENTIAL_SECRET to be set or '
                      'overridden with --os-application-credential-id and '
                      '--os-application-credential-secret respectively.')
-        elif options['os_auth_type']:
-            exit('Only "v3applicationcredential" is supported for '
-                 '--os-auth-type')
         elif options['auth_version'] == '3':
             if not options['auth']:
                 exit('Auth version 3 requires OS_AUTH_URL to be set or '
diff --git a/test/unit/test_shell.py b/test/unit/test_shell.py
index 3c082184..f94e5e23 100644
--- a/test/unit/test_shell.py
+++ b/test/unit/test_shell.py
@@ -2721,7 +2721,7 @@ def test_insufficient_args_v3applicationcredential(self):
                       str(cm.exception))
 
         os_opts = {
-            "auth_type": "v3password",
+            "auth_type": "v3oidcpassword",
             "application_credential_id": "proejct_id",
             "application_credential_secret": "secret",
             "auth_url": "http://example.com:5000/v3"}

From d1f894c124df668b9669d64ce4970c55e9c404fd Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Tue, 2 Jun 2020 13:34:49 -0700
Subject: [PATCH 184/316] Remove references to swift-specs and blueprints

Those have been dead for a long while.

Change-Id: I21306a40479ad319c0ef48aa8bfb88f261011390
---
 README.rst | 6 +-----
 1 file changed, 1 insertion(+), 5 deletions(-)

diff --git a/README.rst b/README.rst
index 5243dd6b..c9ae3d42 100644
--- a/README.rst
+++ b/README.rst
@@ -23,7 +23,7 @@ in the `OpenStack wiki`__.
 __ https://docs.openstack.org/infra/manual/developers.html
 
 This code is based on the original client previously included with
-`OpenStack's Swift`__ The python-swiftclient is licensed under the
+`OpenStack's Swift`__. The python-swiftclient is licensed under the
 Apache License like the rest of OpenStack.
 
 __ https://github.com/openstack/swift
@@ -32,21 +32,17 @@ __ https://github.com/openstack/swift
 * `PyPI`_ - package installation
 * `Online Documentation`_
 * `Launchpad project`_ - release management
-* `Blueprints`_ - feature specifications
 * `Bugs`_ - issue tracking
 * `Source`_
-* `Specs`_
 * `How to Contribute`_
 * `Release Notes`_
 
 .. _PyPI: https://pypi.org/project/python-swiftclient
 .. _Online Documentation: https://docs.openstack.org/python-swiftclient/latest/
 .. _Launchpad project: https://launchpad.net/python-swiftclient
-.. _Blueprints: https://blueprints.launchpad.net/python-swiftclient
 .. _Bugs: https://bugs.launchpad.net/python-swiftclient
 .. _Source: https://opendev.org/openstack/python-swiftclient
 .. _How to Contribute: https://docs.openstack.org/infra/manual/developers.html
-.. _Specs: https://specs.openstack.org/openstack/swift-specs/
 .. _Release Notes: https://docs.openstack.org/releasenotes/python-swiftclient
 
 .. contents:: Contents:

From 22d1f3a39a9b23a62f443c2bd8ab9639c1b5a669 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Wed, 17 Jun 2020 21:05:03 -0700
Subject: [PATCH 185/316] Clean up some warnings

Change-Id: Iae149533d04c7b173c4ef88fb775f5fe13c16466
---
 swiftclient/utils.py    |  7 ++++--
 test/unit/test_utils.py | 52 ++++++++++++++++++++---------------------
 2 files changed, 31 insertions(+), 28 deletions(-)

diff --git a/swiftclient/utils.py b/swiftclient/utils.py
index 9e43237c..656acad4 100644
--- a/swiftclient/utils.py
+++ b/swiftclient/utils.py
@@ -14,7 +14,10 @@
 # limitations under the License.
 """Miscellaneous utility functions for use with Swift."""
 from calendar import timegm
-import collections
+try:
+    from collections.abc import Mapping
+except ImportError:
+    from collections import Mapping
 import gzip
 import hashlib
 import hmac
@@ -218,7 +221,7 @@ def parse_api_response(headers, body):
 
 def split_request_headers(options, prefix=''):
     headers = {}
-    if isinstance(options, collections.Mapping):
+    if isinstance(options, Mapping):
         options = options.items()
     for item in options:
         if isinstance(item, six.string_types):
diff --git a/test/unit/test_utils.py b/test/unit/test_utils.py
index 97abc444..cbee82bf 100644
--- a/test/unit/test_utils.py
+++ b/test/unit/test_utils.py
@@ -521,15 +521,15 @@ def test_tempfile(self):
         with tempfile.NamedTemporaryFile(mode='wb') as f:
             f.write(b'a' * 100)
             f.flush()
-            contents = open(f.name, 'rb')
-            data = u.LengthWrapper(contents, 42, True)
-            s = b'a' * 42
-            read_data = b''.join(iter(data.read, ''))
+            with open(f.name, 'rb') as contents:
+                data = u.LengthWrapper(contents, 42, True)
+                s = b'a' * 42
+                read_data = b''.join(iter(data.read, ''))
 
-            self.assertEqual(42, len(data))
-            self.assertEqual(42, len(read_data))
-            self.assertEqual(s, read_data)
-            self.assertEqual(md5(s).hexdigest(), data.get_md5sum())
+                self.assertEqual(42, len(data))
+                self.assertEqual(42, len(read_data))
+                self.assertEqual(s, read_data)
+                self.assertEqual(md5(s).hexdigest(), data.get_md5sum())
 
     def test_segmented_file(self):
         with tempfile.NamedTemporaryFile(mode='wb') as f:
@@ -539,24 +539,24 @@ def test_segmented_file(self):
                 f.write((c * segment_length).encode())
             f.flush()
             for i, c in enumerate(segments):
-                contents = open(f.name, 'rb')
-                contents.seek(i * segment_length)
-                data = u.LengthWrapper(contents, segment_length, True)
-                read_data = b''.join(iter(data.read, ''))
-                s = (c * segment_length).encode()
-
-                self.assertEqual(segment_length, len(data))
-                self.assertEqual(segment_length, len(read_data))
-                self.assertEqual(s, read_data)
-                self.assertEqual(md5(s).hexdigest(), data.get_md5sum())
-
-                data.reset()
-                self.assertEqual(md5().hexdigest(), data.get_md5sum())
-                read_data = b''.join(iter(data.read, ''))
-                self.assertEqual(segment_length, len(data))
-                self.assertEqual(segment_length, len(read_data))
-                self.assertEqual(s, read_data)
-                self.assertEqual(md5(s).hexdigest(), data.get_md5sum())
+                with open(f.name, 'rb') as contents:
+                    contents.seek(i * segment_length)
+                    data = u.LengthWrapper(contents, segment_length, True)
+                    read_data = b''.join(iter(data.read, ''))
+                    s = (c * segment_length).encode()
+
+                    self.assertEqual(segment_length, len(data))
+                    self.assertEqual(segment_length, len(read_data))
+                    self.assertEqual(s, read_data)
+                    self.assertEqual(md5(s).hexdigest(), data.get_md5sum())
+
+                    data.reset()
+                    self.assertEqual(md5().hexdigest(), data.get_md5sum())
+                    read_data = b''.join(iter(data.read, ''))
+                    self.assertEqual(segment_length, len(data))
+                    self.assertEqual(segment_length, len(read_data))
+                    self.assertEqual(s, read_data)
+                    self.assertEqual(md5(s).hexdigest(), data.get_md5sum())
 
 
 class TestGroupers(unittest.TestCase):

From 842086d27fbb8ae8b5b723a0167d33ca2050feea Mon Sep 17 00:00:00 2001
From: Meuh <fabien+swift@bagard.xyz>
Date: Tue, 28 Jul 2020 16:16:19 +0200
Subject: [PATCH 186/316] Add max_backoff and starting_backoff for get_conn in
 swift service

Change-Id: I45f5d3009e0e2015c7366384ee826113fc27c70b
---
 swiftclient/service.py | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/swiftclient/service.py b/swiftclient/service.py
index b89399fe..cd96a5b9 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -274,7 +274,7 @@ def get_conn(options):
     return Connection(options['auth'],
                       options['user'],
                       options['key'],
-                      options['retries'],
+                      retries=options['retries'],
                       auth_version=options['auth_version'],
                       os_options=options['os_options'],
                       snet=options['snet'],
@@ -283,7 +283,9 @@ def get_conn(options):
                       cert=options['os_cert'],
                       cert_key=options['os_key'],
                       ssl_compression=options['ssl_compression'],
-                      force_auth_retry=options['force_auth_retry'])
+                      force_auth_retry=options['force_auth_retry'],
+                      starting_backoff=options.get('starting_backoff', 1),
+                      max_backoff=options.get('max_backoff', 64))
 
 
 def mkdirs(path):

From 89c8d9b853aa02e0a90682d04cec2cd42f740e80 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Tue, 28 Jul 2020 11:27:33 -0700
Subject: [PATCH 187/316] Speed up test_lazy_connections

It doesn't really need to sleep a full second.

Change-Id: Ida80f0c5a983edb33a93662badb6aa1a25f9a27c
---
 test/unit/test_multithreading.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/test/unit/test_multithreading.py b/test/unit/test_multithreading.py
index 8944d48e..e9732cd8 100644
--- a/test/unit/test_multithreading.py
+++ b/test/unit/test_multithreading.py
@@ -37,7 +37,7 @@ def _func(self, conn, item, *args, **kwargs):
         self.got_args_kwargs.put((args, kwargs))
 
         if item == 'sleep':
-            sleep(1)
+            sleep(.1)
         if item == 'go boom':
             raise Exception('I went boom!')
 

From 0c70d164ba52d76a6dbbbe8765d15fb969fc07ff Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Wed, 17 Jun 2020 15:44:22 -0700
Subject: [PATCH 188/316] (Mostly) revert "Cleanup session on delete"

This reverts commit 1f26c5736949e1c3b57c024a315e33fc419f126e for py2.
Apparently the existence of the __del__ method on Python 2 prevents us
from cleaning up all file descriptors.

Change-Id: Id6cff5dd7b9faf9c4240c0cb26b74d05ed37da5b
Closes-Bug: #1873435
Related-Bug: #1838775
---
 swiftclient/client.py | 18 ++++++++++--------
 1 file changed, 10 insertions(+), 8 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index 0aba6291..5c63b606 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -443,14 +443,16 @@ def __init__(self, url, proxy=None, cacert=None, insecure=False,
         if timeout:
             self.requests_args['timeout'] = timeout
 
-    def __del__(self):
-        """Cleanup resources other than memory"""
-        if self.request_session:
-            # The session we create must be closed to free up file descriptors
-            try:
-                self.request_session.close()
-            finally:
-                self.request_session = None
+    if not six.PY2:
+        def __del__(self):
+            """Cleanup resources other than memory"""
+            if self.request_session:
+                # The session we create must be closed to free up
+                # file descriptors
+                try:
+                    self.request_session.close()
+                finally:
+                    self.request_session = None
 
     def _request(self, *arg, **kwarg):
         """Final wrapper before requests call, to be patched in tests"""

From 0f6713ed5b8cdcf5cbc0850dea224b41d90e63f4 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 14 Aug 2020 10:41:15 -0700
Subject: [PATCH 189/316] Include transaction ID in ClientException.__str__

It's fairly annoying getting a traceback in swift's probe tests then
only having a URL and status code to go searching for in logs.

Leave the shell.py output untouched, though, since we output the
transaction ID on a new line anyway.

Change-Id: Idb849848ec08b6c04812b088467c9a687c2a7e27
---
 swiftclient/exceptions.py     | 12 +++++++++++-
 swiftclient/shell.py          |  3 ++-
 test/unit/test_swiftclient.py | 17 +++++++++++++++++
 3 files changed, 30 insertions(+), 2 deletions(-)

diff --git a/swiftclient/exceptions.py b/swiftclient/exceptions.py
index da70379e..a9b993ce 100644
--- a/swiftclient/exceptions.py
+++ b/swiftclient/exceptions.py
@@ -35,6 +35,13 @@ def __init__(self, msg, http_scheme='', http_host='', http_port='',
         self.http_response_content = http_response_content
         self.http_response_headers = http_response_headers
 
+        self.transaction_id = None
+        if self.http_response_headers:
+            for header in ('X-Trans-Id', 'X-Openstack-Request-Id'):
+                if header in self.http_response_headers:
+                    self.transaction_id = self.http_response_headers[header]
+                    break
+
     @classmethod
     def from_response(cls, resp, msg=None, body=None):
         msg = msg or '%s %s' % (resp.status_code, resp.reason)
@@ -78,4 +85,7 @@ def __str__(self):
             else:
                 b += '  [first 60 chars of response] %s' \
                     % self.http_response_content[:60]
-        return b and '%s: %s' % (a, b) or a
+        c = ''
+        if self.transaction_id:
+            c = ' (txn: %s)' % self.transaction_id
+        return b and '%s: %s%s' % (a, b, c) or (a + c)
diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index b129d637..dbcd437b 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -2058,8 +2058,9 @@ def main(arguments=None):
         try:
             globals()['st_%s' % args[0]](parser, argv[1:], output)
         except ClientException as err:
+            trans_id = err.transaction_id
+            err.transaction_id = None  # clear it so we aren't overly noisy
             output.error(str(err))
-            trans_id = (err.http_response_headers or {}).get('X-Trans-Id')
             if trans_id:
                 output.error("Failed Transaction ID: %s",
                              parse_header_string(trans_id))
diff --git a/test/unit/test_swiftclient.py b/test/unit/test_swiftclient.py
index dfd79c77..2644e337 100644
--- a/test/unit/test_swiftclient.py
+++ b/test/unit/test_swiftclient.py
@@ -84,6 +84,23 @@ def test_attrs(self):
             self.assertIs(True, hasattr(exc, key))
             self.assertEqual(getattr(exc, key), value)
 
+    def test_transaction_id_from_headers(self):
+        exc = c.ClientException('test')
+        self.assertIsNone(exc.transaction_id)
+
+        exc = c.ClientException('test', http_response_headers={})
+        self.assertIsNone(exc.transaction_id)
+
+        exc = c.ClientException('test', http_response_headers={
+            'X-Trans-Id': 'some-id'})
+        self.assertEqual(exc.transaction_id, 'some-id')
+        self.assertIn('(txn: some-id)', str(exc))
+
+        exc = c.ClientException('test', http_response_headers={
+            'X-Openstack-Request-Id': 'some-other-id'})
+        self.assertEqual(exc.transaction_id, 'some-other-id')
+        self.assertIn('(txn: some-other-id)', str(exc))
+
 
 class MockHttpResponse(object):
     def __init__(self, status=0, headers=None, verify=False):

From 5cb906148709ccc74ca96463fd69a5cae2381edb Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Tue, 8 Sep 2020 12:07:48 -0700
Subject: [PATCH 190/316] Clean up some requirements

* Drop the py26 marker for futures; we don't support 2.6 anymore.
* Split hacking version used based on python version.
* Clean up sphinx split -- 2.0+ aren't available to install on py2,
  anyway.

Depends-On: https://review.opendev.org/#/c/752340/
Depends-On: https://review.opendev.org/#/c/752736/
Change-Id: I5a6ba8e65c23ada7297f6684dcbdd886591d0af5
---
 doc/requirements.txt  | 3 +--
 requirements.txt      | 2 +-
 test-requirements.txt | 3 ++-
 3 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/doc/requirements.txt b/doc/requirements.txt
index 3ee9fc2a..5700e3b1 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,5 +1,4 @@
 keystoneauth1>=3.4.0  # Apache-2.0
-sphinx!=1.6.6,!=1.6.7,<2.0.0,>=1.6.2;python_version=='2.7' # BSD
-sphinx>=2.0.0,!=2.1.0;python_version>='3.4' # BSD
+sphinx>=1.6.2,!=1.6.6,!=1.6.7,!=2.1.0,!=3.0.0  # BSD
 reno>=2.5.0 # Apache-2.0
 openstackdocstheme>=1.31.2 # Apache-2.0
diff --git a/requirements.txt b/requirements.txt
index 1c2ce33d..4757239b 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,3 +1,3 @@
-futures>=3.0.0;python_version=='2.7' or python_version=='2.6' # BSD
+futures>=3.0.0;python_version=='2.7' # BSD
 requests>=1.1.0
 six>=1.9.0
diff --git a/test-requirements.txt b/test-requirements.txt
index 5dba1a60..c2fb2c6e 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -1,4 +1,5 @@
-hacking>=1.1.0,<1.2.0 # Apache-2.0
+hacking>=1.1.0,<1.2.0;python_version<'3.0' # Apache-2.0
+hacking>=3.2.0,<3.3.0;python_version>='3.0' # Apache-2.0
 
 coverage!=4.4,>=4.0 # Apache-2.0
 keystoneauth1>=3.4.0  # Apache-2.0

From e367b6270c6d544312817ab31723aae54f4c234a Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Tue, 2 Jun 2020 19:01:07 +0200
Subject: [PATCH 191/316] Switch to newer openstackdocstheme and reno versions

Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

Disable openstackdocs_auto_name to use 'project' variable as name.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I4418f86c3066353d43758118865baf66d1741c79
---
 doc/requirements.txt        |  4 ++--
 doc/source/conf.py          | 10 ++++++----
 lower-constraints.txt       |  4 ----
 releasenotes/source/conf.py |  6 +++---
 4 files changed, 11 insertions(+), 13 deletions(-)

diff --git a/doc/requirements.txt b/doc/requirements.txt
index 5700e3b1..6894ce18 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,4 +1,4 @@
 keystoneauth1>=3.4.0  # Apache-2.0
 sphinx>=1.6.2,!=1.6.6,!=1.6.7,!=2.1.0,!=3.0.0  # BSD
-reno>=2.5.0 # Apache-2.0
-openstackdocstheme>=1.31.2 # Apache-2.0
+reno>=3.1.0 # Apache-2.0
+openstackdocstheme>=2.2.1 # Apache-2.0
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 5f88f5ac..83816050 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -55,6 +55,12 @@
 # General information about the project.
 copyright = u'2013-2016 OpenStack, LLC.'
 
+# -- Options for openstackdocstheme -------------------------------------------
+openstackdocs_repo_name = 'openstack/python-swiftclient'
+openstackdocs_bug_project = 'python-swiftclient'
+openstackdocs_bug_tag = ''
+openstackdocs_pdf_link = True
+
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 # language = None
@@ -131,10 +137,6 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-# html_last_updated_fmt = '%b %d, %Y'
-
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
 # html_use_smartypants = True
diff --git a/lower-constraints.txt b/lower-constraints.txt
index 1e4ffb90..28a10600 100644
--- a/lower-constraints.txt
+++ b/lower-constraints.txt
@@ -20,7 +20,6 @@ MarkupSafe==1.0
 mccabe==0.2.1
 mock==1.2.0
 netaddr==0.7.10
-openstackdocstheme==2.0.0
 openstacksdk==0.11.0
 oslo.config==1.2.0
 pbr==2.0.0
@@ -33,12 +32,9 @@ python-mimeparse==1.6.0
 python-subunit==1.0.0
 pytz==2013.6
 PyYAML==3.12
-reno==2.5.0
 requests==1.1.0
 six==1.9.0
 snowballstemmer==1.2.1
-sphinx==2.0.0
-sphinxcontrib-websupport==1.0.1
 stestr==2.0.0
 testtools==2.2.0
 traceback2==1.4.0
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index 9bdbbe40..a050a546 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -339,6 +339,6 @@
 locale_dirs = ['locale/']
 
 # -- Options for openstackdocstheme -------------------------------------------
-repository_name = 'openstack/python-swiftclient'
-bug_project = 'python-swiftclient'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/python-swiftclient'
+openstackdocs_bug_project = 'python-swiftclient'
+openstackdocs_bug_tag = ''

From 9f69908f759daafc99a162b136b24570a2822ee2 Mon Sep 17 00:00:00 2001
From: Ghanshyam Mann <gmann@ghanshyammann.com>
Date: Fri, 18 Sep 2020 16:01:28 -0500
Subject: [PATCH 192/316] [goal] Migrate testing to ubuntu focal

As per victoria cycle testing runtime and community goal[1]
we need to migrate upstream CI/CD to Ubuntu Focal(20.04).

- Keep py2 functional job run on Bionic node

Story: #2007865
Task: #40221

Change-Id: I578abeb1552d73a2e5c5a24ba7afab975508ea0c
---
 .zuul.yaml | 1 +
 1 file changed, 1 insertion(+)

diff --git a/.zuul.yaml b/.zuul.yaml
index 87ac54b8..334eefc8 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -27,6 +27,7 @@
 - job:
     name: swiftclient-functional-py2
     parent: swiftclient-functional
+    nodeset: openstack-single-node-bionic
     description: |
       Run functional tests of python-swiftclient under Python 2
     vars:

From 16b377c62304c5a4f9f02cd9985534e60a04725b Mon Sep 17 00:00:00 2001
From: OpenStack Release Bot <infra-root@openstack.org>
Date: Fri, 11 Sep 2020 18:40:16 +0000
Subject: [PATCH 193/316] Update master for stable/victoria

Add file to the reno documentation build to show release notes for
stable/victoria.

Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/victoria.

Change-Id: Ic1dc50f7e9d0b38f04a114eb22de25466ba83e56
Sem-Ver: feature
---
 releasenotes/source/index.rst    | 1 +
 releasenotes/source/victoria.rst | 6 ++++++
 2 files changed, 7 insertions(+)
 create mode 100644 releasenotes/source/victoria.rst

diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst
index d46593b0..a63715f1 100644
--- a/releasenotes/source/index.rst
+++ b/releasenotes/source/index.rst
@@ -6,6 +6,7 @@
    :maxdepth: 1
 
    current
+   victoria
    ussuri
    train
    stein
diff --git a/releasenotes/source/victoria.rst b/releasenotes/source/victoria.rst
new file mode 100644
index 00000000..4efc7b6f
--- /dev/null
+++ b/releasenotes/source/victoria.rst
@@ -0,0 +1,6 @@
+=============================
+Victoria Series Release Notes
+=============================
+
+.. release-notes::
+   :branch: stable/victoria

From 5728bf4a502ba11689ec9a600670539898a8bf9c Mon Sep 17 00:00:00 2001
From: OpenStack Release Bot <infra-root@openstack.org>
Date: Fri, 11 Sep 2020 18:40:19 +0000
Subject: [PATCH 194/316] Add Python3 wallaby unit tests

This is an automatically generated patch to ensure unit testing
is in place for all the of the tested runtimes for wallaby.

See also the PTI in governance [1].

[1]: https://governance.openstack.org/tc/reference/project-testing-interface.html

Change-Id: I9a2e832e8165232c15731cfb97d401c84abf95c0
---
 .zuul.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index 87ac54b8..29f58ae0 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -38,7 +38,7 @@
       - lib-forward-testing-python3
       - openstack-lower-constraints-jobs
       - openstack-python-jobs
-      - openstack-python3-victoria-jobs
+      - openstack-python3-wallaby-jobs
       - publish-openstack-docs-pti
       - release-notes-jobs-python3
     check:

From c73792c2e55e4fbdff78a192a991e064a317e840 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Mon, 21 Sep 2020 16:40:05 -0700
Subject: [PATCH 195/316] tests: Make test_delete_container_versions less
 flakey

Hammering that test in a tight loop, I'd often see failures due to
ordering issues. Make the delete single-threaded to avoid that.

Change-Id: Iff45be32a7c3f258214cce78001fd33ad0a39b8c
---
 test/unit/test_shell.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/test/unit/test_shell.py b/test/unit/test_shell.py
index f94e5e23..46ba52ca 100644
--- a/test/unit/test_shell.py
+++ b/test/unit/test_shell.py
@@ -1547,7 +1547,7 @@ def test_delete_container_versions(self, connection):
             [None, []],
         ]
         connection.return_value.attempts = 0
-        argv = ["", "delete", "--versions", "container"]
+        argv = ["", "delete", "--versions", "container", "--object-threads=1"]
         connection.return_value.head_object.return_value = {}
         swiftclient.shell.main(argv)
         connection.return_value.delete_container.assert_called_with(

From 97aa3e65412ee241fce7721927b0b003daf51ed4 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Sat, 18 Apr 2020 22:41:55 -0700
Subject: [PATCH 196/316] Close connections created when calling module-level
 functions

Co-Authored-By: Clay Gerrard <clay.gerrard@gmail.com>
Change-Id: Id62e63afc6f2ffa32eb8640787c78559481050f9
Related-Change: I200ad0cdc8b7999c3f5521b9a822122bd18714bf
Related-Bug: #1873435
Closes-Bug: #1838775
---
 swiftclient/client.py         | 87 ++++++++++++++++++++++++++++-------
 test/unit/test_swiftclient.py |  1 +
 test/unit/utils.py            |  6 ++-
 3 files changed, 75 insertions(+), 19 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index 5c63b606..544247a6 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -268,7 +268,7 @@ class _ObjectBody(object):
     Readable and iterable object body response wrapper.
     """
 
-    def __init__(self, resp, chunk_size):
+    def __init__(self, resp, chunk_size, conn_to_close):
         """
         Wrap the underlying response
 
@@ -277,9 +277,13 @@ def __init__(self, resp, chunk_size):
         """
         self.resp = resp
         self.chunk_size = chunk_size
+        self.conn_to_close = conn_to_close
 
     def read(self, length=None):
-        return self.resp.read(length)
+        buf = self.resp.read(length)
+        if length != 0 and not buf:
+            self.close()
+        return buf
 
     def __iter__(self):
         return self
@@ -295,6 +299,8 @@ def __next__(self):
 
     def close(self):
         self.resp.close()
+        if self.conn_to_close:
+            self.conn_to_close.close()
 
 
 class _RetryBody(_ObjectBody):
@@ -320,7 +326,7 @@ def __init__(self, resp, connection, container, obj,
         :param headers: an optional dictionary with additional headers to
                          include in the request
         """
-        super(_RetryBody, self).__init__(resp, resp_chunk_size)
+        super(_RetryBody, self).__init__(resp, resp_chunk_size, None)
         self.expected_length = int(self.resp.getheader('Content-Length'))
         self.conn = connection
         self.container = container
@@ -443,17 +449,6 @@ def __init__(self, url, proxy=None, cacert=None, insecure=False,
         if timeout:
             self.requests_args['timeout'] = timeout
 
-    if not six.PY2:
-        def __del__(self):
-            """Cleanup resources other than memory"""
-            if self.request_session:
-                # The session we create must be closed to free up
-                # file descriptors
-                try:
-                    self.request_session.close()
-                finally:
-                    self.request_session = None
-
     def _request(self, *arg, **kwarg):
         """Final wrapper before requests call, to be patched in tests"""
         return self.request_session.request(*arg, **kwarg)
@@ -515,7 +510,7 @@ def releasing_read(*args, **kwargs):
                 # urllib3's connection pool. This will reduce the number of
                 # log messages seen in bug #1341777. This does not actually
                 # close a socket. It will also prevent people from being
-                # mislead as to the cause of a bug as in bug #1424732.
+                # misled as to the cause of a bug as in bug #1424732.
                 self.resp.close()
             return chunk
 
@@ -845,8 +840,10 @@ def get_account(url, token, marker=None, limit=None, prefix=None,
     if headers:
         req_headers.update(headers)
 
+    close_conn = False
     if not http_conn:
         http_conn = http_connection(url)
+        close_conn = True
     if full_listing:
         rv = get_account(url, token, marker, limit, prefix, end_marker,
                          http_conn, headers=req_headers, delimiter=delimiter)
@@ -876,6 +873,8 @@ def get_account(url, token, marker=None, limit=None, prefix=None,
     conn.request(method, full_path, '', req_headers)
     resp = conn.getresponse()
     body = resp.read()
+    if close_conn:
+        conn.close()
     http_log(("%s?%s" % (url, qs), method,), {'headers': req_headers},
              resp, body)
 
@@ -902,10 +901,12 @@ def head_account(url, token, http_conn=None, headers=None,
               be lowercase)
     :raises ClientException: HTTP HEAD request failed
     """
+    close_conn = False
     if http_conn:
         parsed, conn = http_conn
     else:
         parsed, conn = http_connection(url)
+        close_conn = True
     method = "HEAD"
     req_headers = {'X-Auth-Token': token}
     if service_token:
@@ -916,6 +917,8 @@ def head_account(url, token, http_conn=None, headers=None,
     conn.request(method, parsed.path, '', req_headers)
     resp = conn.getresponse()
     body = resp.read()
+    if close_conn:
+        conn.close()
     http_log((url, method,), {'headers': req_headers}, resp, body)
     if resp.status < 200 or resp.status >= 300:
         raise ClientException.from_response(resp, 'Account HEAD failed', body)
@@ -941,10 +944,12 @@ def post_account(url, token, headers, http_conn=None, response_dict=None,
     :raises ClientException: HTTP POST request failed
     :returns: resp_headers, body
     """
+    close_conn = False
     if http_conn:
         parsed, conn = http_conn
     else:
         parsed, conn = http_connection(url)
+        close_conn = True
     method = 'POST'
     path = parsed.path
     if query_string:
@@ -957,6 +962,8 @@ def post_account(url, token, headers, http_conn=None, response_dict=None,
     conn.request(method, path, data, req_headers)
     resp = conn.getresponse()
     body = resp.read()
+    if close_conn:
+        conn.close()
     http_log((url, method,), {'headers': req_headers}, resp, body)
 
     store_response(resp, response_dict)
@@ -998,8 +1005,10 @@ def get_container(url, token, container, marker=None, limit=None,
               headers will be a dict and all header names will be lowercase.
     :raises ClientException: HTTP GET request failed
     """
+    close_conn = False
     if not http_conn:
         http_conn = http_connection(url)
+        close_conn = True
     if full_listing:
         rv = get_container(url, token, container, marker, limit, prefix,
                            delimiter, end_marker, version_marker, path=path,
@@ -1048,6 +1057,8 @@ def get_container(url, token, container, marker=None, limit=None,
     conn.request(method, '%s?%s' % (cont_path, qs), '', req_headers)
     resp = conn.getresponse()
     body = resp.read()
+    if close_conn:
+        conn.close()
     http_log(('%(url)s%(cont_path)s?%(qs)s' %
               {'url': url.replace(parsed.path, ''),
                'cont_path': cont_path,
@@ -1078,10 +1089,12 @@ def head_container(url, token, container, http_conn=None, headers=None,
               be lowercase)
     :raises ClientException: HTTP HEAD request failed
     """
+    close_conn = False
     if http_conn:
         parsed, conn = http_conn
     else:
         parsed, conn = http_connection(url)
+        close_conn = True
     path = '%s/%s' % (parsed.path, quote(container))
     method = 'HEAD'
     req_headers = {'X-Auth-Token': token}
@@ -1092,6 +1105,8 @@ def head_container(url, token, container, http_conn=None, headers=None,
     conn.request(method, path, '', req_headers)
     resp = conn.getresponse()
     body = resp.read()
+    if close_conn:
+        conn.close()
     http_log(('%s%s' % (url.replace(parsed.path, ''), path), method,),
              {'headers': req_headers}, resp, body)
 
@@ -1119,10 +1134,12 @@ def put_container(url, token, container, headers=None, http_conn=None,
     :param query_string: if set will be appended with '?' to generated path
     :raises ClientException: HTTP PUT request failed
     """
+    close_conn = False
     if http_conn:
         parsed, conn = http_conn
     else:
         parsed, conn = http_connection(url)
+        close_conn = True
     path = '%s/%s' % (parsed.path, quote(container))
     method = 'PUT'
     req_headers = {'X-Auth-Token': token}
@@ -1137,6 +1154,8 @@ def put_container(url, token, container, headers=None, http_conn=None,
     conn.request(method, path, '', req_headers)
     resp = conn.getresponse()
     body = resp.read()
+    if close_conn:
+        conn.close()
 
     store_response(resp, response_dict)
 
@@ -1162,10 +1181,12 @@ def post_container(url, token, container, headers, http_conn=None,
     :param service_token: service auth token
     :raises ClientException: HTTP POST request failed
     """
+    close_conn = False
     if http_conn:
         parsed, conn = http_conn
     else:
         parsed, conn = http_connection(url)
+        close_conn = True
     path = '%s/%s' % (parsed.path, quote(container))
     method = 'POST'
     req_headers = {'X-Auth-Token': token}
@@ -1178,6 +1199,8 @@ def post_container(url, token, container, headers, http_conn=None,
     conn.request(method, path, '', req_headers)
     resp = conn.getresponse()
     body = resp.read()
+    if close_conn:
+        conn.close()
     http_log(('%s%s' % (url.replace(parsed.path, ''), path), method,),
              {'headers': req_headers}, resp, body)
 
@@ -1206,10 +1229,12 @@ def delete_container(url, token, container, http_conn=None,
     :param headers: additional headers to include in the request
     :raises ClientException: HTTP DELETE request failed
     """
+    close_conn = False
     if http_conn:
         parsed, conn = http_conn
     else:
         parsed, conn = http_connection(url)
+        close_conn = True
     path = '%s/%s' % (parsed.path, quote(container))
     if headers:
         headers = dict(headers)
@@ -1225,6 +1250,8 @@ def delete_container(url, token, container, http_conn=None,
     conn.request(method, path, '', headers)
     resp = conn.getresponse()
     body = resp.read()
+    if close_conn:
+        conn.close()
     http_log(('%s%s' % (url.replace(parsed.path, ''), path), method,),
              {'headers': headers}, resp, body)
 
@@ -1246,7 +1273,8 @@ def get_object(url, token, container, name, http_conn=None,
     :param container: container name that the object is in
     :param name: object name to get
     :param http_conn: a tuple of (parsed url, HTTPConnection object),
-                      (If None, it will create the conn object)
+                      (If None, it will create the conn object and close it
+                      after all content is read)
     :param resp_chunk_size: if defined, chunk size of data to read. NOTE: If
                             you specify a resp_chunk_size you must fully read
                             the object's contents before making another
@@ -1261,10 +1289,12 @@ def get_object(url, token, container, name, http_conn=None,
               headers will be a dict and all header names will be lowercase.
     :raises ClientException: HTTP GET request failed
     """
+    close_conn = False
     if http_conn:
         parsed, conn = http_conn
     else:
         parsed, conn = http_connection(url)
+        close_conn = True
     path = '%s/%s/%s' % (parsed.path, quote(container), quote(name))
     if query_string:
         path += '?' + query_string
@@ -1287,9 +1317,12 @@ def get_object(url, token, container, name, http_conn=None,
                  {'headers': headers}, resp, body)
         raise ClientException.from_response(resp, 'Object GET failed', body)
     if resp_chunk_size:
-        object_body = _ObjectBody(resp, resp_chunk_size)
+        object_body = _ObjectBody(resp, resp_chunk_size,
+                                  conn_to_close=conn if close_conn else None)
     else:
         object_body = resp.read()
+        if close_conn:
+            conn.close()
     http_log(('%s%s' % (url.replace(parsed.path, ''), path), method,),
              {'headers': headers}, resp, None)
 
@@ -1313,10 +1346,12 @@ def head_object(url, token, container, name, http_conn=None,
               be lowercase)
     :raises ClientException: HTTP HEAD request failed
     """
+    close_conn = False
     if http_conn:
         parsed, conn = http_conn
     else:
         parsed, conn = http_connection(url)
+        close_conn = True
     path = '%s/%s/%s' % (parsed.path, quote(container), quote(name))
     if query_string:
         path += '?' + query_string
@@ -1331,6 +1366,8 @@ def head_object(url, token, container, name, http_conn=None,
     conn.request(method, path, '', headers)
     resp = conn.getresponse()
     body = resp.read()
+    if close_conn:
+        conn.close()
     http_log(('%s%s' % (url.replace(parsed.path, ''), path), method,),
              {'headers': headers}, resp, body)
     if resp.status < 200 or resp.status >= 300:
@@ -1380,10 +1417,12 @@ def put_object(url, token=None, container=None, name=None, contents=None,
     :returns: etag
     :raises ClientException: HTTP PUT request failed
     """
+    close_conn = False
     if http_conn:
         parsed, conn = http_conn
     else:
         parsed, conn = http_connection(url, proxy=proxy)
+        close_conn = True
     path = parsed.path
     if container:
         path = '%s/%s' % (path.rstrip('/'), quote(container))
@@ -1442,6 +1481,8 @@ def put_object(url, token=None, container=None, name=None, contents=None,
 
     resp = conn.getresponse()
     body = resp.read()
+    if close_conn:
+        conn.close()
     http_log(('%s%s' % (url.replace(parsed.path, ''), path), 'PUT',),
              {'headers': headers}, resp, body)
 
@@ -1471,10 +1512,12 @@ def post_object(url, token, container, name, headers, http_conn=None,
     :param service_token: service auth token
     :raises ClientException: HTTP POST request failed
     """
+    close_conn = False
     if http_conn:
         parsed, conn = http_conn
     else:
         parsed, conn = http_connection(url)
+        close_conn = True
     path = '%s/%s/%s' % (parsed.path, quote(container), quote(name))
     req_headers = {'X-Auth-Token': token}
     if service_token:
@@ -1484,6 +1527,8 @@ def post_object(url, token, container, name, headers, http_conn=None,
     conn.request('POST', path, '', req_headers)
     resp = conn.getresponse()
     body = resp.read()
+    if close_conn:
+        conn.close()
     http_log(('%s%s' % (url.replace(parsed.path, ''), path), 'POST',),
              {'headers': req_headers}, resp, body)
 
@@ -1516,10 +1561,12 @@ def copy_object(url, token, container, name, destination=None,
     :param service_token: service auth token
     :raises ClientException: HTTP COPY request failed
     """
+    close_conn = False
     if http_conn:
         parsed, conn = http_conn
     else:
         parsed, conn = http_connection(url)
+        close_conn = True
 
     path = parsed.path
     container = quote(container)
@@ -1548,6 +1595,8 @@ def copy_object(url, token, container, name, destination=None,
     conn.request('COPY', path, '', headers)
     resp = conn.getresponse()
     body = resp.read()
+    if close_conn:
+        conn.close()
     http_log(('%s%s' % (url.replace(parsed.path, ''), path), 'COPY',),
              {'headers': headers}, resp, body)
 
@@ -1580,10 +1629,12 @@ def delete_object(url, token=None, container=None, name=None, http_conn=None,
     :param service_token: service auth token
     :raises ClientException: HTTP DELETE request failed
     """
+    close_conn = False
     if http_conn:
         parsed, conn = http_conn
     else:
         parsed, conn = http_connection(url, proxy=proxy)
+        close_conn = True
     path = parsed.path
     if container:
         path = '%s/%s' % (path.rstrip('/'), quote(container))
@@ -1602,6 +1653,8 @@ def delete_object(url, token=None, container=None, name=None, http_conn=None,
     conn.request('DELETE', path, '', headers)
     resp = conn.getresponse()
     body = resp.read()
+    if close_conn:
+        conn.close()
     http_log(('%s%s' % (url.replace(parsed.path, ''), path), 'DELETE',),
              {'headers': headers}, resp, body)
 
diff --git a/test/unit/test_swiftclient.py b/test/unit/test_swiftclient.py
index dfd79c77..bfeb61b9 100644
--- a/test/unit/test_swiftclient.py
+++ b/test/unit/test_swiftclient.py
@@ -785,6 +785,7 @@ def test_ok(self):
         self.assertRequests([
             ('HEAD', 'http://www.tests.com', '', {'x-auth-token': 'asdf'})
         ])
+        self.assertTrue(self.request_log[-1][-1]._closed)
 
     def test_server_error(self):
         body = 'c' * 65
diff --git a/test/unit/utils.py b/test/unit/utils.py
index 025a2342..3190e9d2 100644
--- a/test/unit/utils.py
+++ b/test/unit/utils.py
@@ -109,6 +109,7 @@ def __init__(self, status, etag=None, body='', timestamp='1',
             self.timestamp = timestamp
             self.headers = headers or {}
             self.request = None
+            self._closed = False
 
         def getresponse(self):
             if kwargs.get('raise_exc'):
@@ -167,7 +168,7 @@ def getheader(self, name, default=None):
             return dict(self.getheaders()).get(name.lower(), default)
 
         def close(self):
-            pass
+            self._closed = True
 
     timestamps_iter = iter(kwargs.get('timestamps') or ['1'] * len(code_iter))
     etag_iter = iter(kwargs.get('etags') or [None] * len(code_iter))
@@ -248,7 +249,8 @@ def wrapper(url, proxy=None, cacert=None, insecure=False,
 
                 class RequestsWrapper(object):
                     def close(self):
-                        pass
+                        if hasattr(self, 'resp'):
+                            self.resp.close()
                 conn = RequestsWrapper()
 
                 def request(method, path, *args, **kwargs):

From de5c74069e9fe0e7ae6b696bbd2900a7c853e960 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Thu, 15 Oct 2020 10:13:21 -0700
Subject: [PATCH 197/316] Remove some py38 job cruft

For a time, we wanted to flag it as being voting while it still wasn't
voting for most of OpenStack. It's not needed now, though.

Change-Id: Idccb731a0814335fc4d314eed5caa1f336212b22
---
 .zuul.yaml | 4 ----
 1 file changed, 4 deletions(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index 480c1a81..86654ba1 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -47,15 +47,11 @@
         - swiftclient-swift-functional
         - swiftclient-functional
         - swiftclient-functional-py2
-        - openstack-tox-py38:
-            voting: true
     gate:
       jobs:
         - swiftclient-swift-functional
         - swiftclient-functional
         - swiftclient-functional-py2
-        - openstack-tox-py38:
-            voting: true
     post:
       jobs:
         - openstack-tox-cover

From 74c50dee2de1fdda0d58cc295a70c7ff7d1700e6 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 3 Apr 2020 09:34:38 -0700
Subject: [PATCH 198/316] Have `delete --all` imply `--versions` for the CLI

Change-Id: Id5a6d4cef3d4ed76c897a099a62a4ba3ed8f8dab
---
 swiftclient/shell.py    | 6 ++++--
 test/unit/test_shell.py | 5 ++---
 2 files changed, 6 insertions(+), 5 deletions(-)

diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index dbcd437b..7c6f0f74 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -78,8 +78,8 @@ def immediate_exit(signum, frame):
                         for multiple objects.
 
 Optional arguments:
-  -a, --all             Delete all containers and objects.
-  --versions            Delete all versions
+  -a, --all             Delete all containers and objects. Implies --versions.
+  --versions            Delete all versions.
   --leave-segments      Do not delete segments of manifest objects.
   -H, --header <header:value>
                         Adds a custom request header to use for deleting
@@ -132,6 +132,8 @@ def st_delete(parser, args, output_manager, return_parser=False):
 
     (options, args) = parse_args(parser, args)
     args = args[1:]
+    if options['yes_all']:
+        options['versions'] = True
     if (not args and not options['yes_all']) or (args and options['yes_all']):
         output_manager.error('Usage: %s delete %s\n%s',
                              BASENAME, st_delete_options,
diff --git a/test/unit/test_shell.py b/test/unit/test_shell.py
index 46ba52ca..8c525d9a 100644
--- a/test/unit/test_shell.py
+++ b/test/unit/test_shell.py
@@ -1260,8 +1260,7 @@ def test_delete_account(self, connection):
             [None, [{'name': 'empty_container'}]],
             [None, []],
         ]
-        # N.B: missing --versions flag, version-id gets ignored
-        # only latest object is deleted
+        # N.B: --all implies --versions, clear it all out
         connection.return_value.get_container.side_effect = [
             [None, [{'name': 'object'}, {'name': 'obj\xe9ct2'}]],
             [None, []],
@@ -1279,7 +1278,7 @@ def test_delete_account(self, connection):
                       response_dict={}, headers={}),
             mock.call('container', 'obj\xe9ct2', query_string='',
                       response_dict={}, headers={}),
-            mock.call('container2', 'object', query_string='',
+            mock.call('container2', 'object', query_string='version-id=1',
                       response_dict={}, headers={})], any_order=True)
         self.assertEqual(3, connection.return_value.delete_object.call_count,
                          'Expected 3 calls but found\n%r'

From a5aebc3b9ae39d65ba6c7a744637796700fbad4e Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Mon, 19 Oct 2020 11:05:49 -0700
Subject: [PATCH 199/316] Make py39 voting

Also, add trove classifier for py39.

Depends-On: https://review.opendev.org/#/c/758813/
Change-Id: I8d33b4dd6af990b09141acd52d36e44e9c871b3b
---
 .zuul.yaml | 4 ++++
 setup.cfg  | 1 +
 2 files changed, 5 insertions(+)

diff --git a/.zuul.yaml b/.zuul.yaml
index 86654ba1..3eac7537 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -47,11 +47,15 @@
         - swiftclient-swift-functional
         - swiftclient-functional
         - swiftclient-functional-py2
+        - openstack-tox-py39:
+            voting: true
     gate:
       jobs:
         - swiftclient-swift-functional
         - swiftclient-functional
         - swiftclient-functional-py2
+        - openstack-tox-py39:
+            voting: true
     post:
       jobs:
         - openstack-tox-cover
diff --git a/setup.cfg b/setup.cfg
index 95801a88..a9a59405 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -20,6 +20,7 @@ classifier =
     Programming Language :: Python :: 3.6
     Programming Language :: Python :: 3.7
     Programming Language :: Python :: 3.8
+    Programming Language :: Python :: 3.9
 
 [files]
 packages =

From e6876361f079e9ccd526958e005258bdc68273e9 Mon Sep 17 00:00:00 2001
From: zhangboye <zhangboye@inspur.com>
Date: Sun, 3 Jan 2021 16:44:04 +0800
Subject: [PATCH 200/316] remove unicode from code

Change-Id: I791cc993aef832b30c08fdb5bdd7165a074d263f
---
 doc/source/conf.py          |  6 +++---
 releasenotes/source/conf.py | 12 ++++++------
 2 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/doc/source/conf.py b/doc/source/conf.py
index 83816050..2673d6c5 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -53,7 +53,7 @@
 master_doc = 'index'
 
 # General information about the project.
-copyright = u'2013-2016 OpenStack, LLC.'
+copyright = '2013-2016 OpenStack, LLC.'
 
 # -- Options for openstackdocstheme -------------------------------------------
 openstackdocs_repo_name = 'openstack/python-swiftclient'
@@ -183,8 +183,8 @@
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual])
 latex_documents = [
-    ('index', 'doc-python-swiftclient.tex', u'SwiftClient Documentation',
-     u'OpenStack, LLC.', 'manual'),
+    ('index', 'doc-python-swiftclient.tex', 'SwiftClient Documentation',
+     'OpenStack, LLC.', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index a050a546..0945c81e 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -65,7 +65,7 @@
 master_doc = 'index'
 
 # General information about the project.
-copyright = u'%d, OpenStack Foundation' % datetime.datetime.now().year
+copyright = '%d, OpenStack Foundation' % datetime.datetime.now().year
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -138,7 +138,7 @@
 # The name for this set of Sphinx documents.
 # "<project> v<release> documentation" by default.
 #
-# html_title = u'swift v2.10.0'
+# html_title = 'swift v2.10.0'
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #
@@ -258,8 +258,8 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 # latex_documents = [
-#     (master_doc, 'swift.tex', u'swift Documentation',
-#      u'swift', 'manual'),
+#     (master_doc, 'swift.tex', 'swift Documentation',
+#      'swift', 'manual'),
 # ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -300,7 +300,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 # man_pages = [
-#     (master_doc, 'swift', u'swift Documentation',
+#     (master_doc, 'swift', 'swift Documentation',
 #      [author], 1)
 # ]
 
@@ -315,7 +315,7 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 # texinfo_documents = [
-#     (master_doc, 'swift', u'swift Documentation',
+#     (master_doc, 'swift', 'swift Documentation',
 #      author, 'swift', 'One line description of project.',
 #      'Miscellaneous'),
 # ]

From 06b36ae0e2ee6054162bfb1d9f3cdda39eacbad5 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Mon, 22 Feb 2021 12:21:43 -0800
Subject: [PATCH 201/316] Drop lower-constraints testing

The OpenStack community consensus seems to be that it's not worth the
hassle of fixing. *Maybe* we can revisit this if we ever drop py2
support?

Reasonable spot to start on ML threads:
http://lists.openstack.org/pipermail/openstack-discuss/2021-January/019672.html

Change-Id: Ibf0c891782afe014cc453b713a94c187340d172e
Depends-On: https://review.opendev.org/c/openstack/requirements/+/777025
---
 .zuul.yaml            |  3 ++-
 lower-constraints.txt | 42 ------------------------------------------
 tox.ini               |  7 -------
 3 files changed, 2 insertions(+), 50 deletions(-)
 delete mode 100644 lower-constraints.txt

diff --git a/.zuul.yaml b/.zuul.yaml
index 3eac7537..fb27594f 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -23,6 +23,8 @@
     vars:
       # Override value from parent job to use swiftclient tests
       zuul_work_dir: "{{ zuul.projects['opendev.org/openstack/python-swiftclient'].src_dir }}"
+      # swift can use different tox env names
+      tox_envlist: func
 
 - job:
     name: swiftclient-functional-py2
@@ -37,7 +39,6 @@
     templates:
       - check-requirements
       - lib-forward-testing-python3
-      - openstack-lower-constraints-jobs
       - openstack-python-jobs
       - openstack-python3-wallaby-jobs
       - publish-openstack-docs-pti
diff --git a/lower-constraints.txt b/lower-constraints.txt
deleted file mode 100644
index 28a10600..00000000
--- a/lower-constraints.txt
+++ /dev/null
@@ -1,42 +0,0 @@
-alabaster==0.7.10
-Babel==2.3.4
-certifi==2018.1.18
-chardet==3.0.4
-coverage==4.0
-docutils==0.11
-dulwich==0.15.0
-extras==1.0.0
-fixtures==3.0.0
-flake8==2.2.4
-futures==3.0.0
-hacking==0.10.0
-idna==2.6
-imagesize==0.7.1
-iso8601==0.1.8
-Jinja2==2.10
-keystoneauth1==3.4.0
-linecache2==1.0.0
-MarkupSafe==1.0
-mccabe==0.2.1
-mock==1.2.0
-netaddr==0.7.10
-openstacksdk==0.11.0
-oslo.config==1.2.0
-pbr==2.0.0
-pep8==1.5.7
-PrettyTable==0.7.1
-pyflakes==0.8.1
-Pygments==2.2.0
-python-keystoneclient==0.7.0
-python-mimeparse==1.6.0
-python-subunit==1.0.0
-pytz==2013.6
-PyYAML==3.12
-requests==1.1.0
-six==1.9.0
-snowballstemmer==1.2.1
-stestr==2.0.0
-testtools==2.2.0
-traceback2==1.4.0
-unittest2==1.1.0
-urllib3==1.22
diff --git a/tox.ini b/tox.ini
index 41314364..0837a063 100644
--- a/tox.ini
+++ b/tox.ini
@@ -102,13 +102,6 @@ usedevelop = False
 deps = -r{toxinidir}/doc/requirements.txt
 commands = sphinx-build -a -W -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
 
-[testenv:lower-constraints]
-basepython = python3
-deps =
-  -c{toxinidir}/lower-constraints.txt
-  -r{toxinidir}/test-requirements.txt
-  .[keystone]
-
 [testenv:pdf-docs]
 basepython = python3
 deps = {[testenv:docs]deps}

From c8b48dee58ef25b3ff86b47f4194a197d1bc4cdd Mon Sep 17 00:00:00 2001
From: OpenStack Release Bot <infra-root@openstack.org>
Date: Thu, 18 Mar 2021 11:11:36 +0000
Subject: [PATCH 202/316] Update master for stable/wallaby

Add file to the reno documentation build to show release notes for
stable/wallaby.

Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/wallaby.

Sem-Ver: feature
Change-Id: Idcc50c36c1fac81ed214bcbaf6a97307e3db7ee7
---
 releasenotes/source/index.rst   | 1 +
 releasenotes/source/wallaby.rst | 6 ++++++
 2 files changed, 7 insertions(+)
 create mode 100644 releasenotes/source/wallaby.rst

diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst
index a63715f1..52c38140 100644
--- a/releasenotes/source/index.rst
+++ b/releasenotes/source/index.rst
@@ -6,6 +6,7 @@
    :maxdepth: 1
 
    current
+   wallaby
    victoria
    ussuri
    train
diff --git a/releasenotes/source/wallaby.rst b/releasenotes/source/wallaby.rst
new file mode 100644
index 00000000..d77b5659
--- /dev/null
+++ b/releasenotes/source/wallaby.rst
@@ -0,0 +1,6 @@
+============================
+Wallaby Series Release Notes
+============================
+
+.. release-notes::
+   :branch: stable/wallaby

From 6966fbea57e9fefbd944ed080db384b6c2a9a390 Mon Sep 17 00:00:00 2001
From: OpenStack Release Bot <infra-root@openstack.org>
Date: Thu, 18 Mar 2021 11:11:42 +0000
Subject: [PATCH 203/316] Add Python3 xena unit tests

This is an automatically generated patch to ensure unit testing
is in place for all the of the tested runtimes for xena.

See also the PTI in governance [1].

[1]: https://governance.openstack.org/tc/reference/project-testing-interface.html

Change-Id: Ic272b2583f9e0ff5f1b542ce9596af9d3bf8edef
---
 .zuul.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index fb27594f..7badb0ec 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -40,7 +40,7 @@
       - check-requirements
       - lib-forward-testing-python3
       - openstack-python-jobs
-      - openstack-python3-wallaby-jobs
+      - openstack-python3-xena-jobs
       - publish-openstack-docs-pti
       - release-notes-jobs-python3
     check:

From 998bb8b578019df3a7b229eac806287f3fd32069 Mon Sep 17 00:00:00 2001
From: zhangboye <zhangboye@inspur.com>
Date: Tue, 20 Apr 2021 15:11:00 +0800
Subject: [PATCH 204/316] Use py3 as the default runtime for tox

Moving on py3 as the default runtime for tox to avoid to update
this at each new cycle.

Change-Id: I4a54455e7e8b1b4de2f9656d13f65ef090da68eb
---
 tox.ini | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tox.ini b/tox.ini
index 0837a063..10e7b8d4 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,5 +1,5 @@
 [tox]
-envlist = py27,py38,pep8
+envlist = py27,py3,pep8
 minversion = 2.0
 skipsdist = True
 

From 58f0700ad93c4cfaf3f924fa3ca1c405470d93d6 Mon Sep 17 00:00:00 2001
From: jonasdlindner <jonaslindner55@gmail.com>
Date: Thu, 29 Apr 2021 17:39:28 +0200
Subject: [PATCH 205/316] Fix Typo in shell.py

Change-Id: I2615e0d6b54d8cc020c24d1b5b4064e038f0934b
---
 swiftclient/shell.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 7c6f0f74..43950e6c 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -2012,7 +2012,7 @@ def main(arguments=None):
 
   %(prog)s --os-auth-url https://api.example.com/v3 --auth-version 3\\
       --os-application-credential-id d78683c92f0e4f9b9b02a2e208039412 \\
-      --os-application-credential-secret APPLICTION_CREDENTIAL_SECRET \\
+      --os-application-credential-secret APPLICATION_CREDENTIAL_SECRET \\
       --os-auth-type v3applicationcredential list
 
   %(prog)s --os-auth-token 6ee5eb33efad4e45ab46806eac010566 \\

From 2beddc2f30c601d1cbbb15cb8c2d69b0776df093 Mon Sep 17 00:00:00 2001
From: yangyawei <yangyawei@inspur.com>
Date: Mon, 3 May 2021 10:51:06 +0800
Subject: [PATCH 206/316] setup.cfg: Replace dashes with underscores

Setuptools v54.1.0 introduces a warning that the use of dash-separated
options in 'setup.cfg' will not be supported in a future version [1].
Get ahead of the issue by replacing the dashes with underscores. Without
this, we see 'UserWarning' messages like the following on new enough
versions of setuptools:

  UserWarning: Usage of dash-separated 'description-file' will not be
  supported in future versions. Please use the underscore name
  'description_file' instead

[1] https://github.com/pypa/setuptools/commit/a2e9ae4cb

Change-Id: Ief2c7a217914dc5cacdffc6959ed0585fc6a1225
---
 setup.cfg | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/setup.cfg b/setup.cfg
index a9a59405..c780c388 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -1,11 +1,11 @@
 [metadata]
 name = python-swiftclient
 summary = OpenStack Object Storage API Client Library
-description-file =
+description_file =
     README.rst
 author = OpenStack
-author-email = openstack-discuss@lists.openstack.org
-home-page = https://docs.openstack.org/python-swiftclient/latest/
+author_email = openstack-discuss@lists.openstack.org
+home_page = https://docs.openstack.org/python-swiftclient/latest/
 classifier =
     Environment :: OpenStack
     Intended Audience :: Information Technology

From 99b5b81217abdfc4b7a8c388242aaf50c64f1f5b Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Mon, 10 May 2021 22:51:22 -0700
Subject: [PATCH 207/316] Allow unit tests to be run via pytest

You can run all tests by just running

   $ pytest

Or just unit tests with

   $ pytest test/unit/

Or one specific test with

   $ pytest test/unit/test_swiftclient.py::TestConnection::test_reauth

Change-Id: I1dfa239f9ee9ea85663b5c1f22631a97f87b4dfc
---
 test/unit/test_shell.py | 52 ++++++++++++++++++++++++-----------------
 1 file changed, 30 insertions(+), 22 deletions(-)

diff --git a/test/unit/test_shell.py b/test/unit/test_shell.py
index 8c525d9a..ef5d1669 100644
--- a/test/unit/test_shell.py
+++ b/test/unit/test_shell.py
@@ -28,7 +28,6 @@
 from time import localtime, mktime, strftime, strptime
 
 import six
-import sys
 
 import swiftclient
 from swiftclient.service import SwiftError
@@ -1155,9 +1154,12 @@ def test_upload_segments_to_same_container(self, connection):
                      'x-object-meta-mtime': mock.ANY},
             response_dict={})
 
+    @mock.patch('swiftclient.shell.stdin')
     @mock.patch('swiftclient.shell.io.open')
     @mock.patch('swiftclient.service.SwiftService.upload')
-    def test_upload_from_stdin(self, upload_mock, io_open_mock):
+    def test_upload_from_stdin(self, upload_mock, io_open_mock, stdin_mock):
+        stdin_mock.fileno.return_value = 123
+
         def fake_open(fd, mode):
             mock_io = mock.Mock()
             mock_io.fileno.return_value = fd
@@ -1173,8 +1175,8 @@ def fake_open(fd, mode):
         # element.  This is because the upload method takes a container and a
         # list of SwiftUploadObjects.
         swift_upload_obj = upload_mock.mock_calls[0][1][1][0]
-        self.assertEqual(sys.stdin.fileno(), swift_upload_obj.source.fileno())
-        io_open_mock.assert_called_once_with(sys.stdin.fileno(), mode='rb')
+        self.assertEqual(123, swift_upload_obj.source.fileno())
+        io_open_mock.assert_called_once_with(123, mode='rb')
 
     @mock.patch('swiftclient.service.SwiftService.upload')
     def test_upload_from_stdin_no_name(self, upload_mock):
@@ -3015,24 +3017,30 @@ def _test_options(self, opts, os_opts, flags=None, no_auth=False):
                                                   no_auth=no_auth)
 
     def test_all_args_passed_to_keystone(self):
-        # check that all possible command line args are passed to keystone
-        opts = {'auth-version': '3'}
-        os_opts = dict(self.all_os_opts)
-        os_opts.update(self.catalog_opts)
-        self._test_options(opts, os_opts, flags=self.flags)
-
-        opts = {'auth-version': '2.0'}
-        self._test_options(opts, os_opts, flags=self.flags)
-
-        opts = {}
-        self.defaults['auth-version'] = '3'
-        self._test_options(opts, os_opts, flags=self.flags)
-
-        for o in ('user-domain-name', 'user-domain-id',
-                  'project-domain-name', 'project-domain-id'):
-            os_opts.pop(o)
-        self.defaults['auth-version'] = '2.0'
-        self._test_options(opts, os_opts, flags=self.flags)
+        rootLogger = logging.getLogger()
+        orig_lvl = rootLogger.getEffectiveLevel()
+        try:
+            rootLogger.setLevel(logging.DEBUG)
+            # check that all possible command line args are passed to keystone
+            opts = {'auth-version': '3'}
+            os_opts = dict(self.all_os_opts)
+            os_opts.update(self.catalog_opts)
+            self._test_options(opts, os_opts, flags=self.flags)
+
+            opts = {'auth-version': '2.0'}
+            self._test_options(opts, os_opts, flags=self.flags)
+
+            opts = {}
+            self.defaults['auth-version'] = '3'
+            self._test_options(opts, os_opts, flags=self.flags)
+
+            for o in ('user-domain-name', 'user-domain-id',
+                      'project-domain-name', 'project-domain-id'):
+                os_opts.pop(o)
+            self.defaults['auth-version'] = '2.0'
+            self._test_options(opts, os_opts, flags=self.flags)
+        finally:
+            rootLogger.setLevel(orig_lvl)
 
     def test_catalog_options_and_flags_not_required_v3(self):
         # check that all possible command line args are passed to keystone

From 6d8138ebcf3cc7cc3c50cf8c06b58d5369d5c395 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Tue, 11 May 2021 13:42:47 -0700
Subject: [PATCH 208/316] Allow functional tests to pass with etag_quoter
 enabled by default

Change-Id: I861b5e0a172f0ea0a5b1fe8389cd70da8d4b5d5d
---
 test/functional/test_swiftclient.py | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/test/functional/test_swiftclient.py b/test/functional/test_swiftclient.py
index aaade879..8d001d0f 100644
--- a/test/functional/test_swiftclient.py
+++ b/test/functional/test_swiftclient.py
@@ -207,7 +207,7 @@ def test_upload_object(self):
         hdrs = self.conn.head_object(self.containername, self.objectname)
         self.assertEqual(str(len(self.test_data)),
                          hdrs.get('content-length'))
-        self.assertEqual(self.etag, hdrs.get('etag'))
+        self.assertEqual(self.etag, hdrs.get('etag').strip('"'))
         self.assertEqual('application/octet-stream',
                          hdrs.get('content-type'))
 
@@ -218,7 +218,7 @@ def test_upload_object(self):
         hdrs = self.conn.head_object(self.containername, self.objectname)
         self.assertEqual(str(len(self.test_data)),
                          hdrs.get('content-length'))
-        self.assertEqual(self.etag, hdrs.get('etag'))
+        self.assertEqual(self.etag, hdrs.get('etag').strip('"'))
         self.assertEqual('text/plain',
                          hdrs.get('content-type'))
 
@@ -229,7 +229,7 @@ def test_upload_object(self):
         hdrs = self.conn.head_object(self.containername, self.objectname)
         self.assertEqual(str(len(self.test_data)),
                          hdrs.get('content-length'))
-        self.assertEqual(self.etag, hdrs.get('etag'))
+        self.assertEqual(self.etag, hdrs.get('etag').strip('"'))
         self.assertEqual('text/plain',
                          hdrs.get('content-type'))
 
@@ -241,7 +241,7 @@ def test_upload_object(self):
         hdrs = self.conn.head_object(self.containername, self.objectname)
         self.assertEqual(str(len(self.test_data)),
                          hdrs.get('content-length'))
-        self.assertEqual(self.etag, hdrs.get('etag'))
+        self.assertEqual(self.etag, hdrs.get('etag').strip('"'))
         self.assertEqual('image/jpeg',
                          hdrs.get('content-type'))
 
@@ -252,7 +252,7 @@ def test_upload_object(self):
         hdrs = self.conn.head_object(self.containername, self.objectname)
         self.assertEqual(str(len(self.test_data)),
                          hdrs.get('content-length'))
-        self.assertEqual(self.etag, hdrs.get('etag'))
+        self.assertEqual(self.etag, hdrs.get('etag').strip('"'))
         self.assertEqual('application/octet-stream', hdrs.get('content-type'))
 
         # Content from File-like object
@@ -262,7 +262,7 @@ def test_upload_object(self):
         hdrs = self.conn.head_object(self.containername, self.objectname)
         self.assertEqual(str(len(self.test_data)),
                          hdrs.get('content-length'))
-        self.assertEqual(self.etag, hdrs.get('etag'))
+        self.assertEqual(self.etag, hdrs.get('etag').strip('"'))
         self.assertEqual('application/octet-stream', hdrs.get('content-type'))
 
         # Content from File-like object, but read in chunks
@@ -274,7 +274,7 @@ def test_upload_object(self):
         hdrs = self.conn.head_object(self.containername, self.objectname)
         self.assertEqual(str(len(self.test_data)),
                          hdrs.get('content-length'))
-        self.assertEqual(self.etag, hdrs.get('etag'))
+        self.assertEqual(self.etag, hdrs.get('etag').strip('"'))
         self.assertEqual('application/octet-stream', hdrs.get('content-type'))
 
         # Wrong etag arg, should raise an exception

From abda44a87dd2bdee23edd69d78df7259017162d9 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Tue, 25 May 2021 11:01:01 -0700
Subject: [PATCH 209/316] Use upper-constraints for docs jobs

Looks like there are some issues with too-new-Sphinx and the PDF docs
builds.

Also, get devstack installing on bionic again for our py2 func test job.

Change-Id: I633398054694fe6ba1e0de50278f274daf69fefd
---
 .zuul.yaml | 4 ++++
 tox.ini    | 6 ++++--
 2 files changed, 8 insertions(+), 2 deletions(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index 7badb0ec..a389849a 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -33,6 +33,10 @@
     description: |
       Run functional tests of python-swiftclient under Python 2
     vars:
+      devstack_localrc:
+        # devstack dropped support for bionic, but we want it for easier py2 support.
+        # Set this so we install anyway.
+        FORCE: "yes"
       tox_envlist: py2func
 
 - project:
diff --git a/tox.ini b/tox.ini
index 10e7b8d4..287a244c 100644
--- a/tox.ini
+++ b/tox.ini
@@ -65,7 +65,8 @@ commands = {[testenv:func]commands}
 [testenv:docs]
 basepython = python3
 usedevelop = False
-deps = -r{toxinidir}/doc/requirements.txt
+deps = -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
+       -r{toxinidir}/doc/requirements.txt
 commands=
     sphinx-build -W -b html doc/source doc/build/html -W
 
@@ -99,7 +100,8 @@ commands = bindep test
 [testenv:releasenotes]
 basepython = python3
 usedevelop = False
-deps = -r{toxinidir}/doc/requirements.txt
+deps = -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
+       -r{toxinidir}/doc/requirements.txt
 commands = sphinx-build -a -W -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
 
 [testenv:pdf-docs]

From b846071d2fbc22e0fc2f471d8f2e0bc8c912ff1f Mon Sep 17 00:00:00 2001
From: "wu.shiming" <wushiming@yovole.com>
Date: Tue, 6 Jul 2021 16:10:09 +0800
Subject: [PATCH 210/316] Changed minversion in tox to 3.18.0

The patch bumps min version of tox to 3.18.0 in order to
replace tox's whitelist_externals by allowlist_externals option:
https://github.com/tox-dev/tox/blob/master/docs/changelog.rst#v3180-2020-07-23

Change-Id: I244d98bb3fc7cb75624b598f4d26f784159f5428
---
 tox.ini | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/tox.ini b/tox.ini
index 287a244c..fbc58c78 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,6 +1,6 @@
 [tox]
 envlist = py27,py3,pep8
-minversion = 2.0
+minversion = 3.18.0
 skipsdist = True
 
 [testenv]
@@ -17,7 +17,7 @@ commands = sh -c '(find . -not \( -type d -name .?\* -prune \) \
            \( -type d -name "__pycache__" -or -type f -name "*.py[co]" \) \
            -print0) | xargs -0 rm -rf'
            stestr run {posargs}
-whitelist_externals = sh
+allowlist_externals = sh
 passenv = SWIFT_* *_proxy
 
 [testenv:pep8]
@@ -45,7 +45,7 @@ basepython = python3
 setenv =
     OS_TEST_PATH=test.functional
     PYTHON=coverage run --source swiftclient --parallel-mode
-whitelist_externals =
+allowlist_externals =
     coverage
     rm
 commands =
@@ -59,7 +59,7 @@ commands =
 [testenv:py2func]
 basepython=python2
 setenv = {[testenv:func]setenv}
-whitelist_externals = {[testenv:func]whitelist_externals}
+allowlist_externals = {[testenv:func]allowlist_externals}
 commands = {[testenv:func]commands}
 
 [testenv:docs]
@@ -107,7 +107,7 @@ commands = sphinx-build -a -W -E -d releasenotes/build/doctrees -b html releasen
 [testenv:pdf-docs]
 basepython = python3
 deps = {[testenv:docs]deps}
-whitelist_externals =
+allowlist_externals =
   make
 commands =
   sphinx-build -W -b latex doc/source doc/build/pdf

From afa2c4642a467862a34dea48dc2bd4c9203c6a2a Mon Sep 17 00:00:00 2001
From: jinyuanliu <liujinyuan@inspur.com>
Date: Wed, 15 Sep 2021 01:54:42 -0400
Subject: [PATCH 211/316] Clean up extra spaces

Although these errors are not important, they affect the code specification.

Change-Id: Ifab29d9c803a78ee994b99b4b410893864b90908
---
 run_tests.sh | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/run_tests.sh b/run_tests.sh
index 39ce1915..6991cd1d 100755
--- a/run_tests.sh
+++ b/run_tests.sh
@@ -18,7 +18,7 @@ command -v tox > /dev/null 2>&1
 if [ $? -ne 0 ]; then
   echo 'This script requires "tox" to run.'
   echo 'You can install it with "pip install tox".'
-  exit 1; 
+  exit 1;
 fi
 
 just_pep8=0

From 218676a9905f1fb4d96214831d98c1b2e3924071 Mon Sep 17 00:00:00 2001
From: OpenStack Release Bot <infra-root@openstack.org>
Date: Fri, 10 Sep 2021 15:16:54 +0000
Subject: [PATCH 212/316] Update master for stable/xena

Add file to the reno documentation build to show release notes for
stable/xena.

Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/xena.

Sem-Ver: feature
Change-Id: I79a7fbda1ea9ae034d009c54be4b401809183c42
---
 releasenotes/source/index.rst | 1 +
 releasenotes/source/xena.rst  | 6 ++++++
 2 files changed, 7 insertions(+)
 create mode 100644 releasenotes/source/xena.rst

diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst
index 52c38140..fb60ee00 100644
--- a/releasenotes/source/index.rst
+++ b/releasenotes/source/index.rst
@@ -6,6 +6,7 @@
    :maxdepth: 1
 
    current
+   xena
    wallaby
    victoria
    ussuri
diff --git a/releasenotes/source/xena.rst b/releasenotes/source/xena.rst
new file mode 100644
index 00000000..1be85be3
--- /dev/null
+++ b/releasenotes/source/xena.rst
@@ -0,0 +1,6 @@
+=========================
+Xena Series Release Notes
+=========================
+
+.. release-notes::
+   :branch: stable/xena

From bcf19d47a3e040f3af1c63ebbfd81f372e784cb3 Mon Sep 17 00:00:00 2001
From: OpenStack Release Bot <infra-root@openstack.org>
Date: Fri, 10 Sep 2021 15:16:57 +0000
Subject: [PATCH 213/316] Add Python3 yoga unit tests

This is an automatically generated patch to ensure unit testing
is in place for all the of the tested runtimes for yoga.

See also the PTI in governance [1].

[1]: https://governance.openstack.org/tc/reference/project-testing-interface.html

Change-Id: Icf192aedeadf7fbed6e0f217da5b348172dc4478
---
 .zuul.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index a389849a..e26260a8 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -44,7 +44,7 @@
       - check-requirements
       - lib-forward-testing-python3
       - openstack-python-jobs
-      - openstack-python3-xena-jobs
+      - openstack-python3-yoga-jobs
       - publish-openstack-docs-pti
       - release-notes-jobs-python3
     check:

From 553e34ebfe891fe234abd722ceeba0809775a175 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Mon, 20 Sep 2021 12:33:16 -0700
Subject: [PATCH 214/316] Improve formatting for billions of objects

Change-Id: If8aa08c4c8c8ad6ca2c861602baf1eefa8642a8a
---
 swiftclient/shell.py    |  4 ++--
 test/unit/test_shell.py | 16 +++++++++-------
 2 files changed, 11 insertions(+), 9 deletions(-)

diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 43950e6c..cf90ffcf 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -552,7 +552,7 @@ def _print_stats(options, stats, human):
                         datestamp = '????-??-?? ??:??:??'
                     if not options['totals']:
                         output_manager.print_msg(
-                            "%5s %s %s %s", count, byte_str,
+                            "%12s %s %s %s", count, byte_str,
                             datestamp, item_name)
                 else:    # list container contents
                     subdir = item.get('subdir')
@@ -584,7 +584,7 @@ def _print_stats(options, stats, human):
         if options['long'] or human:
             if not container:
                 output_manager.print_msg(
-                    "%5s %s", prt_bytes(total_count, True),
+                    "%12s %s", prt_bytes(total_count, True),
                     prt_bytes(total_bytes, human))
             else:
                 output_manager.print_msg(
diff --git a/test/unit/test_shell.py b/test/unit/test_shell.py
index 8c525d9a..84dd681e 100644
--- a/test/unit/test_shell.py
+++ b/test/unit/test_shell.py
@@ -475,9 +475,10 @@ def test_list_account_long(self, connection):
                      mock.call(marker='container', prefix=None, headers={})]
             connection.return_value.get_account.assert_has_calls(calls)
 
-            self.assertEqual(output.out,
-                             '    0    0 1970-01-01 00:00:01 container\n'
-                             '    0    0\n')
+            self.assertEqual(
+                output.out,
+                '           0    0 1970-01-01 00:00:01 container\n'
+                '           0    0\n')
 
         # Now test again, this time without returning metadata
         connection.return_value.head_container.return_value = {}
@@ -495,9 +496,10 @@ def test_list_account_long(self, connection):
                      mock.call(marker='container', prefix=None, headers={})]
             connection.return_value.get_account.assert_has_calls(calls)
 
-            self.assertEqual(output.out,
-                             '    0    0 ????-??-?? ??:??:?? container\n'
-                             '    0    0\n')
+            self.assertEqual(
+                output.out,
+                '           0    0 ????-??-?? ??:??:?? container\n'
+                '           0    0\n')
 
     def test_list_account_totals_error(self):
         # No --lh provided: expect info message about incorrect --totals use
@@ -523,7 +525,7 @@ def test_list_account_totals(self, connection):
             swiftclient.shell.main(argv)
             calls = [mock.call(marker='', prefix=None, headers={})]
             connection.return_value.get_account.assert_has_calls(calls)
-            self.assertEqual(output.out, '    6    3\n')
+            self.assertEqual(output.out, '           6    3\n')
 
     @mock.patch('swiftclient.service.Connection')
     def test_list_container(self, connection):

From 5129b33505691f5c4a3e33f2878b157cbd5b4a62 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Mon, 20 Sep 2021 12:35:37 -0700
Subject: [PATCH 215/316] Only log the traceback for non-404s

Change-Id: I08ba4a3120e99b444b13f1ca6f5493529868df26
---
 swiftclient/service.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/swiftclient/service.py b/swiftclient/service.py
index cd96a5b9..8e2c7b00 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -1036,8 +1036,8 @@ def _list_container_job(conn, container, options, result_queue):
                 version_marker = items[-1].get('version_id', '')
         except ClientException as err:
             traceback, err_time = report_traceback()
-            logger.exception(err)
             if err.http_status != 404:
+                logger.exception(err)
                 error = (err, traceback, err_time)
             else:
                 error = (

From ad3e8e49d072d8137c85c451db427d07e1301799 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Thu, 8 Apr 2021 17:16:05 -0700
Subject: [PATCH 216/316] Include storage policy when listing account with
 --long

Change-Id: Ibc2f9445b5a8e80cfb73d0706e20a7e4c62eec4a
---
 swiftclient/shell.py    |  5 +++--
 test/unit/test_shell.py | 20 ++++++++++++--------
 2 files changed, 15 insertions(+), 10 deletions(-)

diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index cf90ffcf..18782720 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -550,10 +550,11 @@ def _print_stats(options, stats, human):
                         datestamp = strftime('%Y-%m-%d %H:%M:%S', utc)
                     except TypeError:
                         datestamp = '????-??-?? ??:??:??'
+                    storage_policy = meta.get('x-storage-policy', '???')
                     if not options['totals']:
                         output_manager.print_msg(
-                            "%12s %s %s %s", count, byte_str,
-                            datestamp, item_name)
+                            "%12s %s %s %-15s %s", count, byte_str,
+                            datestamp, storage_policy, item_name)
                 else:    # list container contents
                     subdir = item.get('subdir')
                     content_type = item.get('content_type')
diff --git a/test/unit/test_shell.py b/test/unit/test_shell.py
index 84dd681e..0cf2258d 100644
--- a/test/unit/test_shell.py
+++ b/test/unit/test_shell.py
@@ -467,6 +467,10 @@ def test_list_account_long(self, connection):
             [None, [{'name': 'container', 'bytes': 0, 'count': 0}]],
             [None, []],
         ]
+        connection.return_value.head_container.return_value = {
+            'x-timestamp': '1617393213.49752',
+            'x-storage-policy': 'some-policy',
+        }
 
         argv = ["", "list", "--lh"]
         with CaptureOutput() as output:
@@ -475,10 +479,10 @@ def test_list_account_long(self, connection):
                      mock.call(marker='container', prefix=None, headers={})]
             connection.return_value.get_account.assert_has_calls(calls)
 
-            self.assertEqual(
-                output.out,
-                '           0    0 1970-01-01 00:00:01 container\n'
-                '           0    0\n')
+        self.assertEqual(
+            output.out,
+            '           0    0 2021-04-02 19:53:33 some-policy     container\n'
+            '           0    0\n')
 
         # Now test again, this time without returning metadata
         connection.return_value.head_container.return_value = {}
@@ -496,10 +500,10 @@ def test_list_account_long(self, connection):
                      mock.call(marker='container', prefix=None, headers={})]
             connection.return_value.get_account.assert_has_calls(calls)
 
-            self.assertEqual(
-                output.out,
-                '           0    0 ????-??-?? ??:??:?? container\n'
-                '           0    0\n')
+        self.assertEqual(
+            output.out,
+            '           0    0 ????-??-?? ??:??:?? ???             container\n'
+            '           0    0\n')
 
     def test_list_account_totals_error(self):
         # No --lh provided: expect info message about incorrect --totals use

From 373fa26ce1620d096918bd34ea4983b8ca96898c Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Tue, 21 Sep 2021 16:02:47 -0700
Subject: [PATCH 217/316] Correctly aggregate totals for >10k items

Previously, we would write out totals for every page of listings, like

    $ swift list sync --prefix=09-21 --total -l
     80000000000
     80000000000
     80000000000
     58096000000

Now, roll those all into a single total:

    $ swift list sync --prefix=09-21 --total -l
    298096000000

Change-Id: Icc265636815220e33e8c9eec0a3ab80e9f899038
---
 swiftclient/shell.py    | 32 +++++++++++++++++---------------
 test/unit/test_shell.py | 13 +++++++++----
 2 files changed, 26 insertions(+), 19 deletions(-)

diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index cf90ffcf..fed0ef95 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -531,8 +531,7 @@ def st_download(parser, args, output_manager, return_parser=False):
 
 def st_list(parser, args, output_manager, return_parser=False):
 
-    def _print_stats(options, stats, human):
-        total_count = total_bytes = 0
+    def _print_stats(options, stats, human, totals):
         container = stats.get("container", None)
         for item in stats["listing"]:
             item_name = item.get('name')
@@ -543,7 +542,7 @@ def _print_stats(options, stats, human):
                     item_bytes = item.get('bytes')
                     byte_str = prt_bytes(item_bytes, human)
                     count = item.get('count')
-                    total_count += count
+                    totals['count'] += count
                     try:
                         meta = item.get('meta')
                         utc = gmtime(float(meta.get('x-timestamp')))
@@ -578,17 +577,7 @@ def _print_stats(options, stats, human):
                             output_manager.print_msg(
                                 "%s %10s %8s %24s %s",
                                 byte_str, date, xtime, content_type, item_name)
-                total_bytes += item_bytes
-
-        # report totals
-        if options['long'] or human:
-            if not container:
-                output_manager.print_msg(
-                    "%12s %s", prt_bytes(total_count, True),
-                    prt_bytes(total_bytes, human))
-            else:
-                output_manager.print_msg(
-                    prt_bytes(total_bytes, human))
+                totals['bytes'] += item_bytes
 
     parser.add_argument(
         '-l', '--long', dest='long', action='store_true', default=False,
@@ -642,6 +631,7 @@ def _print_stats(options, stats, human):
         try:
             if not args:
                 stats_parts_gen = swift.list()
+                container = None
             else:
                 container = args[0]
                 args = args[1:]
@@ -667,12 +657,24 @@ def listing(stats_parts_gen=stats_parts_gen):
                     sort_keys=True, indent=2)
                 output_manager.print_msg('')
                 return
+
+            totals = {'count': 0, 'bytes': 0}
             for stats in stats_parts_gen:
                 if stats["success"]:
-                    _print_stats(options, stats, human)
+                    _print_stats(options, stats, human, totals)
                 else:
                     raise stats["error"]
 
+            # report totals
+            if options['long'] or human:
+                if container is None:
+                    output_manager.print_msg(
+                        "%12s %s", prt_bytes(totals['count'], True),
+                        prt_bytes(totals['bytes'], human))
+                else:
+                    output_manager.print_msg(
+                        prt_bytes(totals['bytes'], human))
+
         except SwiftError as e:
             output_manager.error(e.value)
 
diff --git a/test/unit/test_shell.py b/test/unit/test_shell.py
index 84dd681e..84793ae5 100644
--- a/test/unit/test_shell.py
+++ b/test/unit/test_shell.py
@@ -547,9 +547,12 @@ def test_list_container(self, connection):
 
             self.assertEqual(output.out, 'object_a\n')
 
-        # Test container listing with --long
+        # Test container listing with --long and multiple pages
         connection.return_value.get_container.side_effect = [
-            [None, [{'name': 'object_a', 'bytes': 0,
+            [None, [{'name': 'object_a', 'bytes': 3,
+                     'content_type': 'type/content',
+                     'last_modified': '123T456'}]],
+            [None, [{'name': 'object_b', 'bytes': 5,
                      'content_type': 'type/content',
                      'last_modified': '123T456'}]],
             [None, []],
@@ -567,9 +570,11 @@ def test_list_container(self, connection):
             connection.return_value.get_container.assert_has_calls(calls)
 
             self.assertEqual(output.out,
-                             '           0        123      456'
+                             '           3        123      456'
                              '             type/content object_a\n'
-                             '           0\n')
+                             '           5        123      456'
+                             '             type/content object_b\n'
+                             '           8\n')
 
     @mock.patch('swiftclient.service.Connection')
     def test_list_container_with_headers(self, connection):

From f1858d89e0e1889664ced654755c508f47a0c1f3 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Tue, 11 Jan 2022 16:05:39 -0800
Subject: [PATCH 218/316] Add option to skip container PUT during upload

Currently, a user with read/write access to a container (but without
access to creat new containers) recieves a warning every time they
upload. Now, allow them to avoid the extra request and warning by
specifying --skip-container-put on the command line.

This is also useful when testing: developers can HEAD a container to
ensure it's in memcache, shut down all container servers, then upload
and creaate a bunch of async pendings. Previously, the 503 on container
PUT would prevent the object upload from even being attempted.

Closes-Bug: 1317956
Related-Bug: 1204558
Change-Id: I3d9129a0b6b65c6c6187ae6af003b221afceef47
Related-Change: If1f8a02ee7459ea2158ffa6e958f67d299ec529e
---
 swiftclient/service.py  | 95 ++++++++++++++++++++++-------------------
 swiftclient/shell.py    | 13 ++++--
 test/unit/test_shell.py | 42 ++++++++++++++++++
 3 files changed, 102 insertions(+), 48 deletions(-)

diff --git a/swiftclient/service.py b/swiftclient/service.py
index 8e2c7b00..685b7482 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -202,6 +202,7 @@ def _build_default_global_options():
     'leave_segments': False,
     'changed': None,
     'skip_identical': False,
+    'skip_container_put': False,
     'version_id': None,
     'yes_all': False,
     'read_acl': None,
@@ -1462,6 +1463,7 @@ def upload(self, container, objects, options=None):
                                 'leave_segments': False,
                                 'changed': None,
                                 'skip_identical': False,
+                                'skip_container_put': False,
                                 'fail_fast': False,
                                 'dir_marker': False  # Only for None sources
                             }
@@ -1487,54 +1489,57 @@ def upload(self, container, objects, options=None):
         # the object name. (same as passing --object-name).
         container, _sep, pseudo_folder = container.partition('/')
 
-        # Try to create the container, just in case it doesn't exist. If this
-        # fails, it might just be because the user doesn't have container PUT
-        # permissions, so we'll ignore any error. If there's really a problem,
-        # it'll surface on the first object PUT.
-        policy_header = {}
-        _header = split_headers(options["header"])
-        if POLICY in _header:
-            policy_header[POLICY] = \
-                _header[POLICY]
-        create_containers = [
-            self.thread_manager.container_pool.submit(
-                self._create_container_job, container, headers=policy_header)
-        ]
+        if not options['skip_container_put']:
+            # Try to create the container, just in case it doesn't exist. If
+            # this fails, it might just be because the user doesn't have
+            # container PUT permissions, so we'll ignore any error. If there's
+            # really a problem, it'll surface on the first object PUT.
+            policy_header = {}
+            _header = split_headers(options["header"])
+            if POLICY in _header:
+                policy_header[POLICY] = \
+                    _header[POLICY]
+            create_containers = [
+                self.thread_manager.container_pool.submit(
+                    self._create_container_job, container,
+                    headers=policy_header)
+            ]
 
-        # wait for first container job to complete before possibly attempting
-        # segment container job because segment container job may attempt
-        # to HEAD the first container
-        for r in interruptable_as_completed(create_containers):
-            res = r.result()
-            yield res
+            # wait for first container job to complete before possibly
+            # attempting segment container job because segment container job
+            # may attempt to HEAD the first container
+            for r in interruptable_as_completed(create_containers):
+                res = r.result()
+                yield res
 
-        if segment_size:
-            seg_container = container + '_segments'
-            if options['segment_container']:
-                seg_container = options['segment_container']
-            if seg_container != container:
-                if not policy_header:
-                    # Since no storage policy was specified on the command
-                    # line, rather than just letting swift pick the default
-                    # storage policy, we'll try to create the segments
-                    # container with the same policy as the upload container
-                    create_containers = [
-                        self.thread_manager.container_pool.submit(
-                            self._create_container_job, seg_container,
-                            policy_source=container
-                        )
-                    ]
-                else:
-                    create_containers = [
-                        self.thread_manager.container_pool.submit(
-                            self._create_container_job, seg_container,
-                            headers=policy_header
-                        )
-                    ]
+            if segment_size:
+                seg_container = container + '_segments'
+                if options['segment_container']:
+                    seg_container = options['segment_container']
+                if seg_container != container:
+                    if not policy_header:
+                        # Since no storage policy was specified on the command
+                        # line, rather than just letting swift pick the default
+                        # storage policy, we'll try to create the segments
+                        # container with the same policy as the upload
+                        # container
+                        create_containers = [
+                            self.thread_manager.container_pool.submit(
+                                self._create_container_job, seg_container,
+                                policy_source=container
+                            )
+                        ]
+                    else:
+                        create_containers = [
+                            self.thread_manager.container_pool.submit(
+                                self._create_container_job, seg_container,
+                                headers=policy_header
+                            )
+                        ]
 
-                for r in interruptable_as_completed(create_containers):
-                    res = r.result()
-                    yield res
+                    for r in interruptable_as_completed(create_containers):
+                        res = r.result()
+                        yield res
 
         # We maintain a results queue here and a separate thread to monitor
         # the futures because we want to get results back from potential
diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 6da9d667..76473fd6 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -985,8 +985,9 @@ def st_copy(parser, args, output_manager, return_parser=False):
 st_upload_options = '''[--changed] [--skip-identical] [--segment-size <size>]
                     [--segment-container <container>] [--leave-segments]
                     [--object-threads <thread>] [--segment-threads <threads>]
-                    [--meta <name:value>] [--header <header>] [--use-slo]
-                    [--ignore-checksum] [--object-name <object-name>]
+                    [--meta <name:value>] [--header <header>]
+                    [--use-slo] [--ignore-checksum] [--skip-container-put]
+                    [--object-name <object-name>]
                     <container> <file_or_directory> [<file_or_directory>] [...]
 '''
 
@@ -1032,11 +1033,13 @@ def st_copy(parser, args, output_manager, return_parser=False):
   --use-slo             When used in conjunction with --segment-size it will
                         create a Static Large Object instead of the default
                         Dynamic Large Object.
+  --ignore-checksum     Turn off checksum validation for uploads.
+  --skip-container-put  Assume all necessary containers already exist; don't
+                        automatically try to create them.
   --object-name <object-name>
                         Upload file and name object to <object-name> or upload
                         dir and use <object-name> as object prefix instead of
                         folder name.
-  --ignore-checksum     Turn off checksum validation for uploads.
 '''.strip('\n')
 
 
@@ -1051,6 +1054,10 @@ def st_upload(parser, args, output_manager, return_parser=False):
         '--skip-identical', action='store_true', dest='skip_identical',
         default=False, help='Skip uploading files that are identical on '
         'both sides.')
+    parser.add_argument(
+        '--skip-container-put', action='store_true', dest='skip_container_put',
+        default=False, help='Assume all necessary containers already exist; '
+        "don't automatically try to create them.")
     parser.add_argument(
         '-S', '--segment-size', dest='segment_size', help='Upload files '
         'in segments no larger than <size> (in Bytes) and then create a '
diff --git a/test/unit/test_shell.py b/test/unit/test_shell.py
index 295c918a..2331eaa0 100644
--- a/test/unit/test_shell.py
+++ b/test/unit/test_shell.py
@@ -912,6 +912,48 @@ def test_upload(self, connection, walk):
             query_string='multipart-manifest=put',
             response_dict=mock.ANY)
 
+    @mock.patch('swiftclient.shell.walk')
+    @mock.patch('swiftclient.service.Connection')
+    def test_upload_skip_container_put(self, connection, walk):
+        connection.return_value.head_object.return_value = {
+            'content-length': '0'}
+        connection.return_value.put_object.return_value = EMPTY_ETAG
+        connection.return_value.attempts = 0
+        argv = ["", "upload", "container", "--skip-container-put",
+                self.tmpfile, "-H", "X-Storage-Policy:one",
+                "--meta", "Color:Blue"]
+        swiftclient.shell.main(argv)
+        connection.return_value.put_container.assert_not_called()
+
+        connection.return_value.put_object.assert_called_with(
+            'container',
+            self.tmpfile.lstrip('/'),
+            mock.ANY,
+            content_length=0,
+            headers={'x-object-meta-mtime': mock.ANY,
+                     'X-Storage-Policy': 'one',
+                     'X-Object-Meta-Color': 'Blue'},
+            response_dict={})
+
+        # Upload in segments
+        connection.return_value.head_container.return_value = {
+            'x-storage-policy': 'one'}
+        argv = ["", "upload", "container", "--skip-container-put",
+                self.tmpfile, "-S", "10"]
+        with open(self.tmpfile, "wb") as fh:
+            fh.write(b'12345678901234567890')
+        swiftclient.shell.main(argv)
+        # Both base and segments container are assumed to exist already
+        connection.return_value.put_container.assert_not_called()
+        connection.return_value.put_object.assert_called_with(
+            'container',
+            self.tmpfile.lstrip('/'),
+            '',
+            content_length=0,
+            headers={'x-object-manifest': mock.ANY,
+                     'x-object-meta-mtime': mock.ANY},
+            response_dict={})
+
     @mock.patch('swiftclient.service.SwiftService.upload')
     def test_upload_object_with_account_readonly(self, upload):
         argv = ["", "upload", "container", self.tmpfile]

From 4989d94663b59eac34b7cd5dfaa7e673fc73e862 Mon Sep 17 00:00:00 2001
From: PAPAMICA <mickael@papamica.com>
Date: Wed, 12 Jan 2022 09:57:05 +0100
Subject: [PATCH 219/316] Fix copy.py example.

Change-Id: Id2a58a085f58b0bf17eda636593bb482d614c245
---
 examples/copy.py | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/examples/copy.py b/examples/copy.py
index e928db4e..808cbd53 100644
--- a/examples/copy.py
+++ b/examples/copy.py
@@ -9,17 +9,17 @@
 
 with SwiftService() as swift:
     try:
-        obj = SwiftCopyObject("c", {"Destination": "/cont/d"})
+        obj = SwiftCopyObject("c", {"destination": "/cont/d"})
         for i in swift.copy(
                 "cont", ["a", "b", obj],
-                {"meta": ["foo:bar"], "Destination": "/cc"}):
+                {"meta": ["foo:bar"], "destination": "/cc"}):
             if i["success"]:
                 if i["action"] == "copy_object":
                     print(
                         "object %s copied from /%s/%s" %
                         (i["destination"], i["container"], i["object"])
                     )
-                if i["action"] == "create_container":
+                elif i["action"] == "create_container":
                     print(
                         "container %s created" % i["container"]
                     )

From c2d4fc70540eadd665097945b1376d0ddf88c2b0 Mon Sep 17 00:00:00 2001
From: OpenStack Release Bot <infra-root@openstack.org>
Date: Fri, 4 Mar 2022 17:17:25 +0000
Subject: [PATCH 220/316] Update master for stable/yoga

Add file to the reno documentation build to show release notes for
stable/yoga.

Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/yoga.

Sem-Ver: feature
Change-Id: I55d45e6f076974a3b44ab8b26adbccef26373f85
---
 releasenotes/source/index.rst | 1 +
 releasenotes/source/yoga.rst  | 6 ++++++
 2 files changed, 7 insertions(+)
 create mode 100644 releasenotes/source/yoga.rst

diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst
index fb60ee00..f1da9a60 100644
--- a/releasenotes/source/index.rst
+++ b/releasenotes/source/index.rst
@@ -6,6 +6,7 @@
    :maxdepth: 1
 
    current
+   yoga
    xena
    wallaby
    victoria
diff --git a/releasenotes/source/yoga.rst b/releasenotes/source/yoga.rst
new file mode 100644
index 00000000..7cd5e908
--- /dev/null
+++ b/releasenotes/source/yoga.rst
@@ -0,0 +1,6 @@
+=========================
+Yoga Series Release Notes
+=========================
+
+.. release-notes::
+   :branch: stable/yoga

From 00f5b892273a0f88c368b71404006c53bb6ac749 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Wed, 9 Mar 2022 16:50:33 -0800
Subject: [PATCH 221/316] CI: Drop swiftclient-swift-functional-py2 job

It got busted somewhere between 2022-01-15 and 2022-02-11; looks like
needing to override devstack to install on bionic finally caught up with
us. ;-)

FWIW, it fails down in stack.sh while trying to pip install grpcio:

   commands.CommandError: We expect a missing `_needs_stub` attribute
   from older versions of setuptools. Consider upgrading setuptools.

Change-Id: Iff9094e9dd7a3d0bcdb0dee3b08fa5b61c9186d0
---
 .zuul.yaml | 15 ---------------
 1 file changed, 15 deletions(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index e26260a8..bbbdf109 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -26,19 +26,6 @@
       # swift can use different tox env names
       tox_envlist: func
 
-- job:
-    name: swiftclient-functional-py2
-    parent: swiftclient-functional
-    nodeset: openstack-single-node-bionic
-    description: |
-      Run functional tests of python-swiftclient under Python 2
-    vars:
-      devstack_localrc:
-        # devstack dropped support for bionic, but we want it for easier py2 support.
-        # Set this so we install anyway.
-        FORCE: "yes"
-      tox_envlist: py2func
-
 - project:
     templates:
       - check-requirements
@@ -51,14 +38,12 @@
       jobs:
         - swiftclient-swift-functional
         - swiftclient-functional
-        - swiftclient-functional-py2
         - openstack-tox-py39:
             voting: true
     gate:
       jobs:
         - swiftclient-swift-functional
         - swiftclient-functional
-        - swiftclient-functional-py2
         - openstack-tox-py39:
             voting: true
     post:

From 22a05b2039d0178b52fa3546de8ab265df112636 Mon Sep 17 00:00:00 2001
From: OpenStack Release Bot <infra-root@openstack.org>
Date: Fri, 4 Mar 2022 17:17:27 +0000
Subject: [PATCH 222/316] Add Python3 zed unit tests

This is an automatically generated patch to ensure unit testing
is in place for all the of the tested runtimes for zed.

See also the PTI in governance [1].

[1]: https://governance.openstack.org/tc/reference/project-testing-interface.html

Change-Id: Ia832ebda47bb798876edf3c013e9b9a583405c11
---
 .zuul.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index bbbdf109..92889dcd 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -31,7 +31,7 @@
       - check-requirements
       - lib-forward-testing-python3
       - openstack-python-jobs
-      - openstack-python3-yoga-jobs
+      - openstack-python3-zed-jobs
       - publish-openstack-docs-pti
       - release-notes-jobs-python3
     check:

From 2636965f38a7788bbee19fc90088384834670b10 Mon Sep 17 00:00:00 2001
From: Stephen Finucane <stephenfin@redhat.com>
Date: Thu, 17 Feb 2022 11:21:40 +0000
Subject: [PATCH 223/316] Drop support for Python 2

There's a lot of cleanup possible, but this is a start.

Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Change-Id: Ia1176b7fd5434d52070d482a37abfbb98800cdb3
---
 .zuul.yaml                    |  1 -
 requirements.txt              |  2 +-
 run_tests.sh                  |  4 ++--
 setup.cfg                     |  8 +++-----
 setup.py                      |  9 ++-------
 swiftclient/client.py         | 18 ++----------------
 test/unit/test_swiftclient.py | 28 +---------------------------
 tox.ini                       | 16 +---------------
 8 files changed, 12 insertions(+), 74 deletions(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index 92889dcd..d38f37fa 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -30,7 +30,6 @@
     templates:
       - check-requirements
       - lib-forward-testing-python3
-      - openstack-python-jobs
       - openstack-python3-zed-jobs
       - publish-openstack-docs-pti
       - release-notes-jobs-python3
diff --git a/requirements.txt b/requirements.txt
index 4757239b..b7c92400 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,3 +1,3 @@
-futures>=3.0.0;python_version=='2.7' # BSD
+
 requests>=1.1.0
 six>=1.9.0
diff --git a/run_tests.sh b/run_tests.sh
index 6991cd1d..d1fc50ad 100755
--- a/run_tests.sh
+++ b/run_tests.sh
@@ -9,7 +9,7 @@ function usage {
   echo ""
   echo "This script is deprecated and currently retained for compatibility."
   echo 'You can run the full test suite for multiple environments by running "tox".'
-  echo 'You can run tests for only python 2.7 by running "tox -e py27", or run only'
+  echo 'You can run tests for only python 3.9 by running "tox -e py39", or run only'
   echo 'the pep8 tests with "tox -e pep8".'
   exit
 }
@@ -39,7 +39,7 @@ if [ $just_pep8 -eq 1 ]; then
   exit
 fi
 
-tox -e py27 $toxargs 2>&1 | tee run_tests.err.log  || exit
+tox -e py39 $toxargs 2>&1 | tee run_tests.err.log  || exit
 if [ ${PIPESTATUS[0]} -ne 0 ]; then
   exit ${PIPESTATUS[0]}
 fi
diff --git a/setup.cfg b/setup.cfg
index c780c388..e429b12f 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -3,9 +3,11 @@ name = python-swiftclient
 summary = OpenStack Object Storage API Client Library
 description_file =
     README.rst
+license = Apache License, Version 2.0
 author = OpenStack
 author_email = openstack-discuss@lists.openstack.org
 home_page = https://docs.openstack.org/python-swiftclient/latest/
+python_requires = >=3.6
 classifier =
     Environment :: OpenStack
     Intended Audience :: Information Technology
@@ -14,13 +16,12 @@ classifier =
     Operating System :: POSIX :: Linux
     Operating System :: Microsoft :: Windows
     Programming Language :: Python
-    Programming Language :: Python :: 2
-    Programming Language :: Python :: 2.7
     Programming Language :: Python :: 3
     Programming Language :: Python :: 3.6
     Programming Language :: Python :: 3.7
     Programming Language :: Python :: 3.8
     Programming Language :: Python :: 3.9
+    Programming Language :: Python :: 3 :: Only
 
 [files]
 packages =
@@ -41,9 +42,6 @@ console_scripts =
 keystoneauth1.plugin =
     v1password = swiftclient.authv1:PasswordLoader
 
-[bdist_wheel]
-universal = 1
-
 [pbr]
 skip_authors = True
 skip_changelog = True
diff --git a/setup.py b/setup.py
index 16a18f6e..22cfdce8 100644
--- a/setup.py
+++ b/setup.py
@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 # Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,12 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT
-import setuptools, sys
-
-if sys.version_info < (2, 7):
-    sys.exit('Sorry, Python < 2.7 is not supported for'
-             ' python-swiftclient>=3.0')
+import setuptools
 
 setuptools.setup(
     setup_requires=['pbr'],
diff --git a/swiftclient/client.py b/swiftclient/client.py
index 544247a6..cc5478a8 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -48,25 +48,11 @@
 URI_PATTERN_INFO = re.compile(r'/info')
 URI_PATTERN_VERSION = re.compile(r'\/v\d+\.?\d*(\/.*)?')
 
-try:
-    from logging import NullHandler
-except ImportError:
-    # Added in Python 2.7
-    class NullHandler(logging.Handler):
-        def handle(self, record):
-            pass
-
-        def emit(self, record):
-            pass
-
-        def createLock(self):
-            self.lock = None
-
 ksexceptions = ksclient_v2 = ksclient_v3 = ksa_v3 = None
 try:
     from keystoneclient import exceptions as ksexceptions
     # prevent keystoneclient warning us that it has no log handlers
-    logging.getLogger('keystoneclient').addHandler(NullHandler())
+    logging.getLogger('keystoneclient').addHandler(logging.NullHandler())
     from keystoneclient.v2_0 import client as ksclient_v2
 except ImportError:
     pass
@@ -93,7 +79,7 @@ def prepare_unicode_headers(self, headers):
     requests.models.PreparedRequest.prepare_headers = prepare_unicode_headers
 
 logger = logging.getLogger("swiftclient")
-logger.addHandler(NullHandler())
+logger.addHandler(logging.NullHandler())
 
 #: Default behaviour is to redact header values known to contain secrets,
 #: such as ``X-Auth-Key`` and ``X-Auth-Token``. Up to the first 16 chars
diff --git a/test/unit/test_swiftclient.py b/test/unit/test_swiftclient.py
index ea5f502f..f6dc258f 100644
--- a/test/unit/test_swiftclient.py
+++ b/test/unit/test_swiftclient.py
@@ -1976,34 +1976,8 @@ def test_response_connection_released(self):
         self.assertFalse(resp.read())
         self.assertTrue(resp.closed)
 
-    @unittest.skipIf(six.PY3, 'python2 specific test')
-    def test_response_python2_headers(self):
-        '''Test utf-8 headers in Python 2.
-        '''
-        _, conn = c.http_connection(u'http://www.test.com/')
-        conn.resp = MockHttpResponse(
-            status=200,
-            headers={
-                '\xd8\xaa-unicode': '\xd8\xaa-value',
-                'empty-header': ''
-            }
-        )
-
-        resp = conn.getresponse()
-        self.assertEqual(
-            '\xd8\xaa-value', resp.getheader('\xd8\xaa-unicode'))
-        self.assertEqual(
-            '\xd8\xaa-value', resp.getheader('\xd8\xaa-UNICODE'))
-        self.assertEqual('', resp.getheader('empty-header'))
-        self.assertEqual(
-            dict([('\xd8\xaa-unicode', '\xd8\xaa-value'),
-                  ('empty-header', ''),
-                  ('etag', '"%s"' % EMPTY_ETAG)]),
-            dict(resp.getheaders()))
-
-    @unittest.skipIf(six.PY2, 'python3 specific test')
     def test_response_python3_headers(self):
-        '''Test latin1-encoded headers in Python 3.
+        '''Test latin1-encoded headers.
         '''
         _, conn = c.http_connection(u'http://www.test.com/')
         conn.resp = MockHttpResponse(
diff --git a/tox.ini b/tox.ini
index fbc58c78..e1e679d2 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,5 +1,5 @@
 [tox]
-envlist = py27,py3,pep8
+envlist = py3,pep8
 minversion = 3.18.0
 skipsdist = True
 
@@ -21,16 +21,13 @@ allowlist_externals = sh
 passenv = SWIFT_* *_proxy
 
 [testenv:pep8]
-basepython = python3
 commands =
     python -m flake8 swiftclient test
 
 [testenv:venv]
-basepython = python3
 commands = {posargs}
 
 [testenv:cover]
-basepython = python3
 setenv =
     PYTHON=coverage run --source swiftclient --parallel-mode
 commands =
@@ -41,7 +38,6 @@ commands =
     coverage report
 
 [testenv:func]
-basepython = python3
 setenv =
     OS_TEST_PATH=test.functional
     PYTHON=coverage run --source swiftclient --parallel-mode
@@ -56,14 +52,7 @@ commands =
     coverage report -m
     rm -f .coverage
 
-[testenv:py2func]
-basepython=python2
-setenv = {[testenv:func]setenv}
-allowlist_externals = {[testenv:func]allowlist_externals}
-commands = {[testenv:func]commands}
-
 [testenv:docs]
-basepython = python3
 usedevelop = False
 deps = -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
        -r{toxinidir}/doc/requirements.txt
@@ -88,7 +77,6 @@ show-source = True
 exclude = .venv,.tox,dist,doc,*egg
 
 [testenv:bindep]
-basepython = python3
 # Do not install any requirements. We want this to be fast and work even if
 # system dependencies are missing, since it's used to tell you what system
 # dependencies are missing! This also means that bindep must be installed
@@ -98,14 +86,12 @@ deps = bindep
 commands = bindep test
 
 [testenv:releasenotes]
-basepython = python3
 usedevelop = False
 deps = -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
        -r{toxinidir}/doc/requirements.txt
 commands = sphinx-build -a -W -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
 
 [testenv:pdf-docs]
-basepython = python3
 deps = {[testenv:docs]deps}
 allowlist_externals =
   make

From c09621eb4269e9eaa2c5f386976f356fb0701236 Mon Sep 17 00:00:00 2001
From: Aarni Koskela <akx@iki.fi>
Date: Thu, 10 Feb 2022 18:37:09 +0200
Subject: [PATCH 224/316] Don't patch Requests globally on import

This also upgrades the Requests dependency to 2.4+ (released in 2014)
to avoid having to do version comparisons altogether.

Refs https://bugs.launchpad.net/python-swiftclient/+bug/1904551

Signed-off-by: Aarni Koskela <akx@iki.fi>
Change-Id: I58399f6c526b0b78462f31739c43076314ba9e76
---
 requirements.txt               |  2 +-
 swiftclient/client.py          | 24 ++------------
 swiftclient/requests_compat.py | 57 ++++++++++++++++++++++++++++++++++
 test/unit/test_swiftclient.py  | 20 ++----------
 4 files changed, 62 insertions(+), 41 deletions(-)
 create mode 100644 swiftclient/requests_compat.py

diff --git a/requirements.txt b/requirements.txt
index b7c92400..c802baa3 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,3 +1,3 @@
 
-requests>=1.1.0
+requests>=2.4.0
 six>=1.9.0
diff --git a/swiftclient/client.py b/swiftclient/client.py
index cc5478a8..ddcf63af 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -18,11 +18,9 @@
 """
 import socket
 import re
-import requests
 import logging
 import warnings
 
-from distutils.version import StrictVersion
 from requests.exceptions import RequestException, SSLError
 from six.moves import http_client
 from six.moves.urllib.parse import quote as _quote, unquote
@@ -32,6 +30,7 @@
 
 from swiftclient import version as swiftclient_version
 from swiftclient.exceptions import ClientException
+from swiftclient.requests_compat import SwiftClientRequestsSession
 from swiftclient.utils import (
     iter_wrapper, LengthWrapper, ReadableToIterable, parse_api_response,
     get_body)
@@ -64,20 +63,6 @@
 except ImportError:
     pass
 
-# requests version 1.2.3 try to encode headers in ascii, preventing
-# utf-8 encoded header to be 'prepared'. This also affects all
-# (or at least most) versions of requests on py3
-if StrictVersion(requests.__version__) < StrictVersion('2.0.0') \
-        or not six.PY2:
-    from requests.structures import CaseInsensitiveDict
-
-    def prepare_unicode_headers(self, headers):
-        if headers:
-            self.headers = CaseInsensitiveDict(headers)
-        else:
-            self.headers = CaseInsensitiveDict()
-    requests.models.PreparedRequest.prepare_headers = prepare_unicode_headers
-
 logger = logging.getLogger("swiftclient")
 logger.addHandler(logging.NullHandler())
 
@@ -398,7 +383,7 @@ def __init__(self, url, proxy=None, cacert=None, insecure=False,
         self.host = self.parsed_url.netloc
         self.port = self.parsed_url.port
         self.requests_args = {}
-        self.request_session = requests.Session()
+        self.request_session = SwiftClientRequestsSession()
         # Don't use requests's default headers
         self.request_session.headers = None
         self.resp = None
@@ -1434,11 +1419,6 @@ def put_object(url, token=None, container=None, name=None, contents=None,
                 content_length = int(v)
     if content_type is not None:
         headers['Content-Type'] = content_type
-    elif 'Content-Type' not in headers:
-        if StrictVersion(requests.__version__) < StrictVersion('2.4.0'):
-            # python-requests sets application/x-www-form-urlencoded otherwise
-            # if using python3.
-            headers['Content-Type'] = ''
     if not contents:
         headers['Content-Length'] = '0'
 
diff --git a/swiftclient/requests_compat.py b/swiftclient/requests_compat.py
new file mode 100644
index 00000000..c2371b74
--- /dev/null
+++ b/swiftclient/requests_compat.py
@@ -0,0 +1,57 @@
+# Copyright (c) 2010-2022 OpenStack, LLC.
+#
+# 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 requests
+from requests.sessions import merge_setting, merge_hooks
+from requests.structures import CaseInsensitiveDict
+
+
+class SwiftClientPreparedRequest(requests.PreparedRequest):
+    def prepare_headers(self, headers):
+        try:
+            return super().prepare_headers(headers)
+        except UnicodeError:
+            # If we got an unicode error from the superclass's prepare_headers,
+            # we had a non-spec-compliant non-ASCII header
+            # (e.g. an UTF-8 encoded Swift object metadata header).
+            # In that case, we just pass it through and hope nothing
+            # bad will happen from not following the HTTP spec.
+            self.headers = CaseInsensitiveDict(headers or {})
+
+
+class SwiftClientRequestsSession(requests.Session):
+
+    def prepare_request(self, request):
+        # Close to the superclass's implementation,
+        # but no cookies or .netrc authentication overrides here.
+        p = SwiftClientPreparedRequest()
+        headers = merge_setting(
+            request.headers,
+            self.headers,
+            dict_class=CaseInsensitiveDict,
+        )
+        p.prepare(
+            method=request.method.upper(),
+            url=request.url,
+            files=request.files,
+            data=request.data,
+            json=request.json,
+            headers=headers,
+            params=merge_setting(request.params, self.params),
+            auth=merge_setting(request.auth, self.auth),
+            cookies=None,
+            hooks=merge_hooks(request.hooks, self.hooks),
+        )
+        return p
diff --git a/test/unit/test_swiftclient.py b/test/unit/test_swiftclient.py
index f6dc258f..6bdd6ad6 100644
--- a/test/unit/test_swiftclient.py
+++ b/test/unit/test_swiftclient.py
@@ -1325,7 +1325,6 @@ def test_query_string(self):
 
 class TestPutObject(MockHttpTest):
 
-    @mock.patch('swiftclient.requests.__version__', '2.2.0')
     def test_ok(self):
         c.http_connection = self.fake_http_connection(200)
         args = ('http://www.test.com', 'TOKEN', 'container', 'obj', 'body', 4)
@@ -1336,7 +1335,6 @@ def test_ok(self):
             ('PUT', '/container/obj', 'body', {
                 'x-auth-token': 'TOKEN',
                 'content-length': '4',
-                'content-type': ''
             }),
         ])
 
@@ -1383,7 +1381,6 @@ def test_chunk_warning(self):
             self.assertEqual(len(w), 1)
             self.assertTrue(issubclass(w[-1].category, UserWarning))
 
-    @mock.patch('swiftclient.requests.__version__', '2.2.0')
     def test_server_error(self):
         body = 'c' * 60
         headers = {'foo': 'bar'}
@@ -1398,8 +1395,7 @@ def test_server_error(self):
         self.assertEqual(e.http_status, 500)
         self.assertRequests([
             ('PUT', '/asdf/asdf', 'asdf', {
-                'x-auth-token': 'asdf',
-                'content-type': ''}),
+                'x-auth-token': 'asdf'}),
         ])
 
     def test_query_string(self):
@@ -1540,19 +1536,7 @@ def test_params(self):
         self.assertEqual(request_header['etag'], b'1234-5678')
         self.assertEqual(request_header['content-type'], b'text/plain')
 
-    @mock.patch('swiftclient.requests.__version__', '2.2.0')
-    def test_no_content_type_old_requests(self):
-        conn = c.http_connection(u'http://www.test.com/')
-        resp = MockHttpResponse(status=200)
-        conn[1].getresponse = resp.fake_response
-        conn[1]._request = resp._fake_request
-
-        c.put_object(url='http://www.test.com', http_conn=conn)
-        request_header = resp.requests_params['headers']
-        self.assertEqual(request_header['content-type'], b'')
-
-    @mock.patch('swiftclient.requests.__version__', '2.4.0')
-    def test_no_content_type_new_requests(self):
+    def test_no_content_type_requests(self):
         conn = c.http_connection(u'http://www.test.com/')
         resp = MockHttpResponse(status=200)
         conn[1].getresponse = resp.fake_response

From 3d10744c55d8cfddcd486a3e8521333b9cf606e1 Mon Sep 17 00:00:00 2001
From: Stephen Finucane <stephenfin@redhat.com>
Date: Thu, 17 Feb 2022 11:38:11 +0000
Subject: [PATCH 225/316] Remove __future__ imports

These aren't needed in modern Python 3 versions.

Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Change-Id: I5e81d6fb2e2cb8e4bfae4ed746da002f44e871c4
---
 swiftclient/multithreading.py | 2 --
 swiftclient/service.py        | 3 +--
 swiftclient/shell.py          | 2 --
 test/unit/test_service.py     | 2 +-
 test/unit/test_shell.py       | 1 -
 5 files changed, 2 insertions(+), 8 deletions(-)

diff --git a/swiftclient/multithreading.py b/swiftclient/multithreading.py
index f128790e..665ba63b 100644
--- a/swiftclient/multithreading.py
+++ b/swiftclient/multithreading.py
@@ -13,8 +13,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from __future__ import print_function
-
 import six
 import sys
 
diff --git a/swiftclient/service.py b/swiftclient/service.py
index 8e2c7b00..6b8f73dc 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -12,9 +12,8 @@
 # implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-from __future__ import unicode_literals
-import logging
 
+import logging
 import os
 
 from collections import defaultdict
diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 6da9d667..36d07575 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -14,8 +14,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from __future__ import print_function, unicode_literals
-
 import argparse
 import getpass
 import io
diff --git a/test/unit/test_service.py b/test/unit/test_service.py
index e86a4ff1..7f90eb49 100644
--- a/test/unit/test_service.py
+++ b/test/unit/test_service.py
@@ -13,7 +13,7 @@
 # implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-from __future__ import unicode_literals
+
 import contextlib
 import mock
 import os
diff --git a/test/unit/test_shell.py b/test/unit/test_shell.py
index 295c918a..8d3b1635 100644
--- a/test/unit/test_shell.py
+++ b/test/unit/test_shell.py
@@ -12,7 +12,6 @@
 # implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-from __future__ import unicode_literals
 
 import contextlib
 from genericpath import getmtime

From 4983b909831b72b5361aadf573cadd3afaaf8976 Mon Sep 17 00:00:00 2001
From: Stephen Finucane <stephenfin@redhat.com>
Date: Thu, 17 Feb 2022 11:39:46 +0000
Subject: [PATCH 226/316] Remove coding comments

Everything is unicode in Python 3.

Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Change-Id: I6a076dc67c461f265ed99878e3959e1992a88189
---
 doc/source/conf.py          | 2 --
 releasenotes/source/conf.py | 1 -
 swiftclient/__init__.py     | 1 -
 test/unit/test_service.py   | 1 -
 4 files changed, 5 deletions(-)

diff --git a/doc/source/conf.py b/doc/source/conf.py
index 2673d6c5..1c5fc692 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-#
 # Swiftclient documentation build configuration file, created by
 # sphinx-quickstart on Tue Apr 17 02:17:37 2012.
 #
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index 0945c81e..a1385e55 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # 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
diff --git a/swiftclient/__init__.py b/swiftclient/__init__.py
index dc192afe..38750d10 100644
--- a/swiftclient/__init__.py
+++ b/swiftclient/__init__.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2012 Rackspace
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
diff --git a/test/unit/test_service.py b/test/unit/test_service.py
index 7f90eb49..8c38bd35 100644
--- a/test/unit/test_service.py
+++ b/test/unit/test_service.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2014 OpenStack Foundation
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

From fa137a5bf1f2a86cc15ebc4d973f245e1543105d Mon Sep 17 00:00:00 2001
From: Stephen Finucane <stephenfin@redhat.com>
Date: Thu, 17 Feb 2022 11:37:13 +0000
Subject: [PATCH 227/316] Remove six

This mostly affects tests. Nothing too complicated

Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Change-Id: Iabc78f651e1d48db35638280722f8019798eccd6
---
 requirements.txt                    |  2 -
 swiftclient/authv1.py               |  2 +-
 swiftclient/client.py               | 59 ++++++++++-------------------
 swiftclient/exceptions.py           |  2 +-
 swiftclient/multithreading.py       | 13 ++-----
 swiftclient/service.py              | 30 +++++++--------
 swiftclient/shell.py                |  9 +----
 swiftclient/utils.py                | 24 +++++-------
 test/functional/__init__.py         |  2 +-
 test/functional/test_swiftclient.py |  8 ----
 test/unit/test_command_helpers.py   |  2 +-
 test/unit/test_multithreading.py    | 10 ++---
 test/unit/test_service.py           | 23 +++++------
 test/unit/test_shell.py             | 24 +++++-------
 test/unit/test_swiftclient.py       | 27 +++++++------
 test/unit/test_utils.py             | 28 +++++++-------
 test/unit/utils.py                  | 26 ++++++-------
 17 files changed, 116 insertions(+), 175 deletions(-)

diff --git a/requirements.txt b/requirements.txt
index c802baa3..94cc57fe 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,3 +1 @@
-
 requests>=2.4.0
-six>=1.9.0
diff --git a/swiftclient/authv1.py b/swiftclient/authv1.py
index d70acac3..705dcb40 100644
--- a/swiftclient/authv1.py
+++ b/swiftclient/authv1.py
@@ -40,7 +40,7 @@
 import json
 import time
 
-from six.moves.urllib.parse import urljoin
+from urllib.parse import urljoin
 
 # Note that while we import keystoneauth1 here, we *don't* need to add it to
 # requirements.txt -- this entire module only makes sense (and should only be
diff --git a/swiftclient/client.py b/swiftclient/client.py
index ddcf63af..df5344df 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -22,11 +22,10 @@
 import warnings
 
 from requests.exceptions import RequestException, SSLError
-from six.moves import http_client
-from six.moves.urllib.parse import quote as _quote, unquote
-from six.moves.urllib.parse import urljoin, urlparse, urlunparse
+import http.client as http_client
+from urllib.parse import quote as _quote, unquote
+from urllib.parse import urljoin, urlparse, urlunparse
 from time import sleep, time
-import six
 
 from swiftclient import version as swiftclient_version
 from swiftclient.exceptions import ClientException
@@ -165,34 +164,20 @@ def http_log(args, kwargs, resp, body):
 
 
 def parse_header_string(data):
-    if not isinstance(data, (six.text_type, six.binary_type)):
+    if not isinstance(data, (str, bytes)):
         data = str(data)
-    if six.PY2:
-        if isinstance(data, six.text_type):
-            # Under Python2 requests only returns binary_type, but if we get
-            # some stray text_type input, this should prevent unquote from
-            # interpreting %-encoded data as raw code-points.
-            data = data.encode('utf8')
+    if isinstance(data, bytes):
+        # Under Python3 requests only returns text_type and tosses (!) the
+        # rest of the headers. If that ever changes, this should be a sane
+        # approach.
         try:
-            unquoted = unquote(data).decode('utf8')
+            data = data.decode('ascii')
         except UnicodeDecodeError:
-            try:
-                return data.decode('utf8')
-            except UnicodeDecodeError:
-                return quote(data).decode('utf8')
-    else:
-        if isinstance(data, six.binary_type):
-            # Under Python3 requests only returns text_type and tosses (!) the
-            # rest of the headers. If that ever changes, this should be a sane
-            # approach.
-            try:
-                data = data.decode('ascii')
-            except UnicodeDecodeError:
-                data = quote(data)
-        try:
-            unquoted = unquote(data, errors='strict')
-        except UnicodeDecodeError:
-            return data
+            data = quote(data)
+    try:
+        unquoted = unquote(data, errors='strict')
+    except UnicodeDecodeError:
+        return data
     return unquoted
 
 
@@ -201,20 +186,18 @@ def quote(value, safe='/'):
     Patched version of urllib.quote that encodes utf8 strings before quoting.
     On Python 3, call directly urllib.parse.quote().
     """
-    if six.PY3:
-        return _quote(value, safe=safe)
-    return _quote(encode_utf8(value), safe)
+    return _quote(value, safe=safe)
 
 
 def encode_utf8(value):
-    if type(value) in six.integer_types + (float, bool):
+    if type(value) in (int, float, bool):
         # As of requests 2.11.0, headers must be byte- or unicode-strings.
         # Convert some known-good types as a convenience for developers.
         # Note that we *don't* convert subclasses, as they may have overriddden
         # __str__ or __repr__.
         # See https://github.com/kennethreitz/requests/pull/3366 for more info
         value = str(value)
-    if isinstance(value, six.text_type):
+    if isinstance(value, str):
         value = value.encode('utf8')
     return value
 
@@ -226,7 +209,7 @@ def encode_meta_headers(headers):
         value = encode_utf8(value)
         header = header.lower()
 
-        if (isinstance(header, six.string_types) and
+        if (isinstance(header, str) and
                 header.startswith(USER_METADATA_TYPE)):
             header = encode_utf8(header)
 
@@ -457,12 +440,12 @@ def getresponse(self):
         old_getheader = self.resp.raw.getheader
 
         def _decode_header(string):
-            if string is None or six.PY2:
+            if string is None:
                 return string
             return string.encode('iso-8859-1').decode('utf-8')
 
         def _encode_header(string):
-            if string is None or six.PY2:
+            if string is None:
                 return string
             return string.encode('utf-8').decode('iso-8859-1')
 
@@ -1441,7 +1424,7 @@ def put_object(url, token=None, container=None, name=None, contents=None,
             warnings.warn(warn_msg, stacklevel=2)
         # Match requests's is_stream test
         if hasattr(contents, '__iter__') and not isinstance(contents, (
-                six.text_type, six.binary_type, list, tuple, dict)):
+                str, bytes, list, tuple, dict)):
             contents = iter_wrapper(contents)
         conn.request('PUT', path, contents, headers)
 
diff --git a/swiftclient/exceptions.py b/swiftclient/exceptions.py
index a9b993ce..f0d1b5db 100644
--- a/swiftclient/exceptions.py
+++ b/swiftclient/exceptions.py
@@ -13,7 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from six.moves import urllib
+import urllib
 
 
 class ClientException(Exception):
diff --git a/swiftclient/multithreading.py b/swiftclient/multithreading.py
index 665ba63b..cf72360e 100644
--- a/swiftclient/multithreading.py
+++ b/swiftclient/multithreading.py
@@ -13,11 +13,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import six
 import sys
 
 from concurrent.futures import ThreadPoolExecutor
-from six.moves.queue import PriorityQueue
+from queue import PriorityQueue
 
 
 class OutputManager(object):
@@ -70,12 +69,8 @@ def print_raw(self, data):
         self.print_pool.submit(self._write, data, self.print_stream)
 
     def _write(self, data, stream):
-        if six.PY3:
-            stream.buffer.write(data)
-            stream.flush()
-        if six.PY2:
-            stream.write(data)
-            stream.flush()
+        stream.buffer.write(data)
+        stream.flush()
 
     def print_msg(self, msg, *fmt_args):
         if fmt_args:
@@ -100,8 +95,6 @@ def get_error_count(self):
     def _print(self, item, stream=None):
         if stream is None:
             stream = self.print_stream
-        if six.PY2 and isinstance(item, six.text_type):
-            item = item.encode('utf8')
         print(item, file=stream)
 
     def _print_error(self, item, count=1):
diff --git a/swiftclient/service.py b/swiftclient/service.py
index 6b8f73dc..289e29e8 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -21,6 +21,7 @@
 from copy import deepcopy
 from errno import EEXIST, ENOENT
 from hashlib import md5
+from io import StringIO
 from os import environ, makedirs, stat, utime
 from os.path import (
     basename, dirname, getmtime, getsize, isdir, join, sep as os_path_sep
@@ -29,10 +30,9 @@
 from random import shuffle
 from time import time
 from threading import Thread
-from six import Iterator, StringIO, string_types, text_type
-from six.moves.queue import Queue
-from six.moves.queue import Empty as QueueEmpty
-from six.moves.urllib.parse import quote
+from queue import Queue
+from queue import Empty as QueueEmpty
+from urllib.parse import quote
 
 import json
 
@@ -54,7 +54,7 @@
 logger = logging.getLogger("swiftclient.service")
 
 
-class ResultsIterator(Iterator):
+class ResultsIterator:
     def __init__(self, futures):
         self.futures = interruptable_as_completed(futures)
 
@@ -321,10 +321,10 @@ class SwiftUploadObject(object):
     options to be specified separately for each individual object.
     """
     def __init__(self, source, object_name=None, options=None):
-        if isinstance(source, string_types):
+        if isinstance(source, str):
             self.object_name = object_name or source
         elif source is None or hasattr(source, 'read'):
-            if not object_name or not isinstance(object_name, string_types):
+            if not object_name or not isinstance(object_name, str):
                 raise SwiftError('Object names must be specified as '
                                  'strings for uploads from None or file '
                                  'like objects.')
@@ -347,7 +347,7 @@ class SwiftPostObject(object):
     specified separately for each individual object.
     """
     def __init__(self, object_name, options=None):
-        if not (isinstance(object_name, string_types) and object_name):
+        if not (isinstance(object_name, str) and object_name):
             raise SwiftError(
                 "Object names must be specified as non-empty strings"
             )
@@ -361,7 +361,7 @@ class SwiftDeleteObject(object):
     specified separately for each individual object.
     """
     def __init__(self, object_name, options=None):
-        if not (isinstance(object_name, string_types) and object_name):
+        if not (isinstance(object_name, str) and object_name):
             raise SwiftError(
                 "Object names must be specified as non-empty strings"
             )
@@ -377,7 +377,7 @@ class SwiftCopyObject(object):
     destination and fresh_metadata should be set in options
     """
     def __init__(self, object_name, options=None):
-        if not (isinstance(object_name, string_types) and object_name):
+        if not (isinstance(object_name, str) and object_name):
             raise SwiftError(
                 "Object names must be specified as non-empty strings"
             )
@@ -835,7 +835,7 @@ def _make_post_objects(objects):
         post_objects = []
 
         for o in objects:
-            if isinstance(o, string_types):
+            if isinstance(o, str):
                 obj = SwiftPostObject(o)
                 post_objects.append(obj)
             elif isinstance(o, SwiftPostObject):
@@ -1637,7 +1637,7 @@ def _make_upload_objects(objects, pseudo_folder=''):
         upload_objects = []
 
         for o in objects:
-            if isinstance(o, string_types):
+            if isinstance(o, str):
                 obj = SwiftUploadObject(o, urljoin(pseudo_folder,
                                                    o.lstrip('/')))
                 upload_objects.append(obj)
@@ -2035,7 +2035,7 @@ def _upload_slo_manifest(conn, segment_results, container, obj, headers):
         segment_results.sort(key=lambda di: di['segment_index'])
         for seg in segment_results:
             seg_loc = seg['segment_location'].lstrip('/')
-            if isinstance(seg_loc, text_type):
+            if isinstance(seg_loc, str):
                 seg_loc = seg_loc.encode('utf-8')
 
         manifest_data = json.dumps([
@@ -2578,7 +2578,7 @@ def _make_delete_objects(objects):
         delete_objects = []
 
         for o in objects:
-            if isinstance(o, string_types):
+            if isinstance(o, str):
                 obj = SwiftDeleteObject(o)
                 delete_objects.append(obj)
             elif isinstance(o, SwiftDeleteObject):
@@ -2933,7 +2933,7 @@ def _make_copy_objects(objects, options):
         copy_objects = []
 
         for o in objects:
-            if isinstance(o, string_types):
+            if isinstance(o, str):
                 obj = SwiftCopyObject(o, options)
                 copy_objects.append(obj)
             elif isinstance(o, SwiftCopyObject):
diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 36d07575..a16de884 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -25,8 +25,7 @@
 
 from os import environ, walk, _exit as os_exit
 from os.path import isfile, isdir, join
-from six import text_type, PY2
-from six.moves.urllib.parse import unquote, urlparse
+from urllib.parse import unquote, urlparse
 from sys import argv as sys_argv, exit, stderr, stdin
 from time import gmtime, strftime
 
@@ -191,10 +190,6 @@ def st_delete(parser, args, output_manager, return_parser=False):
                         for o, err in r.get('result', {}).get('Errors', []):
                             # o will be of the form quote("/<cont>/<obj>")
                             o = unquote(o)
-                            if PY2:
-                                # In PY3, unquote(unicode) uses utf-8 like we
-                                # want, but PY2 uses latin-1
-                                o = o.encode('latin-1').decode('utf-8')
                             output_manager.error('Error Deleting: {0}: {1}'
                                                  .format(o[1:], err))
                             try:
@@ -1931,7 +1926,7 @@ def add_default_args(parser):
 def main(arguments=None):
     argv = sys_argv if arguments is None else arguments
 
-    argv = [a if isinstance(a, text_type) else a.decode('utf-8') for a in argv]
+    argv = [a if isinstance(a, str) else a.decode('utf-8') for a in argv]
 
     parser = argparse.ArgumentParser(
         add_help=False, formatter_class=HelpFormatter, usage='''
diff --git a/swiftclient/utils.py b/swiftclient/utils.py
index 656acad4..03e5e7b2 100644
--- a/swiftclient/utils.py
+++ b/swiftclient/utils.py
@@ -13,17 +13,15 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 """Miscellaneous utility functions for use with Swift."""
+
 from calendar import timegm
-try:
-    from collections.abc import Mapping
-except ImportError:
-    from collections import Mapping
+from collections.abc import Mapping
 import gzip
 import hashlib
 import hmac
+import io
 import json
 import logging
-import six
 import time
 import traceback
 
@@ -42,7 +40,7 @@ def config_true_value(value):
     This function comes from swift.common.utils.config_true_value()
     """
     return value is True or \
-        (isinstance(value, six.string_types) and value.lower() in TRUE_VALUES)
+        (isinstance(value, str) and value.lower() in TRUE_VALUES)
 
 
 def prt_bytes(num_bytes, human_flag):
@@ -134,7 +132,7 @@ def generate_temp_url(path, seconds, key, method, absolute=False,
     except ValueError:
         raise ValueError(TIME_ERRMSG)
 
-    if isinstance(path, six.binary_type):
+    if isinstance(path, bytes):
         try:
             path_for_body = path.decode('utf-8')
         except UnicodeDecodeError:
@@ -165,7 +163,7 @@ def generate_temp_url(path, seconds, key, method, absolute=False,
                   ('prefix:' if prefix else '') + path_for_body]
 
     if ip_range:
-        if isinstance(ip_range, six.binary_type):
+        if isinstance(ip_range, bytes):
             try:
                 ip_range = ip_range.decode('utf-8')
             except UnicodeDecodeError:
@@ -177,7 +175,7 @@ def generate_temp_url(path, seconds, key, method, absolute=False,
     hmac_body = u'\n'.join(hmac_parts)
 
     # Encode to UTF-8 for py3 compatibility
-    if not isinstance(key, six.binary_type):
+    if not isinstance(key, bytes):
         key = key.encode('utf-8')
     sig = hmac.new(key, hmac_body.encode('utf-8'), hashlib.sha1).hexdigest()
 
@@ -194,7 +192,7 @@ def generate_temp_url(path, seconds, key, method, absolute=False,
     if prefix:
         temp_url += u'&temp_url_prefix={}'.format(parts[4])
     # Have return type match path from caller
-    if isinstance(path, six.binary_type):
+    if isinstance(path, bytes):
         return temp_url.encode('utf-8')
     else:
         return temp_url
@@ -202,7 +200,7 @@ def generate_temp_url(path, seconds, key, method, absolute=False,
 
 def get_body(headers, body):
     if headers.get('content-encoding') == 'gzip':
-        with gzip.GzipFile(fileobj=six.BytesIO(body), mode='r') as gz:
+        with gzip.GzipFile(fileobj=io.BytesIO(body), mode='r') as gz:
             nbody = gz.read()
         return nbody
     return body
@@ -224,7 +222,7 @@ def split_request_headers(options, prefix=''):
     if isinstance(options, Mapping):
         options = options.items()
     for item in options:
-        if isinstance(item, six.string_types):
+        if isinstance(item, str):
             if ':' not in item:
                 raise ValueError(
                     "Metadata parameter %s must contain a ':'.\n"
@@ -401,8 +399,6 @@ def n_groups(seq, n):
 
 
 def normalize_manifest_path(path):
-    if six.PY2 and isinstance(path, six.text_type):
-        path = path.encode('utf-8')
     if path.startswith('/'):
         return path[1:]
     return path
diff --git a/test/functional/__init__.py b/test/functional/__init__.py
index f0fea3be..249dafe0 100644
--- a/test/functional/__init__.py
+++ b/test/functional/__init__.py
@@ -13,8 +13,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import configparser
 import os
-from six.moves import configparser
 
 TEST_CONFIG = None
 
diff --git a/test/functional/test_swiftclient.py b/test/functional/test_swiftclient.py
index 8d001d0f..5fc8df75 100644
--- a/test/functional/test_swiftclient.py
+++ b/test/functional/test_swiftclient.py
@@ -17,8 +17,6 @@
 import time
 from io import BytesIO
 
-import six
-
 import swiftclient
 from . import TEST_CONFIG
 
@@ -417,12 +415,6 @@ def test_post_object_unicode_header_name(self):
         # https://bugs.python.org/issue37093
         # We'll have to settle for just testing that the POST doesn't blow up
         # with a UnicodeDecodeError
-        if six.PY2:
-            headers = self.conn.head_object(
-                self.containername, self.objectname)
-            self.assertIn(u'x-object-meta-\U0001f44d', headers)
-            self.assertEqual(u'\U0001f44d',
-                             headers.get(u'x-object-meta-\U0001f44d'))
 
     def test_copy_object(self):
         self.conn.put_object(
diff --git a/test/unit/test_command_helpers.py b/test/unit/test_command_helpers.py
index 24684ae2..1cb3bb12 100644
--- a/test/unit/test_command_helpers.py
+++ b/test/unit/test_command_helpers.py
@@ -14,7 +14,7 @@
 # limitations under the License.
 
 import mock
-from six import StringIO
+from io import StringIO
 import unittest
 
 from swiftclient import command_helpers as h
diff --git a/test/unit/test_multithreading.py b/test/unit/test_multithreading.py
index e9732cd8..ee9e7cc5 100644
--- a/test/unit/test_multithreading.py
+++ b/test/unit/test_multithreading.py
@@ -12,13 +12,13 @@
 # implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+
+from queue import Queue, Empty
 import sys
 import unittest
 import threading
-import six
 
 from concurrent.futures import as_completed
-from six.moves.queue import Queue, Empty
 from time import sleep
 
 from swiftclient import multithreading as mt
@@ -216,11 +216,7 @@ def test_printers(self):
         # The threads should have been cleaned up
         self.assertEqual(starting_thread_count, threading.active_count())
 
-        if six.PY3:
-            over_the = "over the '\u062a\u062a'\n"
-        else:
-            over_the = "over the u'\\u062a\\u062a'\n"
-            # We write to the CaptureStream so no decoding is performed
+        over_the = "over the '\u062a\u062a'\n"
         self.assertEqual(''.join([
             'one-argument\n',
             'one fish, 88 fish\n',
diff --git a/test/unit/test_service.py b/test/unit/test_service.py
index 8c38bd35..9f3a2a2f 100644
--- a/test/unit/test_service.py
+++ b/test/unit/test_service.py
@@ -13,20 +13,21 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import builtins
 import contextlib
+import io
 import mock
 import os
-import six
 import tempfile
 import unittest
 import time
 import json
+from io import BytesIO
 
 from concurrent.futures import Future
 from hashlib import md5
 from mock import Mock, PropertyMock
-from six.moves.queue import Queue, Empty as QueueEmptyError
-from six import BytesIO
+from queue import Queue, Empty as QueueEmptyError
 from time import sleep
 
 import swiftclient
@@ -46,12 +47,6 @@
         clean_os_environ[key] = ''
 
 
-if six.PY2:
-    import __builtin__ as builtins
-else:
-    import builtins
-
-
 class TestSwiftPostObject(unittest.TestCase):
 
     def setUp(self):
@@ -1268,7 +1263,7 @@ def test_upload_with_relative_path(self, *args, **kwargs):
         for obj in objects:
             with mock.patch('swiftclient.service.Connection') as mock_conn, \
                     mock.patch.object(builtins, 'open') as mock_open:
-                mock_open.return_value = six.StringIO('asdf')
+                mock_open.return_value = io.StringIO('asdf')
                 mock_conn.return_value.head_object.side_effect = \
                     ClientException('Not Found', http_status=404)
                 mock_conn.return_value.put_object.return_value =\
@@ -2318,7 +2313,7 @@ def _make_result():
 
     def test_download_object_job(self):
         mock_conn = self._get_mock_connection()
-        objcontent = six.BytesIO(b'objcontent')
+        objcontent = io.BytesIO(b'objcontent')
         mock_conn.get_object.side_effect = [
             ({'content-type': 'text/plain',
               'etag': '2cbbfe139a744d6abbe695e17f3c1991'},
@@ -2360,7 +2355,7 @@ def test_download_object_job(self):
 
     def test_download_object_job_with_mtime(self):
         mock_conn = self._get_mock_connection()
-        objcontent = six.BytesIO(b'objcontent')
+        objcontent = io.BytesIO(b'objcontent')
         mock_conn.get_object.side_effect = [
             ({'content-type': 'text/plain',
               'etag': '2cbbfe139a744d6abbe695e17f3c1991',
@@ -2406,7 +2401,7 @@ def test_download_object_job_with_mtime(self):
 
     def test_download_object_job_bad_mtime(self):
         mock_conn = self._get_mock_connection()
-        objcontent = six.BytesIO(b'objcontent')
+        objcontent = io.BytesIO(b'objcontent')
         mock_conn.get_object.side_effect = [
             ({'content-type': 'text/plain',
               'etag': '2cbbfe139a744d6abbe695e17f3c1991',
@@ -2451,7 +2446,7 @@ def test_download_object_job_bad_mtime(self):
 
     def test_download_object_job_ignore_mtime(self):
         mock_conn = self._get_mock_connection()
-        objcontent = six.BytesIO(b'objcontent')
+        objcontent = io.BytesIO(b'objcontent')
         mock_conn.get_object.side_effect = [
             ({'content-type': 'text/plain',
               'etag': '2cbbfe139a744d6abbe695e17f3c1991',
diff --git a/test/unit/test_shell.py b/test/unit/test_shell.py
index 8d3b1635..adf37767 100644
--- a/test/unit/test_shell.py
+++ b/test/unit/test_shell.py
@@ -13,6 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import io
 import contextlib
 from genericpath import getmtime
 import getpass
@@ -26,8 +27,6 @@
 import textwrap
 from time import localtime, mktime, strftime, strptime
 
-import six
-
 import swiftclient
 from swiftclient.service import SwiftError
 import swiftclient.shell
@@ -46,10 +45,7 @@
 except ImportError:
     InsecureRequestWarning = None
 
-if six.PY2:
-    BUILTIN_OPEN = '__builtin__.open'
-else:
-    BUILTIN_OPEN = 'builtins.open'
+BUILTIN_OPEN = 'builtins.open'
 
 mocked_os_environ = {
     'ST_AUTH': 'http://localhost:8080/auth/v1.0',
@@ -631,7 +627,7 @@ def test_download_version_id(self, connection):
     @mock.patch('swiftclient.service.makedirs')
     @mock.patch('swiftclient.service.Connection')
     def test_download(self, connection, makedirs):
-        objcontent = six.BytesIO(b'objcontent')
+        objcontent = io.BytesIO(b'objcontent')
         connection.return_value.get_object.side_effect = [
             ({'content-type': 'text/plain',
               'etag': '2cbbfe139a744d6abbe695e17f3c1991'},
@@ -666,7 +662,7 @@ def test_download(self, connection, makedirs):
         makedirs.reset_mock()
 
         # Test downloading single object
-        objcontent = six.BytesIO(b'objcontent')
+        objcontent = io.BytesIO(b'objcontent')
         connection.return_value.get_object.side_effect = [
             ({'content-type': 'text/plain',
               'etag': '2cbbfe139a744d6abbe695e17f3c1991'},
@@ -682,7 +678,7 @@ def test_download(self, connection, makedirs):
         self.assertEqual([], makedirs.mock_calls)
 
         # Test downloading without md5 checks
-        objcontent = six.BytesIO(b'objcontent')
+        objcontent = io.BytesIO(b'objcontent')
         connection.return_value.get_object.side_effect = [
             ({'content-type': 'text/plain',
               'etag': '2cbbfe139a744d6abbe695e17f3c1991'},
@@ -700,7 +696,7 @@ def test_download(self, connection, makedirs):
         self.assertEqual([], makedirs.mock_calls)
 
         # Test downloading single object to stdout
-        objcontent = six.BytesIO(b'objcontent')
+        objcontent = io.BytesIO(b'objcontent')
         connection.return_value.get_object.side_effect = [
             ({'content-type': 'text/plain',
               'etag': '2cbbfe139a744d6abbe695e17f3c1991'},
@@ -3246,7 +3242,7 @@ def test_auth(self):
         }
         mock_resp = self.fake_http_connection(200, headers=headers)
         with mock.patch('swiftclient.client.http_connection', new=mock_resp):
-            stdout = six.StringIO()
+            stdout = io.StringIO()
             with mock.patch('sys.stdout', new=stdout):
                 argv = [
                     '',
@@ -3265,7 +3261,7 @@ def test_auth(self):
 
     def test_auth_verbose(self):
         with mock.patch('swiftclient.client.http_connection') as mock_conn:
-            stdout = six.StringIO()
+            stdout = io.StringIO()
             with mock.patch('sys.stdout', new=stdout):
                 argv = [
                     '',
@@ -3289,7 +3285,7 @@ def test_auth_v2(self):
         os_options = {'tenant_name': 'demo'}
         with mock.patch('swiftclient.client.get_auth_keystone',
                         new=fake_get_auth_keystone(os_options)):
-            stdout = six.StringIO()
+            stdout = io.StringIO()
             with mock.patch('sys.stdout', new=stdout):
                 argv = [
                     '',
@@ -3310,7 +3306,7 @@ def test_auth_v2(self):
     def test_auth_verbose_v2(self):
         with mock.patch('swiftclient.client.get_auth_keystone') \
                 as mock_keystone:
-            stdout = six.StringIO()
+            stdout = io.StringIO()
             with mock.patch('sys.stdout', new=stdout):
                 argv = [
                     '',
diff --git a/test/unit/test_swiftclient.py b/test/unit/test_swiftclient.py
index 6bdd6ad6..55c18fab 100644
--- a/test/unit/test_swiftclient.py
+++ b/test/unit/test_swiftclient.py
@@ -17,15 +17,14 @@
 import json
 import logging
 import mock
-import six
+import io
 import socket
 import string
 import unittest
 import warnings
 import tempfile
 from hashlib import md5
-from six import binary_type
-from six.moves.urllib.parse import urlparse
+from urllib.parse import urlparse
 from requests.exceptions import RequestException
 
 from .utils import (MockHttpTest, fake_get_auth_keystone, StubResponse,
@@ -214,12 +213,12 @@ def test_encode_meta_headers(self):
 
         self.assertEqual(len(headers), len(r))
         # ensure non meta headers are not encoded
-        self.assertIs(type(r.get('abc')), binary_type)
+        self.assertIs(type(r.get('abc')), bytes)
         del r['abc']
 
         for k, v in r.items():
-            self.assertIs(type(k), binary_type)
-            self.assertIs(type(v), binary_type)
+            self.assertIs(type(k), bytes)
+            self.assertIs(type(v), bytes)
             self.assertIn(v, (b'123', b'12.3', b'True'))
 
     def test_set_user_agent_default(self):
@@ -1329,7 +1328,7 @@ def test_ok(self):
         c.http_connection = self.fake_http_connection(200)
         args = ('http://www.test.com', 'TOKEN', 'container', 'obj', 'body', 4)
         value = c.put_object(*args)
-        self.assertIsInstance(value, six.string_types)
+        self.assertIsInstance(value, str)
         self.assertEqual(value, EMPTY_ETAG)
         self.assertRequests([
             ('PUT', '/container/obj', 'body', {
@@ -1340,7 +1339,7 @@ def test_ok(self):
 
     def test_unicode_ok(self):
         conn = c.http_connection(u'http://www.test.com/')
-        mock_file = six.StringIO(u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91')
+        mock_file = io.StringIO(u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91')
         args = (u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91',
                 u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91',
                 u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91',
@@ -1354,7 +1353,7 @@ def test_unicode_ok(self):
         conn[1].getresponse = resp.fake_response
         conn[1]._request = resp._fake_request
         value = c.put_object(*args, headers=headers, http_conn=conn)
-        self.assertIsInstance(value, six.string_types)
+        self.assertIsInstance(value, str)
         # Test for RFC-2616 encoded symbols
         self.assertIn(("a-b", b".x:yz mn:fg:lp"),
                       resp.buffer)
@@ -1364,7 +1363,7 @@ def test_unicode_ok(self):
 
     def test_chunk_warning(self):
         conn = c.http_connection('http://www.test.com/')
-        mock_file = six.StringIO('asdf')
+        mock_file = io.StringIO('asdf')
         args = ('asdf', 'asdf', 'asdf', 'asdf', mock_file)
         resp = MockHttpResponse()
         conn[1].getresponse = resp.fake_response
@@ -1960,7 +1959,7 @@ def test_response_connection_released(self):
         self.assertFalse(resp.read())
         self.assertTrue(resp.closed)
 
-    def test_response_python3_headers(self):
+    def test_response_headers(self):
         '''Test latin1-encoded headers.
         '''
         _, conn = c.http_connection(u'http://www.test.com/')
@@ -2547,7 +2546,7 @@ def test_reset_stream(self):
         class LocalContents(object):
 
             def __init__(self, tell_value=0):
-                self.data = six.BytesIO(string.ascii_letters.encode() * 10)
+                self.data = io.BytesIO(string.ascii_letters.encode() * 10)
                 self.data.seek(tell_value)
                 self.reads = []
                 self.seeks = []
@@ -2845,7 +2844,7 @@ def test_put_ok(self):
         c.http_connection = self.fake_http_connection(200)
         args = ('http://www.test.com', 'asdf', 'asdf', 'asdf', 'asdf')
         value = c.put_object(*args)
-        self.assertIsInstance(value, six.string_types)
+        self.assertIsInstance(value, str)
 
     def test_head_error(self):
         c.http_connection = self.fake_http_connection(500)
@@ -2859,7 +2858,7 @@ def test_get_error(self):
         self.assertEqual(exc_context.exception.http_status, 404)
 
     def test_content_encoding_gzip_body_is_logged_decoded(self):
-        buf = six.BytesIO()
+        buf = io.BytesIO()
         gz = gzip.GzipFile(fileobj=buf, mode='w')
         data = {"test": u"\u2603"}
         decoded_body = json.dumps(data).encode('utf-8')
diff --git a/test/unit/test_utils.py b/test/unit/test_utils.py
index cbee82bf..02d19f3c 100644
--- a/test/unit/test_utils.py
+++ b/test/unit/test_utils.py
@@ -14,10 +14,10 @@
 # limitations under the License.
 
 import gzip
+import io
 import json
 import unittest
 import mock
-import six
 import tempfile
 from time import gmtime, localtime, mktime, strftime, strptime
 from hashlib import md5, sha1
@@ -142,7 +142,7 @@ def test_generate_temp_url(self, time_mock, hmac_mock):
         url = u.generate_temp_url(self.url, self.seconds,
                                   self.key, self.method)
         key = self.key
-        if not isinstance(key, six.binary_type):
+        if not isinstance(key, bytes):
             key = key.encode('utf-8')
         self.assertEqual(url, self.expected_url)
         self.assertEqual(hmac_mock.mock_calls, [
@@ -170,10 +170,10 @@ def test_generate_temp_url_ip_range(self, time_mock, hmac_mock):
                                       self.key, self.method,
                                       ip_range=ip_range)
             key = self.key
-            if not isinstance(key, six.binary_type):
+            if not isinstance(key, bytes):
                 key = key.encode('utf-8')
 
-            if isinstance(ip_range, six.binary_type):
+            if isinstance(ip_range, bytes):
                 ip_range_expected_url = (
                     expected_url + ip_range.decode('utf-8')
                 )
@@ -215,7 +215,7 @@ def test_generate_temp_url_iso8601_argument(self, hmac_mock):
         lt = localtime()
         expires = strftime(u.EXPIRES_ISO8601_FORMAT[:-1], lt)
 
-        if not isinstance(self.expected_url, six.string_types):
+        if not isinstance(self.expected_url, str):
             expected_url = self.expected_url.replace(
                 b'1400003600', bytes(str(int(mktime(lt))), encoding='ascii'))
         else:
@@ -228,7 +228,7 @@ def test_generate_temp_url_iso8601_argument(self, hmac_mock):
         expires = strftime(u.SHORT_EXPIRES_ISO8601_FORMAT, lt)
         lt = strptime(expires, u.SHORT_EXPIRES_ISO8601_FORMAT)
 
-        if not isinstance(self.expected_url, six.string_types):
+        if not isinstance(self.expected_url, str):
             expected_url = self.expected_url.replace(
                 b'1400003600', bytes(str(int(mktime(lt))), encoding='ascii'))
         else:
@@ -246,11 +246,11 @@ def test_generate_temp_url_iso8601_output(self, time_mock, hmac_mock):
                                   self.key, self.method,
                                   iso8601=True)
         key = self.key
-        if not isinstance(key, six.binary_type):
+        if not isinstance(key, bytes):
             key = key.encode('utf-8')
 
         expires = strftime(u.EXPIRES_ISO8601_FORMAT, gmtime(1400003600))
-        if not isinstance(self.url, six.string_types):
+        if not isinstance(self.url, str):
             self.assertTrue(url.endswith(bytes(expires, 'utf-8')))
         else:
             self.assertTrue(url.endswith(expires))
@@ -280,7 +280,7 @@ def test_generate_temp_url_prefix(self, time_mock, hmac_mock):
             url = u.generate_temp_url(path, self.seconds,
                                       self.key, self.method, prefix=True)
             key = self.key
-            if not isinstance(key, six.binary_type):
+            if not isinstance(key, bytes):
                 key = key.encode('utf-8')
             self.assertEqual(url, expected_url)
             self.assertEqual(hmac_mock.mock_calls, [
@@ -299,7 +299,7 @@ def test_generate_temp_url_invalid_path(self):
 
     @mock.patch('hmac.HMAC.hexdigest', return_value="temp_url_signature")
     def test_generate_absolute_expiry_temp_url(self, hmac_mock):
-        if isinstance(self.expected_url, six.binary_type):
+        if isinstance(self.expected_url, bytes):
             expected_url = self.expected_url.replace(
                 b'1400003600', b'2146636800')
         else:
@@ -486,7 +486,7 @@ def test_unicode(self):
 class TestLengthWrapper(unittest.TestCase):
 
     def test_stringio(self):
-        contents = six.StringIO(u'a' * 50 + u'b' * 50)
+        contents = io.StringIO(u'a' * 50 + u'b' * 50)
         contents.seek(22)
         data = u.LengthWrapper(contents, 42, True)
         s = u'a' * 28 + u'b' * 14
@@ -506,7 +506,7 @@ def test_stringio(self):
         self.assertEqual(md5(s.encode()).hexdigest(), data.get_md5sum())
 
     def test_bytesio(self):
-        contents = six.BytesIO(b'a' * 50 + b'b' * 50)
+        contents = io.BytesIO(b'a' * 50 + b'b' * 50)
         contents.seek(22)
         data = u.LengthWrapper(contents, 42, True)
         s = b'a' * 28 + b'b' * 14
@@ -613,7 +613,7 @@ def test_latin_1(self):
         self.assertEqual({u't\xe9st': u'\xff'}, result)
 
     def test_gzipped_utf8(self):
-        buf = six.BytesIO()
+        buf = io.BytesIO()
         gz = gzip.GzipFile(fileobj=buf, mode='w')
         gz.write(u'{"test": "\u2603"}'.encode('utf8'))
         gz.close()
@@ -631,7 +631,7 @@ def test_not_gzipped(self):
         self.assertEqual({'test': u'\u2603'}, result)
 
     def test_gzipped_body(self):
-        buf = six.BytesIO()
+        buf = io.BytesIO()
         gz = gzip.GzipFile(fileobj=buf, mode='w')
         gz.write(u'{"test": "\u2603"}'.encode('utf8'))
         gz.close()
diff --git a/test/unit/utils.py b/test/unit/utils.py
index 3190e9d2..0dc0b3c9 100644
--- a/test/unit/utils.py
+++ b/test/unit/utils.py
@@ -12,17 +12,19 @@
 # implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+
 import functools
+import io
+import importlib
+import os
 import sys
-from requests import RequestException
-from requests.structures import CaseInsensitiveDict
 from time import sleep
 import unittest
+
+from requests import RequestException
+from requests.structures import CaseInsensitiveDict
 import mock
-import six
-import os
-from six.moves import reload_module
-from six.moves.urllib.parse import urlparse, ParseResult
+from urllib.parse import urlparse, ParseResult
 from swiftclient import client as c
 from swiftclient import shell as s
 from swiftclient.utils import EMPTY_ETAG
@@ -406,7 +408,7 @@ def tearDown(self):
         # un-hygienic mocking on the swiftclient.client module; which may lead
         # to some unfortunate test order dependency bugs by way of the broken
         # window theory if any other modules are similarly patched
-        reload_module(c)
+        importlib.reload(c)
 
 
 class CaptureStreamPrinter(object):
@@ -421,24 +423,20 @@ def write(self, data):
         # No encoding, just convert the raw bytes into a str for testing
         # The below call also validates that we have a byte string.
         self._captured_stream.write(
-            data if isinstance(data, six.binary_type) else data.encode('utf8'))
+            data if isinstance(data, bytes) else data.encode('utf8'))
 
 
 class CaptureStream(object):
 
     def __init__(self, stream):
         self.stream = stream
-        self._buffer = six.BytesIO()
+        self._buffer = io.BytesIO()
         self._capture = CaptureStreamPrinter(self._buffer)
         self.streams = [self._capture]
 
     @property
     def buffer(self):
-        if six.PY3:
-            return self._buffer
-        else:
-            raise AttributeError(
-                'Output stream has no attribute "buffer" in Python2')
+        return self._buffer
 
     def flush(self):
         pass

From 61ce5ac8244206c5e469e24459e365a5b0767dd5 Mon Sep 17 00:00:00 2001
From: Stephen Finucane <stephenfin@redhat.com>
Date: Mon, 21 Mar 2022 18:19:50 +0000
Subject: [PATCH 228/316] Remove unnecessary object subclassing

All classes subclass from object by default in Python 3.

Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Change-Id: I5a1ad57bcc092861ce969759b06a07c880ad3d35
---
 swiftclient/authv1.py         |  4 ++--
 swiftclient/client.py         |  6 +++---
 swiftclient/multithreading.py |  4 ++--
 swiftclient/service.py        | 12 ++++++------
 swiftclient/utils.py          |  6 +++---
 test/unit/test_authv1.py      |  4 ++--
 test/unit/test_swiftclient.py | 12 ++++++------
 test/unit/test_utils.py       |  2 +-
 8 files changed, 25 insertions(+), 25 deletions(-)

diff --git a/swiftclient/authv1.py b/swiftclient/authv1.py
index 705dcb40..84bc38ae 100644
--- a/swiftclient/authv1.py
+++ b/swiftclient/authv1.py
@@ -68,7 +68,7 @@ def dst(self, dt):
 del _UTC
 
 
-class ServiceCatalogV1(object):
+class ServiceCatalogV1:
     def __init__(self, auth_url, storage_url, account):
         self.auth_url = auth_url
         self._storage_url = storage_url
@@ -148,7 +148,7 @@ def endpoint_data_for(self, **kwargs):
         raise exceptions.EndpointNotFound(msg)
 
 
-class AccessInfoV1(object):
+class AccessInfoV1:
     """An object for encapsulating a raw v1 auth token."""
 
     def __init__(self, auth_url, storage_url, account, username, auth_token,
diff --git a/swiftclient/client.py b/swiftclient/client.py
index df5344df..a9130ab5 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -217,7 +217,7 @@ def encode_meta_headers(headers):
     return ret
 
 
-class _ObjectBody(object):
+class _ObjectBody:
     """
     Readable and iterable object body response wrapper.
     """
@@ -331,7 +331,7 @@ def read(self, length=None):
         return buf
 
 
-class HTTPConnection(object):
+class HTTPConnection:
     def __init__(self, url, proxy=None, cacert=None, insecure=False,
                  cert=None, cert_key=None, ssl_compression=False,
                  default_user_agent=None, timeout=None):
@@ -1634,7 +1634,7 @@ def get_capabilities(http_conn):
     return parse_api_response(resp_headers, body)
 
 
-class Connection(object):
+class Connection:
 
     """
     Convenience class to make requests that will also retry the request
diff --git a/swiftclient/multithreading.py b/swiftclient/multithreading.py
index cf72360e..eaccec68 100644
--- a/swiftclient/multithreading.py
+++ b/swiftclient/multithreading.py
@@ -19,7 +19,7 @@
 from queue import PriorityQueue
 
 
-class OutputManager(object):
+class OutputManager:
     """
     One object to manage and provide helper functions for output.
 
@@ -108,7 +108,7 @@ def warning(self, msg, *fmt_args):
         self.error_print_pool.submit(self._print_error, msg, count=0)
 
 
-class MultiThreadingManager(object):
+class MultiThreadingManager:
     """
     One object to manage context for multi-threading.  This should make
     bin/swift less error-prone and allow us to test this code.
diff --git a/swiftclient/service.py b/swiftclient/service.py
index 289e29e8..4a7b1205 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -315,7 +315,7 @@ def split_headers(options, prefix=''):
     return headers
 
 
-class SwiftUploadObject(object):
+class SwiftUploadObject:
     """
     Class for specifying an object upload, allowing the object source, name and
     options to be specified separately for each individual object.
@@ -341,7 +341,7 @@ def __init__(self, source, object_name=None, options=None):
         self.source = source
 
 
-class SwiftPostObject(object):
+class SwiftPostObject:
     """
     Class for specifying an object post, allowing the headers/metadata to be
     specified separately for each individual object.
@@ -355,7 +355,7 @@ def __init__(self, object_name, options=None):
         self.options = options
 
 
-class SwiftDeleteObject(object):
+class SwiftDeleteObject:
     """
     Class for specifying an object delete, allowing the headers/metadata to be
     specified separately for each individual object.
@@ -369,7 +369,7 @@ def __init__(self, object_name, options=None):
         self.options = options
 
 
-class SwiftCopyObject(object):
+class SwiftCopyObject:
     """
     Class for specifying an object copy,
     allowing the destination/headers/metadata/fresh_metadata to be specified
@@ -405,7 +405,7 @@ def __init__(self, object_name, options=None):
                 )
 
 
-class _SwiftReader(object):
+class _SwiftReader:
     """
     Class for downloading objects from swift and raising appropriate
     errors on failures caused by either invalid md5sum or size of the
@@ -470,7 +470,7 @@ def bytes_read(self):
         return self._actual_read
 
 
-class SwiftService(object):
+class SwiftService:
     """
     Service for performing swift operations
     """
diff --git a/swiftclient/utils.py b/swiftclient/utils.py
index 03e5e7b2..e99ed37f 100644
--- a/swiftclient/utils.py
+++ b/swiftclient/utils.py
@@ -254,7 +254,7 @@ def report_traceback():
         return None, None
 
 
-class NoopMD5(object):
+class NoopMD5:
     def __init__(self, *a, **kw):
         pass
 
@@ -265,7 +265,7 @@ def hexdigest(self, *a, **kw):
         return ''
 
 
-class ReadableToIterable(object):
+class ReadableToIterable:
     """
     Wrap a filelike object and act as an iterator.
 
@@ -314,7 +314,7 @@ def __iter__(self):
         return self
 
 
-class LengthWrapper(object):
+class LengthWrapper:
     """
     Wrap a filelike object with a maximum length.
 
diff --git a/test/unit/test_authv1.py b/test/unit/test_authv1.py
index 2ddf24b3..c16227fb 100644
--- a/test/unit/test_authv1.py
+++ b/test/unit/test_authv1.py
@@ -22,7 +22,7 @@
 from swiftclient import authv1
 
 
-class TestDataNoAccount(object):
+class TestDataNoAccount:
     options = dict(
         auth_url='http://saio:8080/auth/v1.0',
         username='test:tester',
@@ -32,7 +32,7 @@ class TestDataNoAccount(object):
     token = 'token'
 
 
-class TestDataWithAccount(object):
+class TestDataWithAccount:
     options = dict(
         auth_url='http://saio:8080/auth/v1.0',
         username='test2:tester2',
diff --git a/test/unit/test_swiftclient.py b/test/unit/test_swiftclient.py
index 55c18fab..673f65fc 100644
--- a/test/unit/test_swiftclient.py
+++ b/test/unit/test_swiftclient.py
@@ -101,7 +101,7 @@ def test_transaction_id_from_headers(self):
         self.assertIn('(txn: some-other-id)', str(exc))
 
 
-class MockHttpResponse(object):
+class MockHttpResponse:
     def __init__(self, status=0, headers=None, verify=False):
         self.status = status
         self.status_code = status
@@ -115,7 +115,7 @@ def __init__(self, status=0, headers=None, verify=False):
             self.headers.update(headers)
         self.closed = False
 
-        class Raw(object):
+        class Raw:
             def __init__(self, headers):
                 self.headers = headers
 
@@ -586,10 +586,10 @@ def test_auth_v3applicationcredential(self):
             "application_credential_id": "proejct_id",
             "application_credential_secret": "secret"}
 
-        class FakeEndpointData(object):
+        class FakeEndpointData:
             catalog_url = 'http://swift.cluster/v1/KEY_project_id'
 
-        class FakeKeystoneuth1v3Session(object):
+        class FakeKeystoneuth1v3Session:
 
             def __init__(self, auth):
                 self.auth = auth
@@ -2543,7 +2543,7 @@ def shim_connection(*a, **kw):
 
     def test_reset_stream(self):
 
-        class LocalContents(object):
+        class LocalContents:
 
             def __init__(self, tell_value=0):
                 self.data = io.BytesIO(string.ascii_letters.encode() * 10)
@@ -2565,7 +2565,7 @@ def read(self, size=-1):
                 self.reads.append((size, read_data))
                 return read_data
 
-        class LocalConnection(object):
+        class LocalConnection:
 
             def __init__(self, parsed_url=None):
                 self.reason = ""
diff --git a/test/unit/test_utils.py b/test/unit/test_utils.py
index 02d19f3c..007b91e8 100644
--- a/test/unit/test_utils.py
+++ b/test/unit/test_utils.py
@@ -641,7 +641,7 @@ def test_gzipped_body(self):
         self.assertEqual({'test': u'\u2603'}, result)
 
 
-class JSONTracker(object):
+class JSONTracker:
     def __init__(self, data):
         self.data = data
         self.calls = []

From 20d837a27665632cc5b164b96671290b04c48a58 Mon Sep 17 00:00:00 2001
From: Stephen Finucane <stephenfin@redhat.com>
Date: Mon, 21 Mar 2022 18:17:41 +0000
Subject: [PATCH 229/316] Remove unnecessary unicode prefixes

All strings are unicode by default in Python 3. No need to mark them as
such.

Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Change-Id: I68fb60ef271abfddebcc9d2137424f5db2a17e92
---
 swiftclient/utils.py                |   8 +-
 test/functional/test_swiftclient.py |   2 +-
 test/unit/test_multithreading.py    |  14 +--
 test/unit/test_service.py           |   4 +-
 test/unit/test_shell.py             |   4 +-
 test/unit/test_swiftclient.py       | 136 ++++++++++++++--------------
 test/unit/test_utils.py             |  70 +++++++-------
 7 files changed, 119 insertions(+), 119 deletions(-)

diff --git a/swiftclient/utils.py b/swiftclient/utils.py
index e99ed37f..860d8bf4 100644
--- a/swiftclient/utils.py
+++ b/swiftclient/utils.py
@@ -172,7 +172,7 @@ def generate_temp_url(path, seconds, key, method, absolute=False,
                 )
         hmac_parts.insert(0, "ip=%s" % ip_range)
 
-    hmac_body = u'\n'.join(hmac_parts)
+    hmac_body = '\n'.join(hmac_parts)
 
     # Encode to UTF-8 for py3 compatibility
     if not isinstance(key, bytes):
@@ -183,14 +183,14 @@ def generate_temp_url(path, seconds, key, method, absolute=False,
         expiration = time.strftime(
             EXPIRES_ISO8601_FORMAT, time.gmtime(expiration))
 
-    temp_url = u'{path}?temp_url_sig={sig}&temp_url_expires={exp}'.format(
+    temp_url = '{path}?temp_url_sig={sig}&temp_url_expires={exp}'.format(
         path=path_for_body, sig=sig, exp=expiration)
 
     if ip_range:
-        temp_url += u'&temp_url_ip_range={}'.format(ip_range)
+        temp_url += '&temp_url_ip_range={}'.format(ip_range)
 
     if prefix:
-        temp_url += u'&temp_url_prefix={}'.format(parts[4])
+        temp_url += '&temp_url_prefix={}'.format(parts[4])
     # Have return type match path from caller
     if isinstance(path, bytes):
         return temp_url.encode('utf-8')
diff --git a/test/functional/test_swiftclient.py b/test/functional/test_swiftclient.py
index 5fc8df75..91e31af0 100644
--- a/test/functional/test_swiftclient.py
+++ b/test/functional/test_swiftclient.py
@@ -409,7 +409,7 @@ def test_post_object(self):
     def test_post_object_unicode_header_name(self):
         self.conn.post_object(self.containername,
                               self.objectname,
-                              {u'x-object-meta-\U0001f44d': u'\U0001f44d'})
+                              {'x-object-meta-\U0001f44d': '\U0001f44d'})
 
         # Note that we can't actually read this header back on py3; see
         # https://bugs.python.org/issue37093
diff --git a/test/unit/test_multithreading.py b/test/unit/test_multithreading.py
index ee9e7cc5..d51bfb7c 100644
--- a/test/unit/test_multithreading.py
+++ b/test/unit/test_multithreading.py
@@ -192,18 +192,18 @@ def test_printers(self):
             thread_manager.print_msg('one-argument')
             thread_manager.print_msg('one %s, %d fish', 'fish', 88)
             thread_manager.error('I have %d problems, but a %s is not one',
-                                 99, u'\u062A\u062A')
+                                 99, '\u062A\u062A')
             thread_manager.print_msg('some\n%s\nover the %r', 'where',
-                                     u'\u062A\u062A')
+                                     '\u062A\u062A')
             thread_manager.error('one-error-argument')
             thread_manager.error('Sometimes\n%.1f%% just\ndoes not\nwork!',
                                  3.14159)
             thread_manager.print_raw(
-                u'some raw bytes: \u062A\u062A'.encode('utf-8'))
+                'some raw bytes: \u062A\u062A'.encode('utf-8'))
 
             thread_manager.print_items([
                 ('key', 'value'),
-                ('object', u'O\u0308bject'),
+                ('object', 'O\u0308bject'),
             ])
 
             thread_manager.print_raw(b'\xffugly\xffraw')
@@ -222,13 +222,13 @@ def test_printers(self):
             'one fish, 88 fish\n',
             'some\n', 'where\n',
             over_the,
-            u'some raw bytes: \u062a\u062a',
+            'some raw bytes: \u062a\u062a',
             '           key: value\n',
-            u'        object: O\u0308bject\n'
+            '        object: O\u0308bject\n'
         ]).encode('utf8') + b'\xffugly\xffraw', out_stream.getvalue())
 
         self.assertEqual(''.join([
-            u'I have 99 problems, but a \u062A\u062A is not one\n',
+            'I have 99 problems, but a \u062A\u062A is not one\n',
             'one-error-argument\n',
             'Sometimes\n', '3.1% just\n', 'does not\n', 'work!\n'
         ]), err_stream.getvalue().decode('utf8'))
diff --git a/test/unit/test_service.py b/test/unit/test_service.py
index 9f3a2a2f..0ad53782 100644
--- a/test/unit/test_service.py
+++ b/test/unit/test_service.py
@@ -564,7 +564,7 @@ def test_bulk_delete(self, mock_connection_class):
             stub_headers, json.dumps(stub_resp).encode('utf8'))
         obj_list = ['x%02d' % i for i in range(100)]
         expected = [{
-            'action': u'bulk_delete',
+            'action': 'bulk_delete',
             'attempts': 0,
             'container': 'c',
             'objects': list(objs),
@@ -594,7 +594,7 @@ def test_bulk_delete_versions(self, mock_connection_class):
         obj_list = [SwiftDeleteObject('x%02d' % i, options={'version_id': i})
                     for i in range(100)]
         expected = [{
-            'action': u'delete_object',
+            'action': 'delete_object',
             'attempts': 0,
             'container': 'c',
             'object': obj.object_name,
diff --git a/test/unit/test_shell.py b/test/unit/test_shell.py
index adf37767..eb70a923 100644
--- a/test/unit/test_shell.py
+++ b/test/unit/test_shell.py
@@ -400,7 +400,7 @@ def test_list_account_with_versions(self):
     def test_list_json(self, connection):
         connection.return_value.get_account.side_effect = [
             [None, [{'name': 'container'}]],
-            [None, [{'name': u'\u263A', 'some-custom-key': 'and value'}]],
+            [None, [{'name': '\u263A', 'some-custom-key': 'and value'}]],
             [None, []],
         ]
 
@@ -412,7 +412,7 @@ def test_list_json(self, connection):
         connection.return_value.get_account.assert_has_calls(calls)
 
         listing = [{'name': 'container'},
-                   {'name': u'\u263A', 'some-custom-key': 'and value'}]
+                   {'name': '\u263A', 'some-custom-key': 'and value'}]
         expected = json.dumps(listing, sort_keys=True, indent=2) + '\n'
         self.assertEqual(output.out, expected)
 
diff --git a/test/unit/test_swiftclient.py b/test/unit/test_swiftclient.py
index 673f65fc..3b591662 100644
--- a/test/unit/test_swiftclient.py
+++ b/test/unit/test_swiftclient.py
@@ -163,34 +163,34 @@ def test_quote(self):
         self.assertEqual('bytes%FF', c.quote(value))
         value = 'native string'
         self.assertEqual('native%20string', c.quote(value))
-        value = u'unicode string'
+        value = 'unicode string'
         self.assertEqual('unicode%20string', c.quote(value))
-        value = u'unicode:\xe9\u20ac'
+        value = 'unicode:\xe9\u20ac'
         self.assertEqual('unicode%3A%C3%A9%E2%82%AC', c.quote(value))
 
     def test_parse_header_string(self):
         value = b'bytes'
-        self.assertEqual(u'bytes', c.parse_header_string(value))
-        value = u'unicode:\xe9\u20ac'
-        self.assertEqual(u'unicode:\xe9\u20ac', c.parse_header_string(value))
+        self.assertEqual('bytes', c.parse_header_string(value))
+        value = 'unicode:\xe9\u20ac'
+        self.assertEqual('unicode:\xe9\u20ac', c.parse_header_string(value))
         value = 'native%20string'
-        self.assertEqual(u'native string', c.parse_header_string(value))
+        self.assertEqual('native string', c.parse_header_string(value))
 
         value = b'encoded%20bytes%E2%82%AC'
-        self.assertEqual(u'encoded bytes\u20ac', c.parse_header_string(value))
+        self.assertEqual('encoded bytes\u20ac', c.parse_header_string(value))
         value = 'encoded%20unicode%E2%82%AC'
-        self.assertEqual(u'encoded unicode\u20ac',
+        self.assertEqual('encoded unicode\u20ac',
                          c.parse_header_string(value))
 
         value = b'bad%20bytes%ff%E2%82%AC'
-        self.assertEqual(u'bad%20bytes%ff%E2%82%AC',
+        self.assertEqual('bad%20bytes%ff%E2%82%AC',
                          c.parse_header_string(value))
-        value = u'bad%20unicode%ff\u20ac'
-        self.assertEqual(u'bad%20unicode%ff\u20ac',
+        value = 'bad%20unicode%ff\u20ac'
+        self.assertEqual('bad%20unicode%ff\u20ac',
                          c.parse_header_string(value))
 
         value = b'really%20bad\xffbytes'
-        self.assertEqual(u'really%2520bad%FFbytes',
+        self.assertEqual('really%2520bad%FFbytes',
                          c.parse_header_string(value))
 
     def test_http_connection(self):
@@ -205,9 +205,9 @@ def test_http_connection(self):
 
     def test_encode_meta_headers(self):
         headers = {'abc': '123',
-                   u'x-container-meta-\u0394': 123,
-                   u'x-account-meta-\u0394': 12.3,
-                   u'x-object-meta-\u0394': True}
+                   'x-container-meta-\u0394': 123,
+                   'x-account-meta-\u0394': 12.3,
+                   'x-object-meta-\u0394': True}
 
         r = swiftclient.encode_meta_headers(headers)
 
@@ -1111,9 +1111,9 @@ def test_response_headers(self):
         conn = c.http_connection('http://www.test.com')
         headers, data = c.get_object('url_is_irrelevant', 'TOKEN',
                                      'container', 'object', http_conn=conn)
-        self.assertEqual(u't\xe9st', headers.get('x-utf-8-header', ''))
-        self.assertEqual(u'%ff', headers.get('x-non-utf-8-header', ''))
-        self.assertEqual(u'%FF', headers.get('x-binary-header', ''))
+        self.assertEqual('t\xe9st', headers.get('x-utf-8-header', ''))
+        self.assertEqual('%ff', headers.get('x-non-utf-8-header', ''))
+        self.assertEqual('%FF', headers.get('x-binary-header', ''))
 
     def test_chunk_size_read_method(self):
         conn = c.Connection('http://auth.url/', 'some_user', 'some_key')
@@ -1338,14 +1338,14 @@ def test_ok(self):
         ])
 
     def test_unicode_ok(self):
-        conn = c.http_connection(u'http://www.test.com/')
-        mock_file = io.StringIO(u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91')
-        args = (u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91',
-                u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91',
-                u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91',
-                u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91',
+        conn = c.http_connection('http://www.test.com/')
+        mock_file = io.StringIO('\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91')
+        args = ('\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91',
+                '\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91',
+                '\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91',
+                '\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91',
                 mock_file)
-        text = u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91'
+        text = '\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91'
         headers = {'X-Header1': text,
                    'X-2': '1', 'X-3': "{'a': 'b'}", 'a-b': '.x:yz mn:fg:lp'}
 
@@ -1410,7 +1410,7 @@ def test_query_string(self):
 
     def test_raw_upload(self):
         # Raw upload happens when content_length is passed to put_object
-        conn = c.http_connection(u'http://www.test.com/')
+        conn = c.http_connection('http://www.test.com/')
         resp = MockHttpResponse(status=200)
         conn[1].getresponse = resp.fake_response
         conn[1]._request = resp._fake_request
@@ -1432,7 +1432,7 @@ def test_raw_upload(self):
 
     def test_chunk_upload(self):
         # Chunked upload happens when no content_length is passed to put_object
-        conn = c.http_connection(u'http://www.test.com/')
+        conn = c.http_connection('http://www.test.com/')
         resp = MockHttpResponse(status=200)
         conn[1].getresponse = resp.fake_response
         conn[1]._request = resp._fake_request
@@ -1457,7 +1457,7 @@ def test_iter_upload(self):
         def data():
             for chunk in ('foo', '', 'bar'):
                 yield chunk
-        conn = c.http_connection(u'http://www.test.com/')
+        conn = c.http_connection('http://www.test.com/')
         resp = MockHttpResponse(status=200)
         conn[1].getresponse = resp.fake_response
         conn[1]._request = resp._fake_request
@@ -1524,7 +1524,7 @@ def test_md5_match(self):
             self.assertEqual(etag, contents.get_md5sum())
 
     def test_params(self):
-        conn = c.http_connection(u'http://www.test.com/')
+        conn = c.http_connection('http://www.test.com/')
         resp = MockHttpResponse(status=200)
         conn[1].getresponse = resp.fake_response
         conn[1]._request = resp._fake_request
@@ -1535,8 +1535,8 @@ def test_params(self):
         self.assertEqual(request_header['etag'], b'1234-5678')
         self.assertEqual(request_header['content-type'], b'text/plain')
 
-    def test_no_content_type_requests(self):
-        conn = c.http_connection(u'http://www.test.com/')
+    def test_no_content_type(self):
+        conn = c.http_connection('http://www.test.com/')
         resp = MockHttpResponse(status=200)
         conn[1].getresponse = resp.fake_response
         conn[1]._request = resp._fake_request
@@ -1546,7 +1546,7 @@ def test_no_content_type_requests(self):
         self.assertNotIn('content-type', request_header)
 
     def test_content_type_in_headers(self):
-        conn = c.http_connection(u'http://www.test.com/')
+        conn = c.http_connection('http://www.test.com/')
         resp = MockHttpResponse(status=200)
         conn[1].getresponse = resp.fake_response
         conn[1]._request = resp._fake_request
@@ -1586,12 +1586,12 @@ def test_ok(self):
         })
 
     def test_unicode_ok(self):
-        conn = c.http_connection(u'http://www.test.com/')
-        args = (u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91',
-                u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91',
-                u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91',
-                u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91')
-        text = u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91'
+        conn = c.http_connection('http://www.test.com/')
+        args = ('\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91',
+                '\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91',
+                '\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91',
+                '\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91')
+        text = '\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91'
         headers = {'X-Header1': text,
                    b'X-Header2': 'value',
                    'X-2': '1', 'X-3': "{'a': 'b'}", 'a-b': '.x:yz mn:kl:qr',
@@ -1890,66 +1890,66 @@ def test_conn_get_capabilities_with_os_options(self):
 class TestHTTPConnection(MockHttpTest):
 
     def test_bad_url_scheme(self):
-        url = u'www.test.com'
+        url = 'www.test.com'
         with self.assertRaises(c.ClientException) as exc_context:
             c.http_connection(url)
         exc = exc_context.exception
-        expected = u'Unsupported scheme "" in url "www.test.com"'
+        expected = 'Unsupported scheme "" in url "www.test.com"'
         self.assertEqual(expected, str(exc))
 
-        url = u'://www.test.com'
+        url = '://www.test.com'
         with self.assertRaises(c.ClientException) as exc_context:
             c.http_connection(url)
         exc = exc_context.exception
-        expected = u'Unsupported scheme "" in url "://www.test.com"'
+        expected = 'Unsupported scheme "" in url "://www.test.com"'
         self.assertEqual(expected, str(exc))
 
-        url = u'blah://www.test.com'
+        url = 'blah://www.test.com'
         with self.assertRaises(c.ClientException) as exc_context:
             c.http_connection(url)
         exc = exc_context.exception
-        expected = u'Unsupported scheme "blah" in url "blah://www.test.com"'
+        expected = 'Unsupported scheme "blah" in url "blah://www.test.com"'
         self.assertEqual(expected, str(exc))
 
     def test_ok_url_scheme(self):
         for scheme in ('http', 'https', 'HTTP', 'HTTPS'):
-            url = u'%s://www.test.com' % scheme
+            url = '%s://www.test.com' % scheme
             parsed_url, conn = c.http_connection(url)
             self.assertEqual(scheme.lower(), parsed_url.scheme)
-            self.assertEqual(u'%s://www.test.com' % scheme, conn.url)
+            self.assertEqual('%s://www.test.com' % scheme, conn.url)
 
     def test_ok_proxy(self):
-        conn = c.http_connection(u'http://www.test.com/',
+        conn = c.http_connection('http://www.test.com/',
                                  proxy='http://localhost:8080')
         self.assertEqual(conn[1].requests_args['proxies']['http'],
                          'http://localhost:8080')
 
     def test_bad_proxy(self):
         try:
-            c.http_connection(u'http://www.test.com/', proxy='localhost:8080')
+            c.http_connection('http://www.test.com/', proxy='localhost:8080')
         except c.ClientException as e:
             self.assertEqual(e.msg, "Proxy's missing scheme")
 
     def test_cacert(self):
-        conn = c.http_connection(u'http://www.test.com/',
+        conn = c.http_connection('http://www.test.com/',
                                  cacert='/dev/urandom')
         self.assertEqual(conn[1].requests_args['verify'], '/dev/urandom')
 
     def test_insecure(self):
-        conn = c.http_connection(u'http://www.test.com/', insecure=True)
+        conn = c.http_connection('http://www.test.com/', insecure=True)
         self.assertEqual(conn[1].requests_args['verify'], False)
 
     def test_cert(self):
-        conn = c.http_connection(u'http://www.test.com/', cert='minnie')
+        conn = c.http_connection('http://www.test.com/', cert='minnie')
         self.assertEqual(conn[1].requests_args['cert'], 'minnie')
 
     def test_cert_key(self):
         conn = c.http_connection(
-            u'http://www.test.com/', cert='minnie', cert_key='mickey')
+            'http://www.test.com/', cert='minnie', cert_key='mickey')
         self.assertEqual(conn[1].requests_args['cert'], ('minnie', 'mickey'))
 
     def test_response_connection_released(self):
-        _parsed_url, conn = c.http_connection(u'http://www.test.com/')
+        _parsed_url, conn = c.http_connection('http://www.test.com/')
         conn.resp = MockHttpResponse()
         conn.resp.raw = mock.Mock()
         conn.resp.raw.read.side_effect = ["Chunk", ""]
@@ -1962,7 +1962,7 @@ def test_response_connection_released(self):
     def test_response_headers(self):
         '''Test latin1-encoded headers.
         '''
-        _, conn = c.http_connection(u'http://www.test.com/')
+        _, conn = c.http_connection('http://www.test.com/')
         conn.resp = MockHttpResponse(
             status=200,
             headers={
@@ -2860,7 +2860,7 @@ def test_get_error(self):
     def test_content_encoding_gzip_body_is_logged_decoded(self):
         buf = io.BytesIO()
         gz = gzip.GzipFile(fileobj=buf, mode='w')
-        data = {"test": u"\u2603"}
+        data = {"test": "\u2603"}
         decoded_body = json.dumps(data).encode('utf-8')
         gz.write(decoded_body)
         gz.close()
@@ -2877,7 +2877,7 @@ def test_content_encoding_gzip_body_is_logged_decoded(self):
             self.assertEqual(exc_context.exception.http_status, 500)
         # it will log the decoded body
         self.assertEqual([
-            mock.call('REQ: %s', u'curl -i http://www.test.com/asdf/asdf '
+            mock.call('REQ: %s', 'curl -i http://www.test.com/asdf/asdf '
                       '-X GET -H "X-Auth-Token: ..."'),
             mock.call('RESP STATUS: %s %s', 500, 'Fake'),
             mock.call('RESP HEADERS: %s', {'content-encoding': 'gzip'}),
@@ -2888,9 +2888,9 @@ def test_redact_token(self):
         with mock.patch('swiftclient.client.logger.debug') as mock_log:
             token_value = 'tkee96b40a8ca44fc5ad72ec5a7c90d9b'
             token_encoded = token_value.encode('utf8')
-            unicode_token_value = (u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91'
-                                   u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91'
-                                   u'\u5929\u7a7a\u4e2d\u7684\u4e4c')
+            unicode_token_value = ('\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91'
+                                   '\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91'
+                                   '\u5929\u7a7a\u4e2d\u7684\u4e4c')
             unicode_token_encoded = unicode_token_value.encode('utf8')
             set_cookie_value = 'X-Auth-Token=%s' % token_value
             set_cookie_encoded = set_cookie_value.encode('utf8')
@@ -2914,8 +2914,8 @@ def test_redact_token(self):
             out = []
             for _, args, kwargs in mock_log.mock_calls:
                 for arg in args:
-                    out.append(u'%s' % arg)
-            output = u''.join(out)
+                    out.append('%s' % arg)
+            output = ''.join(out)
             self.assertIn('X-Auth-Token', output)
             self.assertIn(token_value[:16] + '...', output)
             self.assertIn('X-Storage-Token', output)
@@ -2930,9 +2930,9 @@ def test_show_token(self):
         with mock.patch('swiftclient.client.logger.debug') as mock_log:
             token_value = 'tkee96b40a8ca44fc5ad72ec5a7c90d9b'
             token_encoded = token_value.encode('utf8')
-            unicode_token_value = (u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91'
-                                   u'\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91'
-                                   u'\u5929\u7a7a\u4e2d\u7684\u4e4c')
+            unicode_token_value = ('\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91'
+                                   '\u5929\u7a7a\u4e2d\u7684\u4e4c\u4e91'
+                                   '\u5929\u7a7a\u4e2d\u7684\u4e4c')
             c.logger_settings['redact_sensitive_headers'] = False
             unicode_token_encoded = unicode_token_value.encode('utf8')
             c.http_log(
@@ -2954,8 +2954,8 @@ def test_show_token(self):
             out = []
             for _, args, kwargs in mock_log.mock_calls:
                 for arg in args:
-                    out.append(u'%s' % arg)
-            output = u''.join(out)
+                    out.append('%s' % arg)
+            output = ''.join(out)
             self.assertIn('X-Auth-Token', output)
             self.assertIn(token_value, output)
             self.assertIn('X-Storage-Token', output)
@@ -2963,12 +2963,12 @@ def test_show_token(self):
 
     @mock.patch('swiftclient.client.logger.debug')
     def test_unicode_path(self, mock_log):
-        path = u'http://swift/v1/AUTH_account-\u062a'.encode('utf-8')
+        path = 'http://swift/v1/AUTH_account-\u062a'.encode('utf-8')
         c.http_log(['GET', path], {},
                    MockHttpResponse(status=200, headers=[]), '')
         request_log_line = mock_log.mock_calls[0]
         self.assertEqual('REQ: %s', request_log_line[1][0])
-        self.assertEqual(u'curl -i -X GET %s' % path.decode('utf-8'),
+        self.assertEqual('curl -i -X GET %s' % path.decode('utf-8'),
                          request_log_line[1][1])
 
 
diff --git a/test/unit/test_utils.py b/test/unit/test_utils.py
index 007b91e8..38331546 100644
--- a/test/unit/test_utils.py
+++ b/test/unit/test_utils.py
@@ -304,7 +304,7 @@ def test_generate_absolute_expiry_temp_url(self, hmac_mock):
                 b'1400003600', b'2146636800')
         else:
             expected_url = self.expected_url.replace(
-                u'1400003600', u'2146636800')
+                '1400003600', '2146636800')
         url = u.generate_temp_url(self.url, 2146636800, self.key, self.method,
                                   absolute=True)
         self.assertEqual(url, expected_url)
@@ -372,32 +372,32 @@ def test_generate_temp_url_bad_path(self):
 
 
 class TestTempURLUnicodePathAndKey(TestTempURL):
-    url = u'/v1/\u00e4/c/\u00f3'
-    key = u'k\u00e9y'
-    expected_url = (u'%s?temp_url_sig=temp_url_signature'
-                    u'&temp_url_expires=1400003600') % url
-    expected_body = u'\n'.join([
-        u'GET',
-        u'1400003600',
+    url = '/v1/\u00e4/c/\u00f3'
+    key = 'k\u00e9y'
+    expected_url = ('%s?temp_url_sig=temp_url_signature'
+                    '&temp_url_expires=1400003600') % url
+    expected_body = '\n'.join([
+        'GET',
+        '1400003600',
         url,
     ]).encode('utf-8')
 
 
 class TestTempURLUnicodePathBytesKey(TestTempURL):
-    url = u'/v1/\u00e4/c/\u00f3'
-    key = u'k\u00e9y'.encode('utf-8')
-    expected_url = (u'%s?temp_url_sig=temp_url_signature'
-                    u'&temp_url_expires=1400003600') % url
+    url = '/v1/\u00e4/c/\u00f3'
+    key = 'k\u00e9y'.encode('utf-8')
+    expected_url = ('%s?temp_url_sig=temp_url_signature'
+                    '&temp_url_expires=1400003600') % url
     expected_body = '\n'.join([
-        u'GET',
-        u'1400003600',
+        'GET',
+        '1400003600',
         url,
     ]).encode('utf-8')
 
 
 class TestTempURLBytesPathUnicodeKey(TestTempURL):
-    url = u'/v1/\u00e4/c/\u00f3'.encode('utf-8')
-    key = u'k\u00e9y'
+    url = '/v1/\u00e4/c/\u00f3'.encode('utf-8')
+    key = 'k\u00e9y'
     expected_url = url + (b'?temp_url_sig=temp_url_signature'
                           b'&temp_url_expires=1400003600')
     expected_body = b'\n'.join([
@@ -408,8 +408,8 @@ class TestTempURLBytesPathUnicodeKey(TestTempURL):
 
 
 class TestTempURLBytesPathAndKey(TestTempURL):
-    url = u'/v1/\u00e4/c/\u00f3'.encode('utf-8')
-    key = u'k\u00e9y'.encode('utf-8')
+    url = '/v1/\u00e4/c/\u00f3'.encode('utf-8')
+    key = 'k\u00e9y'.encode('utf-8')
     expected_url = url + (b'?temp_url_sig=temp_url_signature'
                           b'&temp_url_expires=1400003600')
     expected_body = b'\n'.join([
@@ -420,7 +420,7 @@ class TestTempURLBytesPathAndKey(TestTempURL):
 
 
 class TestTempURLBytesPathAndNonUtf8Key(TestTempURL):
-    url = u'/v1/\u00e4/c/\u00f3'.encode('utf-8')
+    url = '/v1/\u00e4/c/\u00f3'.encode('utf-8')
     key = b'k\xffy'
     expected_url = url + (b'?temp_url_sig=temp_url_signature'
                           b'&temp_url_expires=1400003600')
@@ -463,7 +463,7 @@ def test_md5_creation(self):
 
     def test_unicode(self):
         # Check no errors are raised if unicode data is feed in.
-        unicode_data = u'abc'
+        unicode_data = 'abc'
         actual_md5sum = md5(unicode_data.encode()).hexdigest()
         chunk_size = 2
 
@@ -486,11 +486,11 @@ def test_unicode(self):
 class TestLengthWrapper(unittest.TestCase):
 
     def test_stringio(self):
-        contents = io.StringIO(u'a' * 50 + u'b' * 50)
+        contents = io.StringIO('a' * 50 + 'b' * 50)
         contents.seek(22)
         data = u.LengthWrapper(contents, 42, True)
-        s = u'a' * 28 + u'b' * 14
-        read_data = u''.join(iter(data.read, ''))
+        s = 'a' * 28 + 'b' * 14
+        read_data = ''.join(iter(data.read, ''))
 
         self.assertEqual(42, len(data))
         self.assertEqual(42, len(read_data))
@@ -500,7 +500,7 @@ def test_stringio(self):
         data.reset()
         self.assertEqual(md5().hexdigest(), data.get_md5sum())
 
-        read_data = u''.join(iter(data.read, ''))
+        read_data = ''.join(iter(data.read, ''))
         self.assertEqual(42, len(read_data))
         self.assertEqual(s, read_data)
         self.assertEqual(md5(s.encode()).hexdigest(), data.get_md5sum())
@@ -591,12 +591,12 @@ class TestApiResponeParser(unittest.TestCase):
 
     def test_utf8_default(self):
         result = u.parse_api_response(
-            {}, u'{"test": "\u2603"}'.encode('utf8'))
-        self.assertEqual({'test': u'\u2603'}, result)
+            {}, '{"test": "\u2603"}'.encode('utf8'))
+        self.assertEqual({'test': '\u2603'}, result)
 
         result = u.parse_api_response(
-            {}, u'{"test": "\\u2603"}'.encode('utf8'))
-        self.assertEqual({'test': u'\u2603'}, result)
+            {}, '{"test": "\\u2603"}'.encode('utf8'))
+        self.assertEqual({'test': '\u2603'}, result)
 
     def test_bad_json(self):
         self.assertRaises(ValueError, u.parse_api_response,
@@ -610,35 +610,35 @@ def test_latin_1(self):
         result = u.parse_api_response(
             {'content-type': 'application/json; charset=iso8859-1'},
             b'{"t\xe9st": "\xff"}')
-        self.assertEqual({u't\xe9st': u'\xff'}, result)
+        self.assertEqual({'t\xe9st': '\xff'}, result)
 
     def test_gzipped_utf8(self):
         buf = io.BytesIO()
         gz = gzip.GzipFile(fileobj=buf, mode='w')
-        gz.write(u'{"test": "\u2603"}'.encode('utf8'))
+        gz.write('{"test": "\u2603"}'.encode('utf8'))
         gz.close()
         result = u.parse_api_response(
             {'content-encoding': 'gzip'},
             buf.getvalue())
-        self.assertEqual({'test': u'\u2603'}, result)
+        self.assertEqual({'test': '\u2603'}, result)
 
 
 class TestGetBody(unittest.TestCase):
 
     def test_not_gzipped(self):
         result = u.parse_api_response(
-            {}, u'{"test": "\\u2603"}'.encode('utf8'))
-        self.assertEqual({'test': u'\u2603'}, result)
+            {}, '{"test": "\\u2603"}'.encode('utf8'))
+        self.assertEqual({'test': '\u2603'}, result)
 
     def test_gzipped_body(self):
         buf = io.BytesIO()
         gz = gzip.GzipFile(fileobj=buf, mode='w')
-        gz.write(u'{"test": "\u2603"}'.encode('utf8'))
+        gz.write('{"test": "\u2603"}'.encode('utf8'))
         gz.close()
         result = u.parse_api_response(
             {'content-encoding': 'gzip'},
             buf.getvalue())
-        self.assertEqual({'test': u'\u2603'}, result)
+        self.assertEqual({'test': '\u2603'}, result)
 
 
 class JSONTracker:

From 95f68cd673afe07aef9d14904de1c974fc684ef2 Mon Sep 17 00:00:00 2001
From: Pavel Abalikhin <anpavl@gmail.com>
Date: Thu, 21 Apr 2022 17:08:17 +0300
Subject: [PATCH 230/316] Add timeout for Swift service

Connection class has timeout parameter but SwiftService and shell don't use it.
That can lead to an endless wait when network is unreachable.

Change-Id: Iafa42fc2f8b56feefa2bc8ea6a1b8845717d3bab
---
 swiftclient/service.py | 1 +
 swiftclient/shell.py   | 3 +++
 2 files changed, 4 insertions(+)

diff --git a/swiftclient/service.py b/swiftclient/service.py
index 4a7b1205..9d9fc594 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -273,6 +273,7 @@ def get_conn(options):
     return Connection(options['auth'],
                       options['user'],
                       options['key'],
+                      timeout=options.get('timeout'),
                       retries=options['retries'],
                       auth_version=options['auth_version'],
                       os_options=options['os_options'],
diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index a16de884..df7c5115 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -1728,6 +1728,9 @@ def add_default_args(parser):
     parser.add_argument('-K', '--key', dest='key',
                         default=environ.get('ST_KEY'),
                         help='Key for obtaining an auth token.')
+    parser.add_argument('-T', '--timeout', type=int, dest='timeout',
+                        default=None,
+                        help='Timeout in seconds to wait for response.')
     parser.add_argument('-R', '--retries', type=int, default=5, dest='retries',
                         help='The number of times to retry a failed '
                              'connection.')

From 20c97e83d3af855e5e238dfa4b10b7bf29533d57 Mon Sep 17 00:00:00 2001
From: Steve Kowalik <steven@wedontsleep.org>
Date: Tue, 24 May 2022 11:56:35 +1000
Subject: [PATCH 231/316] Remove use of mock

Since Python 3.4, the unittest module has provided mock, negating the
need for the external dependancy. Switch to using unittest.mock.

Change-Id: Idec3aaed2fddd1ece3ed86ee0bcc48f7616d56fa
---
 test-requirements.txt             |  1 -
 test/unit/test_authv1.py          |  2 +-
 test/unit/test_command_helpers.py |  2 +-
 test/unit/test_service.py         | 67 +++++++++++++++----------------
 test/unit/test_shell.py           |  2 +-
 test/unit/test_swiftclient.py     |  2 +-
 test/unit/test_utils.py           |  2 +-
 test/unit/utils.py                |  2 +-
 8 files changed, 39 insertions(+), 41 deletions(-)

diff --git a/test-requirements.txt b/test-requirements.txt
index c2fb2c6e..b0633eb9 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -3,6 +3,5 @@ hacking>=3.2.0,<3.3.0;python_version>='3.0' # Apache-2.0
 
 coverage!=4.4,>=4.0 # Apache-2.0
 keystoneauth1>=3.4.0  # Apache-2.0
-mock>=1.2.0 # BSD
 stestr>=2.0.0,!=3.0.0 # Apache-2.0
 openstacksdk>=0.11.0 # Apache-2.0
diff --git a/test/unit/test_authv1.py b/test/unit/test_authv1.py
index c16227fb..b4de7e0f 100644
--- a/test/unit/test_authv1.py
+++ b/test/unit/test_authv1.py
@@ -14,8 +14,8 @@
 
 import datetime
 import json
-import mock
 import unittest
+from unittest import mock
 from keystoneauth1 import plugin
 from keystoneauth1 import loading
 from keystoneauth1 import exceptions
diff --git a/test/unit/test_command_helpers.py b/test/unit/test_command_helpers.py
index 1cb3bb12..3e51aa90 100644
--- a/test/unit/test_command_helpers.py
+++ b/test/unit/test_command_helpers.py
@@ -13,9 +13,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import mock
 from io import StringIO
 import unittest
+from unittest import mock
 
 from swiftclient import command_helpers as h
 from swiftclient.multithreading import OutputManager
diff --git a/test/unit/test_service.py b/test/unit/test_service.py
index 0ad53782..1176a1f8 100644
--- a/test/unit/test_service.py
+++ b/test/unit/test_service.py
@@ -16,17 +16,16 @@
 import builtins
 import contextlib
 import io
-import mock
 import os
 import tempfile
 import unittest
 import time
 import json
 from io import BytesIO
+from unittest import mock
 
 from concurrent.futures import Future
 from hashlib import md5
-from mock import Mock, PropertyMock
 from queue import Queue, Empty as QueueEmptyError
 from time import sleep
 
@@ -215,9 +214,9 @@ def _consume(sr):
 
 class _TestServiceBase(unittest.TestCase):
     def _get_mock_connection(self, attempts=2):
-        m = Mock(spec=Connection)
-        type(m).attempts = PropertyMock(return_value=attempts)
-        type(m).auth_end_time = PropertyMock(return_value=4)
+        m = mock.Mock(spec=Connection)
+        type(m).attempts = mock.PropertyMock(return_value=attempts)
+        type(m).auth_end_time = mock.PropertyMock(return_value=4)
         return m
 
     def _get_queue(self, q):
@@ -272,7 +271,7 @@ def test_delete_segment(self):
     def test_delete_segment_exception(self):
         mock_q = Queue()
         mock_conn = self._get_mock_connection()
-        mock_conn.delete_object = Mock(side_effect=self.exc)
+        mock_conn.delete_object = mock.Mock(side_effect=self.exc)
         expected_r = self._get_expected({
             'action': 'delete_segment',
             'object': 'test_s',
@@ -298,7 +297,7 @@ def test_delete_segment_exception(self):
     def test_delete_object(self):
         mock_q = Queue()
         mock_conn = self._get_mock_connection()
-        mock_conn.head_object = Mock(return_value={})
+        mock_conn.head_object = mock.Mock(return_value={})
         expected_r = self._get_expected({
             'action': 'delete_object',
             'success': True
@@ -346,7 +345,7 @@ def test_delete_object_version(self, mock_connection_class):
     def test_delete_object_with_headers(self):
         mock_q = Queue()
         mock_conn = self._get_mock_connection()
-        mock_conn.head_object = Mock(return_value={})
+        mock_conn.head_object = mock.Mock(return_value={})
         expected_r = self._get_expected({
             'action': 'delete_object',
             'success': True
@@ -369,7 +368,7 @@ def test_delete_object_with_headers(self):
     def test_delete_object_exception(self):
         mock_q = Queue()
         mock_conn = self._get_mock_connection()
-        mock_conn.delete_object = Mock(side_effect=self.exc)
+        mock_conn.delete_object = mock.Mock(side_effect=self.exc)
         expected_r = self._get_expected({
             'action': 'delete_object',
             'success': False,
@@ -402,7 +401,7 @@ def test_delete_object_slo_support(self):
         # additional query string to cause the right delete server side
         mock_q = Queue()
         mock_conn = self._get_mock_connection()
-        mock_conn.head_object = Mock(
+        mock_conn.head_object = mock.Mock(
             return_value={'x-static-large-object': True}
         )
         expected_r = self._get_expected({
@@ -435,10 +434,10 @@ def test_delete_object_dlo_support(self):
         # A DLO object is determined in _delete_object by heading the object
         # and checking for the existence of a x-object-manifest header.
         # Mock that here.
-        mock_conn.head_object = Mock(
+        mock_conn.head_object = mock.Mock(
             return_value={'x-object-manifest': 'manifest_c/manifest_p'}
         )
-        mock_conn.get_container = Mock(
+        mock_conn.get_container = mock.Mock(
             side_effect=[(None, [{'name': 'test_seg_1'},
                                  {'name': 'test_seg_2'}]),
                          (None, {})]
@@ -495,7 +494,7 @@ def test_delete_empty_container_with_headers(self):
 
     def test_delete_empty_container_exception(self):
         mock_conn = self._get_mock_connection()
-        mock_conn.delete_container = Mock(side_effect=self.exc)
+        mock_conn.delete_container = mock.Mock(side_effect=self.exc)
         expected_r = self._get_expected({
             'action': 'delete_container',
             'success': False,
@@ -825,7 +824,7 @@ def test_list_account(self):
             (None, [{'name': 'test_c'}]),
             (None, [])
         ]
-        mock_conn.get_account = Mock(side_effect=get_account_returns)
+        mock_conn.get_account = mock.Mock(side_effect=get_account_returns)
 
         expected_r = self._get_expected({
             'action': 'list_account_part',
@@ -841,12 +840,12 @@ def test_list_account(self):
         self.assertIsNone(self._get_queue(mock_q))
 
         long_opts = dict(self.opts, **{'long': True})
-        mock_conn.head_container = Mock(return_value={'test_m': '1'})
+        mock_conn.head_container = mock.Mock(return_value={'test_m': '1'})
         get_account_returns = [
             (None, [{'name': 'test_c'}]),
             (None, [])
         ]
-        mock_conn.get_account = Mock(side_effect=get_account_returns)
+        mock_conn.get_account = mock.Mock(side_effect=get_account_returns)
 
         expected_r_long = self._get_expected({
             'action': 'list_account_part',
@@ -868,7 +867,7 @@ def test_list_account_with_headers(self):
             (None, [{'name': 'test_c'}]),
             (None, [])
         ]
-        mock_conn.get_account = Mock(side_effect=get_account_returns)
+        mock_conn.get_account = mock.Mock(side_effect=get_account_returns)
 
         expected_r = self._get_expected({
             'action': 'list_account_part',
@@ -892,7 +891,7 @@ def test_list_account_with_headers(self):
     def test_list_account_exception(self):
         mock_q = Queue()
         mock_conn = self._get_mock_connection()
-        mock_conn.get_account = Mock(side_effect=self.exc)
+        mock_conn.get_account = mock.Mock(side_effect=self.exc)
         expected_r = self._get_expected({
             'action': 'list_account_part',
             'success': False,
@@ -918,7 +917,7 @@ def test_list_container(self):
             (None, [{'name': 'test_o'}]),
             (None, [])
         ]
-        mock_conn.get_container = Mock(side_effect=get_container_returns)
+        mock_conn.get_container = mock.Mock(side_effect=get_container_returns)
 
         expected_r = self._get_expected({
             'action': 'list_container_part',
@@ -935,12 +934,12 @@ def test_list_container(self):
         self.assertIsNone(self._get_queue(mock_q))
 
         long_opts = dict(self.opts, **{'long': True})
-        mock_conn.head_container = Mock(return_value={'test_m': '1'})
+        mock_conn.head_container = mock.Mock(return_value={'test_m': '1'})
         get_container_returns = [
             (None, [{'name': 'test_o'}]),
             (None, [])
         ]
-        mock_conn.get_container = Mock(side_effect=get_container_returns)
+        mock_conn.get_container = mock.Mock(side_effect=get_container_returns)
 
         expected_r_long = self._get_expected({
             'action': 'list_container_part',
@@ -964,7 +963,7 @@ def test_list_container_marker(self):
             (None, [{'name': 'b'}, {'name': 'c'}]),
             (None, [])
         ]
-        mock_get_cont = Mock(side_effect=get_container_returns)
+        mock_get_cont = mock.Mock(side_effect=get_container_returns)
         mock_conn.get_container = mock_get_cont
 
         expected_r = self._get_expected({
@@ -998,7 +997,7 @@ def test_list_container_with_headers(self):
             (None, [{'name': 'test_o'}]),
             (None, [])
         ]
-        mock_conn.get_container = Mock(side_effect=get_container_returns)
+        mock_conn.get_container = mock.Mock(side_effect=get_container_returns)
 
         expected_r = self._get_expected({
             'action': 'list_container_part',
@@ -1027,7 +1026,7 @@ def test_list_container_with_headers(self):
     def test_list_container_exception(self):
         mock_q = Queue()
         mock_conn = self._get_mock_connection()
-        mock_conn.get_container = Mock(side_effect=self.exc)
+        mock_conn.get_container = mock.Mock(side_effect=self.exc)
         expected_r = self._get_expected({
             'action': 'list_container_part',
             'container': 'test_c',
@@ -1120,7 +1119,7 @@ def test_list_queue_size(self, mock_get_conn):
             (None, [{'name': 'container14'}]),
             (None, [])
         ]
-        mock_conn.get_account = Mock(side_effect=get_account_returns)
+        mock_conn.get_account = mock.Mock(side_effect=get_account_returns)
         mock_get_conn.return_value = mock_conn
 
         s = SwiftService(options=self.opts)
@@ -2218,7 +2217,7 @@ def fake_sub_page(*args):
 
         sub_page.side_effect = fake_sub_page
 
-        r = Mock(spec=Future)
+        r = mock.Mock(spec=Future)
         r.result.return_value = self._get_expected({
             'success': True,
             'start_time': 1,
@@ -2257,7 +2256,7 @@ def __str__(self):
                 return repr(self.value)
 
         def _make_result():
-            r = Mock(spec=Future)
+            r = mock.Mock(spec=Future)
             r.result.return_value = self._get_expected({
                 'success': True,
                 'start_time': 1,
@@ -2329,7 +2328,7 @@ def test_download_object_job(self):
         })
 
         with mock.patch.object(builtins, 'open') as mock_open:
-            written_content = Mock()
+            written_content = mock.Mock()
             mock_open.return_value = written_content
             s = SwiftService()
             _opts = self.opts.copy()
@@ -2373,7 +2372,7 @@ def test_download_object_job_with_mtime(self):
 
         with mock.patch.object(builtins, 'open') as mock_open, \
                 mock.patch('swiftclient.service.utime') as mock_utime:
-            written_content = Mock()
+            written_content = mock.Mock()
             mock_open.return_value = written_content
             s = SwiftService()
             _opts = self.opts.copy()
@@ -2419,7 +2418,7 @@ def test_download_object_job_bad_mtime(self):
 
         with mock.patch.object(builtins, 'open') as mock_open, \
                 mock.patch('swiftclient.service.utime') as mock_utime:
-            written_content = Mock()
+            written_content = mock.Mock()
             mock_open.return_value = written_content
             s = SwiftService()
             _opts = self.opts.copy()
@@ -2464,7 +2463,7 @@ def test_download_object_job_ignore_mtime(self):
 
         with mock.patch.object(builtins, 'open') as mock_open, \
                 mock.patch('swiftclient.service.utime') as mock_utime:
-            written_content = Mock()
+            written_content = mock.Mock()
             mock_open.return_value = written_content
             s = SwiftService()
             _opts = self.opts.copy()
@@ -2492,7 +2491,7 @@ def test_download_object_job_ignore_mtime(self):
 
     def test_download_object_job_exception(self):
         mock_conn = self._get_mock_connection()
-        mock_conn.get_object = Mock(side_effect=self.exc)
+        mock_conn.get_object = mock.Mock(side_effect=self.exc)
         expected_r = self._get_expected({
             'success': False,
             'error': self.exc,
@@ -3026,7 +3025,7 @@ def test_object_post(self, res_iter, thread_manager):
         Check post method translates strings and objects to _post_object_job
         calls correctly
         """
-        tm_instance = Mock()
+        tm_instance = mock.Mock()
         thread_manager.return_value = tm_instance
 
         self.opts.update({'meta': ["meta1:test1"], "header": ["hdr1:test1"]})
@@ -3071,7 +3070,7 @@ def test_object_copy(self, inter_compl, thread_manager):
         Check copy method translates strings and objects to _copy_object_job
         calls correctly
         """
-        tm_instance = Mock()
+        tm_instance = mock.Mock()
         thread_manager.return_value = tm_instance
 
         self.opts.update({'meta': ["meta1:test1"], "header": ["hdr1:test1"]})
diff --git a/test/unit/test_shell.py b/test/unit/test_shell.py
index eb70a923..94168b5d 100644
--- a/test/unit/test_shell.py
+++ b/test/unit/test_shell.py
@@ -20,10 +20,10 @@
 import hashlib
 import json
 import logging
-import mock
 import os
 import tempfile
 import unittest
+from unittest import mock
 import textwrap
 from time import localtime, mktime, strftime, strptime
 
diff --git a/test/unit/test_swiftclient.py b/test/unit/test_swiftclient.py
index 3b591662..ad2af50c 100644
--- a/test/unit/test_swiftclient.py
+++ b/test/unit/test_swiftclient.py
@@ -16,11 +16,11 @@
 import gzip
 import json
 import logging
-import mock
 import io
 import socket
 import string
 import unittest
+from unittest import mock
 import warnings
 import tempfile
 from hashlib import md5
diff --git a/test/unit/test_utils.py b/test/unit/test_utils.py
index 38331546..33fd4157 100644
--- a/test/unit/test_utils.py
+++ b/test/unit/test_utils.py
@@ -17,7 +17,7 @@
 import io
 import json
 import unittest
-import mock
+from unittest import mock
 import tempfile
 from time import gmtime, localtime, mktime, strftime, strptime
 from hashlib import md5, sha1
diff --git a/test/unit/utils.py b/test/unit/utils.py
index 0dc0b3c9..87d32107 100644
--- a/test/unit/utils.py
+++ b/test/unit/utils.py
@@ -20,10 +20,10 @@
 import sys
 from time import sleep
 import unittest
+from unittest import mock
 
 from requests import RequestException
 from requests.structures import CaseInsensitiveDict
-import mock
 from urllib.parse import urlparse, ParseResult
 from swiftclient import client as c
 from swiftclient import shell as s

From 5d451fb92031989ea9982fc29140175014448ea2 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Tue, 22 Mar 2022 10:14:19 -0700
Subject: [PATCH 232/316] More cleanup following py2 removal

* Drop py2-only hacking pin from test-requirements.

* Remove quote() helper; urllib.parse.quote() works fine.

* Remove some useless code.

Change-Id: I9ffc923f58f1d11538f83ff26f7beb53cdf134c3
---
 swiftclient/client.py            | 10 +---------
 swiftclient/service.py           |  5 -----
 swiftclient/shell.py             |  2 --
 test-requirements.txt            |  7 +++----
 test/unit/test_multithreading.py |  3 +--
 test/unit/test_shell.py          |  4 ++--
 6 files changed, 7 insertions(+), 24 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index a9130ab5..168bfeda 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -23,7 +23,7 @@
 
 from requests.exceptions import RequestException, SSLError
 import http.client as http_client
-from urllib.parse import quote as _quote, unquote
+from urllib.parse import quote, unquote
 from urllib.parse import urljoin, urlparse, urlunparse
 from time import sleep, time
 
@@ -181,14 +181,6 @@ def parse_header_string(data):
     return unquoted
 
 
-def quote(value, safe='/'):
-    """
-    Patched version of urllib.quote that encodes utf8 strings before quoting.
-    On Python 3, call directly urllib.parse.quote().
-    """
-    return _quote(value, safe=safe)
-
-
 def encode_utf8(value):
     if type(value) in (int, float, bool):
         # As of requests 2.11.0, headers must be byte- or unicode-strings.
diff --git a/swiftclient/service.py b/swiftclient/service.py
index 9d9fc594..ed0f40a7 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -2034,11 +2034,6 @@ def _upload_slo_manifest(conn, segment_results, container, obj, headers):
         if headers is None:
             headers = {}
         segment_results.sort(key=lambda di: di['segment_index'])
-        for seg in segment_results:
-            seg_loc = seg['segment_location'].lstrip('/')
-            if isinstance(seg_loc, str):
-                seg_loc = seg_loc.encode('utf-8')
-
         manifest_data = json.dumps([
             {
                 'path': d['segment_location'],
diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index df7c5115..445d4cb8 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -1929,8 +1929,6 @@ def add_default_args(parser):
 def main(arguments=None):
     argv = sys_argv if arguments is None else arguments
 
-    argv = [a if isinstance(a, str) else a.decode('utf-8') for a in argv]
-
     parser = argparse.ArgumentParser(
         add_help=False, formatter_class=HelpFormatter, usage='''
 %(prog)s [--version] [--help] [--os-help] [--snet] [--verbose]
diff --git a/test-requirements.txt b/test-requirements.txt
index b0633eb9..a4b64ee7 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -1,7 +1,6 @@
-hacking>=1.1.0,<1.2.0;python_version<'3.0' # Apache-2.0
-hacking>=3.2.0,<3.3.0;python_version>='3.0' # Apache-2.0
+hacking>=3.2.0,<3.3.0 # Apache-2.0
 
-coverage!=4.4,>=4.0 # Apache-2.0
+coverage!=4.4,>=4.0   # Apache-2.0
 keystoneauth1>=3.4.0  # Apache-2.0
 stestr>=2.0.0,!=3.0.0 # Apache-2.0
-openstacksdk>=0.11.0 # Apache-2.0
+openstacksdk>=0.11.0  # Apache-2.0
diff --git a/test/unit/test_multithreading.py b/test/unit/test_multithreading.py
index d51bfb7c..8237d829 100644
--- a/test/unit/test_multithreading.py
+++ b/test/unit/test_multithreading.py
@@ -216,12 +216,11 @@ def test_printers(self):
         # The threads should have been cleaned up
         self.assertEqual(starting_thread_count, threading.active_count())
 
-        over_the = "over the '\u062a\u062a'\n"
         self.assertEqual(''.join([
             'one-argument\n',
             'one fish, 88 fish\n',
             'some\n', 'where\n',
-            over_the,
+            "over the '\u062a\u062a'\n",
             'some raw bytes: \u062a\u062a',
             '           key: value\n',
             '        object: O\u0308bject\n'
diff --git a/test/unit/test_shell.py b/test/unit/test_shell.py
index 94168b5d..105dddb1 100644
--- a/test/unit/test_shell.py
+++ b/test/unit/test_shell.py
@@ -1622,7 +1622,7 @@ def test_delete_verbose_output_utf8(self):
         with mock.patch('swiftclient.shell.SwiftService.delete') as mock_func:
             with CaptureOutput() as out:
                 mock_func.return_value = [res]
-                swiftclient.shell.main(base_argv + [container.encode('utf-8')])
+                swiftclient.shell.main(base_argv + [container])
 
                 mock_func.assert_called_once_with(container=container)
                 self.assertTrue(out.out.find(
@@ -1635,7 +1635,7 @@ def test_delete_verbose_output_utf8(self):
         with mock.patch('swiftclient.shell.SwiftService.delete') as mock_func:
             with CaptureOutput() as out:
                 mock_func.return_value = [res]
-                swiftclient.shell.main(base_argv + [container.encode('utf-8')])
+                swiftclient.shell.main(base_argv + [container])
 
                 mock_func.assert_called_once_with(container=container)
                 self.assertTrue(out.out.find(

From 1dc635a32c30d4e6c823b8367247f4554365c456 Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <tkajinam@redhat.com>
Date: Tue, 7 Jun 2022 00:35:53 +0900
Subject: [PATCH 233/316] doc: Comment out language option

... because explicit language=None causes the below warning since
Sphinx 5.0.0.

Invalid configuration value found: 'language = None'. Update your
configuration to a valid language code. Falling back to 'en' (English).

Change-Id: I842fd6c1eb5c0e14d85f8eec6078d735fbd506b8
---
 releasenotes/source/conf.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index a1385e55..0d202563 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -71,7 +71,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+# language = None
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:

From 9eee29d2e46e774eb08acb76c3317a58856f3f71 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Wed, 8 Jun 2022 09:30:17 -0700
Subject: [PATCH 234/316] tempurl: Support sha256 and sha512 signatures

Up the default to sha256 since

* the proxy has supported (and defaulted to allowing) it for four years
  now, and
* Rackspace has supported it for even longer.

Include a note in the --help about older clusters likely requiring sha1.

Change-Id: Ibac2bb7e2e4c9946c7384f0aab8e43d0d79ba645
Related-Change: Ia9dd1a91cc3c9c946f5f029cdefc9e66bcf01046
Related-Bug: #1733634
Closes-Bug: #1977867
---
 swiftclient/shell.py    |  11 ++++-
 swiftclient/utils.py    |  22 +++++++--
 test/unit/test_shell.py |  63 ++++++++++++++++++------
 test/unit/test_utils.py | 103 ++++++++++++++++++++++++++++------------
 4 files changed, 151 insertions(+), 48 deletions(-)

diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index df7c5115..b4721fe4 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -1427,6 +1427,8 @@ def st_auth(parser, args, thread_manager, return_parser=False):
                         ISO 8601 UTC timestamp instead of a Unix timestamp.
   --ip-range            If present, the temporary URL will be restricted to the
                         given ip or ip range.
+  --digest              The digest algorithm to use. Defaults to sha256, but
+                        older clusters may only support sha1.
 '''.strip('\n')
 
 
@@ -1456,6 +1458,12 @@ def st_tempurl(parser, args, thread_manager, return_parser=False):
         help=("If present, the temporary URL will be restricted to the "
               "given ip or ip range."),
     )
+    parser.add_argument(
+        '--digest', choices=('sha1', 'sha256', 'sha512'),
+        default='sha256',
+        help=("The digest algorithm to use. Defaults to sha256, but "
+              "older clusters may only support sha1."),
+    )
 
     # We return the parser to build up the bash_completion
     if return_parser:
@@ -1480,7 +1488,8 @@ def st_tempurl(parser, args, thread_manager, return_parser=False):
                                  absolute=options['absolute_expiry'],
                                  iso8601=options['iso8601'],
                                  prefix=options['prefix_based'],
-                                 ip_range=options['ip_range'])
+                                 ip_range=options['ip_range'],
+                                 digest=options['digest'])
     except ValueError as err:
         thread_manager.error(err)
         return
diff --git a/swiftclient/utils.py b/swiftclient/utils.py
index 860d8bf4..c865d273 100644
--- a/swiftclient/utils.py
+++ b/swiftclient/utils.py
@@ -14,6 +14,7 @@
 # limitations under the License.
 """Miscellaneous utility functions for use with Swift."""
 
+import base64
 from calendar import timegm
 from collections.abc import Mapping
 import gzip
@@ -70,7 +71,8 @@ def prt_bytes(num_bytes, human_flag):
 
 
 def generate_temp_url(path, seconds, key, method, absolute=False,
-                      prefix=False, iso8601=False, ip_range=None):
+                      prefix=False, iso8601=False, ip_range=None,
+                      digest='sha256'):
     """Generates a temporary URL that gives unauthenticated access to the
     Swift object.
 
@@ -95,7 +97,11 @@ def generate_temp_url(path, seconds, key, method, absolute=False,
         instead of a UNIX timestamp will be created.
     :param ip_range: if a valid ip range, restricts the temporary URL to the
         range of ips.
-    :raises ValueError: if timestamp or path is not in valid format.
+    :param digest: digest algorithm to use. Must be one of ``sha1``,
+                   ``sha256``, or ``sha512``.
+    :raises ValueError: if timestamp or path is not in valid format,
+                        or if digest is not one of ``sha1``, ``sha256``, or
+                        ``sha512``.
     :return: the path portion of a temporary URL
     """
     try:
@@ -140,6 +146,11 @@ def generate_temp_url(path, seconds, key, method, absolute=False,
     else:
         path_for_body = path
 
+    if isinstance(digest, str) and digest in ('sha1', 'sha256', 'sha512'):
+        digest = getattr(hashlib, digest)
+    if digest not in (hashlib.sha1, hashlib.sha256, hashlib.sha512):
+        raise ValueError('digest must be one of sha1, sha256, or sha512')
+
     parts = path_for_body.split('/', 4)
     if len(parts) != 5 or parts[0] or not all(parts[1:(4 if prefix else 5)]):
         if prefix:
@@ -177,7 +188,12 @@ def generate_temp_url(path, seconds, key, method, absolute=False,
     # Encode to UTF-8 for py3 compatibility
     if not isinstance(key, bytes):
         key = key.encode('utf-8')
-    sig = hmac.new(key, hmac_body.encode('utf-8'), hashlib.sha1).hexdigest()
+    mac = hmac.new(key, hmac_body.encode('utf-8'), digest)
+    if digest == hashlib.sha512:
+        sig = 'sha512:' + base64.urlsafe_b64encode(
+            mac.digest()).decode('ascii').strip('=')
+    else:
+        sig = mac.hexdigest()
 
     if iso8601:
         expiration = time.strftime(
diff --git a/test/unit/test_shell.py b/test/unit/test_shell.py
index 94168b5d..db0d66c3 100644
--- a/test/unit/test_shell.py
+++ b/test/unit/test_shell.py
@@ -2035,7 +2035,7 @@ def test_temp_url(self, temp_url):
         swiftclient.shell.main(argv)
         temp_url.assert_called_with(
             '/v1/AUTH_account/c/o', "60", 'secret_key', 'GET', absolute=False,
-            iso8601=False, prefix=False, ip_range=None)
+            iso8601=False, prefix=False, ip_range=None, digest='sha256')
 
     @mock.patch('swiftclient.shell.generate_temp_url', return_value='')
     def test_temp_url_prefix_based(self, temp_url):
@@ -2044,7 +2044,7 @@ def test_temp_url_prefix_based(self, temp_url):
         swiftclient.shell.main(argv)
         temp_url.assert_called_with(
             '/v1/AUTH_account/c/', "60", 'secret_key', 'GET', absolute=False,
-            iso8601=False, prefix=True, ip_range=None)
+            iso8601=False, prefix=True, ip_range=None, digest='sha256')
 
     @mock.patch('swiftclient.shell.generate_temp_url', return_value='')
     def test_temp_url_iso8601_in(self, temp_url):
@@ -2056,7 +2056,7 @@ def test_temp_url_iso8601_in(self, temp_url):
             swiftclient.shell.main(argv)
             temp_url.assert_called_with(
                 '/v1/AUTH_account/c/', d, 'secret_key', 'GET', absolute=False,
-                iso8601=False, prefix=False, ip_range=None)
+                iso8601=False, prefix=False, ip_range=None, digest='sha256')
 
     @mock.patch('swiftclient.shell.generate_temp_url', return_value='')
     def test_temp_url_iso8601_out(self, temp_url):
@@ -2065,7 +2065,7 @@ def test_temp_url_iso8601_out(self, temp_url):
         swiftclient.shell.main(argv)
         temp_url.assert_called_with(
             '/v1/AUTH_account/c/', "60", 'secret_key', 'GET', absolute=False,
-            iso8601=True, prefix=False, ip_range=None)
+            iso8601=True, prefix=False, ip_range=None, digest='sha256')
 
     @mock.patch('swiftclient.shell.generate_temp_url', return_value='')
     def test_absolute_expiry_temp_url(self, temp_url):
@@ -2074,7 +2074,7 @@ def test_absolute_expiry_temp_url(self, temp_url):
         swiftclient.shell.main(argv)
         temp_url.assert_called_with(
             '/v1/AUTH_account/c/o', "60", 'secret_key', 'GET', absolute=True,
-            iso8601=False, prefix=False, ip_range=None)
+            iso8601=False, prefix=False, ip_range=None, digest='sha256')
 
     @mock.patch('swiftclient.shell.generate_temp_url', return_value='')
     def test_temp_url_with_ip_range(self, temp_url):
@@ -2083,11 +2083,11 @@ def test_temp_url_with_ip_range(self, temp_url):
         swiftclient.shell.main(argv)
         temp_url.assert_called_with(
             '/v1/AUTH_account/c/o', "60", 'secret_key', 'GET', absolute=False,
-            iso8601=False, prefix=False, ip_range='1.2.3.4')
+            iso8601=False, prefix=False, ip_range='1.2.3.4', digest='sha256')
 
     def test_temp_url_output(self):
         argv = ["", "tempurl", "GET", "60", "/v1/a/c/o",
-                "secret_key", "--absolute"]
+                "secret_key", "--absolute", "--digest", "sha1"]
         with CaptureOutput(suppress_systemexit=True) as output:
             swiftclient.shell.main(argv)
         sig = "63bc77a473a1c2ce956548cacf916f292eb9eac3"
@@ -2095,14 +2095,14 @@ def test_temp_url_output(self):
         self.assertEqual(expected, output.out)
 
         argv = ["", "tempurl", "GET", "60", "http://saio:8080/v1/a/c/o",
-                "secret_key", "--absolute"]
+                "secret_key", "--absolute", "--digest", "sha1"]
         with CaptureOutput(suppress_systemexit=True) as output:
             swiftclient.shell.main(argv)
         expected = "http://saio:8080%s" % expected
         self.assertEqual(expected, output.out)
 
         argv = ["", "tempurl", "GET", "60", "/v1/a/c/",
-                "secret_key", "--absolute", "--prefix"]
+                "secret_key", "--absolute", "--prefix", "--digest", "sha1"]
         with CaptureOutput(suppress_systemexit=True) as output:
             swiftclient.shell.main(argv)
         sig = '00008c4be1573ba74fc2ab9bce02e3a93d04b349'
@@ -2111,7 +2111,8 @@ def test_temp_url_output(self):
         self.assertEqual(expected, output.out)
 
         argv = ["", "tempurl", "GET", "60", "/v1/a/c/",
-                "secret_key", "--absolute", "--prefix", '--iso8601']
+                "secret_key", "--absolute", "--prefix", '--iso8601',
+                "--digest", "sha1"]
         with CaptureOutput(suppress_systemexit=True) as output:
             swiftclient.shell.main(argv)
         sig = '00008c4be1573ba74fc2ab9bce02e3a93d04b349'
@@ -2124,7 +2125,7 @@ def test_temp_url_output(self):
                  strftime(EXPIRES_ISO8601_FORMAT[:-1], localtime(60)))
         for d in dates:
             argv = ["", "tempurl", "GET", d, "/v1/a/c/o",
-                    "secret_key"]
+                    "secret_key", "--digest", "sha1"]
             with CaptureOutput(suppress_systemexit=True) as output:
                 swiftclient.shell.main(argv)
             sig = "63bc77a473a1c2ce956548cacf916f292eb9eac3"
@@ -2135,19 +2136,20 @@ def test_temp_url_output(self):
             mktime(strptime('2005-05-01', SHORT_EXPIRES_ISO8601_FORMAT))))
 
         argv = ["", "tempurl", "GET", ts, "/v1/a/c/",
-                "secret_key", "--absolute"]
+                "secret_key", "--absolute", "--digest", "sha1"]
         with CaptureOutput(suppress_systemexit=True) as output:
             swiftclient.shell.main(argv)
             expected = output.out
 
         argv = ["", "tempurl", "GET", '2005-05-01', "/v1/a/c/",
-                "secret_key", "--absolute"]
+                "secret_key", "--absolute", "--digest", "sha1"]
         with CaptureOutput(suppress_systemexit=True) as output:
             swiftclient.shell.main(argv)
             self.assertEqual(expected, output.out)
 
         argv = ["", "tempurl", "GET", "60", "/v1/a/c/o",
-                "secret_key", "--absolute", "--ip-range", "1.2.3.4"]
+                "secret_key", "--absolute", "--ip-range", "1.2.3.4",
+                "--digest", "sha1"]
         with CaptureOutput(suppress_systemexit=True) as output:
             swiftclient.shell.main(argv)
         sig = "6a6ec8efa4be53904ecba8d055d841e24a937c98"
@@ -2157,6 +2159,39 @@ def test_temp_url_output(self):
         )
         self.assertEqual(expected, output.out)
 
+    def test_temp_url_digests_output(self):
+        argv = ["", "tempurl", "GET", "60", "/v1/a/c/o",
+                "secret_key", "--absolute"]
+        with CaptureOutput(suppress_systemexit=True) as output:
+            swiftclient.shell.main(argv)
+        s = "db04994a589b1a2538bff694f0a4f57c7a397617ac2cb49f924d222bbe2b3e01"
+        expected = "/v1/a/c/o?temp_url_sig=%s&temp_url_expires=60\n" % s
+        self.assertEqual(expected, output.out)
+
+        argv = ["", "tempurl", "GET", "60", "/v1/a/c/o",
+                "secret_key", "--absolute", "--digest", "sha256"]
+        with CaptureOutput(suppress_systemexit=True) as output:
+            swiftclient.shell.main(argv)
+        # same signature/expectation
+        self.assertEqual(expected, output.out)
+
+        argv = ["", "tempurl", "GET", "60", "/v1/a/c/o",
+                "secret_key", "--absolute", "--digest", "sha1"]
+        with CaptureOutput(suppress_systemexit=True) as output:
+            swiftclient.shell.main(argv)
+        sig = "63bc77a473a1c2ce956548cacf916f292eb9eac3"
+        expected = "/v1/a/c/o?temp_url_sig=%s&temp_url_expires=60\n" % sig
+        self.assertEqual(expected, output.out)
+
+        argv = ["", "tempurl", "GET", "60", "/v1/a/c/o",
+                "secret_key", "--absolute", "--digest", "sha512"]
+        with CaptureOutput(suppress_systemexit=True) as output:
+            swiftclient.shell.main(argv)
+        sig = ("sha512:nMXwEAHu3jzlCZi4wWO1juEq4DikFlX8a729PLJVvUp"
+               "vg0GpgkJnX5uCG1x-v2KfTrmRtLOcT7KBK2RXLW1uKw")
+        expected = "/v1/a/c/o?temp_url_sig=%s&temp_url_expires=60\n" % sig
+        self.assertEqual(expected, output.out)
+
     def test_temp_url_error_output(self):
         expected = 'path must be full path to an object e.g. /v1/a/c/o\n'
         for bad_path in ('/v1/a/c', 'v1/a/c/o', '/v1/a/c/', '/v1/a//o',
diff --git a/test/unit/test_utils.py b/test/unit/test_utils.py
index 33fd4157..129208d5 100644
--- a/test/unit/test_utils.py
+++ b/test/unit/test_utils.py
@@ -20,7 +20,7 @@
 from unittest import mock
 import tempfile
 from time import gmtime, localtime, mktime, strftime, strptime
-from hashlib import md5, sha1
+import hashlib
 
 from swiftclient import utils as u
 
@@ -127,17 +127,65 @@ class TestTempURL(unittest.TestCase):
     seconds = 3600
     key = 'correcthorsebatterystaple'
     method = 'GET'
-    expected_url = url + ('?temp_url_sig=temp_url_signature'
-                          '&temp_url_expires=1400003600')
     expected_body = '\n'.join([
         method,
         '1400003600',
         url,
     ]).encode('utf-8')
 
+    @property
+    def expected_url(self):
+        if isinstance(self.url, bytes):
+            return self.url + (b'?temp_url_sig=temp_url_signature'
+                               b'&temp_url_expires=1400003600')
+        return self.url + (u'?temp_url_sig=temp_url_signature'
+                           u'&temp_url_expires=1400003600')
+
+    @property
+    def expected_sha512_url(self):
+        if isinstance(self.url, bytes):
+            return self.url + (b'?temp_url_sig=sha512:dGVtcF91cmxfc2lnbmF0dXJl'
+                               b'&temp_url_expires=1400003600')
+        return self.url + (u'?temp_url_sig=sha512:dGVtcF91cmxfc2lnbmF0dXJl'
+                           u'&temp_url_expires=1400003600')
+
+    @mock.patch('hmac.HMAC')
+    @mock.patch('time.time', return_value=1400000000)
+    def test_generate_sha1_temp_url(self, time_mock, hmac_mock):
+        hmac_mock().hexdigest.return_value = 'temp_url_signature'
+        url = u.generate_temp_url(self.url, self.seconds,
+                                  self.key, self.method, digest='sha1')
+        key = self.key
+        if not isinstance(key, bytes):
+            key = key.encode('utf-8')
+        self.assertEqual(url, self.expected_url)
+        self.assertEqual(hmac_mock.mock_calls, [
+            mock.call(),
+            mock.call(key, self.expected_body, hashlib.sha1),
+            mock.call().hexdigest(),
+        ])
+        self.assertIsInstance(url, type(self.url))
+
+    @mock.patch('hmac.HMAC')
+    @mock.patch('time.time', return_value=1400000000)
+    def test_generate_sha512_temp_url(self, time_mock, hmac_mock):
+        hmac_mock().digest.return_value = b'temp_url_signature'
+        url = u.generate_temp_url(self.url, self.seconds,
+                                  self.key, self.method, digest=hashlib.sha512)
+        key = self.key
+        if not isinstance(key, bytes):
+            key = key.encode('utf-8')
+        self.assertEqual(url, self.expected_sha512_url)
+        self.assertEqual(hmac_mock.mock_calls, [
+            mock.call(),
+            mock.call(key, self.expected_body, hashlib.sha512),
+            mock.call().digest(),
+        ])
+        self.assertIsInstance(url, type(self.url))
+
     @mock.patch('hmac.HMAC')
     @mock.patch('time.time', return_value=1400000000)
-    def test_generate_temp_url(self, time_mock, hmac_mock):
+    def test_generate_sha256_temp_url_by_default(self, time_mock, hmac_mock):
         hmac_mock().hexdigest.return_value = 'temp_url_signature'
         url = u.generate_temp_url(self.url, self.seconds,
                                   self.key, self.method)
@@ -147,7 +195,7 @@ def test_generate_temp_url(self, time_mock, hmac_mock):
         self.assertEqual(url, self.expected_url)
         self.assertEqual(hmac_mock.mock_calls, [
             mock.call(),
-            mock.call(key, self.expected_body, sha1),
+            mock.call(key, self.expected_body, hashlib.sha256),
             mock.call().hexdigest(),
         ])
         self.assertIsInstance(url, type(self.url))
@@ -195,7 +243,7 @@ def test_generate_temp_url_ip_range(self, time_mock, hmac_mock):
             self.assertEqual(url, ip_range_expected_url)
 
             self.assertEqual(hmac_mock.mock_calls, [
-                mock.call(key, expected_body, sha1),
+                mock.call(key, expected_body, hashlib.sha256),
                 mock.call().hexdigest(),
             ])
             self.assertIsInstance(url, type(path))
@@ -256,7 +304,7 @@ def test_generate_temp_url_iso8601_output(self, time_mock, hmac_mock):
             self.assertTrue(url.endswith(expires))
         self.assertEqual(hmac_mock.mock_calls, [
             mock.call(),
-            mock.call(key, self.expected_body, sha1),
+            mock.call(key, self.expected_body, hashlib.sha256),
             mock.call().hexdigest(),
         ])
         self.assertIsInstance(url, type(self.url))
@@ -284,7 +332,7 @@ def test_generate_temp_url_prefix(self, time_mock, hmac_mock):
                 key = key.encode('utf-8')
             self.assertEqual(url, expected_url)
             self.assertEqual(hmac_mock.mock_calls, [
-                mock.call(key, expected_body, sha1),
+                mock.call(key, expected_body, hashlib.sha256),
                 mock.call().hexdigest(),
             ])
 
@@ -374,8 +422,6 @@ def test_generate_temp_url_bad_path(self):
 class TestTempURLUnicodePathAndKey(TestTempURL):
     url = '/v1/\u00e4/c/\u00f3'
     key = 'k\u00e9y'
-    expected_url = ('%s?temp_url_sig=temp_url_signature'
-                    '&temp_url_expires=1400003600') % url
     expected_body = '\n'.join([
         'GET',
         '1400003600',
@@ -386,8 +432,6 @@ class TestTempURLUnicodePathAndKey(TestTempURL):
 class TestTempURLUnicodePathBytesKey(TestTempURL):
     url = '/v1/\u00e4/c/\u00f3'
     key = 'k\u00e9y'.encode('utf-8')
-    expected_url = ('%s?temp_url_sig=temp_url_signature'
-                    '&temp_url_expires=1400003600') % url
     expected_body = '\n'.join([
         'GET',
         '1400003600',
@@ -398,8 +442,6 @@ class TestTempURLUnicodePathBytesKey(TestTempURL):
 class TestTempURLBytesPathUnicodeKey(TestTempURL):
     url = '/v1/\u00e4/c/\u00f3'.encode('utf-8')
     key = 'k\u00e9y'
-    expected_url = url + (b'?temp_url_sig=temp_url_signature'
-                          b'&temp_url_expires=1400003600')
     expected_body = b'\n'.join([
         b'GET',
         b'1400003600',
@@ -410,8 +452,6 @@ class TestTempURLBytesPathUnicodeKey(TestTempURL):
 class TestTempURLBytesPathAndKey(TestTempURL):
     url = '/v1/\u00e4/c/\u00f3'.encode('utf-8')
     key = 'k\u00e9y'.encode('utf-8')
-    expected_url = url + (b'?temp_url_sig=temp_url_signature'
-                          b'&temp_url_expires=1400003600')
     expected_body = b'\n'.join([
         b'GET',
         b'1400003600',
@@ -422,8 +462,6 @@ class TestTempURLBytesPathAndKey(TestTempURL):
 class TestTempURLBytesPathAndNonUtf8Key(TestTempURL):
     url = '/v1/\u00e4/c/\u00f3'.encode('utf-8')
     key = b'k\xffy'
-    expected_url = url + (b'?temp_url_sig=temp_url_signature'
-                          b'&temp_url_expires=1400003600')
     expected_body = b'\n'.join([
         b'GET',
         b'1400003600',
@@ -436,7 +474,7 @@ class TestReadableToIterable(unittest.TestCase):
     def test_iter(self):
         chunk_size = 4
         write_data = tuple(x.encode() for x in ('a', 'b', 'c', 'd'))
-        actual_md5sum = md5()
+        actual_md5sum = hashlib.md5()
 
         with tempfile.TemporaryFile() as f:
             for x in write_data:
@@ -454,8 +492,8 @@ def test_iter(self):
     def test_md5_creation(self):
         # Check creation with a real and noop md5 class
         data = u.ReadableToIterable(None, None, md5=True)
-        self.assertEqual(md5().hexdigest(), data.get_md5sum())
-        self.assertIs(type(md5()), type(data.md5sum))
+        self.assertEqual(hashlib.md5().hexdigest(), data.get_md5sum())
+        self.assertIs(type(hashlib.md5()), type(data.md5sum))
 
         data = u.ReadableToIterable(None, None, md5=False)
         self.assertEqual('', data.get_md5sum())
@@ -464,7 +502,7 @@ def test_md5_creation(self):
     def test_unicode(self):
         # Check no errors are raised if unicode data is feed in.
         unicode_data = 'abc'
-        actual_md5sum = md5(unicode_data.encode()).hexdigest()
+        actual_md5sum = hashlib.md5(unicode_data.encode()).hexdigest()
         chunk_size = 2
 
         with tempfile.TemporaryFile(mode='w+') as f:
@@ -495,15 +533,17 @@ def test_stringio(self):
         self.assertEqual(42, len(data))
         self.assertEqual(42, len(read_data))
         self.assertEqual(s, read_data)
-        self.assertEqual(md5(s.encode()).hexdigest(), data.get_md5sum())
+        self.assertEqual(hashlib.md5(s.encode()).hexdigest(),
+                         data.get_md5sum())
 
         data.reset()
-        self.assertEqual(md5().hexdigest(), data.get_md5sum())
+        self.assertEqual(hashlib.md5().hexdigest(), data.get_md5sum())
 
         read_data = ''.join(iter(data.read, ''))
         self.assertEqual(42, len(read_data))
         self.assertEqual(s, read_data)
-        self.assertEqual(md5(s.encode()).hexdigest(), data.get_md5sum())
+        self.assertEqual(hashlib.md5(s.encode()).hexdigest(),
+                         data.get_md5sum())
 
     def test_bytesio(self):
         contents = io.BytesIO(b'a' * 50 + b'b' * 50)
@@ -515,7 +555,7 @@ def test_bytesio(self):
         self.assertEqual(42, len(data))
         self.assertEqual(42, len(read_data))
         self.assertEqual(s, read_data)
-        self.assertEqual(md5(s).hexdigest(), data.get_md5sum())
+        self.assertEqual(hashlib.md5(s).hexdigest(), data.get_md5sum())
 
     def test_tempfile(self):
         with tempfile.NamedTemporaryFile(mode='wb') as f:
@@ -529,7 +569,7 @@ def test_tempfile(self):
                 self.assertEqual(42, len(data))
                 self.assertEqual(42, len(read_data))
                 self.assertEqual(s, read_data)
-                self.assertEqual(md5(s).hexdigest(), data.get_md5sum())
+                self.assertEqual(hashlib.md5(s).hexdigest(), data.get_md5sum())
 
     def test_segmented_file(self):
         with tempfile.NamedTemporaryFile(mode='wb') as f:
@@ -548,15 +588,18 @@ def test_segmented_file(self):
                     self.assertEqual(segment_length, len(data))
                     self.assertEqual(segment_length, len(read_data))
                     self.assertEqual(s, read_data)
-                    self.assertEqual(md5(s).hexdigest(), data.get_md5sum())
+                    self.assertEqual(hashlib.md5(s).hexdigest(),
+                                     data.get_md5sum())
 
                     data.reset()
-                    self.assertEqual(md5().hexdigest(), data.get_md5sum())
+                    self.assertEqual(hashlib.md5().hexdigest(),
+                                     data.get_md5sum())
                     read_data = b''.join(iter(data.read, ''))
                     self.assertEqual(segment_length, len(data))
                     self.assertEqual(segment_length, len(read_data))
                     self.assertEqual(s, read_data)
-                    self.assertEqual(md5(s).hexdigest(), data.get_md5sum())
+                    self.assertEqual(hashlib.md5(s).hexdigest(),
+                                     data.get_md5sum())
 
 
 class TestGroupers(unittest.TestCase):

From 0bd2ab5cb0020bc15f36a2614aecdc28feecbea0 Mon Sep 17 00:00:00 2001
From: Takashi Natsume <takanattie@gmail.com>
Date: Thu, 18 Aug 2022 22:24:00 +0900
Subject: [PATCH 235/316] Fix misuse of assertTrue

Replace assertTrue with assertEqual.

Change-Id: Ia3524bc5b3b01c0039bede6bb172535eb85bac08
Closes-Bug: 1986948
Signed-off-by: Takashi Natsume <takanattie@gmail.com>
---
 test/functional/test_swiftclient.py | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/test/functional/test_swiftclient.py b/test/functional/test_swiftclient.py
index 91e31af0..a5c1211c 100644
--- a/test/functional/test_swiftclient.py
+++ b/test/functional/test_swiftclient.py
@@ -332,7 +332,7 @@ def test_download_object_retry_chunked(self):
                                           resp_chunk_size=resp_chunk_size)
         data = next(body)
         self.assertEqual(self.test_data[:resp_chunk_size], data)
-        self.assertTrue(1, self.conn.attempts)
+        self.assertEqual(1, self.conn.attempts)
         for chunk in body.resp:
             # Flush remaining data from underlying response
             # (simulate a dropped connection)
@@ -369,13 +369,13 @@ def test_download_object_non_chunked(self):
         hdrs, body = self.conn.get_object(self.containername, self.objectname)
         data = body
         self.assertEqual(self.test_data, data)
-        self.assertTrue(1, self.conn.attempts)
+        self.assertEqual(1, self.conn.attempts)
 
         hdrs, body = self.conn.get_object(self.containername, self.objectname,
                                           resp_chunk_size=0)
         data = body
         self.assertEqual(self.test_data, data)
-        self.assertTrue(1, self.conn.attempts)
+        self.assertEqual(1, self.conn.attempts)
 
     def test_post_account(self):
         self.conn.post_account({'x-account-meta-data': 'Something'})

From a1d2f31131d79d7c551dbac4fc1e9c4d177d2df5 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Wed, 17 Aug 2022 16:58:36 -0700
Subject: [PATCH 236/316] Enable retry_on_ratelimit by default

UpgradeImpact
=============
The Connection class now enables retry_on_ratelimit by default.
If you need to return to the old behavior, explicitly pass
retry_on_ratelimit=False as a keyword arg.

The SwiftService class will now enables the retry_on_ratelimit option by
default. If you need to return to the old behavior, explicitly set it to
false in your options dict.

Change-Id: I3221fda84f0b8031c50128aa600e2c19deb5b102
---
 swiftclient/client.py         | 8 ++++----
 swiftclient/service.py        | 3 +++
 test/unit/test_swiftclient.py | 3 ++-
 3 files changed, 9 insertions(+), 5 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index a9130ab5..8415db22 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -1654,7 +1654,7 @@ def __init__(self, authurl=None, user=None, key=None, retries=5,
                  starting_backoff=1, max_backoff=64, tenant_name=None,
                  os_options=None, auth_version="1", cacert=None,
                  insecure=False, cert=None, cert_key=None,
-                 ssl_compression=True, retry_on_ratelimit=False,
+                 ssl_compression=True, retry_on_ratelimit=True,
                  timeout=None, session=None, force_auth_retry=False):
         """
         :param authurl: authentication URL
@@ -1686,9 +1686,9 @@ def __init__(self, authurl=None, user=None, key=None, retries=5,
                                 will be made. This may provide a performance
                                 increase for https upload/download operations.
         :param retry_on_ratelimit: by default, a ratelimited connection will
-                                   raise an exception to the caller. Setting
-                                   this parameter to True will cause a retry
-                                   after a backoff.
+                                   retry after a backoff. Setting this
+                                   parameter to False will cause an exception
+                                   to be raised to the caller.
         :param timeout: The connect timeout for the HTTP connection.
         :param session: A keystoneauth session object.
         :param force_auth_retry: reset auth info even if client got unexpected
diff --git a/swiftclient/service.py b/swiftclient/service.py
index 9d9fc594..545ea47f 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -155,6 +155,7 @@ def _build_default_global_options():
         "user": environ.get('ST_USER'),
         "key": environ.get('ST_KEY'),
         "retries": 5,
+        "retry_on_ratelimit": True,
         "force_auth_retry": False,
         "os_username": environ.get('OS_USERNAME'),
         "os_user_id": environ.get('OS_USER_ID'),
@@ -270,10 +271,12 @@ def get_conn(options):
     """
     Return a connection building it from the options.
     """
+    options = dict(_default_global_options, **options)
     return Connection(options['auth'],
                       options['user'],
                       options['key'],
                       timeout=options.get('timeout'),
+                      retry_on_ratelimit=options['retry_on_ratelimit'],
                       retries=options['retries'],
                       auth_version=options['auth_version'],
                       os_options=options['os_options'],
diff --git a/test/unit/test_swiftclient.py b/test/unit/test_swiftclient.py
index ad2af50c..436245d8 100644
--- a/test/unit/test_swiftclient.py
+++ b/test/unit/test_swiftclient.py
@@ -2149,7 +2149,8 @@ def quick_sleep(*args):
         c.http_connection = self.fake_http_connection(
             200, 498,
             headers=auth_resp_headers)
-        conn = c.Connection('http://www.test.com/auth/v1.0', 'asdf', 'asdf')
+        conn = c.Connection('http://www.test.com/auth/v1.0', 'asdf', 'asdf',
+                            retry_on_ratelimit=False)
         with self.assertRaises(c.ClientException) as exc_context:
             conn.head_account()
         self.assertIn('Account HEAD failed', str(exc_context.exception))

From 653cbcb686fc34cc28f9c7889e8746e77b95371a Mon Sep 17 00:00:00 2001
From: Clay Gerrard <clay.gerrard@gmail.com>
Date: Wed, 10 Aug 2022 12:38:54 -0500
Subject: [PATCH 237/316] Expand retry handling on ratelimit response

We have seen middlewares that return ratelimit responses as 498 or 429,
so tolerate either.

Closes-Bug: #1879572
Change-Id: I027222157f6c2ad7882a0508302c9de097baae4c
---
 swiftclient/client.py         |  2 +-
 test/unit/test_swiftclient.py | 54 +++++++++++++++++++----------------
 2 files changed, 31 insertions(+), 25 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index 8415db22..16bbba82 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -1833,7 +1833,7 @@ def _retry(self, reset_func, func, *args, **kwargs):
                     self.http_conn = None
                 elif 500 <= err.http_status <= 599:
                     pass
-                elif self.retry_on_ratelimit and err.http_status == 498:
+                elif self.retry_on_ratelimit and err.http_status in (498, 429):
                     pass
                 else:
                     raise
diff --git a/test/unit/test_swiftclient.py b/test/unit/test_swiftclient.py
index 436245d8..ae3e76fd 100644
--- a/test/unit/test_swiftclient.py
+++ b/test/unit/test_swiftclient.py
@@ -2130,31 +2130,37 @@ def quick_sleep(*args):
             pass
         c.sleep = quick_sleep
 
-        # test retries
-        conn = c.Connection('http://www.test.com/auth/v1.0', 'asdf', 'asdf',
-                            retry_on_ratelimit=True)
-        code_iter = [200] + [498] * (conn.retries + 1)
-        auth_resp_headers = {
-            'x-auth-token': 'asdf',
-            'x-storage-url': 'http://storage/v1/test',
-        }
-        c.http_connection = self.fake_http_connection(
-            *code_iter, headers=auth_resp_headers)
-        with self.assertRaises(c.ClientException) as exc_context:
-            conn.head_account()
-        self.assertIn('Account HEAD failed', str(exc_context.exception))
-        self.assertEqual(conn.attempts, conn.retries + 1)
+        def test_status_code(code):
+            # test retries
+            conn = c.Connection('http://www.test.com/auth/v1.0',
+                                'asdf', 'asdf', retry_on_ratelimit=True)
+            code_iter = [200] + [code] * (conn.retries + 1)
+            auth_resp_headers = {
+                'x-auth-token': 'asdf',
+                'x-storage-url': 'http://storage/v1/test',
+            }
+            c.http_connection = self.fake_http_connection(
+                *code_iter, headers=auth_resp_headers)
+            with self.assertRaises(c.ClientException) as exc_context:
+                conn.head_account()
+            self.assertIn('Account HEAD failed', str(exc_context.exception))
+            self.assertEqual(code, exc_context.exception.http_status)
+            self.assertEqual(conn.attempts, conn.retries + 1)
 
-        # test default no-retry
-        c.http_connection = self.fake_http_connection(
-            200, 498,
-            headers=auth_resp_headers)
-        conn = c.Connection('http://www.test.com/auth/v1.0', 'asdf', 'asdf',
-                            retry_on_ratelimit=False)
-        with self.assertRaises(c.ClientException) as exc_context:
-            conn.head_account()
-        self.assertIn('Account HEAD failed', str(exc_context.exception))
-        self.assertEqual(conn.attempts, 1)
+            # test default no-retry
+            c.http_connection = self.fake_http_connection(
+                200, code,
+                headers=auth_resp_headers)
+            conn = c.Connection('http://www.test.com/auth/v1.0',
+                                'asdf', 'asdf', retry_on_ratelimit=False)
+            with self.assertRaises(c.ClientException) as exc_context:
+                conn.head_account()
+            self.assertIn('Account HEAD failed', str(exc_context.exception))
+            self.assertEqual(code, exc_context.exception.http_status)
+            self.assertEqual(conn.attempts, 1)
+
+        test_status_code(498)
+        test_status_code(429)
 
     def test_retry_with_socket_error(self):
         def quick_sleep(*args):

From defbb4a8f390c7de73ac6a90fc1ab5009e8105ee Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Thu, 15 Oct 2020 14:05:28 -0700
Subject: [PATCH 238/316] Allow tempurl times to have units

Specifically, let users add a suffix for seconds, minutes, hours, or
days.

Change-Id: Ibbe7e5aa8aa8e54935da76109c2ea13fb83bc7ab
---
 swiftclient/shell.py    | 18 +++++----
 swiftclient/utils.py    | 89 +++++++++++++++++++++++++----------------
 test/unit/test_shell.py |  8 ++++
 test/unit/test_utils.py | 39 ++++++++++++++++++
 4 files changed, 112 insertions(+), 42 deletions(-)

diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 5bcff7fc..ed39b819 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -1381,14 +1381,16 @@ def st_auth(parser, args, thread_manager, return_parser=False):
   <method>              An HTTP method to allow for this temporary URL.
                         Usually 'GET' or 'PUT'.
   <time>                The amount of time the temporary URL will be
-                        valid. The time can be specified in two ways:
-                        an integer representing the time in seconds or an
-                        ISO 8601 timestamp in a specific format.
-                        If --absolute is passed and time
-                        is an integer, the seconds are intepreted as the Unix
-                        timestamp when the temporary URL will expire. The ISO
-                        8601 timestamp can be specified in one of following
-                        formats:
+                        valid. The time can be specified in three ways:
+                        an integer representing the time in seconds;
+                        a number with a 's', 'm', 'h', or 'd' suffix to specify
+                        the time in seconds, minutes, hours, or days; or
+                        an ISO 8601 timestamp in a specific format.
+                        If --absolute is passed and time is an integer, the
+                        seconds are intepreted as the Unix timestamp when the
+                        temporary URL will expire.
+                        The ISO 8601 timestamp can be specified in one of
+                        following formats:
 
                         i) Complete date: YYYY-MM-DD (eg 1997-07-16)
 
diff --git a/swiftclient/utils.py b/swiftclient/utils.py
index c865d273..1b80e6d6 100644
--- a/swiftclient/utils.py
+++ b/swiftclient/utils.py
@@ -70,40 +70,7 @@ def prt_bytes(num_bytes, human_flag):
         return '%.1f%s' % (num, suffix)
 
 
-def generate_temp_url(path, seconds, key, method, absolute=False,
-                      prefix=False, iso8601=False, ip_range=None,
-                      digest='sha256'):
-    """Generates a temporary URL that gives unauthenticated access to the
-    Swift object.
-
-    :param path: The full path to the Swift object or prefix if
-        a prefix-based temporary URL should be generated. Example:
-        /v1/AUTH_account/c/o or /v1/AUTH_account/c/prefix.
-    :param seconds: time in seconds or ISO 8601 timestamp.
-        If absolute is False and this is the string representation of an
-        integer, then this specifies the amount of time in seconds for which
-        the temporary URL will be valid.
-        If absolute is True then this specifies an absolute time at which the
-        temporary URL will expire.
-    :param key: The secret temporary URL key set on the Swift
-        cluster. To set a key, run 'swift post -m
-        "Temp-URL-Key: <substitute tempurl key here>"'
-    :param method: A HTTP method, typically either GET or PUT, to allow
-        for this temporary URL.
-    :param absolute: if True then the seconds parameter is interpreted as a
-        Unix timestamp, if seconds represents an integer.
-    :param prefix: if True then a prefix-based temporary URL will be generated.
-    :param iso8601: if True, a URL containing an ISO 8601 UTC timestamp
-        instead of a UNIX timestamp will be created.
-    :param ip_range: if a valid ip range, restricts the temporary URL to the
-        range of ips.
-    :param digest: digest algorithm to use. Must be one of ``sha1``,
-                   ``sha256``, or ``sha512``.
-    :raises ValueError: if timestamp or path is not in valid format,
-                        or if digest is not one of ``sha1``, ``sha256``, or
-                        ``sha512``.
-    :return: the path portion of a temporary URL
-    """
+def parse_timestamp(seconds, absolute=False):
     try:
         try:
             timestamp = float(seconds)
@@ -127,6 +94,20 @@ def generate_temp_url(path, seconds, key, method, absolute=False,
                     absolute = True
                     break
 
+            if t is None and not absolute:
+                for suffix, multiplier in (
+                    ('s', 1),
+                    ('m', 60),
+                    ('min', 60),
+                    ('h', 60 * 60),
+                    ('hr', 60 * 60),
+                    ('d', 24 * 60 * 60),
+                ):
+                    if seconds.endswith(suffix):
+                        timestamp = t = int(
+                            multiplier * float(seconds[:-len(suffix)]))
+                        break
+
             if t is None:
                 raise ValueError()
         else:
@@ -137,6 +118,46 @@ def generate_temp_url(path, seconds, key, method, absolute=False,
                 raise ValueError()
     except ValueError:
         raise ValueError(TIME_ERRMSG)
+    return timestamp, absolute
+
+
+def generate_temp_url(path, seconds, key, method, absolute=False,
+                      prefix=False, iso8601=False, ip_range=None,
+                      digest='sha256'):
+    """Generates a temporary URL that gives unauthenticated access to the
+    Swift object.
+
+    :param path: The full path to the Swift object or prefix if
+        a prefix-based temporary URL should be generated. Example:
+        /v1/AUTH_account/c/o or /v1/AUTH_account/c/prefix.
+    :param seconds: time in seconds or ISO 8601 timestamp.
+        If absolute is False and this is the string representation of an
+        integer, then this specifies the amount of time in seconds for which
+        the temporary URL will be valid. This may include a suffix to scale
+        the value: 's' for seconds, 'm' (or 'min') for minutes,
+        'h' (or 'hr') for hours, or 'd' for days.
+        If absolute is True then this specifies an absolute time at which the
+        temporary URL will expire.
+    :param key: The secret temporary URL key set on the Swift
+        cluster. To set a key, run 'swift post -m
+        "Temp-URL-Key: <substitute tempurl key here>"'
+    :param method: A HTTP method, typically either GET or PUT, to allow
+        for this temporary URL.
+    :param absolute: if True then the seconds parameter is interpreted as a
+        Unix timestamp, if seconds represents an integer.
+    :param prefix: if True then a prefix-based temporary URL will be generated.
+    :param iso8601: if True, a URL containing an ISO 8601 UTC timestamp
+        instead of a UNIX timestamp will be created.
+    :param ip_range: if a valid ip range, restricts the temporary URL to the
+        range of ips.
+    :param digest: digest algorithm to use. Must be one of ``sha1``,
+                   ``sha256``, or ``sha512``.
+    :raises ValueError: if timestamp or path is not in valid format,
+                        or if digest is not one of ``sha1``, ``sha256``, or
+                        ``sha512``.
+    :return: the path portion of a temporary URL
+    """
+    timestamp, absolute = parse_timestamp(seconds, absolute)
 
     if isinstance(path, bytes):
         try:
diff --git a/test/unit/test_shell.py b/test/unit/test_shell.py
index 8254388a..80c031ea 100644
--- a/test/unit/test_shell.py
+++ b/test/unit/test_shell.py
@@ -2037,6 +2037,14 @@ def test_temp_url(self, temp_url):
             '/v1/AUTH_account/c/o', "60", 'secret_key', 'GET', absolute=False,
             iso8601=False, prefix=False, ip_range=None, digest='sha256')
 
+        # sanity check that suffixes will just pass through to utils.py
+        argv = ["", "tempurl", "GET", "2d", "/v1/AUTH_account/c/o",
+                "secret_key"]
+        swiftclient.shell.main(argv)
+        temp_url.assert_called_with(
+            '/v1/AUTH_account/c/o', "2d", 'secret_key', 'GET', absolute=False,
+            iso8601=False, prefix=False, ip_range=None, digest='sha256')
+
     @mock.patch('swiftclient.shell.generate_temp_url', return_value='')
     def test_temp_url_prefix_based(self, temp_url):
         argv = ["", "tempurl", "GET", "60", "/v1/AUTH_account/c/",
diff --git a/test/unit/test_utils.py b/test/unit/test_utils.py
index 129208d5..6d2f4a17 100644
--- a/test/unit/test_utils.py
+++ b/test/unit/test_utils.py
@@ -122,6 +122,43 @@ def test_overflow(self):
         self.assertEqual('1024Y', u.prt_bytes(bytes_, True).lstrip())
 
 
+class TestParseTimestamp(unittest.TestCase):
+    def test_int(self):
+        self.assertEqual((1234, False), u.parse_timestamp(1234, False))
+        self.assertEqual((3600, False), u.parse_timestamp('3600', False))
+
+    def test_suffixed(self):
+        self.assertEqual((54, False), u.parse_timestamp('54.321s', False))
+        self.assertEqual((int(54.321 * 60), False),
+                         u.parse_timestamp('54.321m', False))
+        self.assertEqual((900, False),
+                         u.parse_timestamp('15min', False))
+        self.assertEqual((int(54.321 * 60 * 60), False),
+                         u.parse_timestamp('54.321h', False))
+        self.assertEqual((7200, False),
+                         u.parse_timestamp('2hr', False))
+        self.assertEqual((60 * 60 * 24, False), u.parse_timestamp('1d', False))
+
+    def test_str(self):
+        self.assertEqual((1615852800, True),
+                         u.parse_timestamp('2021-03-16T00:00:00Z', False))
+
+    def test_absolute(self):
+        self.assertEqual((1234, True), u.parse_timestamp(1234, True))
+        self.assertEqual((1615852800, True),
+                         u.parse_timestamp('2021-03-16T00:00:00Z', True))
+
+    def test_error(self):
+        with self.assertRaises(ValueError):
+            u.parse_timestamp('asdf', False)
+        with self.assertRaises(ValueError):
+            u.parse_timestamp(12.34, False)
+        with self.assertRaises(ValueError):
+            u.parse_timestamp('54.321', True)
+        with self.assertRaises(ValueError):
+            u.parse_timestamp(-1, False)
+
+
 class TestTempURL(unittest.TestCase):
     url = '/v1/AUTH_account/c/o'
     seconds = 3600
@@ -422,6 +459,7 @@ def test_generate_temp_url_bad_path(self):
 class TestTempURLUnicodePathAndKey(TestTempURL):
     url = '/v1/\u00e4/c/\u00f3'
     key = 'k\u00e9y'
+    seconds = '1hr'
     expected_body = '\n'.join([
         'GET',
         '1400003600',
@@ -432,6 +470,7 @@ class TestTempURLUnicodePathAndKey(TestTempURL):
 class TestTempURLUnicodePathBytesKey(TestTempURL):
     url = '/v1/\u00e4/c/\u00f3'
     key = 'k\u00e9y'.encode('utf-8')
+    seconds = '60m'
     expected_body = '\n'.join([
         'GET',
         '1400003600',

From f4e62191bc174e6235130aab36feb3b161de7848 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 22 Jul 2022 21:38:57 -0700
Subject: [PATCH 239/316] Allow tempurl to be used to sign /info requests

Change-Id: I1f9d26541e9c8f5aec7a6790c87df397d178efe6
---
 swiftclient/utils.py    | 14 +++++++++++---
 test/unit/test_utils.py | 26 ++++++++++++++++++++++++++
 2 files changed, 37 insertions(+), 3 deletions(-)

diff --git a/swiftclient/utils.py b/swiftclient/utils.py
index 1b80e6d6..0a675374 100644
--- a/swiftclient/utils.py
+++ b/swiftclient/utils.py
@@ -173,7 +173,11 @@ def generate_temp_url(path, seconds, key, method, absolute=False,
         raise ValueError('digest must be one of sha1, sha256, or sha512')
 
     parts = path_for_body.split('/', 4)
-    if len(parts) != 5 or parts[0] or not all(parts[1:(4 if prefix else 5)]):
+    if path_for_body == '/info':
+        # /info signatures do not support prefixes or ip ranges
+        prefix = False
+        ip_range = None
+    elif len(parts) != 5 or parts[0] or not all(parts[1:(4 if prefix else 5)]):
         if prefix:
             raise ValueError('path must at least contain /v1/a/c/')
         else:
@@ -220,8 +224,12 @@ def generate_temp_url(path, seconds, key, method, absolute=False,
         expiration = time.strftime(
             EXPIRES_ISO8601_FORMAT, time.gmtime(expiration))
 
-    temp_url = '{path}?temp_url_sig={sig}&temp_url_expires={exp}'.format(
-        path=path_for_body, sig=sig, exp=expiration)
+    if path_for_body == '/info':
+        temp_url = '{path}?swiftinfo_sig={sig}&swiftinfo_expires={exp}'.format(
+            path=path_for_body, sig=sig, exp=expiration)
+    else:
+        temp_url = '{path}?temp_url_sig={sig}&temp_url_expires={exp}'.format(
+            path=path_for_body, sig=sig, exp=expiration)
 
     if ip_range:
         temp_url += '&temp_url_ip_range={}'.format(ip_range)
diff --git a/test/unit/test_utils.py b/test/unit/test_utils.py
index 6d2f4a17..deb38579 100644
--- a/test/unit/test_utils.py
+++ b/test/unit/test_utils.py
@@ -508,6 +508,32 @@ class TestTempURLBytesPathAndNonUtf8Key(TestTempURL):
     ])
 
 
+class TestTempURLInfoPath(TestTempURL):
+    url = '/info'.encode('utf-8')
+    expected_body = b'\n'.join([
+        b'GET',
+        b'1400003600',
+        url,
+    ])
+
+    @property
+    def expected_url(self):
+        if isinstance(self.url, bytes):
+            return self.url + (b'?swiftinfo_sig=temp_url_signature'
+                               b'&swiftinfo_expires=1400003600')
+        return self.url + (u'?swiftinfo_sig=temp_url_signature'
+                           u'&swiftinfo_expires=1400003600')
+
+    @property
+    def expected_sha512_url(self):
+        if isinstance(self.url, bytes):
+            return self.url + (
+                b'?swiftinfo_sig=sha512:dGVtcF91cmxfc2lnbmF0dXJl'
+                b'&swiftinfo_expires=1400003600')
+        return self.url + (u'?swiftinfo_sig=sha512:dGVtcF91cmxfc2lnbmF0dXJl'
+                           u'&swiftinfo_expires=1400003600')
+
+
 class TestReadableToIterable(unittest.TestCase):
 
     def test_iter(self):

From 7f4855dd1bed11528216c43c85e576736cc46958 Mon Sep 17 00:00:00 2001
From: OpenStack Release Bot <infra-root@openstack.org>
Date: Fri, 9 Sep 2022 10:27:22 +0000
Subject: [PATCH 240/316] Update master for stable/zed

Add file to the reno documentation build to show release notes for
stable/zed.

Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/zed.

Sem-Ver: feature
Change-Id: Ibe6a46e97a8e08c2ec38ad1a3b80a1f63659a689
---
 releasenotes/source/index.rst | 1 +
 releasenotes/source/zed.rst   | 6 ++++++
 2 files changed, 7 insertions(+)
 create mode 100644 releasenotes/source/zed.rst

diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst
index f1da9a60..11c331bd 100644
--- a/releasenotes/source/index.rst
+++ b/releasenotes/source/index.rst
@@ -6,6 +6,7 @@
    :maxdepth: 1
 
    current
+   zed
    yoga
    xena
    wallaby
diff --git a/releasenotes/source/zed.rst b/releasenotes/source/zed.rst
new file mode 100644
index 00000000..9608c05e
--- /dev/null
+++ b/releasenotes/source/zed.rst
@@ -0,0 +1,6 @@
+========================
+Zed Series Release Notes
+========================
+
+.. release-notes::
+   :branch: stable/zed

From d9d6257e3b79bb481a6bca2ab67be4caa30f4ea0 Mon Sep 17 00:00:00 2001
From: OpenStack Release Bot <infra-root@openstack.org>
Date: Fri, 9 Sep 2022 10:27:24 +0000
Subject: [PATCH 241/316] Switch to 2023.1 Python3 unit tests and generic
 template name

This is an automatically generated patch to ensure unit testing
is in place for all the of the tested runtimes for antelope. Also,
updating the template name to generic one.

See also the PTI in governance [1].

[1]: https://governance.openstack.org/tc/reference/project-testing-interface.html

Change-Id: I4b8d75aab6b5d80756fbd83ffb62e5135365a685
---
 .zuul.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index d38f37fa..00d179d6 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -30,7 +30,7 @@
     templates:
       - check-requirements
       - lib-forward-testing-python3
-      - openstack-python3-zed-jobs
+      - openstack-python3-jobs
       - publish-openstack-docs-pti
       - release-notes-jobs-python3
     check:

From 3264fd6cfda8e2c144ba9afd2cf5bc7d1c28ddef Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Tue, 27 Dec 2022 13:58:26 -0800
Subject: [PATCH 242/316] Drop *_proxy from passenv

For tox 3.x and earlier, passenv was a space-separated list; as of tox
4.0.0, it's comma-separated. For a while, our spaces would be silently
included in the now-one-and-only passenv value parsed (which wasn't
great, but mostly just caused confusion) -- as of tox 4.0.6, however, it
became a hard error, and all tests would fail like

  pass_env values cannot contain whitespace, use comma to have multiple
  values in a single line, invalid values found 'SWIFT_* *_proxy'

Unfortunately, we don't really know what versions of tox all our various
stakeholders might want/need to use (though we currently set a
minversion of 3.18.0), and (to my knowledge) there's no way to specify
multiple values for passenv in a way that would be compatible with both
old and new tox.

Fortunately, as of 3.14.4, tox include HTTP_PROXY, HTTPS_PROXY, and
NO_PROXY in passenv by default. I'm fairly certain those were the only
reason we had *_proxy to begin with, so just drop it.

Change-Id: I8ddfbc6376434c39e231846135a99bd0bdca9497
---
 .zuul.yaml | 3 +++
 tox.ini    | 2 +-
 2 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index d38f37fa..024b9698 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -10,6 +10,9 @@
     # for installation.
     required-projects:
       - opendev.org/openstack/python-swiftclient
+    vars:
+      # New tox keeps breaking things as of 2023-01
+      ensure_tox_version: '<4'
 
 - job:
     name: swiftclient-functional
diff --git a/tox.ini b/tox.ini
index e1e679d2..3a6cd8a0 100644
--- a/tox.ini
+++ b/tox.ini
@@ -18,7 +18,7 @@ commands = sh -c '(find . -not \( -type d -name .?\* -prune \) \
            -print0) | xargs -0 rm -rf'
            stestr run {posargs}
 allowlist_externals = sh
-passenv = SWIFT_* *_proxy
+passenv = SWIFT_*
 
 [testenv:pep8]
 commands =

From 7a83087a52b86a23be974d7768fb4dd185343ab8 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Thu, 5 Jan 2023 17:45:20 -0800
Subject: [PATCH 243/316] Mark Python 3.10 testing as voting

Change-Id: I4743973e34ef1fcba9e5b64e32b2f1f458de75ba
---
 .zuul.yaml | 4 ++++
 setup.cfg  | 1 +
 2 files changed, 5 insertions(+)

diff --git a/.zuul.yaml b/.zuul.yaml
index 024b9698..5d45a395 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -42,12 +42,16 @@
         - swiftclient-functional
         - openstack-tox-py39:
             voting: true
+        - openstack-tox-py310:
+            voting: true
     gate:
       jobs:
         - swiftclient-swift-functional
         - swiftclient-functional
         - openstack-tox-py39:
             voting: true
+        - openstack-tox-py310:
+            voting: true
     post:
       jobs:
         - openstack-tox-cover
diff --git a/setup.cfg b/setup.cfg
index e429b12f..dfeb3b7c 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -21,6 +21,7 @@ classifier =
     Programming Language :: Python :: 3.7
     Programming Language :: Python :: 3.8
     Programming Language :: Python :: 3.9
+    Programming Language :: Python :: 3.10
     Programming Language :: Python :: 3 :: Only
 
 [files]

From 20cee12be68628528c1b417bcd91c2c56f04ea8a Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Thu, 5 Jan 2023 17:47:25 -0800
Subject: [PATCH 244/316] Add experimental jobs for py36/37

Change-Id: I6452aa6019d66da21dd512a6b4267a896d4893d4
---
 .zuul.yaml | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/.zuul.yaml b/.zuul.yaml
index 5d45a395..e38fa65e 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -36,6 +36,11 @@
       - openstack-python3-zed-jobs
       - publish-openstack-docs-pti
       - release-notes-jobs-python3
+    experimental:
+      # on-demand pipeline used to test older (but still supported) versions of python
+      jobs:
+        - openstack-tox-py36
+        - openstack-tox-py37
     check:
       jobs:
         - swiftclient-swift-functional

From 6954ab1bbb464eebe30875bf53ee79037baf7ea1 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 6 Jan 2023 12:05:14 -0800
Subject: [PATCH 245/316] Back-fill a bunch of ChangeLog releases

Change-Id: I3d89c3ff3d2789d64ba8f9c46fd1cd27c4c3a845
---
 AUTHORS   |  17 +++++++++
 ChangeLog | 101 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 118 insertions(+)

diff --git a/AUTHORS b/AUTHORS
index 165e9d07..fe536af0 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -1,3 +1,4 @@
+Aarni Koskela (akx@iki.fi)
 Alessandro Pilotti (ap@pilotti.it)
 Alex Gaynor (alex.gaynor@gmail.com)
 Alex Schultz (aschultz@redhat.com)
@@ -43,6 +44,8 @@ Fabien Boucher (fabien.boucher@enovance.com)
 Feng Liu (mefengliu23@gmail.com)
 Flavio Percoco (flaper87@gmail.com)
 Florent Flament (florent.flament-ext@cloudwatt.com)
+fuzihao (fuzihao@inspur.com)
+Ghanshyam Mann (gmann@ghanshyammann.com)
 Greg Holt (gholt@rackspace.com)
 Greg Lange (greglange@gmail.com)
 groqez (groqez@yopmail.net)
@@ -54,6 +57,7 @@ Hiroshi Miura (miurahr@nttdata.co.jp)
 howardlee (lihongweibj@inspur.com)
 Hu Bing (hubingsh@cn.ibm.com)
 Ian Cordasco (ian.cordasco@rackspace.com)
+Ivan Kolodyazhny (e0ne@e0ne.info)
 jacky06 (zhang.min@99cloud.net)
 Jaivish Kothari (jaivish.kothari@nectechnologies.in)
 Jakub Krajcovic (jakub.krajcovic@gmail.com)
@@ -63,8 +67,10 @@ Jeremy Stanley (fungi@yuggoth.org)
 Ji-Wei (ji.wei3@zte.com.cn)
 Jian Zhang (jian.zhang@intel.com)
 Jing Liuqing (jing.liuqing@99cloud.net)
+jinyuanliu (liujinyuan@inspur.com)
 Jiří Suchomel (jsuchome@suse.cz)
 Joel Wright (joel.wright@sohonet.com)
+jonasdlindner (jonaslindner55@gmail.com)
 John Dickinson (me@not.mn)
 Jola Mirecka (jola.mirecka@hp.com)
 Josh Gachnang (josh@pcsforeducation.com)
@@ -88,6 +94,7 @@ Mark Washenberger (mark.washenberger@rackspace.com)
 Martin Geisler (martin@geisler.net)
 Matthew Oliver (matt@oliver.net.au)
 Matthieu Huin (mhu@enovance.com)
+Meuh (fabien+swift@bagard.xyz)
 Mike Widman (mwidman@endurancewindpower.com)
 Min Min Ren (rminmin@cn.ibm.com)
 mmcardle (mark.mcardle@sohonet.com)
@@ -101,6 +108,8 @@ Nguyen Hung Phuong (phuongnh@vn.fujitsu.com)
 Nick Craig-Wood (nick@craig-wood.com)
 Ondrej Novy (ondrej.novy@firma.seznam.cz)
 Pallavi (pallavi.s@nectechnologies.in)
+PAPAMICA (mickael@papamica.com)
+Pavel Abalikhin (anpavl@gmail.com)
 Paul Belanger (pabelanger@redhat.com)
 Paulo Ewerton (pauloewerton@lsd.ufcg.edu.br)
 pengyuesheng (pengyuesheng@gohighsec.com)
@@ -119,6 +128,7 @@ SaiKiran (saikiranveeravarapu@gmail.com)
 Sam Morrison (sorrison@gmail.com)
 Samuel Merritt (sam@swiftstack.com)
 Sean Dague (sean@dague.net)
+Sean McGinnis (sean.mcginnis@gmail.com)
 Sébastien Blaisot (sebastien@blaisot.org)
 Sergey Gotliv (sgotliv@redhat.com)
 Sergio Cazzolato (sergio.j.cazzolato@intel.com)
@@ -129,6 +139,8 @@ Shashirekha Gundur (shashirekha.j.gundur@intel.com)
 shu-mutou (shu-mutou@rf.jp.nec.com)
 Stanislav Vitkovskiy (stas.vitkovsky@gmail.com)
 Stanislaw Pitucha (stanislaw.pitucha@hpe.com)
+Stephen Finucane (stephenfin@redhat.com)
+Steve Kowalik (steven@wedontsleep.org)
 Steve Martinelli (stevemar@ca.ibm.com)
 Steven Hardy (shardy@redhat.com)
 Stuart McLaren (stuart.mclaren@hpe.com)
@@ -136,6 +148,8 @@ sunjia (sunjia@inspur.com)
 Sushil Kumar (sushil.kumar2@globallogic.com)
 tanlin (lin.tan@intel.com)
 Taurus Cheung (Taurus.Cheung@harmonicinc.com)
+Takashi Kajinami (tkajinam@redhat.com)
+Takashi Natsume (takanattie@gmail.com)
 TheSriram (sriram@klusterkloud.com)
 Thiago da Silva (thiagodasilva@gmail.com)
 Thomas Goirand (thomas@goirand.fr)
@@ -156,8 +170,10 @@ wangxiyuan (wangxiyuan@huawei.com)
 wangzhenyu (wangzy@fiberhome.com)
 Wu Wenxiang (wu.wenxiang@99cloud.net)
 wu.chunyang (wu.chunyang@99cloud.net)
+wu.shiming (wushiming@yovole.com)
 YangLei (yanglyy@cn.ibm.com)
 yangxurong (yangxurong@huawei.com)
+yangyawei (yangyawei@inspur.com)
 You Yamagata (bi.yamagata@gmail.com)
 Yuan Zhou (yuan.zhou@intel.com)
 Yushiro FURUKAWA (y.furukawa_2@jp.fujitsu.com)
@@ -166,6 +182,7 @@ yuyafei (yu.yafei@zte.com.cn)
 YUZAWA Takahiko (yuzawataka@intellilink.co.jp)
 Zack M. Davis (zdavis@swiftstack.com)
 zhang-jinnan (ben.os@99cloud.net)
+zhangboye (zhangboye@inspur.com)
 zhangyanxian (zhangyanxianmail@163.com)
 zheng yin (yin.zheng@easystack.cn)
 Zhenguo Niu (zhenguo@unitedstack.com)
diff --git a/ChangeLog b/ChangeLog
index cecee2da..802b2ef1 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,104 @@
+4.1.0
+-----
+
+* Tempurl times may now include suffixes: 's', 'm', 'h', or 'd' to indicate
+  seconds, minutes, hours, or days respectively. Times with no suffix
+  continue to be interpretted as seconds.
+
+* Rate-limit responses (498, 429) are now retried.
+
+* Added a `--skip-container-put` option when uploading.
+
+
+4.0.1
+-----
+
+* Added a new `--digest` option to `swift tempurl` to select the signature
+  algorithm to use. Default is sha256, which has been supported by default
+  since Swift 2.17.0, though older clusters may require sha1 (the previous
+  default). Use `swift capabilities` to check the `allowed_digests`.
+
+
+4.0.0
+-----
+
+* Drop support for Python 2.
+
+* Added a `--timeout` option. By default, operations wait indefinitely.
+
+* Swiftclient no longer monkey-patches the requests library.
+
+
+3.13.1
+-----
+
+* This is the final release to support Python 2.
+
+* Fix some example code.
+
+
+3.13.0
+-----
+
+* Improve account-listing formatting when containers have billions of objects.
+
+* Include storage policy information in long-formatted account listings.
+
+* Fix aggregation when listings include more than 10,000 items.
+
+* Suppress traceback logging for 404s.
+
+
+3.12.0
+-----
+
+* Various minor bug fixes and improvements.
+
+
+3.11.1
+-----
+
+* Various minor bug fixes and improvements.
+
+
+3.11.0
+-----
+
+* Fixed a file descriptor leak on Python 2 that was introduced in 3.9.0.
+
+* Transaction IDs are now included in more exceptions.
+
+* Fixed a socket leak when using some module-level functions.
+
+* `swift delete --all` now implies `--versions` to delete all old versions
+  of objects as well.
+
+* Now tested under Python 3.9.
+
+
+3.10.1
+-----
+
+* Tolerate some password-based values for `OS_AUTH_TYPE`.
+
+* Added `max_backoff` and `starting_backoff` options in the `SwiftService` API.
+
+
+3.10.0
+-----
+
+* Added support for the new object-versioning API to the `list`, `stat`,
+  `delete`, and `download` subcommands. This optional API was introduced
+  in Swift 2.24.0; for more information on the API, see
+  https://docs.openstack.org/swift/latest/middleware.html#object-versioning-api
+
+* Added support for Keystone v3 application credentials using
+  `--os-auth-type v3applicationcredential`.
+
+* Fixed an issue with capabilities-endpoint discovery when Swift is exposed as
+  a subpath on the server.
+
+
 3.9.0
 -----
 

From ff6b359d066981861f35fbc31803321a6e6b3304 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Wed, 15 Feb 2023 21:00:51 -0800
Subject: [PATCH 246/316] Retry with fresh socket on 499

Change-Id: I0c22eefb587375997672724c03744c9cda473708
---
 swiftclient/client.py         | 4 +++-
 test/unit/test_swiftclient.py | 1 +
 2 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index e42ac700..b9f12aac 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -1821,7 +1821,9 @@ def _retry(self, reset_func, func, *args, **kwargs):
                     retried_auth = True
                 elif self.attempts > self.retries or err.http_status is None:
                     raise
-                elif err.http_status == 408:
+                elif err.http_status in (408, 499):
+                    # Server hit a timeout, so HTTP request/response framing
+                    # are likely in a bad state; trash the connection
                     self.http_conn = None
                 elif 500 <= err.http_status <= 599:
                     pass
diff --git a/test/unit/test_swiftclient.py b/test/unit/test_swiftclient.py
index ae3e76fd..55b4679a 100644
--- a/test/unit/test_swiftclient.py
+++ b/test/unit/test_swiftclient.py
@@ -2224,6 +2224,7 @@ def mock_http_connection(*args, **kwargs):
         do_test(401, 2)
         # others will be tried until retry limits
         do_test(408, 6)
+        do_test(499, 6)
         do_test(500, 6)
         do_test(503, 6)
 

From cf3be5210f9c5f73d79ba9b8d23f3b08ea152a7d Mon Sep 17 00:00:00 2001
From: OpenStack Release Bot <infra-root@openstack.org>
Date: Fri, 24 Feb 2023 15:08:24 +0000
Subject: [PATCH 247/316] Update master for stable/2023.1

Add file to the reno documentation build to show release notes for
stable/2023.1.

Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/2023.1.

Sem-Ver: feature
Change-Id: I757174e91ffd514d97a76886ab728652ddba79e9
---
 releasenotes/source/2023.1.rst | 6 ++++++
 releasenotes/source/index.rst  | 1 +
 2 files changed, 7 insertions(+)
 create mode 100644 releasenotes/source/2023.1.rst

diff --git a/releasenotes/source/2023.1.rst b/releasenotes/source/2023.1.rst
new file mode 100644
index 00000000..d1238479
--- /dev/null
+++ b/releasenotes/source/2023.1.rst
@@ -0,0 +1,6 @@
+===========================
+2023.1 Series Release Notes
+===========================
+
+.. release-notes::
+   :branch: stable/2023.1
diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst
index 11c331bd..ae2042c1 100644
--- a/releasenotes/source/index.rst
+++ b/releasenotes/source/index.rst
@@ -6,6 +6,7 @@
    :maxdepth: 1
 
    current
+   2023.1
    zed
    yoga
    xena

From 16f0034e67f16cb81912bcc6a0f7ac9823f32e1f Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 10 Mar 2023 21:17:32 -0800
Subject: [PATCH 248/316] Switch from pkg_resources to importlib

Seen on Arch Linux:

    ModuleNotFoundError: No module named 'pkg_resources'

On new enough Python, we don't need it anyway.

Change-Id: I3d46319a36a1c2477e9f7dae0c7e40a362a17639
---
 swiftclient/version.py | 30 ++++++++++++++++++++++--------
 1 file changed, 22 insertions(+), 8 deletions(-)

diff --git a/swiftclient/version.py b/swiftclient/version.py
index 6f01f369..4a03ce98 100644
--- a/swiftclient/version.py
+++ b/swiftclient/version.py
@@ -12,16 +12,30 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
-import pkg_resources
+version_string = None
 
+# First, try to get our version out of PKG-INFO. If we're installed,
+# this'll let us find our version without pulling in pbr. After all, if
+# we're installed on a system, we're not in a Git-managed source tree, so
+# pbr doesn't really buy us anything.
 try:
-    # First, try to get our version out of PKG-INFO. If we're installed,
-    # this will let us find our version without pulling in pbr. After all, if
-    # we're installed on a system, we're not in a Git-managed source tree, so
-    # pbr doesn't really buy us anything.
-    version_string = pkg_resources.get_provider(
-        pkg_resources.Requirement.parse('python-swiftclient')).version
-except pkg_resources.DistributionNotFound:
+    import importlib.metadata
+except ImportError:
+    # python < 3.8
+    import pkg_resources
+    try:
+        version_string = pkg_resources.get_provider(
+            pkg_resources.Requirement.parse('python-swiftclient')).version
+    except pkg_resources.DistributionNotFound:
+        pass
+else:
+    try:
+        version_string = importlib.metadata.distribution(
+            'python-swiftclient').version
+    except importlib.metadata.PackageNotFoundError:
+        pass
+
+if version_string is None:
     # No PKG-INFO? We're probably running from a checkout, then. Let pbr do
     # its thing to figure out a version number.
     import pbr.version

From 6adb8bb17fe55a33d3605944653ca956eabc9ece Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 10 Mar 2023 09:22:34 -0800
Subject: [PATCH 249/316] service: Check content-length before etag

If the received content-length does not match expectations, of course
the etag won't match!

Co-Authored-By: Alistair Coles <alistairncoles@gmail.com>
Change-Id: I1a0c066c11b94718fffbb11e13b82d0b16e01626
---
 swiftclient/service.py    | 14 +++++++-------
 test/unit/test_service.py | 20 ++++++++++++++++++--
 2 files changed, 25 insertions(+), 9 deletions(-)

diff --git a/swiftclient/service.py b/swiftclient/service.py
index 9a6c7a11..d1c98d6c 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -457,13 +457,6 @@ def __iter__(self):
         self._check_contents()
 
     def _check_contents(self):
-        if self._actual_md5 and self._expected_md5:
-            etag = self._actual_md5.hexdigest()
-            if etag != self._expected_md5:
-                raise SwiftError('Error downloading {0}: md5sum != etag, '
-                                 '{1} != {2}'.format(
-                                     self._path, etag, self._expected_md5))
-
         if (self._content_length is not None and
                 self._actual_read != self._content_length):
             raise SwiftError('Error downloading {0}: read_length != '
@@ -471,6 +464,13 @@ def _check_contents(self):
                                  self._path, self._actual_read,
                                  self._content_length))
 
+        if self._actual_md5 and self._expected_md5:
+            etag = self._actual_md5.hexdigest()
+            if etag != self._expected_md5:
+                raise SwiftError('Error downloading {0}: md5sum != etag, '
+                                 '{1} != {2}'.format(
+                                     self._path, etag, self._expected_md5))
+
     def bytes_read(self):
         return self._actual_read
 
diff --git a/test/unit/test_service.py b/test/unit/test_service.py
index 1176a1f8..b6db22d2 100644
--- a/test/unit/test_service.py
+++ b/test/unit/test_service.py
@@ -196,8 +196,24 @@ def _consume(sr):
 
         # Check error is raised if SwiftReader doesn't read the same length
         # as the content length it is created with
-        sr = self.sr('path', BytesIO(b'body'), {'content-length': 5})
-        self.assertRaises(SwiftError, _consume, sr)
+        sr = self.sr('path', BytesIO(b'body'), {'content-length': 5,
+                                                'etag': 'bad etag'})
+        with self.assertRaises(SwiftError) as cm:
+            _consume(sr)
+        self.assertEqual(
+            "'Error downloading path: read_length != content_length, 4 != 5'",
+            str(cm.exception))
+
+        # Check error is raised if SwiftReader doesn't calculate the expected
+        # hash
+        sr = self.sr('path', BytesIO(b'body'), {'content-length': 4,
+                                                'etag': 'bad etag'})
+        with self.assertRaises(SwiftError) as cm:
+            _consume(sr)
+        self.assertEqual(
+            "'Error downloading path: md5sum != etag, "
+            "841a2d689ad86bd1611447453c22c6fc != bad etag'",
+            str(cm.exception))
 
         sr = self.sr('path', BytesIO(b'body'), {'content-length': 4})
         _consume(sr)

From e3432982405a8446ca2c7384334fa9c6d10a6271 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Tue, 14 Mar 2023 11:52:50 -0700
Subject: [PATCH 250/316] Include transaction ID on content-check failures

Change-Id: I6b667db26ffc5dccdcadfc8c73f7accb81f03dac
---
 swiftclient/service.py    | 20 +++++++++++++-------
 test/unit/test_service.py | 16 ++++++++++++++--
 2 files changed, 27 insertions(+), 9 deletions(-)

diff --git a/swiftclient/service.py b/swiftclient/service.py
index d1c98d6c..e905ea64 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -419,6 +419,9 @@ class _SwiftReader:
     def __init__(self, path, body, headers, checksum=True):
         self._path = path
         self._body = body
+        self._txn_id = headers.get('x-openstack-request-id')
+        if self._txn_id is None:
+            self._txn_id = headers.get('x-trans-id')
         self._actual_read = 0
         self._content_length = None
         self._actual_md5 = None
@@ -459,17 +462,20 @@ def __iter__(self):
     def _check_contents(self):
         if (self._content_length is not None and
                 self._actual_read != self._content_length):
-            raise SwiftError('Error downloading {0}: read_length != '
-                             'content_length, {1:d} != {2:d}'.format(
-                                 self._path, self._actual_read,
-                                 self._content_length))
+            raise SwiftError(
+                'Error downloading {0}: read_length != content_length, '
+                '{1:d} != {2:d} (txn: {3})'.format(
+                    self._path, self._actual_read, self._content_length,
+                    self._txn_id or 'unknown'))
 
         if self._actual_md5 and self._expected_md5:
             etag = self._actual_md5.hexdigest()
             if etag != self._expected_md5:
-                raise SwiftError('Error downloading {0}: md5sum != etag, '
-                                 '{1} != {2}'.format(
-                                     self._path, etag, self._expected_md5))
+                raise SwiftError(
+                    'Error downloading {0}: md5sum != etag, '
+                    '{1} != {2} (txn: {3})'.format(
+                        self._path, etag, self._expected_md5,
+                        self._txn_id or 'unknown'))
 
     def bytes_read(self):
         return self._actual_read
diff --git a/test/unit/test_service.py b/test/unit/test_service.py
index b6db22d2..cdab61fa 100644
--- a/test/unit/test_service.py
+++ b/test/unit/test_service.py
@@ -201,7 +201,19 @@ def _consume(sr):
         with self.assertRaises(SwiftError) as cm:
             _consume(sr)
         self.assertEqual(
-            "'Error downloading path: read_length != content_length, 4 != 5'",
+            "'Error downloading path: read_length != content_length, "
+            "4 != 5 (txn: unknown)'",
+            str(cm.exception))
+
+        # Check error includes txn id if available
+        sr = self.sr('path', BytesIO(b'body'), {'content-length': 5,
+                                                'etag': 'bad etag',
+                                                'x-trans-id': 'uuid'})
+        with self.assertRaises(SwiftError) as cm:
+            _consume(sr)
+        self.assertEqual(
+            "'Error downloading path: read_length != content_length, "
+            "4 != 5 (txn: uuid)'",
             str(cm.exception))
 
         # Check error is raised if SwiftReader doesn't calculate the expected
@@ -212,7 +224,7 @@ def _consume(sr):
             _consume(sr)
         self.assertEqual(
             "'Error downloading path: md5sum != etag, "
-            "841a2d689ad86bd1611447453c22c6fc != bad etag'",
+            "841a2d689ad86bd1611447453c22c6fc != bad etag (txn: unknown)'",
             str(cm.exception))
 
         sr = self.sr('path', BytesIO(b'body'), {'content-length': 4})

From d368644bc6a8bbcb13878c0bd2f16dfc8bbd99e0 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 17 Mar 2023 16:47:34 -0700
Subject: [PATCH 251/316] Metadata updates

Include project_urls so PyPI gets more sidebar links.

Include long_description_content_type to quiet a twine warning.

Change-Id: Id3b90927ba24fd47efdbeeb2107bdae9e86e93ba
---
 setup.cfg | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/setup.cfg b/setup.cfg
index dfeb3b7c..9d407650 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -3,10 +3,16 @@ name = python-swiftclient
 summary = OpenStack Object Storage API Client Library
 description_file =
     README.rst
+long_description_content_type = text/x-rst
 license = Apache License, Version 2.0
 author = OpenStack
 author_email = openstack-discuss@lists.openstack.org
 home_page = https://docs.openstack.org/python-swiftclient/latest/
+project_urls =
+    Bug Tracker = https://bugs.launchpad.net/python-swiftclient
+    Documentation = https://docs.openstack.org/python-swiftclient/latest/
+    Release Notes = https://opendev.org/openstack/python-swiftclient/src/branch/master/ChangeLog
+    Source Code = https://opendev.org/openstack/python-swiftclient
 python_requires = >=3.6
 classifier =
     Environment :: OpenStack

From 099dd66265dfdc94e162eba4c1ec3a33b305bc26 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 17 Mar 2023 16:14:15 -0700
Subject: [PATCH 252/316] Retry on SSLError

...provided it isn't something to do with certification validation.

Closes-Bug: #1641363
Closes-Bug: #2011731
Change-Id: Ic3acbf431e444fcd8bc0fe79571fe2db4140cf22
---
 swiftclient/client.py         |  9 ++++--
 test/unit/test_swiftclient.py | 58 ++++++++++++++++++++++++++++++++++-
 2 files changed, 64 insertions(+), 3 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index b9f12aac..06350901 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -1798,8 +1798,13 @@ def _retry(self, reset_func, func, *args, **kwargs):
                           service_token=self.service_token, **kwargs)
                 self._add_response_dict(caller_response_dict, kwargs)
                 return rv
-            except SSLError:
-                raise
+            except SSLError as e:
+                self._add_response_dict(caller_response_dict, kwargs)
+                if ('certificate verify' in str(e)) or \
+                        ('hostname' in str(e)) or \
+                        self.attempts > self.retries:
+                    raise
+                self.http_conn = None
             except (socket.error, RequestException):
                 self._add_response_dict(caller_response_dict, kwargs)
                 if self.attempts > self.retries:
diff --git a/test/unit/test_swiftclient.py b/test/unit/test_swiftclient.py
index 55b4679a..42d470cd 100644
--- a/test/unit/test_swiftclient.py
+++ b/test/unit/test_swiftclient.py
@@ -25,7 +25,7 @@
 import tempfile
 from hashlib import md5
 from urllib.parse import urlparse
-from requests.exceptions import RequestException
+from requests.exceptions import RequestException, SSLError
 
 from .utils import (MockHttpTest, fake_get_auth_keystone, StubResponse,
                     FakeKeystone)
@@ -2176,6 +2176,62 @@ def quick_sleep(*args):
         self.assertEqual(mock_auth.call_count, 1)
         self.assertEqual(conn.attempts, conn.retries + 1)
 
+    def test_no_retry_with_cert_sslerror(self):
+        def quick_sleep(*args):
+            pass
+        c.sleep = quick_sleep
+        for err in (
+            # Taken from real testing (requests==2.25.1, urllib3==1.26.5,
+            # pyOpenSSL==21.0.0) but note that these are actually way more
+            # messy/wrapped up in other exceptions
+            SSLError(
+                '[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: '
+                'certificate has expired (_ssl.c:997)'),
+            SSLError(
+                "hostname 'wrong.host.badssl.com' doesn't match either of "
+                "'*.badssl.com', 'badssl.com'"),
+            SSLError(
+                '[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: '
+                'self-signed certificate (_ssl.c:997)'),
+            SSLError(
+                '[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: '
+                'self-signed certificate in certificate chain (_ssl.c:997)'),
+            SSLError(
+                '[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: '
+                'unable to get local issuer certificate (_ssl.c:997)'),
+            SSLError(
+                '[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: '
+                'CA signature digest algorithm too weak (_ssl.c:997)'),
+        ):
+            conn = c.Connection('http://www.test.com', 'asdf', 'asdf')
+            with self.subTest(err=err), mock.patch(
+                    'swiftclient.client.http_connection') as \
+                    fake_http_connection, \
+                    mock.patch('swiftclient.client.get_auth_1_0') as mock_auth:
+                mock_auth.return_value = ('http://mock.com', 'mock_token')
+                fake_http_connection.side_effect = err
+                self.assertRaises(socket.error, conn.head_account)
+                self.assertEqual(mock_auth.call_count, 1)
+                self.assertEqual(conn.attempts, 1)
+
+    def test_retry_with_non_cert_sslerror(self):
+        def quick_sleep(*args):
+            pass
+        c.sleep = quick_sleep
+        conn = c.Connection('http://www.test.com', 'asdf', 'asdf')
+        with mock.patch('swiftclient.client.http_connection') as \
+                fake_http_connection, \
+                mock.patch('swiftclient.client.get_auth_1_0') as mock_auth:
+            mock_auth.return_value = ('http://mock.com', 'mock_token')
+            fake_http_connection.side_effect = SSLError(
+                "HTTPSConnectionPool(host='example.com', port=443): "
+                "Max retries exceeded with url: /v1/AUTH_test (Caused by "
+                "SSLError(SSLZeroReturnError(6, 'TLS/SSL connection has "
+                "been closed (EOF) (_ssl.c:997)')))")
+            self.assertRaises(socket.error, conn.head_account)
+        self.assertEqual(mock_auth.call_count, 1)
+        self.assertEqual(conn.attempts, conn.retries + 1)
+
     def test_retry_with_force_auth_retry_exceptions(self):
         def quick_sleep(*args):
             pass

From 9e703b9345cffd90d723e0ce5c180a385c75c62e Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Mon, 20 Mar 2023 11:27:50 -0700
Subject: [PATCH 253/316] shell: Allow timeouts to have units

Related-Change: Ibbe7e5aa8aa8e54935da76109c2ea13fb83bc7ab
Change-Id: Ifeaaea790d1dadc84b157a7cf2be7590949c70f0
---
 swiftclient/shell.py    |  4 ++--
 swiftclient/utils.py    | 14 ++++++++++++++
 test/unit/test_shell.py | 21 +++++++++++++++++++++
 3 files changed, 37 insertions(+), 2 deletions(-)

diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 882a1c08..dc68aa9c 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -31,7 +31,7 @@
 
 from swiftclient import RequestException
 from swiftclient.utils import config_true_value, generate_temp_url, \
-    prt_bytes, JSONableIterable
+    prt_bytes, parse_timeout, JSONableIterable
 from swiftclient.multithreading import OutputManager
 from swiftclient.exceptions import ClientException
 from swiftclient import __version__ as client_version
@@ -1746,7 +1746,7 @@ def add_default_args(parser):
     parser.add_argument('-K', '--key', dest='key',
                         default=environ.get('ST_KEY'),
                         help='Key for obtaining an auth token.')
-    parser.add_argument('-T', '--timeout', type=int, dest='timeout',
+    parser.add_argument('-T', '--timeout', type=parse_timeout, dest='timeout',
                         default=None,
                         help='Timeout in seconds to wait for response.')
     parser.add_argument('-R', '--retries', type=int, default=5, dest='retries',
diff --git a/swiftclient/utils.py b/swiftclient/utils.py
index 0a675374..39481e49 100644
--- a/swiftclient/utils.py
+++ b/swiftclient/utils.py
@@ -70,6 +70,20 @@ def prt_bytes(num_bytes, human_flag):
         return '%.1f%s' % (num, suffix)
 
 
+def parse_timeout(value):
+    for suffix, multiplier in (
+        ('s', 1),
+        ('m', 60),
+        ('min', 60),
+        ('h', 60 * 60),
+        ('hr', 60 * 60),
+        ('d', 24 * 60 * 60),
+    ):
+        if value.endswith(suffix):
+            return multiplier * float(value[:-len(suffix)])
+    return float(value)
+
+
 def parse_timestamp(seconds, absolute=False):
     try:
         try:
diff --git a/test/unit/test_shell.py b/test/unit/test_shell.py
index 98d73e9a..f1032466 100644
--- a/test/unit/test_shell.py
+++ b/test/unit/test_shell.py
@@ -2424,6 +2424,27 @@ def test_debug_trumps_info(self, connection, mock_logging):
                           % (mock_logging.call_args_list, argv))
 
 
+@mock.patch.dict(os.environ, mocked_os_environ)
+class TestTimeoutOption(unittest.TestCase):
+    @mock.patch('swiftclient.service.Connection')
+    def test_timeout_parsing(self, connection):
+        for timeout, expected in (
+            ("12", 12),
+            ("12.3", 12.3),
+            ("5s", 5),
+            ("25.6s", 25.6),
+            ("2m", 120),
+            ("2.5min", 150),
+            ("1h", 3600),
+            (".5hr", 1800),
+        ):
+            connection.reset_mock()
+            with self.subTest(timeout=timeout):
+                swiftclient.shell.main(["", "stat", "--timeout", timeout])
+                self.assertEqual(connection.mock_calls[0].kwargs['timeout'],
+                                 expected)
+
+
 class TestBase(unittest.TestCase):
     """
     Provide some common methods to subclasses

From 6a8675e897e634abd26d993181ac4a45b9cf16f7 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Mon, 14 Nov 2022 13:17:47 -0800
Subject: [PATCH 254/316] Use SLO by default for segmented uploads if the
 cluster supports it

We've had SLO for nearly ten years, and it is preferable for most
use-cases. It's time to default to SLO rather than DLO.

Add a new --use-dlo option to give users a way to return to old
behavior; ensure there is still a --use-slo option so we don't break
existing scripts that may use it.

UpgradeImpact:
==============
The default segmented-upload behavior has changed; Static Large Objects
are now used by default rather than Dynamic Large Objects. To revert to
the old behavior:

* CLI users may use the new `--use-dlo` option
* Service API users may explicitly set `use_slo` to False in their
  options dicts

Change-Id: Iebcd64ced8eab6efebb9f02a0c4be6bf6338cb3b
---
 swiftclient/service.py    | 16 +++++++-
 swiftclient/shell.py      | 20 ++++++----
 test/unit/test_service.py | 80 ++++++++++++++++++++++++++++++++++++++-
 test/unit/test_shell.py   | 65 +++++++++++++++++++++++++++++--
 4 files changed, 168 insertions(+), 13 deletions(-)

diff --git a/swiftclient/service.py b/swiftclient/service.py
index e905ea64..dd714090 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -196,7 +196,7 @@ def _build_default_global_options():
 _default_local_options = {
     'sync_to': None,
     'sync_key': None,
-    'use_slo': False,
+    'use_slo': None,
     'segment_size': None,
     'segment_container': None,
     'leave_segments': False,
@@ -1467,7 +1467,7 @@ def upload(self, container, objects, options=None):
                                 'meta': [],
                                 'header': [],
                                 'segment_size': None,
-                                'use_slo': False,
+                                'use_slo': True,
                                 'segment_container': None,
                                 'leave_segments': False,
                                 'changed': None,
@@ -1493,6 +1493,18 @@ def upload(self, container, objects, options=None):
         except ValueError:
             raise SwiftError('Segment size should be an integer value')
 
+        if segment_size and options['use_slo'] is None:
+            try:
+                cap_result = self.capabilities()
+            except ClientException:
+                # pre-info swift, maybe? assume no slo middleware
+                options['use_slo'] = False
+            else:
+                if not cap_result['success']:
+                    options['use_slo'] = False
+                else:
+                    options['use_slo'] = 'slo' in cap_result['capabilities']
+
         # Incase we have a psudeo-folder path for <container> arg, derive
         # the container name from the top path and prepend the rest to
         # the object name. (same as passing --object-name).
diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 882a1c08..319141d5 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -978,8 +978,8 @@ def st_copy(parser, args, output_manager, return_parser=False):
 st_upload_options = '''[--changed] [--skip-identical] [--segment-size <size>]
                     [--segment-container <container>] [--leave-segments]
                     [--object-threads <thread>] [--segment-threads <threads>]
-                    [--meta <name:value>] [--header <header>]
-                    [--use-slo] [--ignore-checksum] [--skip-container-put]
+                    [--meta <name:value>] [--header <header>] [--use-slo]
+                    [--use-dlo] [--ignore-checksum] [--skip-container-put]
                     [--object-name <object-name>]
                     <container> <file_or_directory> [<file_or_directory>] [...]
 '''
@@ -1024,8 +1024,11 @@ def st_copy(parser, args, output_manager, return_parser=False):
                         repeated. Example: -H "content-type:text/plain"
                          -H "Content-Length: 4000".
   --use-slo             When used in conjunction with --segment-size it will
-                        create a Static Large Object instead of the default
-                        Dynamic Large Object.
+                        create a Static Large Object. Deprecated; this is now
+                        the default behavior when the cluster supports it.
+  --use-dlo             When used in conjunction with --segment-size it will
+                        create a Dynamic Large Object. May be useful with old
+                        swift clusters.
   --ignore-checksum     Turn off checksum validation for uploads.
   --skip-container-put  Assume all necessary containers already exist; don't
                         automatically try to create them.
@@ -1087,10 +1090,13 @@ def st_upload(parser, args, output_manager, return_parser=False):
         ' This option may be repeated. Example: -H "content-type:text/plain" '
         '-H "Content-Length: 4000"')
     parser.add_argument(
-        '--use-slo', action='store_true', default=False,
+        '--use-slo', action='store_true', default=None,
         help='When used in conjunction with --segment-size, it will '
-        'create a Static Large Object instead of the default '
-        'Dynamic Large Object.')
+        'create a Static Large Object.')
+    parser.add_argument(
+        '--use-dlo', action='store_false', dest="use_slo", default=None,
+        help='When used in conjunction with --segment-size, it will '
+        'create a Dynamic Large Object.')
     parser.add_argument(
         '--object-name', dest='object_name',
         help='Upload file and name object to <object-name> or upload dir and '
diff --git a/test/unit/test_service.py b/test/unit/test_service.py
index cdab61fa..99351255 100644
--- a/test/unit/test_service.py
+++ b/test/unit/test_service.py
@@ -1410,7 +1410,7 @@ def open_wrapper(*a, **kw):
             self.assertTrue(fp.closed,
                             'Failed to close open(%s)' % formatted_args)
 
-    def test_upload_object_job_file_with_unicode_path(self):
+    def test_upload_dlo_job_file_with_unicode_path(self):
         # Uploading a file results in the file object being wrapped in a
         # LengthWrapper. This test sets the options in such a way that much
         # of _upload_object_job is skipped bringing the critical path down
@@ -1471,6 +1471,84 @@ def test_upload_object_job_file_with_unicode_path(self):
                                                     headers={},
                                                     response_dict={})
 
+    def test_upload_slo_job_file_with_unicode_path(self):
+        # Uploading a file results in the file object being wrapped in a
+        # LengthWrapper. This test sets the options in such a way that much
+        # of _upload_object_job is skipped bringing the critical path down
+        # to around 60 lines to ease testing.
+        with tempfile.NamedTemporaryFile() as f:
+            f.write(b'a' * 30)
+            f.flush()
+            expected_r = {
+                'action': 'upload_object',
+                'attempts': 2,
+                'container': 'test_c',
+                'headers': {},
+                'large_object': True,
+                'object': 'テスト/dummy.dat',
+                'manifest_response_dict': {},
+                'segment_results': [
+                    {'action': 'upload_segment',
+                     'success': True,
+                     'segment_index': i,
+                     'segment_location': 'test_c+segments/slo/%d' % i,
+                     'segment_etag': 'part-etag',
+                     'segment_size': 1000 + i}
+                    for i in range(3)],
+                'status': 'uploaded',
+                'success': True,
+            }
+            expected_mtime = '%f' % os.path.getmtime(f.name)
+
+            mock_conn = mock.Mock()
+            mock_conn.put_object.return_value = ''
+            type(mock_conn).attempts = mock.PropertyMock(return_value=2)
+
+            s = SwiftService()
+            with mock.patch.object(s, '_upload_segment_job') as mock_job:
+                mock_job.side_effect = [
+                    {'action': 'upload_segment',
+                     'success': True,
+                     'segment_index': i,
+                     'segment_location': 'test_c+segments/slo/%d' % i,
+                     'segment_etag': 'part-etag',
+                     'segment_size': 1000 + i}
+                    for i in range(3)]
+
+                r = s._upload_object_job(conn=mock_conn,
+                                         container='test_c',
+                                         source=f.name,
+                                         obj='テスト/dummy.dat',
+                                         options=dict(s._options,
+                                                      segment_size=10,
+                                                      leave_segments=True,
+                                                      use_slo=True))
+
+            mtime = r['headers']['x-object-meta-mtime']
+            self.assertEqual(expected_mtime, mtime)
+            del r['headers']['x-object-meta-mtime']
+
+            self.assertEqual(r['path'], f.name)
+            del r['path']
+
+            self.assertEqual(r, expected_r)
+            self.assertEqual(mock_conn.put_object.call_count, 1)
+            mock_conn.put_object.assert_called_with(
+                'test_c',
+                'テスト/dummy.dat',
+                ' '.join([
+                    '[{"path": "test_c+segments/slo/0",',
+                    '"etag": "part-etag", "size_bytes": 1000},',
+                    '{"path": "test_c+segments/slo/1",',
+                    '"etag": "part-etag", "size_bytes": 1001},',
+                    '{"path": "test_c+segments/slo/2",',
+                    '"etag": "part-etag", "size_bytes": 1002}]',
+                ]),
+                query_string='multipart-manifest=put',
+                headers={},
+                response_dict={},
+            )
+
     def test_upload_segment_job(self):
         with tempfile.NamedTemporaryFile() as f:
             f.write(b'a' * 10)
diff --git a/test/unit/test_shell.py b/test/unit/test_shell.py
index 98d73e9a..d494167f 100644
--- a/test/unit/test_shell.py
+++ b/test/unit/test_shell.py
@@ -861,7 +861,8 @@ def test_upload(self, connection, walk):
         # Upload in segments
         connection.return_value.head_container.return_value = {
             'x-storage-policy': 'one'}
-        argv = ["", "upload", "container", self.tmpfile, "-S", "10"]
+        argv = ["", "upload", "container", self.tmpfile,
+                "-S", "10", "--use-dlo"]
         with open(self.tmpfile, "wb") as fh:
             fh.write(b'12345678901234567890')
         swiftclient.shell.main(argv)
@@ -907,6 +908,62 @@ def test_upload(self, connection, walk):
             query_string='multipart-manifest=put',
             response_dict=mock.ANY)
 
+        # detect no SLO
+        connection.reset_mock()
+        connection.return_value.head_container.return_value = {
+            'x-storage-policy': 'one'}
+        argv = ["", "upload", "container/pseudo-folder/nested",
+                self.tmpfile, "-S", "10"]
+        with open(self.tmpfile, "wb") as fh:
+            fh.write(b'12345678901234567890')
+        connection.return_value.get_capabilities.return_value = {}
+        swiftclient.shell.main(argv)
+        expected_calls = [mock.call('container',
+                                    {},
+                                    response_dict={}),
+                          mock.call('container_segments',
+                                    {'X-Storage-Policy': 'one'},
+                                    response_dict={})]
+        connection.return_value.put_container.assert_has_calls(expected_calls)
+        connection.return_value.put_object.assert_called_with(
+            'container',
+            'pseudo-folder/nested' + self.tmpfile,
+            '',
+            content_length=0,
+            headers={'x-object-manifest': mock.ANY,
+                     'x-object-meta-mtime': mock.ANY},
+            response_dict={})
+
+        # detect SLO
+        connection.reset_mock()
+        connection.return_value.head_container.return_value = {
+            'x-storage-policy': 'one'}
+        argv = ["", "upload", "container/pseudo-folder/nested",
+                self.tmpfile, "-S", "10"]
+        with open(self.tmpfile, "wb") as fh:
+            fh.write(b'12345678901234567890')
+        connection.return_value.get_capabilities.return_value = {
+            'slo': {},
+        }
+        swiftclient.shell.main(argv)
+        expected_calls = [mock.call('container',
+                                    {},
+                                    response_dict={}),
+                          mock.call('container_segments',
+                                    {'X-Storage-Policy': 'one'},
+                                    response_dict={})]
+        print(connection.return_value.mock_calls)
+        connection.return_value.put_container.assert_has_calls(expected_calls)
+        connection.return_value.put_object.assert_called_with(
+            'container',
+            'pseudo-folder/nested' + self.tmpfile,
+            mock.ANY,
+            headers={
+                'x-object-meta-mtime': mock.ANY,
+            },
+            query_string='multipart-manifest=put',
+            response_dict=mock.ANY)
+
     @mock.patch('swiftclient.shell.walk')
     @mock.patch('swiftclient.service.Connection')
     def test_upload_skip_container_put(self, connection, walk):
@@ -934,7 +991,7 @@ def test_upload_skip_container_put(self, connection, walk):
         connection.return_value.head_container.return_value = {
             'x-storage-policy': 'one'}
         argv = ["", "upload", "container", "--skip-container-put",
-                self.tmpfile, "-S", "10"]
+                self.tmpfile, "-S", "10", "--use-dlo"]
         with open(self.tmpfile, "wb") as fh:
             fh.write(b'12345678901234567890')
         swiftclient.shell.main(argv)
@@ -1187,7 +1244,7 @@ def test_upload_segments_to_same_container(self, connection):
         connection.return_value.attempts = 0
         connection.return_value.put_object.return_value = EMPTY_ETAG
         argv = ["", "upload", "container", self.tmpfile, "-S", "10",
-                "-C", "container"]
+                "-C", "container", "--use-dlo"]
         with open(self.tmpfile, "wb") as fh:
             fh.write(b'12345678901234567890')
         swiftclient.shell.main(argv)
@@ -3560,6 +3617,7 @@ def test_segment_upload_with_write_only_access(self):
 
         args, env = self._make_cmd('upload',
                                    cmd_args=[self.cont, self.obj,
+                                             '--use-dlo',
                                              '--leave-segments',
                                              '--segment-size=10',
                                              '--segment-container=%s'
@@ -3600,6 +3658,7 @@ def test_segment_upload_with_write_only_access_segments_container(self):
 
         args, env = self._make_cmd('upload',
                                    cmd_args=[self.cont, self.obj,
+                                             '--use-dlo',
                                              '--leave-segments',
                                              '--segment-size=10'])
         with mock.patch('swiftclient.client.ksclient_v3', self.fake_ks):

From f96c3cff5cdb56d1f23e02566e863d9c501f6a28 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Tue, 21 Mar 2023 13:07:01 -0700
Subject: [PATCH 255/316] docs: Fix code-generated docs

Skip multithreading since some upstream docstrings have invalid ReST.

Change-Id: I682238b8307e5a2f9bd7607676749497cd6d4261
---
 doc/source/swiftclient.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/doc/source/swiftclient.rst b/doc/source/swiftclient.rst
index 108443ae..b352b1d6 100644
--- a/doc/source/swiftclient.rst
+++ b/doc/source/swiftclient.rst
@@ -4,6 +4,7 @@ swiftclient
 ==============
 
 .. automodule:: swiftclient
+   :inherited-members:
 
 swiftclient.authv1
 ==================
@@ -15,16 +16,19 @@ swiftclient.client
 ==================
 
 .. automodule:: swiftclient.client
+   :inherited-members:
 
 swiftclient.service
 ===================
 
 .. automodule:: swiftclient.service
+   :inherited-members:
 
 swiftclient.exceptions
 ======================
 
 .. automodule:: swiftclient.exceptions
+   :inherited-members:
 
 swiftclient.multithreading
 ==========================
@@ -35,3 +39,4 @@ swiftclient.utils
 =================
 
 .. automodule:: swiftclient.utils
+   :inherited-members:

From 9c4534384593bf826924bfdf177a944a07bda641 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Thu, 23 Mar 2023 09:03:05 -0700
Subject: [PATCH 256/316] shell: Allow uploads from stdin to specify --use-dlo

Change-Id: Id6818ab416380242cc215a980a541fc59109c69c
---
 swiftclient/shell.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 69f9481b..c5fb2190 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -1168,7 +1168,7 @@ def st_upload(parser, args, output_manager, return_parser=False):
         return
 
     if from_stdin:
-        if not options['use_slo']:
+        if options['use_slo'] is None:
             options['use_slo'] = True
         if not options['segment_size']:
             options['segment_size'] = DEFAULT_STDIN_SEGMENT

From 825145e9e6259d4a8d25502b2a6cc1257d9e86ba Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Thu, 23 Mar 2023 09:17:21 -0700
Subject: [PATCH 257/316] trivial: Refactor os_options processing

Change-Id: I01c096084172ea8ebeda791016a603c59c7924cd
---
 swiftclient/service.py | 39 ++++++++++++++++++++-------------------
 1 file changed, 20 insertions(+), 19 deletions(-)

diff --git a/swiftclient/service.py b/swiftclient/service.py
index dd714090..79cf86c5 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -122,26 +122,27 @@ def process_options(options):
 
     # Specific OpenStack options
     options['os_options'] = {
-        'user_id': options['os_user_id'],
-        'user_domain_id': options['os_user_domain_id'],
-        'user_domain_name': options['os_user_domain_name'],
-        'tenant_id': options['os_tenant_id'],
-        'tenant_name': options['os_tenant_name'],
-        'project_id': options['os_project_id'],
-        'project_name': options['os_project_name'],
-        'project_domain_id': options['os_project_domain_id'],
-        'project_domain_name': options['os_project_domain_name'],
-        'service_type': options['os_service_type'],
-        'endpoint_type': options['os_endpoint_type'],
-        'auth_token': options['os_auth_token'],
-        'object_storage_url': options['os_storage_url'],
-        'region_name': options['os_region_name'],
-        'auth_type': options['os_auth_type'],
-        'application_credential_id':
-        options['os_application_credential_id'],
-        'application_credential_secret':
-        options['os_application_credential_secret'],
+        opt: options['os_' + opt] for opt in (
+            'user_id',
+            'user_domain_id',
+            'user_domain_name',
+            'tenant_id',
+            'tenant_name',
+            'project_id',
+            'project_name',
+            'project_domain_id',
+            'project_domain_name',
+            'service_type',
+            'endpoint_type',
+            'auth_token',
+            'region_name',
+            'auth_type',
+            'application_credential_id',
+            'application_credential_secret',
+        )
     }
+    # this one doesn't follow the same convention
+    options['os_options']['object_storage_url'] = options['os_storage_url']
 
 
 def _build_default_global_options():

From ee952c1bf250550d5da5b8a988e9e930edefce86 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 10 Mar 2023 21:39:57 -0800
Subject: [PATCH 258/316] Ensure v*password auth_type correctly implies auth
 version

Change-Id: I787b0988b7518850f1e1f93ca269f39f8cdec15c
---
 swiftclient/service.py  | 19 ++++++---
 test/unit/test_shell.py | 86 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 100 insertions(+), 5 deletions(-)

diff --git a/swiftclient/service.py b/swiftclient/service.py
index 79cf86c5..3d1b4764 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -90,14 +90,26 @@ def __repr__(self):
 
 
 def process_options(options):
+    auth_types_to_versions = {
+        'v1password': '1.0',
+        'v2password': '2.0',
+        'v3password': '3',
+        'v3applicationcredential': '3',
+    }
+
+    version_from_type = auth_types_to_versions.get(options['os_auth_type'])
+    if version_from_type:
+        options['auth_version'] = version_from_type
+
     # tolerate sloppy auth_version
     if options.get('auth_version') == '3.0':
         options['auth_version'] = '3'
     elif options.get('auth_version') == '2':
         options['auth_version'] = '2.0'
 
-    if options.get('auth_version') not in ('2.0', '3') and not all(
-            options.get(key) for key in ('auth', 'user', 'key')):
+    if options.get('auth_version') not in ('2.0', '3') and \
+            options.get('os_auth_type') != 'v1password' and \
+            not all(options.get(key) for key in ('auth', 'user', 'key')):
         # Use keystone auth if any of the new-style args are present
         if any(options.get(k) for k in (
                 'os_user_domain_id',
@@ -109,9 +121,6 @@ def process_options(options):
         else:
             options['auth_version'] = '2.0'
 
-    if options.get('os_auth_type', None) == 'v3applicationcredential':
-        options['auth_version'] == '3'
-
     # Use new-style args if old ones not present
     if not options['auth'] and options['os_auth_url']:
         options['auth'] = options['os_auth_url']
diff --git a/test/unit/test_shell.py b/test/unit/test_shell.py
index 5e69f4a6..e76f73c0 100644
--- a/test/unit/test_shell.py
+++ b/test/unit/test_shell.py
@@ -2759,6 +2759,92 @@ def test_os_identity_api_version(self):
                 swiftclient.shell.main(args)
         self._verify_opts(result[0], expected_opts, expected_os_opts, {})
 
+    def test_os_auth_type_password_implies_version(self):
+        args = ["", "stat"]
+        env = {
+            'OS_AUTH_URL': 'http://example.com/auth',
+            'OS_AUTH_TYPE': 'v1password',
+            'OS_USERNAME': 'user',
+            'OS_PASSWORD': 'secret',
+        }
+        result = [None, None]
+        fake_command = self._make_fake_command(result)
+        with mock.patch.dict(os.environ, env):
+            with mock.patch('swiftclient.shell.st_stat', fake_command):
+                swiftclient.shell.main(args)
+        self._verify_opts(result[0], {
+            'auth_version': '1.0',
+            'user': 'user',
+            'key': 'secret',
+        }, {
+            'auth_url': 'http://example.com/auth',
+            'auth_type': 'v1password',
+            'username': 'user',
+            'password': 'secret',
+        }, {
+            'auth_url': 'http://example.com/auth',
+            'auth_type': 'v1password',
+            'username': 'user',
+            'password': 'secret',
+            'identity_api_version': '1.0',
+        })
+
+        env = {
+            'OS_AUTH_URL': 'http://example.com/auth',
+            'OS_AUTH_TYPE': 'v2password',
+            'OS_USERNAME': 'user',
+            'OS_PASSWORD': 'secret',
+        }
+        result = [None, None]
+        fake_command = self._make_fake_command(result)
+        with mock.patch.dict(os.environ, env):
+            with mock.patch('swiftclient.shell.st_stat', fake_command):
+                swiftclient.shell.main(args)
+        self._verify_opts(result[0], {
+            'auth_version': '2.0',
+            'user': 'user',
+            'key': 'secret',
+        }, {
+            'auth_url': 'http://example.com/auth',
+            'auth_type': 'v2password',
+            'username': 'user',
+            'password': 'secret',
+        }, {
+            'auth_url': 'http://example.com/auth',
+            'auth_type': 'v2password',
+            'username': 'user',
+            'password': 'secret',
+            'identity_api_version': '2.0',
+        })
+
+        env = {
+            'OS_AUTH_URL': 'http://example.com/auth',
+            'OS_AUTH_TYPE': 'v3password',
+            'OS_USERNAME': 'user',
+            'OS_PASSWORD': 'secret',
+        }
+        result = [None, None]
+        fake_command = self._make_fake_command(result)
+        with mock.patch.dict(os.environ, env):
+            with mock.patch('swiftclient.shell.st_stat', fake_command):
+                swiftclient.shell.main(args)
+        self._verify_opts(result[0], {
+            'auth_version': '3',
+            'user': 'user',
+            'key': 'secret',
+        }, {
+            'auth_url': 'http://example.com/auth',
+            'auth_type': 'v3password',
+            'username': 'user',
+            'password': 'secret',
+        }, {
+            'auth_url': 'http://example.com/auth',
+            'auth_type': 'v3password',
+            'username': 'user',
+            'password': 'secret',
+            'identity_api_version': '3',
+        })
+
     def test_args_v3(self):
         opts = {"auth_version": "3"}
         os_opts = {"password": "secret",

From 236c2775c6b8f1c79444899726ca4c9b87fbb47e Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Sun, 26 Mar 2023 21:36:39 -0700
Subject: [PATCH 259/316] Changelog for 4.3.0 (and 4.2.0)

Change-Id: Ia5f65c19bc31053dbdb4482a23ce977aa0c3f565
---
 ChangeLog                             | 43 +++++++++++++++++++++++++++
 releasenotes/notes/4_3_0_release.yaml | 40 +++++++++++++++++++++++++
 2 files changed, 83 insertions(+)
 create mode 100644 releasenotes/notes/4_3_0_release.yaml

diff --git a/ChangeLog b/ChangeLog
index 802b2ef1..861f0c80 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,46 @@
+4.3.0
+-----
+
+* Static Large Objects will now be used by default for segmented uploads
+  to clusters that support them. The new `--use-dlo` option may be used to
+  create Dynamic Large Objects, as was the previous behavior without
+  `--use-slo`.
+
+* Uploads from stdin may now be Dynamic Large Objects by using the new
+  `--use-dlo` option.
+
+* The `--timeout` option may now include 's', 'm', and 'h' suffixes similar
+  to the `tempurl` `<time>` argument.
+
+* `499 Client Disconnect` responses are now retried in a manner similar to
+  `408 Request Timeout` responses.
+
+* Requests are retried for more SSL errors. Only certificate validation
+  errors will not be retried.
+
+* If downloaded content does not match the Content-Length from response
+  headers, the reported error will now highlight Content-Length rather than
+  ETag.
+
+* Transaction IDs are now included when downloaded content does not match
+  the expectations set by response headers.
+
+* Fix an import error for some distributions by using `importlib` rather than
+  `pkg_resources` when possible.
+
+* Various other minor bug fixes and improvements.
+
+
+4.2.0
+-----
+
+* The `tempurl` subcommand may now be used to sign admin `/info` requests.
+
+* Now tested under Python 3.10.
+
+* Various other minor bug fixes and improvements.
+
+
 4.1.0
 -----
 
diff --git a/releasenotes/notes/4_3_0_release.yaml b/releasenotes/notes/4_3_0_release.yaml
new file mode 100644
index 00000000..6f56bbd1
--- /dev/null
+++ b/releasenotes/notes/4_3_0_release.yaml
@@ -0,0 +1,40 @@
+---
+features:
+  - |
+    Static Large Objects will now be used by default for segmented uploads
+    to clusters that support them. The new ``--use-dlo`` option may be used to
+    create Dynamic Large Objects, as was the previous behavior without
+    ``--use-slo``.
+
+  - |
+    Uploads from stdin may now be Dynamic Large Objects by using the new
+    ``--use-dlo`` option.
+
+  - |
+    The ``--timeout`` option may now include 's', 'm', and 'h' suffixes similar
+    to the ``tempurl`` ``<time>`` argument.
+
+fixes:
+  - |
+    ``499 Client Disconnect`` responses are now retried in a manner similar to
+    ``408 Request Timeout`` responses.
+
+  - |
+    Requests are retried for more SSL errors. Only certificate validation
+    errors will not be retried.
+
+  - |
+    If downloaded content does not match the Content-Length from response
+    headers, the reported error will now highlight Content-Length rather than
+    ETag.
+
+  - |
+    Transaction IDs are now included when downloaded content does not match
+    the expectations set by response headers.
+
+  - |
+    Fix an import error for some distributions by using ``importlib`` rather than
+    ``pkg_resources`` when possible.
+
+  - |
+    Various other minor bug fixes and improvements.

From 90f565009a2d18d6f4f3660aa57673e99ba638a7 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 7 Jul 2023 12:41:48 -0700
Subject: [PATCH 260/316] Declare py311 support

Add a voting job, update trove classifiers.

Change-Id: I757b76e3af5f667a670cdf65687f23ef2b486666
---
 .zuul.yaml | 10 ++++++++++
 setup.cfg  |  1 +
 2 files changed, 11 insertions(+)

diff --git a/.zuul.yaml b/.zuul.yaml
index 3c680ab0..2a719fc9 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -29,6 +29,14 @@
       # swift can use different tox env names
       tox_envlist: func
 
+- job:
+    name: swiftclient-tox-py311
+    parent: openstack-tox-py310
+    vars:
+      tox_envlist: py311
+      bindep_profile: test py311
+      python_version: '3.11'
+
 - project:
     templates:
       - check-requirements
@@ -49,6 +57,7 @@
             voting: true
         - openstack-tox-py310:
             voting: true
+        - swiftclient-tox-py311
     gate:
       jobs:
         - swiftclient-swift-functional
@@ -57,6 +66,7 @@
             voting: true
         - openstack-tox-py310:
             voting: true
+        - swiftclient-tox-py311
     post:
       jobs:
         - openstack-tox-cover
diff --git a/setup.cfg b/setup.cfg
index 9d407650..3b2dd469 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -28,6 +28,7 @@ classifier =
     Programming Language :: Python :: 3.8
     Programming Language :: Python :: 3.9
     Programming Language :: Python :: 3.10
+    Programming Language :: Python :: 3.11
     Programming Language :: Python :: 3 :: Only
 
 [files]

From c52e404262e9a81afcdad1abed631699a14ec953 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 7 Jul 2023 14:32:05 -0700
Subject: [PATCH 261/316] tests: Skip keystoneauth tests if not available

Change-Id: I80af28b49415c5bea6399683922b6649f04ed011
---
 test/unit/test_authv1.py      | 17 +++++++++++++----
 test/unit/test_swiftclient.py |  5 ++++-
 2 files changed, 17 insertions(+), 5 deletions(-)

diff --git a/test/unit/test_authv1.py b/test/unit/test_authv1.py
index b4de7e0f..c22cc39c 100644
--- a/test/unit/test_authv1.py
+++ b/test/unit/test_authv1.py
@@ -16,10 +16,13 @@
 import json
 import unittest
 from unittest import mock
-from keystoneauth1 import plugin
-from keystoneauth1 import loading
-from keystoneauth1 import exceptions
-from swiftclient import authv1
+try:
+    from keystoneauth1 import plugin
+    from keystoneauth1 import loading
+    from keystoneauth1 import exceptions
+    from swiftclient import authv1
+except ImportError:
+    plugin = loading = exceptions = authv1 = None
 
 
 class TestDataNoAccount:
@@ -44,6 +47,10 @@ class TestDataWithAccount:
 
 
 class TestPluginLoading(TestDataNoAccount, unittest.TestCase):
+    def setUp(self):
+        if authv1 is None:
+            raise unittest.SkipTest('keystoneauth1 is not available')
+
     def test_can_load(self):
         loader = loading.get_plugin_loader('v1password')
         self.assertIsInstance(loader, authv1.PasswordLoader)
@@ -120,6 +127,8 @@ class TestPluginLoadingWithAccount(TestDataWithAccount, TestPluginLoading):
 
 class TestPlugin(TestDataNoAccount, unittest.TestCase):
     def setUp(self):
+        if authv1 is None:
+            raise unittest.SkipTest('keystoneauth1 is not available')
         self.mock_session = mock.MagicMock()
         self.mock_response = self.mock_session.get.return_value
         self.mock_response.status_code = 200
diff --git a/test/unit/test_swiftclient.py b/test/unit/test_swiftclient.py
index 42d470cd..be4f4a5e 100644
--- a/test/unit/test_swiftclient.py
+++ b/test/unit/test_swiftclient.py
@@ -579,7 +579,10 @@ def test_auth_v3_with_tenant_name(self):
         self.assertTrue(token)
 
     def test_auth_v3applicationcredential(self):
-        from keystoneauth1 import exceptions as ksauthexceptions
+        try:
+            from keystoneauth1 import exceptions as ksauthexceptions
+        except ImportError:
+            raise unittest.SkipTest('keystoneauth1 is not available')
 
         os_options = {
             "auth_type": "v3applicationcredential",

From 9331880e7364787790239014c14b73f380aa6a1f Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 25 Aug 2023 09:26:27 -0700
Subject: [PATCH 262/316] tests: Fix timeout assertion for py36, py37

The kwargs property was introduced in py38.

Change-Id: Id380fee6a2131bf88baa27145c8158277eef10c1
---
 test/unit/test_shell.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/test/unit/test_shell.py b/test/unit/test_shell.py
index e76f73c0..eedbc4be 100644
--- a/test/unit/test_shell.py
+++ b/test/unit/test_shell.py
@@ -2498,7 +2498,7 @@ def test_timeout_parsing(self, connection):
             connection.reset_mock()
             with self.subTest(timeout=timeout):
                 swiftclient.shell.main(["", "stat", "--timeout", timeout])
-                self.assertEqual(connection.mock_calls[0].kwargs['timeout'],
+                self.assertEqual(connection.mock_calls[0][2]['timeout'],
                                  expected)
 
 

From ff8731bde1b6d36d6d2b811b9167ad57f23f87a4 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 25 Aug 2023 09:42:47 -0700
Subject: [PATCH 263/316] Remove pypy from bindep.txt

We haven't tested under pypy since 2020, and haven't done so
*successfully* for even longer.

As that was the only remaining set of packages in bindep.txt,
remove it entirely.

Related-Change: Ibc80d23846b364bfcd82043430ef71ad4b6e271b
Change-Id: I0e4abc482e546f36358f6085a6d5635490f4ac5c
---
 bindep.txt | 6 ------
 1 file changed, 6 deletions(-)
 delete mode 100644 bindep.txt

diff --git a/bindep.txt b/bindep.txt
deleted file mode 100644
index 17c0cd56..00000000
--- a/bindep.txt
+++ /dev/null
@@ -1,6 +0,0 @@
-# This is a cross-platform list tracking distribution packages needed by tests;
-# see https://docs.openstack.org/infra/bindep/ for additional information.
-
-pypy [test !platform:fedora]
-pypy-dev [test platform:dpkg]
-pypy-devel [test platform:rpm !platform:fedora]

From eb5d5d464cd4d7338633b0333c93b984e2202cbf Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 25 Aug 2023 09:13:46 -0700
Subject: [PATCH 264/316] Clean up CI jobs

We no longer need our own py311 job; there is now an openstack-tox-py311
included in openstack-python3-jobs (though we want to make it voting).

Additionally, that template has marked py39 and py310 jobs as voting, so
we no longer need to do that ourselves.

Change-Id: Ie964678af069d5255e463ef22b1b53957d28f918
---
 .zuul.yaml | 18 ++----------------
 1 file changed, 2 insertions(+), 16 deletions(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index 2a719fc9..3917e26e 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -29,14 +29,6 @@
       # swift can use different tox env names
       tox_envlist: func
 
-- job:
-    name: swiftclient-tox-py311
-    parent: openstack-tox-py310
-    vars:
-      tox_envlist: py311
-      bindep_profile: test py311
-      python_version: '3.11'
-
 - project:
     templates:
       - check-requirements
@@ -53,20 +45,14 @@
       jobs:
         - swiftclient-swift-functional
         - swiftclient-functional
-        - openstack-tox-py39:
+        - openstack-tox-py311:
             voting: true
-        - openstack-tox-py310:
-            voting: true
-        - swiftclient-tox-py311
     gate:
       jobs:
         - swiftclient-swift-functional
         - swiftclient-functional
-        - openstack-tox-py39:
-            voting: true
-        - openstack-tox-py310:
+        - openstack-tox-py311:
             voting: true
-        - swiftclient-tox-py311
     post:
       jobs:
         - openstack-tox-cover

From 54fbfa8bc9c10feb48fbce843d6ba6fcf6533ece Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 25 Aug 2023 08:56:21 -0700
Subject: [PATCH 265/316] ChangeLog for 4.4.0

Change-Id: I0cec9e7f88323d63dde7f78677b340fb3a53d19f
---
 ChangeLog                                              | 6 ++++++
 releasenotes/notes/4_4_0_release-d731bab5982c160b.yaml | 4 ++++
 2 files changed, 10 insertions(+)
 create mode 100644 releasenotes/notes/4_4_0_release-d731bab5982c160b.yaml

diff --git a/ChangeLog b/ChangeLog
index 861f0c80..3b0d9fae 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+4.4.0
+-----
+
+* Now tested under Python 3.11.
+
+
 4.3.0
 -----
 
diff --git a/releasenotes/notes/4_4_0_release-d731bab5982c160b.yaml b/releasenotes/notes/4_4_0_release-d731bab5982c160b.yaml
new file mode 100644
index 00000000..4b20b7b5
--- /dev/null
+++ b/releasenotes/notes/4_4_0_release-d731bab5982c160b.yaml
@@ -0,0 +1,4 @@
+---
+features:
+  - |
+    Now tested under Python 3.11.

From 44f11384ffcb012d71d2c67ae4751ba7494a4254 Mon Sep 17 00:00:00 2001
From: OpenStack Release Bot <infra-root@openstack.org>
Date: Fri, 1 Sep 2023 13:36:09 +0000
Subject: [PATCH 266/316] Update master for stable/2023.2

Add file to the reno documentation build to show release notes for
stable/2023.2.

Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/2023.2.

Sem-Ver: feature
Change-Id: I4bd3883583c1ae3e10b07815b8587b1c6be480a8
---
 releasenotes/source/2023.2.rst | 6 ++++++
 releasenotes/source/index.rst  | 1 +
 2 files changed, 7 insertions(+)
 create mode 100644 releasenotes/source/2023.2.rst

diff --git a/releasenotes/source/2023.2.rst b/releasenotes/source/2023.2.rst
new file mode 100644
index 00000000..a4838d7d
--- /dev/null
+++ b/releasenotes/source/2023.2.rst
@@ -0,0 +1,6 @@
+===========================
+2023.2 Series Release Notes
+===========================
+
+.. release-notes::
+   :branch: stable/2023.2
diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst
index ae2042c1..bb8394b4 100644
--- a/releasenotes/source/index.rst
+++ b/releasenotes/source/index.rst
@@ -6,6 +6,7 @@
    :maxdepth: 1
 
    current
+   2023.2
    2023.1
    zed
    yoga

From 4698f1f64253ae33b6b9a223a522aa3a2fab3d25 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Wed, 6 Jul 2022 22:50:45 -0700
Subject: [PATCH 267/316] shell: Print friendly account byte quotas

This gives us an opportunity to give it more human-friendly units
when doing a `stat --lh`.

Change-Id: I01c02ffcba94d89ae03f87c1c64afca4d491a895
---
 swiftclient/command_helpers.py | 17 +++++++++++++++--
 test/unit/test_shell.py        | 28 ++++++++++++++++++++++++++++
 2 files changed, 43 insertions(+), 2 deletions(-)

diff --git a/swiftclient/command_helpers.py b/swiftclient/command_helpers.py
index f37040f8..20310886 100644
--- a/swiftclient/command_helpers.py
+++ b/swiftclient/command_helpers.py
@@ -15,6 +15,7 @@
 
 
 POLICY_HEADER_PREFIX = 'x-account-storage-policy-'
+PER_POLICY_QUOTA_HEADER_PREFIX = 'x-account-quota-bytes-policy-'
 
 
 def stat_account(conn, options):
@@ -38,6 +39,10 @@ def stat_account(conn, options):
         ('Objects', object_count),
         ('Bytes', bytes_used),
     ])
+    if headers.get('x-account-meta-quota-bytes'):
+        quota_bytes = prt_bytes(headers.get('x-account-meta-quota-bytes'),
+                                options['human']).lstrip()
+        items.append(('Quota Bytes', quota_bytes))
 
     policies = set()
     for header_key, header_value in headers.items():
@@ -68,6 +73,10 @@ def stat_account(conn, options):
                  options['human']
              ).lstrip()),
         ))
+        policy_quota = headers.get(PER_POLICY_QUOTA_HEADER_PREFIX + policy)
+        if policy_quota:
+            items.append(('Quota Bytes for policy "' + policy + '"',
+                          prt_bytes(policy_quota, options['human']).lstrip()))
 
     return items, headers
 
@@ -75,7 +84,10 @@ def stat_account(conn, options):
 def print_account_stats(items, headers, output_manager):
     exclude_policy_headers = []
     for header_key, header_value in headers.items():
-        if header_key.lower().startswith(POLICY_HEADER_PREFIX):
+        if header_key.lower().startswith((
+                POLICY_HEADER_PREFIX,
+                PER_POLICY_QUOTA_HEADER_PREFIX,
+        )):
             exclude_policy_headers.append(header_key)
 
     items.extend(headers_to_items(
@@ -84,7 +96,8 @@ def print_account_stats(items, headers, output_manager):
             'content-length', 'date',
             'x-account-container-count',
             'x-account-object-count',
-            'x-account-bytes-used'] + exclude_policy_headers)))
+            'x-account-bytes-used',
+            'x-account-meta-quota-bytes'] + exclude_policy_headers)))
 
     # line up the items nicely
     offset = max(len(item) for item, value in items)
diff --git a/test/unit/test_shell.py b/test/unit/test_shell.py
index eedbc4be..3575ee22 100644
--- a/test/unit/test_shell.py
+++ b/test/unit/test_shell.py
@@ -159,6 +159,34 @@ def test_stat_account(self, connection):
                              '   Objects: 2\n'
                              '     Bytes: 3\n')
 
+    @mock.patch('swiftclient.service.Connection')
+    def test_stat_account_with_quota(self, connection):
+        argv = ["", "stat", "--lh"]
+        return_headers = {
+            'x-account-container-count': '2000',
+            'x-account-object-count': '3000',
+            'x-account-bytes-used': '4000000',
+            'x-account-storage-policy-gold-bytes-used': '4000',
+            'x-account-meta-quota-bytes': '5000000',
+            'x-account-quota-bytes-policy-gold': '5000',
+            'content-length': 0,
+            'date': ''}
+        connection.return_value.head_account.return_value = return_headers
+        connection.return_value.url = 'http://127.0.0.1/v1/AUTH_account'
+        with CaptureOutput() as output:
+            swiftclient.shell.main(argv)
+
+            self.assertEqual(
+                output.out,
+                '                      Account: AUTH_account\n'
+                '                   Containers: 2000\n'
+                '                      Objects: 2.9K\n'
+                '                        Bytes: 3.8M\n'
+                '                  Quota Bytes: 4.8M\n'
+                '     Objects in policy "gold": 0\n'
+                '       Bytes in policy "gold": 3.9K\n'
+                'Quota Bytes for policy "gold": 4.9K\n')
+
     @mock.patch('swiftclient.service.Connection')
     def test_stat_account_with_headers(self, connection):
         argv = ["", "stat", "-H", "Skip-Middleware: Test"]

From 6f01f84ce2fa17b08e56dd5d3537a68d876a9988 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 15 Dec 2023 12:18:18 -0800
Subject: [PATCH 268/316] tests: Fix call assertion

Under py312, MagicMock.has_calls raises an AttributeError. This is
actually a good thing, as previously we weren't actually making the
assertions we thought we were making.

Fix the one place that we forgot the leading `assert_`, and switch it
to `any_order=True`; this is required for the test to pass, as there
are additional calls between the two expected calls.

See https://github.com/python/cpython/commit/1d4d677d

Change-Id: Ia2ff2f198b4c1312a3e7dce32f11b87050683d45
---
 test/unit/test_shell.py | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/test/unit/test_shell.py b/test/unit/test_shell.py
index eedbc4be..1bd26fff 100644
--- a/test/unit/test_shell.py
+++ b/test/unit/test_shell.py
@@ -867,12 +867,13 @@ def test_upload(self, connection, walk):
             fh.write(b'12345678901234567890')
         swiftclient.shell.main(argv)
         expected_calls = [mock.call('container',
-                                    {'X-Storage-Policy': mock.ANY},
+                                    {'X-Storage-Policy': 'one'},
                                     response_dict={}),
                           mock.call('container_segments',
-                                    {'X-Storage-Policy': mock.ANY},
+                                    {'X-Storage-Policy': 'one'},
                                     response_dict={})]
-        connection.return_value.put_container.has_calls(expected_calls)
+        connection.return_value.put_container.assert_has_calls(expected_calls,
+                                                               any_order=True)
         connection.return_value.put_object.assert_called_with(
             'container',
             self.tmpfile.lstrip('/'),

From 45a311fc621324742f6d981a94ab93a3b30422e1 Mon Sep 17 00:00:00 2001
From: DavHau <hsngrmpf@gmail.com>
Date: Wed, 3 Jan 2024 12:17:02 +0700
Subject: [PATCH 269/316] Remove duplicate script entry leading to broken wheel
 build

The entry_point option already defines the /bin/swift script implicitly.
The definition of `scripts=bin/swift` ontop of that leads to a corrupt wheel build and can lead to a collision error during installation:
FileExistsError: File already exists: [...]/bin/swift

Closes-Bug: #1996959
Change-Id: I17d0c2b02555172eeedaa164aad956691ccb3b0a
---
 setup.cfg | 2 --
 1 file changed, 2 deletions(-)

diff --git a/setup.cfg b/setup.cfg
index 3b2dd469..726bb873 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -34,8 +34,6 @@ classifier =
 [files]
 packages =
     swiftclient
-scripts =
-    bin/swift
 data_files =
     share/man/man1 = doc/manpages/swift.1
 

From 85a3e827a52664831b688627f6f3e2094f0809f6 Mon Sep 17 00:00:00 2001
From: DavHau <hsngrmpf+github@gmail.com>
Date: Wed, 3 Jan 2024 11:26:36 +0700
Subject: [PATCH 270/316] make setup dependencies discoverable

Currently, dependency resolvers like the one of PDM, cannot resolve the
setup dependencies correctly, as those are hidden inside the python
code of setup.py

Supplement setup.py with pyproject.toml. Note that we can't remove
setup.py yet, as it remains part of OpenStack's Project Testing
Interface.

Change-Id: Ifb414df2577bc9ada78eaa26747da4f4bd673dda
---
 pyproject.toml | 3 +++
 1 file changed, 3 insertions(+)
 create mode 100644 pyproject.toml

diff --git a/pyproject.toml b/pyproject.toml
new file mode 100644
index 00000000..6194cd34
--- /dev/null
+++ b/pyproject.toml
@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools", "pbr"]
+build-backend = "setuptools.build_meta"

From 16224e36e8ef9f2da533a5437791a4802a892bbf Mon Sep 17 00:00:00 2001
From: OpenStack Release Bot <infra-root@openstack.org>
Date: Thu, 8 Feb 2024 14:39:47 +0000
Subject: [PATCH 271/316] reno: Update master for unmaintained/yoga

Update the yoga release notes configuration to build from
unmaintained/yoga.

Change-Id: Ia6a273d087867c271832413e7aa41a27feab23c5
---
 releasenotes/source/yoga.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/releasenotes/source/yoga.rst b/releasenotes/source/yoga.rst
index 7cd5e908..43cafdea 100644
--- a/releasenotes/source/yoga.rst
+++ b/releasenotes/source/yoga.rst
@@ -3,4 +3,4 @@ Yoga Series Release Notes
 =========================
 
 .. release-notes::
-   :branch: stable/yoga
+   :branch: unmaintained/yoga

From 1e0ab242cabcbe1fe673d8950ff857092d71127f Mon Sep 17 00:00:00 2001
From: Matthew Oliver <matt@oliver.net.au>
Date: Tue, 20 Feb 2024 16:21:50 +1100
Subject: [PATCH 272/316] lint: Up-rev hacking

Without up-reving hacking python 3.12 can't be used for pep8/flake8
checks. Also address a few new pyflakes issues that seem reasonable
to enforce:

   E275 missing whitespace after keyword
   H214 Use assertIn/NotIn(A, B) rather than
        assertTrue/False(A in/not in B)
   H211 do not compare types, use assert{Is,IsNot}Instance

Add F811 (redefinition of unused 'function'), as this check makes
client.py fail.

And noqa some longer lines that we're happy to carry.

Change-Id: Ic97698a310ffe7114b668b8c4bc0195f6997bb45
---
 swiftclient/shell.py          | 8 ++++----
 test-requirements.txt         | 2 +-
 test/unit/test_service.py     | 2 +-
 test/unit/test_shell.py       | 2 +-
 test/unit/test_swiftclient.py | 4 ++--
 tox.ini                       | 3 ++-
 6 files changed, 11 insertions(+), 10 deletions(-)

diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index c5fb2190..faa20001 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -754,7 +754,7 @@ def st_stat(parser, args, output_manager, return_parser=False):
                                     items, headers, output_manager
                                 )
                             else:
-                                raise(stat_result["error"])
+                                raise stat_result["error"]
                     else:
                         output_manager.error(
                             'Usage: %s stat %s\n%s', BASENAME,
@@ -768,7 +768,7 @@ def st_stat(parser, args, output_manager, return_parser=False):
                   [--sync-key <sync-key>] [--meta <name:value>]
                   [--header <header>]
                   [<container> [<object>]]
-'''
+'''  # noqa
 
 st_post_help = '''
 Updates meta information for the account, container, or object.
@@ -864,7 +864,7 @@ def st_post(parser, args, output_manager, return_parser=False):
                 else:
                     result = swift.post(container=container)
             if not result["success"]:
-                raise(result["error"])
+                raise result["error"]
 
         except SwiftError as e:
             output_manager.error(e.value)
@@ -1520,7 +1520,7 @@ def st_tempurl(parser, args, thread_manager, return_parser=False):
 
 Optional positional arguments:
   <command>           Swift client command to filter the flags by.
-'''.strip('\n')
+'''.strip('\n')  # noqa
 
 
 st_bash_completion_options = '''[command]
diff --git a/test-requirements.txt b/test-requirements.txt
index a4b64ee7..63909c63 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -1,4 +1,4 @@
-hacking>=3.2.0,<3.3.0 # Apache-2.0
+hacking>=3.2.0,<6.2.0 # Apache-2.0
 
 coverage!=4.4,>=4.0   # Apache-2.0
 keystoneauth1>=3.4.0  # Apache-2.0
diff --git a/test/unit/test_service.py b/test/unit/test_service.py
index 99351255..6bc50ca7 100644
--- a/test/unit/test_service.py
+++ b/test/unit/test_service.py
@@ -1330,7 +1330,7 @@ def test_upload_stream(self, mock_conn):
             options)
         responses = [x for x in resp_iter]
         for resp in responses:
-            self.assertFalse('error' in resp)
+            self.assertNotIn('error', resp)
             self.assertTrue(resp['success'])
         self.assertEqual(5, len(responses))
         container_resp, segment_container_resp = responses[0:2]
diff --git a/test/unit/test_shell.py b/test/unit/test_shell.py
index 1bd26fff..71568d29 100644
--- a/test/unit/test_shell.py
+++ b/test/unit/test_shell.py
@@ -711,7 +711,7 @@ def test_download(self, connection, makedirs):
     @mock.patch('swiftclient.service.Connection')
     def test_download_shuffle(self, connection, mock_shuffle):
         # Test that the container and object lists are shuffled
-        mock_shuffle.side_effect = lambda l: l
+        mock_shuffle.side_effect = lambda to_shuffle: to_shuffle
         connection.return_value.get_object.return_value = [
             {'content-type': 'text/plain',
              'etag': EMPTY_ETAG},
diff --git a/test/unit/test_swiftclient.py b/test/unit/test_swiftclient.py
index be4f4a5e..3506a11d 100644
--- a/test/unit/test_swiftclient.py
+++ b/test/unit/test_swiftclient.py
@@ -2000,7 +2000,7 @@ def test_instance_kwargs(self):
                 'authurl': 'http://www.test.com',
                 'tenant_name': 'atenant'}
         conn = c.Connection(**args)
-        self.assertEqual(type(conn), c.Connection)
+        self.assertIsInstance(conn, c.Connection)
 
     def test_instance_kwargs_token(self):
         args = {'preauthtoken': 'atoken123',
@@ -3056,7 +3056,7 @@ def test_close_ok(self):
         conn = c.Connection(url, 'asdf', 'asdf')
         self.assertIsNone(conn.http_conn)
         conn.http_conn = c.http_connection(url)
-        self.assertEqual(type(conn.http_conn), tuple)
+        self.assertIsInstance(conn.http_conn, tuple)
         self.assertEqual(len(conn.http_conn), 2)
         http_conn_obj = conn.http_conn[1]
         self.assertIsInstance(http_conn_obj, c.HTTPConnection)
diff --git a/tox.ini b/tox.ini
index 3a6cd8a0..a2bf8a95 100644
--- a/tox.ini
+++ b/tox.ini
@@ -69,7 +69,8 @@ commands=
 # H404: multi line docstring should start without a leading new line
 # H405: multi line docstring summary not separated with an empty line
 # W504: line break after binary operator
-ignore = H101,H301,H306,H401,H403,H404,H405,W504
+# F811: Redefinition of unused name from line n
+ignore = H101,H301,H306,H401,H403,H404,H405,W504,F811
 # H106: Don’t put vim configuration in source files
 # H203: Use assertIs(Not)None to check for None
 enable-extensions=H106,H203

From 3c529ceb70cf0d71f4cd30edf1cea0cfa110b6f4 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Wed, 21 Feb 2024 10:58:29 -0800
Subject: [PATCH 273/316] CI: constrain deps for tests

Previously, we ran unconstrained so we could piggy-back off our extras,
but it causes issues in stable gates.

Change-Id: I5b04a1e4d6fb46cdcd50b547aa52290b8bf022ab
---
 test-requirements.txt | 1 +
 tox.ini               | 9 ++++-----
 2 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/test-requirements.txt b/test-requirements.txt
index a4b64ee7..ae929d49 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -1,6 +1,7 @@
 hacking>=3.2.0,<3.3.0 # Apache-2.0
 
 coverage!=4.4,>=4.0   # Apache-2.0
+python-keystoneclient>=0.7.0
 keystoneauth1>=3.4.0  # Apache-2.0
 stestr>=2.0.0,!=3.0.0 # Apache-2.0
 openstacksdk>=0.11.0  # Apache-2.0
diff --git a/tox.ini b/tox.ini
index 3a6cd8a0..2b852a5e 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,18 +1,18 @@
 [tox]
 envlist = py3,pep8
 minversion = 3.18.0
-skipsdist = True
 
 [testenv]
+skipsdist = True
 usedevelop = True
 list_dependencies_command = python -m pip freeze
 setenv =
   LANG=en_US.utf-8
   VIRTUAL_ENV={envdir}
 
-deps = -r{toxinidir}/requirements.txt
+deps = -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
+       -r{toxinidir}/requirements.txt
        -r{toxinidir}/test-requirements.txt
-       .[keystone]
 commands = sh -c '(find . -not \( -type d -name .?\* -prune \) \
            \( -type d -name "__pycache__" -or -type f -name "*.py[co]" \) \
            -print0) | xargs -0 rm -rf'
@@ -87,8 +87,7 @@ commands = bindep test
 
 [testenv:releasenotes]
 usedevelop = False
-deps = -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
-       -r{toxinidir}/doc/requirements.txt
+deps = {[testenv:docs]deps}
 commands = sphinx-build -a -W -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
 
 [testenv:pdf-docs]

From 0ec6246ac9a29dcb5b486ca48cb3b4af516b6992 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Mon, 26 Feb 2024 13:17:49 -0800
Subject: [PATCH 274/316] CI: skip func tests on irrelevant changes

These tests take 5-30x longer than the unit tests & style check; only
run them if there's a reason to think their outcome might have changed.

Change-Id: I2ccee79538f8bf6408e7bfb8a9826201180a41fe
---
 .zuul.yaml | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index 3917e26e..c9b5fc5e 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -43,8 +43,15 @@
         - openstack-tox-py37
     check:
       jobs:
-        - swiftclient-swift-functional
-        - swiftclient-functional
+        - swiftclient-functional:
+            irrelevant-files: &functest-irrelevant-files
+              - ^(doc|releasenotes)/.*$
+              - ^test/unit/.*$
+              - ^(.gitreview|.mailmap|AUTHORS|ChangeLog|.*\.rst)$
+        - swiftclient-swift-functional:
+            irrelevant-files: *functest-irrelevant-files
+        - tempest-full-py3:
+            irrelevant-files: *functest-irrelevant-files
         - openstack-tox-py311:
             voting: true
     gate:

From 3de67228a80a07f92353fa9958b881b209e92046 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Tue, 27 Feb 2024 08:34:26 -0800
Subject: [PATCH 275/316] CI: add py39 and py310 to experimental pipeline

The openstack-python3-jobs template covers py38 and py311, with the
assumption that intermediate Python releases should pass, too. Since
we already have an experimental pipeline to spot-check that tests
still pass on various Python versions, include those intermediate
releases as well.

Change-Id: I0b4e8839ec14a4ad7529a9929f1150e5bc586059
---
 .zuul.yaml | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index c9b5fc5e..5befed60 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -37,10 +37,13 @@
       - publish-openstack-docs-pti
       - release-notes-jobs-python3
     experimental:
-      # on-demand pipeline used to test older (but still supported) versions of python
+      # on-demand pipeline used to test older (but still supported) versions of python,
+      # as well as intermediate releases that the openstack-python3-jobs might skip
       jobs:
         - openstack-tox-py36
         - openstack-tox-py37
+        - openstack-tox-py39
+        - openstack-tox-py310
     check:
       jobs:
         - swiftclient-functional:

From 153f4cd277f99f32e702737dfa48e959e8a20977 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Tue, 27 Feb 2024 08:49:23 -0800
Subject: [PATCH 276/316] CI: Fix py36 and py37 jobs

The openstack/requirements repo has dropped support for these versions
of python; as a result, some constraints have moved forward to versions
requiring py38+.

Fortunately, the Python ecosystem has gotten much better about specifying
Python version requirements, so we should be clear to just trust the
package metadata to get us a useful version.

Change-Id: I44941d9f7cb145631a0daae2d12cfe85be854f6f
---
 tox.ini | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/tox.ini b/tox.ini
index 4ebf6537..097a9949 100644
--- a/tox.ini
+++ b/tox.ini
@@ -24,6 +24,12 @@ passenv = SWIFT_*
 commands =
     python -m flake8 swiftclient test
 
+[testenv:{py36,py37}]
+# Drop the use of constraints; most dependencies have dropped support for
+# these versions already, and have updated their metadata to reflect that
+deps = -r{toxinidir}/requirements.txt
+       -r{toxinidir}/test-requirements.txt
+
 [testenv:venv]
 commands = {posargs}
 

From 27171d981cae670ac31f123713b31f1c93045447 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Mon, 26 Feb 2024 11:00:39 -0800
Subject: [PATCH 277/316] Authors / changelog for 4.5.0

Change-Id: I7fd65c32a7034fc5d1e01fc822b9771d49ad81c2
---
 .mailmap                                             |  1 +
 AUTHORS                                              |  1 +
 ChangeLog                                            | 12 ++++++++++++
 .../notes/4_5_0_release-b315d25b889293f2.yaml        | 12 ++++++++++++
 4 files changed, 26 insertions(+)
 create mode 100644 releasenotes/notes/4_5_0_release-b315d25b889293f2.yaml

diff --git a/.mailmap b/.mailmap
index bc092300..0f7a8237 100644
--- a/.mailmap
+++ b/.mailmap
@@ -97,3 +97,4 @@ Nandini Tata <nandini.tata@intel.com> <nandini.tata.15@gmail.com>
 Flavio Percoco <flaper87@gmail.com>
 Timur Alperovich <timuralp@swiftstack.com> <timur@timuralp.com>
 Thiago da Silva <thiagodasilva@gmail.com> <thiago@redhat.com>
+DavHau <hsngrmpf@gmail.com> <hsngrmpf+github@gmail.com>
diff --git a/AUTHORS b/AUTHORS
index fe536af0..181f6484 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -30,6 +30,7 @@ Corey Bryant (corey.bryant@canonical.com)
 Dan Prince (dprince@redhat.com)
 Daniel Wakefield (daniel.wakefield@hp.com)
 Darrell Bishop (darrell@swiftstack.com)
+DavHau (hsngrmpf@gmail.com)
 David Goetz (david.goetz@rackspace.com)
 David Kranz (david.kranz@qrclab.com)
 David Shrewsbury (shrewsbury.dave@gmail.com)
diff --git a/ChangeLog b/ChangeLog
index 3b0d9fae..936115f5 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,15 @@
+4.5.0
+-----
+
+* `swift stat --lh` now prints account quotas (including per-policy quotas)
+  in human-readable units, similar to account usage values.
+
+* Modernized some aspects of packaging, allowing wheels to be built with more
+  (and more recent) tools.
+
+* Various other minor bug fixes and improvements.
+
+
 4.4.0
 -----
 
diff --git a/releasenotes/notes/4_5_0_release-b315d25b889293f2.yaml b/releasenotes/notes/4_5_0_release-b315d25b889293f2.yaml
new file mode 100644
index 00000000..69ad629e
--- /dev/null
+++ b/releasenotes/notes/4_5_0_release-b315d25b889293f2.yaml
@@ -0,0 +1,12 @@
+---
+features:
+  - |
+    ``swift stat --lh`` now prints account quotas (including per-policy quotas)
+    in human-readable units, similar to account usage values.
+
+  - |
+    Modernized some aspects of packaging, allowing wheels to be built with more
+    (and more recent) tools.
+fixes:
+  - |
+    Various other minor bug fixes and improvements.

From ac2a60dc0d2932583e70406b6d456e6ae094c3dd Mon Sep 17 00:00:00 2001
From: Yan Xiao <yanxiao@nvidia.com>
Date: Fri, 15 Dec 2023 09:19:35 -0500
Subject: [PATCH 278/316] Add transaction id to errors

Add transaction id to errors to help troubleshoot, including error
when downloading object with truncted/missing segment, stat'ing or
listing non-existent container.

Change response headers returned by client.py Connection APIs
such as get_object() from lowercase dict to CaseInsensitiveDict,
as some error paths rely on this to retrieve the transaction id,
while there are existing code paths using response.headers which
is CaseInsensitiveDict from requests lib.

Change-Id: Ice9cc9fe68684563f18ee527996e5a4292230a96
---
 swiftclient/client.py         |  10 ++-
 swiftclient/multithreading.py |   4 +
 swiftclient/service.py        |  25 ++++--
 swiftclient/shell.py          |  22 ++---
 test/unit/test_service.py     |  27 +++++-
 test/unit/test_shell.py       | 165 +++++++++++++++++++++++++++++++++-
 test/unit/test_swiftclient.py |   8 ++
 7 files changed, 239 insertions(+), 22 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index 06350901..074e3062 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -19,10 +19,13 @@
 import socket
 import re
 import logging
+from urllib3.exceptions import HTTPError as urllib_http_error
+
 import warnings
 
 from requests.exceptions import RequestException, SSLError
 import http.client as http_client
+from requests.structures import CaseInsensitiveDict
 from urllib.parse import quote, unquote
 from urllib.parse import urljoin, urlparse, urlunparse
 from time import sleep, time
@@ -287,7 +290,7 @@ def read(self, length=None):
         try:
             buf = self.resp.read(length)
             self.bytes_read += len(buf)
-        except (socket.error, RequestException):
+        except (socket.error, urllib_http_error, RequestException):
             if self.conn.attempts > self.conn.retries:
                 raise
         if (not buf and self.bytes_read < self.expected_length and
@@ -735,9 +738,9 @@ def get_auth(auth_url, user, key, **kwargs):
 
 
 def resp_header_dict(resp):
-    resp_headers = {}
+    resp_headers = CaseInsensitiveDict()
     for header, value in resp.getheaders():
-        header = parse_header_string(header).lower()
+        header = parse_header_string(header)
         resp_headers[header] = parse_header_string(value)
     return resp_headers
 
@@ -1926,6 +1929,7 @@ def get_object(self, container, obj, resp_chunk_size=None,
             is_not_range_request and resp_chunk_size and
             self.attempts <= self.retries and
             rheaders.get('transfer-encoding') is None)
+
         if retry_is_possible:
             body = _RetryBody(body.resp, self, container, obj,
                               resp_chunk_size=resp_chunk_size,
diff --git a/swiftclient/multithreading.py b/swiftclient/multithreading.py
index eaccec68..9659997c 100644
--- a/swiftclient/multithreading.py
+++ b/swiftclient/multithreading.py
@@ -89,6 +89,10 @@ def error(self, msg, *fmt_args):
             msg = msg % fmt_args
         self.error_print_pool.submit(self._print_error, msg)
 
+    def error_with_txn_id(self, swift_err):
+        self.error("{}\nFailed Transaction ID: {}".format(
+            swift_err.value, swift_err.transaction_id or 'unknown'))
+
     def get_error_count(self):
         return self.error_count
 
diff --git a/swiftclient/service.py b/swiftclient/service.py
index 3d1b4764..d0e93075 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -32,6 +32,9 @@
 from threading import Thread
 from queue import Queue
 from queue import Empty as QueueEmpty
+from requests.exceptions import RequestException
+from socket import error as socket_error
+from urllib3.exceptions import HTTPError as urllib_http_error
 from urllib.parse import quote
 
 import json
@@ -68,12 +71,16 @@ def __next__(self):
 
 class SwiftError(Exception):
     def __init__(self, value, container=None, obj=None,
-                 segment=None, exc=None):
+                 segment=None, exc=None, transaction_id=None):
         self.value = value
         self.container = container
         self.obj = obj
         self.segment = segment
         self.exception = exc
+        if transaction_id is None:
+            self.transaction_id = getattr(exc, 'transaction_id', None)
+        else:
+            self.transaction_id = transaction_id
 
     def __str__(self):
         value = repr(self.value)
@@ -459,7 +466,9 @@ def __init__(self, path, body, headers, checksum=True):
             try:
                 self._content_length = int(headers.get('content-length'))
             except ValueError:
-                raise SwiftError('content-length header must be an integer')
+                raise SwiftError(
+                    'content-length header must be an integer',
+                    transaction_id=self._txn_id)
 
     def __iter__(self):
         for chunk in self._body:
@@ -1306,9 +1315,15 @@ def _download_object_job(self, conn, container, obj, options):
                             else:
                                 pseudodir = True
 
-                for chunk in obj_body:
-                    if fp is not None:
-                        fp.write(chunk)
+                try:
+                    for chunk in obj_body:
+                        if fp is not None:
+                            fp.write(chunk)
+                except (socket_error,
+                        urllib_http_error,
+                        RequestException) as err:
+                    raise ClientException(
+                        str(err), http_response_headers=headers)
 
                 finish_time = time()
 
diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index c5fb2190..4f6cf2de 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -227,7 +227,7 @@ def st_delete(parser, args, output_manager, return_parser=False):
                         output_manager.error('Error Deleting: {0}: {1}'
                                              .format(p, r['error']))
         except SwiftError as err:
-            output_manager.error(err.value)
+            output_manager.error_with_txn_id(err)
 
 
 st_download_options = '''[--all] [--marker <marker>] [--prefix <prefix>]
@@ -484,11 +484,13 @@ def st_download(parser, args, output_manager, return_parser=False):
                                     "Object '%s/%s' not found", container, obj)
                                 continue
                         output_manager.error(
-                            "Error downloading object '%s/%s': %s",
-                            container, obj, error)
+                            "Error downloading object '%s/%s': %s\n"
+                            "Failed Transaction ID: %s",
+                            container, obj, error,
+                            getattr(error, 'transaction_id', 'unknown'))
 
         except SwiftError as e:
-            output_manager.error(e.value)
+            output_manager.error_with_txn_id(e)
         except Exception as e:
             output_manager.error(e)
 
@@ -670,7 +672,7 @@ def listing(stats_parts_gen=stats_parts_gen):
                         prt_bytes(totals['bytes'], human))
 
         except SwiftError as e:
-            output_manager.error(e.value)
+            output_manager.error_with_txn_id(e)
 
 
 st_stat_options = '''[--lh] [--header <header:value>]
@@ -761,7 +763,7 @@ def st_stat(parser, args, output_manager, return_parser=False):
                             st_stat_options, st_stat_help)
 
         except SwiftError as e:
-            output_manager.error(e.value)
+            output_manager.error_with_txn_id(e)
 
 
 st_post_options = '''[--read-acl <acl>] [--write-acl <acl>] [--sync-to <sync-to>]
@@ -867,7 +869,7 @@ def st_post(parser, args, output_manager, return_parser=False):
                 raise(result["error"])
 
         except SwiftError as e:
-            output_manager.error(e.value)
+            output_manager.error_with_txn_id(e)
 
 
 st_copy_options = '''[--destination </container/object>] [--fresh-metadata]
@@ -972,7 +974,7 @@ def st_copy(parser, args, output_manager, return_parser=False):
                 return
 
         except SwiftError as e:
-            output_manager.error(e.value)
+            output_manager.error_with_txn_id(e)
 
 
 st_upload_options = '''[--changed] [--skip-identical] [--segment-size <size>]
@@ -1270,7 +1272,7 @@ def st_upload(parser, args, output_manager, return_parser=False):
                                 "to chunk the object")
 
         except SwiftError as e:
-            output_manager.error(e.value)
+            output_manager.error_with_txn_id(e)
 
 
 st_capabilities_options = '''[--json] [<proxy_url>]
@@ -1332,7 +1334,7 @@ def _print_compo_cap(name, capabilities):
                 del capabilities['swift']
                 _print_compo_cap('Additional middleware', capabilities)
         except SwiftError as e:
-            output_manager.error(e.value)
+            output_manager.error_with_txn_id(e)
 
 
 st_info = st_capabilities
diff --git a/test/unit/test_service.py b/test/unit/test_service.py
index 99351255..1c6207d8 100644
--- a/test/unit/test_service.py
+++ b/test/unit/test_service.py
@@ -27,6 +27,7 @@
 from concurrent.futures import Future
 from hashlib import md5
 from queue import Queue, Empty as QueueEmptyError
+from requests.structures import CaseInsensitiveDict
 from time import sleep
 
 import swiftclient
@@ -167,8 +168,10 @@ def test_create_with_content_length(self):
         self.assertIsNone(sr._actual_md5)
 
         # Check Contentlength raises error if it isn't an integer
-        self.assertRaises(SwiftError, self.sr, 'path', 'body',
-                          {'content-length': 'notanint'})
+        with self.assertRaises(SwiftError) as cm:
+            self.sr('path', 'body', {'content-length': 'notanint'})
+        self.assertEqual("'content-length header must be an integer'",
+                         str(cm.exception))
 
     def test_iterator_usage(self):
         def _consume(sr):
@@ -653,6 +656,7 @@ def test_empty_swifterror_creation(self):
         self.assertIsNone(se.exception)
 
         self.assertEqual(str(se), '5')
+        self.assertNotIn(str(se), 'Transaction ID')
 
     def test_swifterror_creation(self):
         test_exc = Exception('test exc')
@@ -665,6 +669,25 @@ def test_swifterror_creation(self):
         self.assertEqual(se.exception, test_exc)
 
         self.assertEqual(str(se), '5 container:con object:obj segment:seg')
+        self.assertNotIn(str(se), 'Transaction ID')
+
+    def test_swifterror_clientexception_creation(self):
+        test_exc = ClientException(
+            Exception('test exc'),
+            http_response_headers=CaseInsensitiveDict({
+                'x-trans-id': 'someTransId'})
+        )
+        se = SwiftError(5, 'con', 'obj', 'seg', test_exc)
+
+        self.assertEqual(se.value, 5)
+        self.assertEqual(se.container, 'con')
+        self.assertEqual(se.obj, 'obj')
+        self.assertEqual(se.segment, 'seg')
+        self.assertEqual(se.exception, test_exc)
+
+        self.assertEqual('someTransId', se.transaction_id)
+        self.assertNotIn('someTransId', str(se))
+        self.assertIn('5 container:con object:obj segment:seg', str(se))
 
 
 class TestServiceUtils(unittest.TestCase):
diff --git a/test/unit/test_shell.py b/test/unit/test_shell.py
index eedbc4be..13940794 100644
--- a/test/unit/test_shell.py
+++ b/test/unit/test_shell.py
@@ -15,17 +15,21 @@
 
 import io
 import contextlib
+import socket
 from genericpath import getmtime
 import getpass
 import hashlib
 import json
 import logging
 import os
+from requests.structures import CaseInsensitiveDict
 import tempfile
 import unittest
 from unittest import mock
 import textwrap
 from time import localtime, mktime, strftime, strptime
+from requests.exceptions import RequestException
+from urllib3.exceptions import HTTPError
 
 import swiftclient
 from swiftclient.service import SwiftError
@@ -207,6 +211,28 @@ def test_stat_container(self, connection):
                              '  Sync To: other\n'
                              ' Sync Key: secret\n')
 
+    @mock.patch('swiftclient.service.Connection')
+    def test_stat_container_not_found(self, connection):
+        connection.return_value.head_container.side_effect = \
+            swiftclient.ClientException(
+                'test',
+                http_status=404,
+                http_response_headers=CaseInsensitiveDict({
+                    'x-trans-id': 'someTransId'})
+            )
+        argv = ["", "stat", "container"]
+
+        with CaptureOutput() as output:
+            with self.assertRaises(SystemExit):
+                swiftclient.shell.main(argv)
+                connection.return_value.head_container.assert_called_with(
+                    'container', headers={}, resp_chunk_size=65536,
+                    response_dict={})
+
+            self.assertIn('Container \'container\' not found\n'
+                          'Failed Transaction ID: someTransId',
+                          output.err)
+
     @mock.patch('swiftclient.service.Connection')
     def test_stat_container_with_headers(self, connection):
         return_headers = {
@@ -285,6 +311,27 @@ def test_stat_object(self, connection):
                              '          ETag: md5\n'
                              '      Manifest: manifest\n')
 
+    @mock.patch('swiftclient.service.Connection')
+    def test_stat_object_not_found(self, connection):
+        connection.return_value.head_object.side_effect = \
+            swiftclient.ClientException(
+                'test', http_status=404,
+                http_response_headers=CaseInsensitiveDict({
+                    'x-trans-id': 'someTransId'})
+            )
+        argv = ["", "stat", "container", "object"]
+
+        with CaptureOutput() as output:
+            with self.assertRaises(SystemExit):
+                swiftclient.shell.main(argv)
+                connection.return_value.head_object.assert_called_with(
+                    'container', 'object', headers={}, resp_chunk_size=65536,
+                    response_dict={})
+
+            self.assertIn('test: 404\n'
+                          'Failed Transaction ID: someTransId',
+                          output.err)
+
     @mock.patch('swiftclient.service.Connection')
     def test_stat_object_with_headers(self, connection):
         return_headers = {
@@ -707,6 +754,117 @@ def test_download(self, connection, makedirs):
             swiftclient.shell.main(argv)
             self.assertEqual('objcontent', output.out)
 
+    def _do_test_download_clientexception(self, exc):
+        retry_calls = []
+
+        def _fake_retry(conn, *args, **kwargs):
+            retry_calls.append((args, kwargs))
+            conn.attempts += 1
+
+            body = mock.MagicMock()
+            body.resp.read.side_effect = RequestException('test_exc')
+            return (CaseInsensitiveDict({
+                'content-type': 'text/plain',
+                'etag': '2cbbfe139a744d6abbe695e17f3c1991',
+                'x-trans-id': 'someTransId'}),
+                body)
+
+        argv = ["", "download", "container", "object", "--retries", "1"]
+        with CaptureOutput() as output:
+            with mock.patch(BUILTIN_OPEN) as mock_open:
+                with mock.patch("swiftclient.service.Connection._retry",
+                                _fake_retry):
+                    with self.assertRaises(SystemExit):
+                        swiftclient.shell.main(argv)
+                    mock_open.assert_called_with('object', 'wb', 65536)
+            self.assertEqual([
+                ((None, swiftclient.client.get_object, 'container', 'object'),
+                 {'headers': {},
+                  'query_string': None,
+                  'resp_chunk_size': 65536,
+                  'response_dict': {}}),
+                ((None, swiftclient.client.get_object, 'container', 'object'),
+                 {'attempts': 1,
+                  'headers': {'If-Match': mock.ANY, 'Range': 'bytes=0-'},
+                  'query_string': None,
+                  'resp_chunk_size': 65536,
+                  'response_dict': {}})],
+                retry_calls)
+            self.assertIn('Error downloading object \'container/object\': '
+                          'test_exc',
+                          str(output.err))
+            self.assertIn('someTransId', str(output.err))
+
+    def test_download_request_exception(self):
+        self._do_test_download_clientexception(RequestException('text_exc'))
+
+    def test_download_socket_error(self):
+        self._do_test_download_clientexception(socket.error())
+
+    def test_download_http_error(self):
+        self._do_test_download_clientexception(HTTPError)
+
+    def test_download_request_exception_retries_0(self):
+        retry_calls = []
+
+        def _fake_retry(conn, *args, **kwargs):
+            retry_calls.append((args, kwargs))
+            conn.attempts += 1
+
+            body = mock.MagicMock()
+            body.__iter__.side_effect = RequestException('test_exc')
+            return (CaseInsensitiveDict({
+                'content-type': 'text/plain',
+                'etag': '2cbbfe139a744d6abbe695e17f3c1991',
+                'x-trans-id': 'someTransId'}),
+                body)
+
+        argv = ["", "download", "container", "object", "--retries", "0"]
+        with CaptureOutput() as output:
+            with mock.patch(BUILTIN_OPEN) as mock_open:
+                with mock.patch("swiftclient.service.Connection._retry",
+                                _fake_retry):
+                    with self.assertRaises(SystemExit):
+                        swiftclient.shell.main(argv)
+                    mock_open.assert_called_with('object', 'wb', 65536)
+            self.assertEqual([
+                ((None, swiftclient.client.get_object, 'container', 'object'),
+                 {'headers': {},
+                  'query_string': None,
+                  'resp_chunk_size': 65536,
+                  'response_dict': {}}), ],
+                retry_calls)
+            self.assertIn('Error downloading object \'container/object\': '
+                          'test_exc',
+                          str(output.err))
+            self.assertIn('someTransId', str(output.err))
+
+    @mock.patch('swiftclient.service.Connection')
+    def test_download_bad_content_length(self, connection):
+        objcontent = io.BytesIO(b'objcontent')
+        connection.return_value.get_object.side_effect = [
+            (CaseInsensitiveDict({
+                'content-type': 'text/plain',
+                'content-length': 'BAD',
+                'etag': '2cbbfe139a744d6abbe695e17f3c1991',
+                'x-trans-id': 'someTransId'}),
+             objcontent)
+        ]
+        with CaptureOutput() as output:
+            with self.assertRaises(SystemExit):
+                with mock.patch(BUILTIN_OPEN) as mock_open:
+                    argv = ["", "download", "container", "object"]
+                    swiftclient.shell.main(argv)
+                connection.return_value.get_object.assert_called_with(
+                    'container', 'object', headers={}, resp_chunk_size=65536,
+                    response_dict={})
+                mock_open.assert_called_with('object', 'wb', 65536)
+
+            self.assertIn("Error downloading object \'container/object\': "
+                          "'content-length header must be an integer'"
+                          "\nFailed Transaction ID: someTransId",
+                          str(output.err))
+
     @mock.patch('swiftclient.service.shuffle')
     @mock.patch('swiftclient.service.Connection')
     def test_download_shuffle(self, connection, mock_shuffle):
@@ -1901,7 +2059,9 @@ def test_post_account_not_found(self, connection):
             with self.assertRaises(SystemExit):
                 swiftclient.shell.main(argv)
 
-            self.assertEqual(output.err, 'Account not found\n')
+            self.assertEqual(
+                output.err,
+                'Account not found\nFailed Transaction ID: unknown\n')
 
     @mock.patch('swiftclient.service.Connection')
     def test_post_container(self, connection):
@@ -2093,7 +2253,8 @@ def test_copy_two_objects_bad_destination(self, connection):
             self.assertEqual(
                 output.err,
                 'Combination of multiple objects and destination '
-                'including object is invalid\n')
+                'including object is invalid\n'
+                'Failed Transaction ID: unknown\n')
 
     @mock.patch('swiftclient.service.Connection')
     def test_copy_object_bad_auth(self, connection):
diff --git a/test/unit/test_swiftclient.py b/test/unit/test_swiftclient.py
index be4f4a5e..a34e94f1 100644
--- a/test/unit/test_swiftclient.py
+++ b/test/unit/test_swiftclient.py
@@ -1118,6 +1118,14 @@ def test_response_headers(self):
         self.assertEqual('%ff', headers.get('x-non-utf-8-header', ''))
         self.assertEqual('%FF', headers.get('x-binary-header', ''))
 
+        self.assertEqual('t\xe9st', headers.get('X-Utf-8-Header', ''))
+        self.assertEqual('%ff', headers.get('X-Non-Utf-8-Header', ''))
+        self.assertEqual('%FF', headers.get('X-Binary-Header', ''))
+
+        self.assertEqual('t\xe9st', headers.get('X-UTF-8-HEADER', ''))
+        self.assertEqual('%ff', headers.get('X-NON-UTF-8-HEADER', ''))
+        self.assertEqual('%FF', headers.get('X-BINARY-HEADER', ''))
+
     def test_chunk_size_read_method(self):
         conn = c.Connection('http://auth.url/', 'some_user', 'some_key')
         with mock.patch('swiftclient.client.get_auth_1_0') as mock_get_auth:

From 0dacfe725735c1badc46e2ea366ddd7b0c152be4 Mon Sep 17 00:00:00 2001
From: OpenStack Release Bot <infra-root@openstack.org>
Date: Tue, 12 Mar 2024 10:47:52 +0000
Subject: [PATCH 279/316] reno: Update master for unmaintained/victoria

Update the victoria release notes configuration to build from
unmaintained/victoria.

Change-Id: Ia2bc3dfffcf0804b127eb6d81ff76e52ed702ec1
---
 releasenotes/source/victoria.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/releasenotes/source/victoria.rst b/releasenotes/source/victoria.rst
index 4efc7b6f..8ce93341 100644
--- a/releasenotes/source/victoria.rst
+++ b/releasenotes/source/victoria.rst
@@ -3,4 +3,4 @@ Victoria Series Release Notes
 =============================
 
 .. release-notes::
-   :branch: stable/victoria
+   :branch: unmaintained/victoria

From 6c2d5887d1c9860b8e2cc4968bede4bcba2c8b31 Mon Sep 17 00:00:00 2001
From: OpenStack Release Bot <infra-root@openstack.org>
Date: Tue, 12 Mar 2024 10:48:38 +0000
Subject: [PATCH 280/316] reno: Update master for unmaintained/wallaby

Update the wallaby release notes configuration to build from
unmaintained/wallaby.

Change-Id: I0d228453dae70e0ce36b2ca4c893784d077ae0cb
---
 releasenotes/source/wallaby.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/releasenotes/source/wallaby.rst b/releasenotes/source/wallaby.rst
index d77b5659..bcf35c5f 100644
--- a/releasenotes/source/wallaby.rst
+++ b/releasenotes/source/wallaby.rst
@@ -3,4 +3,4 @@ Wallaby Series Release Notes
 ============================
 
 .. release-notes::
-   :branch: stable/wallaby
+   :branch: unmaintained/wallaby

From 32397333ea029014d05ec9afe6c2b0a297a3d6a7 Mon Sep 17 00:00:00 2001
From: OpenStack Release Bot <infra-root@openstack.org>
Date: Tue, 12 Mar 2024 10:49:14 +0000
Subject: [PATCH 281/316] reno: Update master for unmaintained/xena

Update the xena release notes configuration to build from
unmaintained/xena.

Change-Id: I478a6bb6c5372f26e1001b05930b108fac14c6be
---
 releasenotes/source/xena.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/releasenotes/source/xena.rst b/releasenotes/source/xena.rst
index 1be85be3..d19eda48 100644
--- a/releasenotes/source/xena.rst
+++ b/releasenotes/source/xena.rst
@@ -3,4 +3,4 @@ Xena Series Release Notes
 =========================
 
 .. release-notes::
-   :branch: stable/xena
+   :branch: unmaintained/xena

From 12dacb3e2cc7567c9bdfaa1be3fc0f6d1442169a Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Mon, 29 Apr 2024 15:10:15 -0700
Subject: [PATCH 282/316] Mark py312 job as voting and update classifiers

Change-Id: I31f26e13a90547940436599fbda5af5745937563
---
 .zuul.yaml | 6 ++++--
 setup.cfg  | 1 +
 2 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index 5befed60..94988e9f 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -55,13 +55,15 @@
             irrelevant-files: *functest-irrelevant-files
         - tempest-full-py3:
             irrelevant-files: *functest-irrelevant-files
-        - openstack-tox-py311:
+        - openstack-tox-py311
+        - openstack-tox-py312:
             voting: true
     gate:
       jobs:
         - swiftclient-swift-functional
         - swiftclient-functional
-        - openstack-tox-py311:
+        - openstack-tox-py311
+        - openstack-tox-py312:
             voting: true
     post:
       jobs:
diff --git a/setup.cfg b/setup.cfg
index 726bb873..fd2f6713 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -29,6 +29,7 @@ classifier =
     Programming Language :: Python :: 3.9
     Programming Language :: Python :: 3.10
     Programming Language :: Python :: 3.11
+    Programming Language :: Python :: 3.12
     Programming Language :: Python :: 3 :: Only
 
 [files]

From 5b6c66dc483a9926f51aff99f2917f358ae9cde6 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Mon, 29 Apr 2024 15:30:55 -0700
Subject: [PATCH 283/316] Bring back (experimental) py38 job

The job templates changed recently; see
https://opendev.org/openstack/openstack-zuul-jobs/commit/3d6a033e

Change-Id: Iff1ae48a79a4e2ad3ac55ada2f5af8516d069abf
---
 .zuul.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index 94988e9f..3bdc3d0d 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -42,7 +42,7 @@
       jobs:
         - openstack-tox-py36
         - openstack-tox-py37
-        - openstack-tox-py39
+        - openstack-tox-py38
         - openstack-tox-py310
     check:
       jobs:

From bf9343959f84072a9dcdf391139a9a22cce0a270 Mon Sep 17 00:00:00 2001
From: OpenStack Release Bot <infra-root@openstack.org>
Date: Thu, 7 Mar 2024 15:39:32 +0000
Subject: [PATCH 284/316] Update master for stable/2024.1

Add file to the reno documentation build to show release notes for
stable/2024.1.

Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/2024.1.

Sem-Ver: feature
Change-Id: I7d7ddaf111a41d5148d039ec342e49cc00ec8122
---
 releasenotes/source/2024.1.rst | 6 ++++++
 releasenotes/source/index.rst  | 1 +
 2 files changed, 7 insertions(+)
 create mode 100644 releasenotes/source/2024.1.rst

diff --git a/releasenotes/source/2024.1.rst b/releasenotes/source/2024.1.rst
new file mode 100644
index 00000000..4977a4f1
--- /dev/null
+++ b/releasenotes/source/2024.1.rst
@@ -0,0 +1,6 @@
+===========================
+2024.1 Series Release Notes
+===========================
+
+.. release-notes::
+   :branch: stable/2024.1
diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst
index bb8394b4..c154b9e6 100644
--- a/releasenotes/source/index.rst
+++ b/releasenotes/source/index.rst
@@ -6,6 +6,7 @@
    :maxdepth: 1
 
    current
+   2024.1
    2023.2
    2023.1
    zed

From 1152d16ffcca2d220d914cd133b04ff794faf8c9 Mon Sep 17 00:00:00 2001
From: OpenStack Release Bot <infra-root@openstack.org>
Date: Tue, 30 Apr 2024 11:05:51 +0000
Subject: [PATCH 285/316] reno: Update master for unmaintained/zed

Update the zed release notes configuration to build from
unmaintained/zed.

Change-Id: Ic39b5b275c2e4591e13fa51d0422ca768edec6c6
---
 releasenotes/source/zed.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/releasenotes/source/zed.rst b/releasenotes/source/zed.rst
index 9608c05e..6cc2b155 100644
--- a/releasenotes/source/zed.rst
+++ b/releasenotes/source/zed.rst
@@ -3,4 +3,4 @@ Zed Series Release Notes
 ========================
 
 .. release-notes::
-   :branch: stable/zed
+   :branch: unmaintained/zed

From ed6fd60915fed7fd2a319fbbf1daec5f04169ebf Mon Sep 17 00:00:00 2001
From: Clay Gerrard <clay.gerrard@gmail.com>
Date: Wed, 17 Apr 2024 13:59:56 -0500
Subject: [PATCH 286/316] Fix swiftclient output regression

Fix swiftclient output regression introduced by the related change:
  - output for SLO object download: fix incorrect error from
    SwiftReader about SLO object ETag header not matching MD5 checksum
  - output for object stat: fix duplicated ETag
  - output for account/container stat: fix duplicated byte/object counts

Co-Authored-By: Yan Xiao <yanxiao@nvidia.com>
Related-Change: Ice9cc9fe68684563f18ee527996e5a4292230a96
Change-Id: I5b2d79f89d1b6016de69d6b58879e5c2ef31e107
---
 swiftclient/client.py             | 11 ++++++++++-
 test/unit/test_command_helpers.py | 28 ++++++++++++++++++++++++++++
 test/unit/test_service.py         | 27 ++++++++++++++++++++++++---
 test/unit/test_shell.py           | 12 ++++++------
 test/unit/test_swiftclient.py     | 11 +++++++++++
 5 files changed, 79 insertions(+), 10 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index 074e3062..b858ec26 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -212,6 +212,15 @@ def encode_meta_headers(headers):
     return ret
 
 
+class LowerKeyCaseInsensitiveDict(CaseInsensitiveDict):
+    """
+    CaseInsensitiveDict returning lower case keys for items()
+    """
+
+    def __iter__(self):
+        return iter(self._store.keys())
+
+
 class _ObjectBody:
     """
     Readable and iterable object body response wrapper.
@@ -738,7 +747,7 @@ def get_auth(auth_url, user, key, **kwargs):
 
 
 def resp_header_dict(resp):
-    resp_headers = CaseInsensitiveDict()
+    resp_headers = LowerKeyCaseInsensitiveDict()
     for header, value in resp.getheaders():
         header = parse_header_string(header)
         resp_headers[header] = parse_header_string(value)
diff --git a/test/unit/test_command_helpers.py b/test/unit/test_command_helpers.py
index 3e51aa90..f2846d22 100644
--- a/test/unit/test_command_helpers.py
+++ b/test/unit/test_command_helpers.py
@@ -18,6 +18,7 @@
 from unittest import mock
 
 from swiftclient import command_helpers as h
+from swiftclient.client import LowerKeyCaseInsensitiveDict
 from swiftclient.multithreading import OutputManager
 
 
@@ -245,5 +246,32 @@ def test_stat_object_verbose(self):
             ETag: 68b329da9893e34099c7d8ad5cb9c940
       Meta Color: blue
 Content-Encoding: gzip
+"""
+        self.assertOut(expected)
+
+    def test_stat_object_case_insensitive_headers(self):
+        self.options['verbose'] += 1
+        # stub head object request
+        stub_headers = LowerKeyCaseInsensitiveDict({
+            'content-length': 2 ** 20,
+            'x-object-meta-color': 'blue',
+            'ETag': '68b329da9893e34099c7d8ad5cb9c940',
+            'content-encoding': 'gzip',
+        })
+        self.conn.head_object.return_value = stub_headers
+        args = ('c', 'o')
+        with self.output_manager as output_manager:
+            items, headers = h.stat_object(self.conn, self.options, *args)
+            h.print_object_stats(items, headers, output_manager)
+        expected = """
+             URL: http://storage/v1/a/c/o
+      Auth Token: tk12345
+         Account: a
+       Container: c
+          Object: o
+  Content Length: 1048576
+            ETag: 68b329da9893e34099c7d8ad5cb9c940
+      Meta Color: blue
+Content-Encoding: gzip
 """
         self.assertOut(expected)
diff --git a/test/unit/test_service.py b/test/unit/test_service.py
index 9325d646..a6f1ab73 100644
--- a/test/unit/test_service.py
+++ b/test/unit/test_service.py
@@ -27,12 +27,13 @@
 from concurrent.futures import Future
 from hashlib import md5
 from queue import Queue, Empty as QueueEmptyError
-from requests.structures import CaseInsensitiveDict
 from time import sleep
 
 import swiftclient
 import swiftclient.utils as utils
-from swiftclient.client import Connection, ClientException
+from swiftclient.client import (
+    Connection, ClientException, LowerKeyCaseInsensitiveDict
+)
 from swiftclient.service import (
     SwiftService, SwiftError, SwiftUploadObject, SwiftDeleteObject
 )
@@ -242,6 +243,26 @@ def _consume(sr):
         self.assertEqual(sr._actual_md5.hexdigest(),
                          md5('abc'.encode() * 3).hexdigest())
 
+    def test_swift_reader_knows_slo_etag_is_not_md5(self):
+        segment_bodies = [b'abc', b'def', b'ghi']
+        # slo etag is md5 of the sum of md5 of segments
+        slo_etag = md5(b''.join(
+            md5(b).hexdigest().encode()
+            for b in segment_bodies
+        )).hexdigest()
+        headers = LowerKeyCaseInsensitiveDict({
+            'Content-Length': len(b''.join(segment_bodies)),
+            'X-Static-Large-Object': 'true',
+            'ETag': '"%s"' % slo_etag
+        })
+        sr = self.sr('path', segment_bodies, headers)
+        # x-static-large-object; so no exception is raised!
+        actual_md5 = md5(b''.join(sr)).hexdigest()
+        self.assertEqual(sr._actual_read, 9)
+        self.assertIsNone(sr._actual_md5)
+        self.assertEqual(actual_md5,
+                         md5(b''.join(segment_bodies)).hexdigest())
+
 
 class _TestServiceBase(unittest.TestCase):
     def _get_mock_connection(self, attempts=2):
@@ -674,7 +695,7 @@ def test_swifterror_creation(self):
     def test_swifterror_clientexception_creation(self):
         test_exc = ClientException(
             Exception('test exc'),
-            http_response_headers=CaseInsensitiveDict({
+            http_response_headers=LowerKeyCaseInsensitiveDict({
                 'x-trans-id': 'someTransId'})
         )
         se = SwiftError(5, 'con', 'obj', 'seg', test_exc)
diff --git a/test/unit/test_shell.py b/test/unit/test_shell.py
index 2caf05a9..e4e19012 100644
--- a/test/unit/test_shell.py
+++ b/test/unit/test_shell.py
@@ -22,7 +22,6 @@
 import json
 import logging
 import os
-from requests.structures import CaseInsensitiveDict
 import tempfile
 import unittest
 from unittest import mock
@@ -32,6 +31,7 @@
 from urllib3.exceptions import HTTPError
 
 import swiftclient
+from swiftclient.client import LowerKeyCaseInsensitiveDict
 from swiftclient.service import SwiftError
 import swiftclient.shell
 import swiftclient.utils
@@ -245,7 +245,7 @@ def test_stat_container_not_found(self, connection):
             swiftclient.ClientException(
                 'test',
                 http_status=404,
-                http_response_headers=CaseInsensitiveDict({
+                http_response_headers=LowerKeyCaseInsensitiveDict({
                     'x-trans-id': 'someTransId'})
             )
         argv = ["", "stat", "container"]
@@ -344,7 +344,7 @@ def test_stat_object_not_found(self, connection):
         connection.return_value.head_object.side_effect = \
             swiftclient.ClientException(
                 'test', http_status=404,
-                http_response_headers=CaseInsensitiveDict({
+                http_response_headers=LowerKeyCaseInsensitiveDict({
                     'x-trans-id': 'someTransId'})
             )
         argv = ["", "stat", "container", "object"]
@@ -791,7 +791,7 @@ def _fake_retry(conn, *args, **kwargs):
 
             body = mock.MagicMock()
             body.resp.read.side_effect = RequestException('test_exc')
-            return (CaseInsensitiveDict({
+            return (LowerKeyCaseInsensitiveDict({
                 'content-type': 'text/plain',
                 'etag': '2cbbfe139a744d6abbe695e17f3c1991',
                 'x-trans-id': 'someTransId'}),
@@ -841,7 +841,7 @@ def _fake_retry(conn, *args, **kwargs):
 
             body = mock.MagicMock()
             body.__iter__.side_effect = RequestException('test_exc')
-            return (CaseInsensitiveDict({
+            return (LowerKeyCaseInsensitiveDict({
                 'content-type': 'text/plain',
                 'etag': '2cbbfe139a744d6abbe695e17f3c1991',
                 'x-trans-id': 'someTransId'}),
@@ -871,7 +871,7 @@ def _fake_retry(conn, *args, **kwargs):
     def test_download_bad_content_length(self, connection):
         objcontent = io.BytesIO(b'objcontent')
         connection.return_value.get_object.side_effect = [
-            (CaseInsensitiveDict({
+            (LowerKeyCaseInsensitiveDict({
                 'content-type': 'text/plain',
                 'content-length': 'BAD',
                 'etag': '2cbbfe139a744d6abbe695e17f3c1991',
diff --git a/test/unit/test_swiftclient.py b/test/unit/test_swiftclient.py
index 4c79fe2d..2886dbc1 100644
--- a/test/unit/test_swiftclient.py
+++ b/test/unit/test_swiftclient.py
@@ -1117,6 +1117,17 @@ def test_response_headers(self):
         self.assertEqual('t\xe9st', headers.get('x-utf-8-header', ''))
         self.assertEqual('%ff', headers.get('x-non-utf-8-header', ''))
         self.assertEqual('%FF', headers.get('x-binary-header', ''))
+        for k, v in headers.items():
+            # N.B. k is always lower case!
+            self.assertTrue(k.islower())
+        for k in headers.keys():
+            # N.B. k is always lower case!
+            self.assertTrue(k.islower())
+        self.assertTrue(set([
+            'x-utf-8-header',
+            'x-non-utf-8-header',
+            'x-binary-header',
+        ]).intersection(headers))
 
         self.assertEqual('t\xe9st', headers.get('X-Utf-8-Header', ''))
         self.assertEqual('%ff', headers.get('X-Non-Utf-8-Header', ''))

From 9e3f6f787154aea1ddc978c34fb41f76b6abbc18 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Tue, 27 Aug 2024 10:53:40 -0700
Subject: [PATCH 287/316] Authors/ChangeLog for 4.6.0

Change-Id: I6de17cbe80b4fe49148dc88d4b7c053388397a55
---
 AUTHORS                                               |  1 +
 ChangeLog                                             | 10 ++++++++++
 .../notes/4_6_0_release-92e466eb55b80225.yaml         | 11 +++++++++++
 3 files changed, 22 insertions(+)
 create mode 100644 releasenotes/notes/4_6_0_release-92e466eb55b80225.yaml

diff --git a/AUTHORS b/AUTHORS
index 181f6484..031d49a8 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -172,6 +172,7 @@ wangzhenyu (wangzy@fiberhome.com)
 Wu Wenxiang (wu.wenxiang@99cloud.net)
 wu.chunyang (wu.chunyang@99cloud.net)
 wu.shiming (wushiming@yovole.com)
+Yan Xiao (yanxiao@nvidia.com)
 YangLei (yanglyy@cn.ibm.com)
 yangxurong (yangxurong@huawei.com)
 yangyawei (yangyawei@inspur.com)
diff --git a/ChangeLog b/ChangeLog
index 936115f5..dca6815c 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,13 @@
+4.6.0
+-----
+
+* Transaction IDs are included with more errors.
+
+* Now tested under Python 3.12.
+
+* Various other minor bug fixes and improvements.
+
+
 4.5.0
 -----
 
diff --git a/releasenotes/notes/4_6_0_release-92e466eb55b80225.yaml b/releasenotes/notes/4_6_0_release-92e466eb55b80225.yaml
new file mode 100644
index 00000000..71ad26e5
--- /dev/null
+++ b/releasenotes/notes/4_6_0_release-92e466eb55b80225.yaml
@@ -0,0 +1,11 @@
+---
+features:
+  - |
+    Now tested under Python 3.12.
+
+fixes:
+  - |
+    Transaction IDs are included with more errors.
+
+  - |
+    Various other minor bug fixes and improvements.

From 5da3095f7ffa0339817786a6ef7bcd5e283abc4a Mon Sep 17 00:00:00 2001
From: OpenStack Release Bot <infra-root@openstack.org>
Date: Fri, 6 Sep 2024 14:04:26 +0000
Subject: [PATCH 288/316] Update master for stable/2024.2

Add file to the reno documentation build to show release notes for
stable/2024.2.

Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/2024.2.

Sem-Ver: feature
Change-Id: I407b09ac3013e7128ec68edf37f8e1a9da3f1a09
---
 releasenotes/source/2024.2.rst | 6 ++++++
 releasenotes/source/index.rst  | 1 +
 2 files changed, 7 insertions(+)
 create mode 100644 releasenotes/source/2024.2.rst

diff --git a/releasenotes/source/2024.2.rst b/releasenotes/source/2024.2.rst
new file mode 100644
index 00000000..aaebcbc8
--- /dev/null
+++ b/releasenotes/source/2024.2.rst
@@ -0,0 +1,6 @@
+===========================
+2024.2 Series Release Notes
+===========================
+
+.. release-notes::
+   :branch: stable/2024.2
diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst
index c154b9e6..6a57e5f9 100644
--- a/releasenotes/source/index.rst
+++ b/releasenotes/source/index.rst
@@ -6,6 +6,7 @@
    :maxdepth: 1
 
    current
+   2024.2
    2024.1
    2023.2
    2023.1

From e9fbe357642fdc41bd3e4513ba8b1890ddc4a184 Mon Sep 17 00:00:00 2001
From: OpenStack Release Bot <infra-root@openstack.org>
Date: Mon, 25 Nov 2024 10:48:43 +0000
Subject: [PATCH 289/316] reno: Update master for unmaintained/2023.1

Update the 2023.1 release notes configuration to build from
unmaintained/2023.1.

Change-Id: Id7a8f331e8a05a1b0a0de4e66655f302cfdba066
---
 releasenotes/source/2023.1.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/releasenotes/source/2023.1.rst b/releasenotes/source/2023.1.rst
index d1238479..2c9a36fa 100644
--- a/releasenotes/source/2023.1.rst
+++ b/releasenotes/source/2023.1.rst
@@ -3,4 +3,4 @@
 ===========================
 
 .. release-notes::
-   :branch: stable/2023.1
+   :branch: unmaintained/2023.1

From ed3244e0a238970f16428845d8bc3d1ea16cd924 Mon Sep 17 00:00:00 2001
From: OpenStack Release Bot <infra-root@openstack.org>
Date: Thu, 6 Mar 2025 09:06:19 +0000
Subject: [PATCH 290/316] Update master for stable/2025.1

Add file to the reno documentation build to show release notes for
stable/2025.1.

Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/2025.1.

Sem-Ver: feature
Change-Id: I5b0d95b27d871a06ead27c6dc73de8f221b057da
---
 releasenotes/source/2025.1.rst | 6 ++++++
 releasenotes/source/index.rst  | 1 +
 2 files changed, 7 insertions(+)
 create mode 100644 releasenotes/source/2025.1.rst

diff --git a/releasenotes/source/2025.1.rst b/releasenotes/source/2025.1.rst
new file mode 100644
index 00000000..3add0e53
--- /dev/null
+++ b/releasenotes/source/2025.1.rst
@@ -0,0 +1,6 @@
+===========================
+2025.1 Series Release Notes
+===========================
+
+.. release-notes::
+   :branch: stable/2025.1
diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst
index 6a57e5f9..de7b0a9f 100644
--- a/releasenotes/source/index.rst
+++ b/releasenotes/source/index.rst
@@ -6,6 +6,7 @@
    :maxdepth: 1
 
    current
+   2025.1
    2024.2
    2024.1
    2023.2

From 9e67409f33d708f2beafb21cafeff30e9a7ff637 Mon Sep 17 00:00:00 2001
From: Pawel Tetera <ptetera@redhat.com>
Date: Tue, 25 Mar 2025 20:10:44 +0000
Subject: [PATCH 291/316] Add --debug-with-secrets and truncate by default

Previously, data which may be considered sensitive
such as the X-Auth-Token or X-Storage-Token headers is hidden for
the --info option but not --debug.

This patch enables truncating of LOGGER_SENSITIVE_HEADERS by default for
--debug so that end users can share debug output more easily without
having to manually sanitize logs and adds unit tests for it.

A separate --debug-with-secrets option is provided should explicit
printing of auth tokens be desirable, mimicking the old behaviour.

--debug-insecure, suggested on launchpad naming was considered as well
however a --insecure param which skips SSL verification already exists
and does something else. The --with-secrets suffix should also help
make the purpose of this param explicit enough.

Closes-Bug: #2061011
Closes-Bug: #2061012
Change-Id: Ie64b0f496c016a5871de7ada84acb572c008d127
---
 swiftclient/shell.py    | 18 +++++++++++++-----
 test/unit/test_shell.py | 21 ++++++++++++++++++++-
 2 files changed, 33 insertions(+), 6 deletions(-)

diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 1dc8d2f4..23691f25 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -1638,14 +1638,17 @@ def prompt_for_password():
 def parse_args(parser, args, enforce_requires=True):
     options, args = parser.parse_known_args(args or ['-h'])
     options = vars(options)
-    if enforce_requires and (options.get('debug') or options.get('info')):
+    if enforce_requires and (options.get('debug') or
+                             options.get('debug_with_secrets') or
+                             options.get('info')):
         logging.getLogger("swiftclient")
-        if options.get('debug'):
+        if options.get('debug') or options.get('debug_with_secrets'):
             logging.basicConfig(level=logging.DEBUG)
             logging.getLogger('iso8601').setLevel(logging.WARNING)
-            client_logger_settings['redact_sensitive_headers'] = False
         elif options.get('info'):
             logging.basicConfig(level=logging.INFO)
+    client_logger_settings['redact_sensitive_headers'] = not (
+        enforce_requires and options.get('debug_with_secrets'))
 
     if args and options.get('help'):
         _help = globals().get('st_%s_help' % args[0])
@@ -1732,6 +1735,11 @@ def add_default_args(parser):
                         default=False, help='Show the curl commands and '
                         'results of all http queries regardless of result '
                         'status.')
+    parser.add_argument('--debug-with-secrets', action='store_true',
+                        dest='debug_with_secrets', default=False,
+                        help='Show the curl commands and '
+                        'results of all http queries regardless of result '
+                        'status (without truncating auth tokens).')
     parser.add_argument('--info', action='store_true', dest='info',
                         default=False, help='Show the curl commands and '
                         'results of all http queries which return an error.')
@@ -1958,8 +1966,8 @@ def main(arguments=None):
     parser = argparse.ArgumentParser(
         add_help=False, formatter_class=HelpFormatter, usage='''
 %(prog)s [--version] [--help] [--os-help] [--snet] [--verbose]
-             [--debug] [--info] [--quiet] [--auth <auth_url>]
-             [--auth-version <auth_version> |
+             [--debug] [--debug-with-secrets] [--info] [--quiet]
+             [--auth <auth_url>] [--auth-version <auth_version> |
                  --os-identity-api-version <auth_version> ]
              [--user <username>]
              [--key <api_key>] [--retries <num_retries>]
diff --git a/test/unit/test_shell.py b/test/unit/test_shell.py
index e4e19012..b2b34431 100644
--- a/test/unit/test_shell.py
+++ b/test/unit/test_shell.py
@@ -2647,10 +2647,23 @@ def test_option_after_posarg(self, connection, mock_logging):
         argv = ["", "stat", "--info"]
         swiftclient.shell.main(argv)
         mock_logging.assert_called_with(level=logging.INFO)
+        self.assertTrue(
+            swiftclient.logger_settings.get('redact_sensitive_headers')
+        )
 
         argv = ["", "stat", "--debug"]
         swiftclient.shell.main(argv)
         mock_logging.assert_called_with(level=logging.DEBUG)
+        self.assertTrue(
+            swiftclient.logger_settings.get('redact_sensitive_headers')
+        )
+
+        argv = ["", "stat", "--debug-with-secrets"]
+        swiftclient.shell.main(argv)
+        mock_logging.assert_called_with(level=logging.DEBUG)
+        self.assertFalse(
+            swiftclient.logger_settings.get('redact_sensitive_headers')
+        )
 
     @mock.patch('logging.basicConfig')
     @mock.patch('swiftclient.service.Connection')
@@ -2660,7 +2673,13 @@ def test_debug_trumps_info(self, connection, mock_logging):
                           ["", "--info", "stat", "--debug"],
                           ["", "--debug", "stat", "--info"],
                           ["", "--info", "--debug", "stat"],
-                          ["", "--debug", "--info", "stat"])
+                          ["", "--debug", "--info", "stat"],
+                          ["", "stat", "--info", "--debug-with-secrets"],
+                          ["", "stat", "--debug-with-secrets", "--info"],
+                          ["", "--info", "stat", "--debug-with-secrets"],
+                          ["", "--debug-with-secrets", "stat", "--info"],
+                          ["", "--info", "--debug-with-secrets", "stat"],
+                          ["", "--debug-with-secrets", "--info", "stat"])
         for argv in argv_scenarios:
             mock_logging.reset_mock()
             swiftclient.shell.main(argv)

From 79e7c9fb1842494cd97542cb622848b4e66dea7f Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 30 Aug 2024 08:48:38 -0700
Subject: [PATCH 292/316] Test under py313

Change-Id: I737808b82ecfa9cdcbc70e28082db57be932840a
---
 .zuul.yaml | 4 ++++
 setup.cfg  | 1 +
 2 files changed, 5 insertions(+)

diff --git a/.zuul.yaml b/.zuul.yaml
index 3bdc3d0d..ab160395 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -58,6 +58,8 @@
         - openstack-tox-py311
         - openstack-tox-py312:
             voting: true
+        - openstack-tox-py313:
+            voting: true
     gate:
       jobs:
         - swiftclient-swift-functional
@@ -65,6 +67,8 @@
         - openstack-tox-py311
         - openstack-tox-py312:
             voting: true
+        - openstack-tox-py313:
+            voting: true
     post:
       jobs:
         - openstack-tox-cover
diff --git a/setup.cfg b/setup.cfg
index fd2f6713..479d19a4 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -30,6 +30,7 @@ classifier =
     Programming Language :: Python :: 3.10
     Programming Language :: Python :: 3.11
     Programming Language :: Python :: 3.12
+    Programming Language :: Python :: 3.13
     Programming Language :: Python :: 3 :: Only
 
 [files]

From 5ffc285092500f2fb4427ea971023d05e03af319 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Fri, 25 Apr 2025 15:49:05 -0700
Subject: [PATCH 293/316] Remove tags from README

The tags framework has been discontinued for a long time; see
https://governance.openstack.org/tc/reference/tags/ and
https://governance.openstack.org/tc/resolutions/20211224-tags-framework-removal.html

Related-Change: I5f6a3351469516aa81d5eb0fe7c842fe35d1433a
Change-Id: I90f757448180a8aa8fcd1ad297d6e733c115b3ec
---
 README.rst | 9 ---------
 1 file changed, 9 deletions(-)

diff --git a/README.rst b/README.rst
index c9ae3d42..869a9de2 100644
--- a/README.rst
+++ b/README.rst
@@ -1,12 +1,3 @@
-========================
-Team and repository tags
-========================
-
-.. image:: https://governance.openstack.org/tc/badges/python-swiftclient.svg
-    :target: https://governance.openstack.org/tc/reference/tags/index.html
-
-.. Change things from this point on
-
 Python bindings to the OpenStack Object Storage API
 ===================================================
 

From e3422e8d8671db8a1c05bc31efa84a120a48353c Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Tue, 13 May 2025 14:56:38 -0700
Subject: [PATCH 294/316] Drop support for py36

Change-Id: I3d7162f63791362b45a3d65502c9d488615af485
---
 .zuul.yaml | 1 -
 setup.cfg  | 3 +--
 2 files changed, 1 insertion(+), 3 deletions(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index ab160395..55509b5e 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -40,7 +40,6 @@
       # on-demand pipeline used to test older (but still supported) versions of python,
       # as well as intermediate releases that the openstack-python3-jobs might skip
       jobs:
-        - openstack-tox-py36
         - openstack-tox-py37
         - openstack-tox-py38
         - openstack-tox-py310
diff --git a/setup.cfg b/setup.cfg
index 479d19a4..9a1c5399 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -13,7 +13,7 @@ project_urls =
     Documentation = https://docs.openstack.org/python-swiftclient/latest/
     Release Notes = https://opendev.org/openstack/python-swiftclient/src/branch/master/ChangeLog
     Source Code = https://opendev.org/openstack/python-swiftclient
-python_requires = >=3.6
+python_requires = >=3.7
 classifier =
     Environment :: OpenStack
     Intended Audience :: Information Technology
@@ -23,7 +23,6 @@ classifier =
     Operating System :: Microsoft :: Windows
     Programming Language :: Python
     Programming Language :: Python :: 3
-    Programming Language :: Python :: 3.6
     Programming Language :: Python :: 3.7
     Programming Language :: Python :: 3.8
     Programming Language :: Python :: 3.9

From b2416ae6142cb9f391ca56f4640772629e39b1fa Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Tue, 13 May 2025 15:09:44 -0700
Subject: [PATCH 295/316] CI: Fix up the testing matrix

- Remove py310 from experimental pipeline; it has become the new
  lower-bound for all of OpenStack.
- Add py39 to experimental; we still want to support it, even if
  OpenStack at large has moved on.
- Get rid of py312 overrides; they are no longer necessary.

Change-Id: I64f8dadf661217fde3066f790915c835293c8029
---
 .zuul.yaml | 9 ++-------
 tox.ini    | 2 +-
 2 files changed, 3 insertions(+), 8 deletions(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index ab160395..96a45a89 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -43,7 +43,8 @@
         - openstack-tox-py36
         - openstack-tox-py37
         - openstack-tox-py38
-        - openstack-tox-py310
+        - openstack-tox-py39
+        - openstack-tox-py311
     check:
       jobs:
         - swiftclient-functional:
@@ -55,18 +56,12 @@
             irrelevant-files: *functest-irrelevant-files
         - tempest-full-py3:
             irrelevant-files: *functest-irrelevant-files
-        - openstack-tox-py311
-        - openstack-tox-py312:
-            voting: true
         - openstack-tox-py313:
             voting: true
     gate:
       jobs:
         - swiftclient-swift-functional
         - swiftclient-functional
-        - openstack-tox-py311
-        - openstack-tox-py312:
-            voting: true
         - openstack-tox-py313:
             voting: true
     post:
diff --git a/tox.ini b/tox.ini
index 097a9949..19173daf 100644
--- a/tox.ini
+++ b/tox.ini
@@ -24,7 +24,7 @@ passenv = SWIFT_*
 commands =
     python -m flake8 swiftclient test
 
-[testenv:{py36,py37}]
+[testenv:{py36,py37,py38}]
 # Drop the use of constraints; most dependencies have dropped support for
 # these versions already, and have updated their metadata to reflect that
 deps = -r{toxinidir}/requirements.txt

From 8486005ebd881a5c60b6ba0e802387975a5644c0 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Thu, 15 May 2025 20:55:33 -0700
Subject: [PATCH 296/316] Authors/ChangeLog for 4.8.0

Change-Id: I91ae6faa19f918d829659d8457760455dcc0ab6f
---
 AUTHORS                                       |  1 +
 ChangeLog                                     | 19 +++++++++++++++++++
 .../notes/4_8_0_release-41ba0852981191c3.yaml | 16 ++++++++++++++++
 3 files changed, 36 insertions(+)
 create mode 100644 releasenotes/notes/4_8_0_release-41ba0852981191c3.yaml

diff --git a/AUTHORS b/AUTHORS
index 031d49a8..3d9531ff 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -113,6 +113,7 @@ PAPAMICA (mickael@papamica.com)
 Pavel Abalikhin (anpavl@gmail.com)
 Paul Belanger (pabelanger@redhat.com)
 Paulo Ewerton (pauloewerton@lsd.ufcg.edu.br)
+Pawel Tetera (ptetera@redhat.com)
 pengyuesheng (pengyuesheng@gohighsec.com)
 Pete Zaitcev (zaitcev@kotori.zaitcev.us)
 Peter Lisak (peter.lisak@firma.seznam.cz)
diff --git a/ChangeLog b/ChangeLog
index dca6815c..c5d93a93 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,22 @@
+4.8.0
+-----
+
+* Auth tokens are now truncated when running with `--debug`. Added
+  `--debug-with-secrets` flag to enable previous, less-secure behavior.
+
+* Dropped support for Python 3.6.
+
+* Now tested under Python 3.13.
+
+* Various other minor bug fixes and improvements.
+
+
+4.7.0
+-----
+
+* Various minor bug fixes and improvements.
+
+
 4.6.0
 -----
 
diff --git a/releasenotes/notes/4_8_0_release-41ba0852981191c3.yaml b/releasenotes/notes/4_8_0_release-41ba0852981191c3.yaml
new file mode 100644
index 00000000..461c2eb7
--- /dev/null
+++ b/releasenotes/notes/4_8_0_release-41ba0852981191c3.yaml
@@ -0,0 +1,16 @@
+---
+features:
+  - |
+    Now tested under Python 3.13.
+
+fixes:
+  - |
+    Auth tokens are now truncated when running with ``--debug``. Added
+    ``--debug-with-secrets`` flag to enable previous, less-secure behavior.
+
+  - |
+    Various other minor bug fixes and improvements.
+
+other:
+  - |
+    Dropped support for Python 3.6.

From f749e4bdd00a90cc6f8569b7eff3a73eab6ceba2 Mon Sep 17 00:00:00 2001
From: OpenStack Release Bot <infra-root@openstack.org>
Date: Thu, 4 Sep 2025 13:49:59 +0000
Subject: [PATCH 297/316] Update master for stable/2025.2

Add file to the reno documentation build to show release notes for
stable/2025.2.

Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/2025.2.

Sem-Ver: feature
Change-Id: Iffadfcf4863f6ef8a8d25e35518ea4afa9a95e4a
Signed-off-by: OpenStack Release Bot <infra-root@openstack.org>
Generated-By: openstack/project-config:roles/copy-release-tools-scripts/files/release-tools/add_release_note_page.sh
---
 releasenotes/source/2025.2.rst | 6 ++++++
 releasenotes/source/index.rst  | 1 +
 2 files changed, 7 insertions(+)
 create mode 100644 releasenotes/source/2025.2.rst

diff --git a/releasenotes/source/2025.2.rst b/releasenotes/source/2025.2.rst
new file mode 100644
index 00000000..4dae18d8
--- /dev/null
+++ b/releasenotes/source/2025.2.rst
@@ -0,0 +1,6 @@
+===========================
+2025.2 Series Release Notes
+===========================
+
+.. release-notes::
+   :branch: stable/2025.2
diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst
index de7b0a9f..c6ced8f8 100644
--- a/releasenotes/source/index.rst
+++ b/releasenotes/source/index.rst
@@ -6,6 +6,7 @@
    :maxdepth: 1
 
    current
+   2025.2
    2025.1
    2024.2
    2024.1

From 6d302a9214611e645fd37d183245b7cb8bd94482 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Tue, 16 Sep 2025 16:28:56 -0700
Subject: [PATCH 298/316] Use stdlib UTC

Change-Id: Ifcb0e1dd46d8ed736c8ad8d6fbfd82fec33e4768
Signed-off-by: Tim Burke <tim.burke@gmail.com>
---
 swiftclient/authv1.py | 21 +++------------------
 1 file changed, 3 insertions(+), 18 deletions(-)

diff --git a/swiftclient/authv1.py b/swiftclient/authv1.py
index 84bc38ae..b2a037c7 100644
--- a/swiftclient/authv1.py
+++ b/swiftclient/authv1.py
@@ -37,6 +37,7 @@
 """
 
 import datetime
+from datetime import timezone
 import json
 import time
 
@@ -52,22 +53,6 @@
 from keystoneauth1.identity import base
 
 
-# stupid stdlib...
-class _UTC(datetime.tzinfo):
-    def utcoffset(self, dt):
-        return datetime.timedelta(0)
-
-    def tzname(self, dt):
-        return "UTC"
-
-    def dst(self, dt):
-        return datetime.timedelta(0)
-
-
-UTC = _UTC()
-del _UTC
-
-
 class ServiceCatalogV1:
     def __init__(self, auth_url, storage_url, account):
         self.auth_url = auth_url
@@ -171,11 +156,11 @@ def __init__(self, auth_url, storage_url, account, username, auth_token,
     def expires(self):
         if self._expires is None:
             return None
-        return datetime.datetime.fromtimestamp(self._expires, UTC)
+        return datetime.datetime.fromtimestamp(self._expires, timezone.utc)
 
     @property
     def issued(self):
-        return datetime.datetime.fromtimestamp(self._issued, UTC)
+        return datetime.datetime.fromtimestamp(self._issued, timezone.utc)
 
     @property
     def user_id(self):

From 49bd8055380fa3182a4d0f30d3fc40b8744f1099 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Tue, 16 Sep 2025 20:33:33 -0700
Subject: [PATCH 299/316] Unpin tox

tox 4.x seems less likely to break things than 3.x these days.

Change-Id: Ice7365a341dd08dff17c2cae918e86b084d3cc45
Signed-off-by: Tim Burke <tim.burke@gmail.com>
---
 .zuul.yaml | 3 ---
 1 file changed, 3 deletions(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index f0c08d7c..9e911cb5 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -10,9 +10,6 @@
     # for installation.
     required-projects:
       - opendev.org/openstack/python-swiftclient
-    vars:
-      # New tox keeps breaking things as of 2023-01
-      ensure_tox_version: '<4'
 
 - job:
     name: swiftclient-functional

From b2d465f938cee34f75ea845a735634fb261d6137 Mon Sep 17 00:00:00 2001
From: David Svenson <davidsvenson@outlook.com>
Date: Mon, 6 Oct 2025 14:31:00 +0200
Subject: [PATCH 300/316] Pass timeout to the ksa session too.

For whatever reason the timeout isn't passed on here. I can't think of any reason to not use the timeout here too.

Closes: https://bugs.launchpad.net/python-swiftclient/+bug/2126931
Change-Id: Ife99b3bd6610de92233907c9eaf9fa9295cdef2b
Signed-off-by: David Svenson <davidsvenson@outlook.com>
---
 swiftclient/client.py         | 2 +-
 test/unit/test_swiftclient.py | 5 ++++-
 2 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index b858ec26..263aaa8c 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -601,7 +601,7 @@ def get_auth_keystone(auth_url, user, key, os_options, **kwargs):
                     'application_credential_secret'),
                 application_credential_id=os_options.get(
                     'application_credential_id'))
-            sess = ksa_session.Session(auth=auth)
+            sess = ksa_session.Session(auth=auth, timeout=timeout)
             token = sess.get_token()
         except ksauthexceptions.Unauthorized:
             msg = 'Unauthorized. Check application credential id and secret.'
diff --git a/test/unit/test_swiftclient.py b/test/unit/test_swiftclient.py
index 2886dbc1..600b787e 100644
--- a/test/unit/test_swiftclient.py
+++ b/test/unit/test_swiftclient.py
@@ -594,8 +594,11 @@ class FakeEndpointData:
 
         class FakeKeystoneuth1v3Session:
 
-            def __init__(self, auth):
+            def __init__(self, auth, timeout=None):
                 self.auth = auth
+                self.timeout = None
+                if timeout is not None:
+                    self.timeout = float(timeout)
                 self.token = 'token'
 
             def get_token(self):

From 97c7470c349ea9f605ee6aa3be44cf3f5072c7ea Mon Sep 17 00:00:00 2001
From: OpenStack Release Bot <infra-root@openstack.org>
Date: Fri, 31 Oct 2025 11:46:41 +0000
Subject: [PATCH 301/316] reno: Update master for unmaintained/2024.1

Update the 2024.1 release notes configuration to build from
unmaintained/2024.1.

Change-Id: Ifda078f079a8855f653d64eefb06d677d3f02427
Signed-off-by: OpenStack Release Bot <infra-root@openstack.org>
Generated-By: openstack/project-config:roles/copy-release-tools-scripts/files/release-tools/change_reno_branch_to_unmaintained.sh
---
 releasenotes/source/2024.1.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/releasenotes/source/2024.1.rst b/releasenotes/source/2024.1.rst
index 4977a4f1..6896656b 100644
--- a/releasenotes/source/2024.1.rst
+++ b/releasenotes/source/2024.1.rst
@@ -3,4 +3,4 @@
 ===========================
 
 .. release-notes::
-   :branch: stable/2024.1
+   :branch: unmaintained/2024.1

From b308ac14204abb011bf5acab57f8be89c048b456 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Tue, 11 Nov 2025 10:05:39 -0800
Subject: [PATCH 302/316] CI: fix (and update) test-on-demand targets

Change-Id: I27f9e1b3e6a81b9e1efc9ecf993d9158c9f7c7d9
Signed-off-by: Tim Burke <tim.burke@gmail.com>
---
 .zuul.yaml | 6 +++++-
 tox.ini    | 2 +-
 2 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index 9e911cb5..598540a1 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -37,10 +37,14 @@
       # on-demand pipeline used to test older (but still supported) versions of python,
       # as well as intermediate releases that the openstack-python3-jobs might skip
       jobs:
-        - openstack-tox-py37
+        - openstack-tox-py37:
+            nodeset: ubuntu-jammy
+            vars:
+              python_use_pyenv: True
         - openstack-tox-py38
         - openstack-tox-py39
         - openstack-tox-py311
+        - openstack-tox-py312
     check:
       jobs:
         - swiftclient-functional:
diff --git a/tox.ini b/tox.ini
index 19173daf..f991fd66 100644
--- a/tox.ini
+++ b/tox.ini
@@ -24,7 +24,7 @@ passenv = SWIFT_*
 commands =
     python -m flake8 swiftclient test
 
-[testenv:{py36,py37,py38}]
+[testenv:{py37,py38,py39}]
 # Drop the use of constraints; most dependencies have dropped support for
 # these versions already, and have updated their metadata to reflect that
 deps = -r{toxinidir}/requirements.txt

From d520b2bce952fe262b5e0dd23ebe931724349b33 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Tue, 11 Nov 2025 09:45:33 -0800
Subject: [PATCH 303/316] Authors/ChangeLog for 4.9.0

Change-Id: Ide10e87ab413cdb3623e59ea59c6bbc8a1ad5ddd
Signed-off-by: Tim Burke <tim.burke@gmail.com>
---
 AUTHORS                                                | 1 +
 ChangeLog                                              | 8 ++++++++
 releasenotes/notes/4_9_0_release-b26426108163280d.yaml | 7 +++++++
 3 files changed, 16 insertions(+)
 create mode 100644 releasenotes/notes/4_9_0_release-b26426108163280d.yaml

diff --git a/AUTHORS b/AUTHORS
index 3d9531ff..ec6e5bc8 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -34,6 +34,7 @@ DavHau (hsngrmpf@gmail.com)
 David Goetz (david.goetz@rackspace.com)
 David Kranz (david.kranz@qrclab.com)
 David Shrewsbury (shrewsbury.dave@gmail.com)
+David Svenson (davidsvenson@outlook.com)
 Davide Guerri (davide.guerri@hp.com)
 Dean Troyer (dtroyer@gmail.com)
 Dirk Mueller (dirk@dmllr.de)
diff --git a/ChangeLog b/ChangeLog
index c5d93a93..c889d621 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+4.9.0
+-----
+
+* The ``timeout`` parameter is now included when creating Keystoneauth Sessions.
+
+* Various other minor improvements.
+
+
 4.8.0
 -----
 
diff --git a/releasenotes/notes/4_9_0_release-b26426108163280d.yaml b/releasenotes/notes/4_9_0_release-b26426108163280d.yaml
new file mode 100644
index 00000000..956f7d0b
--- /dev/null
+++ b/releasenotes/notes/4_9_0_release-b26426108163280d.yaml
@@ -0,0 +1,7 @@
+---
+fixes:
+  - |
+    The ``timeout`` parameter is now included when creating Keystoneauth Sessions.
+
+  - |
+    Various other minor improvements.

From 0c736022233d3225a0313b74a09b3ca0fbbed519 Mon Sep 17 00:00:00 2001
From: Ivan Anfimov <lazekteam@gmail.com>
Date: Fri, 6 Feb 2026 21:40:01 +0000
Subject: [PATCH 304/316] Update description about auth version in sample
 configuration

Now accept only v3.

Change-Id: Ia25846670f2d330ef8be0e9305115835736071d3
Signed-off-by: Ivan Anfimov <lazekteam@gmail.com>
---
 test/sample.conf | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

diff --git a/test/sample.conf b/test/sample.conf
index 04dfdd9a..bdffcdb7 100644
--- a/test/sample.conf
+++ b/test/sample.conf
@@ -1,10 +1,8 @@
 [func_test]
 # sample config
 auth_uri = http://127.0.0.1:8080/auth/v1.0/
-## sample config for Swift with Keystone v2 API
-# For keystone v3 change auth_version to 3 and auth_prefix to /v3/
-#auth_version = 2
-#auth_uri = http://localhost:5000/v2.0/
+# sample config for Swift with Keystone API v3
+#auth_uri = http://localhost:5000/v3/
 
 # You may want to run tests against endpoints that use development certs
 # without installing the CA system-wide. Use this to trust an extra set

From ac4b80bc0a52363dac3bc03feb178058d01b2b05 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Tue, 16 Sep 2025 15:30:11 -0700
Subject: [PATCH 305/316] authv1: Modernize returned service catalog

Keystone has only been returning v3 catalogs for a while now, so many
client libraries have dropped support for the old v2 catalogs. We should
switch to the new format so we stop causing KeyErrors like

    File ".../cliff/formatters/table.py", line 109, in add_rows
      table.add_row(_format_row(first_row))
                    ^^^^^^^^^^^^^^^^^^^^^^
    File ".../cliff/formatters/table.py", line 38, in _format_row
      r = r.human_readable()
          ^^^^^^^^^^^^^^^^^^
    File ".../openstackclient/identity/v3/catalog.py", line 37, in human_readable
      ret += "  {}: {}\n".format(ep['interface'], ep['url'])
                                 ~~^^^^^^^^^^^^^
  KeyError: 'interface'

(Previously seen while trying to run `openstack catalog show` with latest
python-openstackclient/osc-lib/openstacksdk -- but this used to work!)

Change-Id: Ie8726b97e1dde7d7bfd8e4215af6af52e1fd870e
Signed-off-by: Tim Burke <tim.burke@gmail.com>
---
 swiftclient/authv1.py                   | 11 +++--
 swiftclient/client.py                   |  2 +-
 test-requirements.txt                   |  1 +
 test/functional/test_openstackclient.py | 62 +++++++++++++++++++++++++
 test/unit/test_authv1.py                |  2 +-
 test/unit/test_shell.py                 |  2 +-
 6 files changed, 74 insertions(+), 6 deletions(-)
 create mode 100644 test/functional/test_openstackclient.py

diff --git a/swiftclient/authv1.py b/swiftclient/authv1.py
index b2a037c7..3edb68d2 100644
--- a/swiftclient/authv1.py
+++ b/swiftclient/authv1.py
@@ -70,13 +70,15 @@ def catalog(self):
         # openstackclient wants this for the `catalog list` and
         # `catalog show` commands
         endpoints = [{
+            'interface': 'public',
             'region': 'default',
-            'publicURL': self._storage_url,
+            'url': self._storage_url,
         }]
         if self.storage_url != self._storage_url:
             endpoints.insert(0, {
+                'interface': 'public',
                 'region': 'override',
-                'publicURL': self.storage_url,
+                'url': self.storage_url,
             })
 
         return [
@@ -89,8 +91,9 @@ def catalog(self):
                 'name': 'auth',
                 'type': 'identity',
                 'endpoints': [{
+                    'interface': 'public',
                     'region': 'default',
-                    'publicURL': self.auth_url,
+                    'url': self.auth_url,
                 }],
             }
         ]
@@ -151,6 +154,8 @@ def __init__(self, auth_url, storage_url, account, username, auth_token,
             self._expires = None
         # following is used by openstackclient
         self.project_id = None
+        self.domain_id = 'default'
+        self.system_scoped = False
 
     @property
     def expires(self):
diff --git a/swiftclient/client.py b/swiftclient/client.py
index 263aaa8c..9cc7474f 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -577,7 +577,7 @@ def get_auth_keystone(auth_url, user, key, os_options, **kwargs):
 
     filter_kwargs = {}
     service_type = os_options.get('service_type') or 'object-store'
-    endpoint_type = os_options.get('endpoint_type') or 'publicURL'
+    endpoint_type = os_options.get('endpoint_type') or 'public'
     if os_options.get('region_name'):
         filter_kwargs['attr'] = 'region'
         filter_kwargs['filter_value'] = os_options['region_name']
diff --git a/test-requirements.txt b/test-requirements.txt
index 731bdb0b..9049f52b 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -5,3 +5,4 @@ python-keystoneclient>=0.7.0
 keystoneauth1>=3.4.0  # Apache-2.0
 stestr>=2.0.0,!=3.0.0 # Apache-2.0
 openstacksdk>=0.11.0  # Apache-2.0
+python-openstackclient>=3.12.0  # Apache-2.0
diff --git a/test/functional/test_openstackclient.py b/test/functional/test_openstackclient.py
new file mode 100644
index 00000000..14574251
--- /dev/null
+++ b/test/functional/test_openstackclient.py
@@ -0,0 +1,62 @@
+# Copyright (c) 2025 NVIDIA
+#
+# 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 os
+import subprocess
+import unittest
+
+from . import TEST_CONFIG
+
+
+class TestOpenStackClient(unittest.TestCase):
+    @classmethod
+    def setUpClass(cls):
+        # NB: Only runs for v1 auth, to exercise our keystoneauth plugin
+        cls.skip_tests = (TEST_CONFIG is None or
+                          TEST_CONFIG['auth_version'] != '1')
+        cls.env = {
+            'OS_AUTH_TYPE': 'v1password',
+            'OS_AUTH_URL': TEST_CONFIG['auth_url'] or '',
+            'OS_USERNAME': TEST_CONFIG['account_username'] or '',
+            'OS_PASSWORD': TEST_CONFIG['password'] or '',
+            'OS_CACERT': TEST_CONFIG['cacert'] or '',
+        }
+        if 'PATH' in os.environ:
+            cls.env['PATH'] = os.environ['PATH']
+
+    def setUp(self):
+        if self.skip_tests:
+            raise unittest.SkipTest('SKIPPING V1-AUTH TESTS')
+
+    def _run(self, *args):
+        subprocess.run(args, env=self.env, check=True)
+
+    def test_token_issue(self):
+        self._run('openstack', 'token', 'issue')
+
+    def test_catalog_list(self):
+        self._run('openstack', 'catalog', 'list')
+
+    def test_catalog_show(self):
+        self._run('openstack', 'catalog', 'show', 'swift')
+        self._run('openstack', 'catalog', 'show', 'object-store')
+        self._run('openstack', 'catalog', 'show', 'auth')
+
+    def test_account_show(self):
+        self._run('openstack', 'object', 'store', 'account', 'show')
+        # If account show works and the openstacksdk tests work, presumably
+        # container/object commands work, too
+
+    # service list? endpoint list?
diff --git a/test/unit/test_authv1.py b/test/unit/test_authv1.py
index c22cc39c..363ec039 100644
--- a/test/unit/test_authv1.py
+++ b/test/unit/test_authv1.py
@@ -163,7 +163,7 @@ def test_get_access(self):
         self.assertEqual('object-store', catalog[0].get('type'))
         self.assertIn('endpoints', catalog[0])
         self.assertIn(self.storage_url, [
-            e.get('publicURL') for e in catalog[0]['endpoints']])
+            e.get('url') for e in catalog[0]['endpoints']])
 
     def test_get_access_with_expiry(self):
         auth_plugin = authv1.PasswordPlugin(**self.options)
diff --git a/test/unit/test_shell.py b/test/unit/test_shell.py
index b2b34431..e097ad68 100644
--- a/test/unit/test_shell.py
+++ b/test/unit/test_shell.py
@@ -3365,7 +3365,7 @@ class TestKeystoneOptions(MockHttpTest):
     # options that are given default values in code if missing from CLI
     defaults = {'auth-version': '2.0',
                 'service-type': 'object-store',
-                'endpoint-type': 'publicURL'}
+                'endpoint-type': 'public'}
 
     def _build_os_opts(self, keys):
         os_opts = {}

From ab7bf2e0c0c2d3018c9c6c51fe54ecf82742e437 Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Mon, 23 Feb 2026 09:41:49 -0800
Subject: [PATCH 306/316] CI: Make py314 job voting

Change-Id: Ied0635ede2ba9daca0fc68100652d27c5a330f8d
Signed-off-by: Tim Burke <tim.burke@gmail.com>
---
 .zuul.yaml | 6 ++++--
 setup.cfg  | 1 +
 2 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/.zuul.yaml b/.zuul.yaml
index 598540a1..e222ddcc 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -56,13 +56,15 @@
             irrelevant-files: *functest-irrelevant-files
         - tempest-full-py3:
             irrelevant-files: *functest-irrelevant-files
-        - openstack-tox-py313:
+        - openstack-tox-py313
+        - openstack-tox-py314:
             voting: true
     gate:
       jobs:
         - swiftclient-swift-functional
         - swiftclient-functional
-        - openstack-tox-py313:
+        - openstack-tox-py313
+        - openstack-tox-py314:
             voting: true
     post:
       jobs:
diff --git a/setup.cfg b/setup.cfg
index 9a1c5399..4780b0bb 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -30,6 +30,7 @@ classifier =
     Programming Language :: Python :: 3.11
     Programming Language :: Python :: 3.12
     Programming Language :: Python :: 3.13
+    Programming Language :: Python :: 3.14
     Programming Language :: Python :: 3 :: Only
 
 [files]

From ee39a1507f3af52f9da4fd572deafad81586f2e4 Mon Sep 17 00:00:00 2001
From: Anthony Roussel <anthony@roussel.dev>
Date: Mon, 23 Feb 2026 23:51:43 +0100
Subject: [PATCH 307/316] Fix compatibility with urllib3 v2.6

urllib3 v2.6 removed `HTTPResponse.getheader(name, default)` in favor of
`HTTPResponse.headers.get(name, default)`, see https://github.com/urllib3/urllib3/pull/3622

Changed from `resp.raw.getheader` to `resp.headers.get` for compatibility.
Fixed `test_response_headers` test to verify getheader() works properly.

Change-Id: Ic0fab4ca6407f5435d87aa02d533f3eb826f5b3b
Signed-off-by: Anthony Roussel <anthony@roussel.dev>
---
 swiftclient/client.py         | 2 +-
 test/unit/test_swiftclient.py | 1 +
 2 files changed, 2 insertions(+), 1 deletion(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index 263aaa8c..f763d97c 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -441,7 +441,7 @@ def putrequest(self, full_path, data=None, headers=None, files=None):
     def getresponse(self):
         """Adapt requests response to httplib interface"""
         self.resp.status = self.resp.status_code
-        old_getheader = self.resp.raw.getheader
+        old_getheader = self.resp.headers.get
 
         def _decode_header(string):
             if string is None:
diff --git a/test/unit/test_swiftclient.py b/test/unit/test_swiftclient.py
index 600b787e..5a306608 100644
--- a/test/unit/test_swiftclient.py
+++ b/test/unit/test_swiftclient.py
@@ -2003,6 +2003,7 @@ def test_response_headers(self):
         self.assertEqual(
             '\u062a-value', resp.getheader('\u062a-UNICODE'))
         self.assertEqual('', resp.getheader('empty-header'))
+        self.assertEqual('"%s"' % EMPTY_ETAG, resp.getheader('etag'))
         self.assertEqual(
             dict([('\u062a-unicode', '\u062a-value'),
                   ('empty-header', ''),

From dab0e5e55bf058a3396c9f3ae03124d460c5683a Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Mon, 13 Apr 2020 14:15:09 -0700
Subject: [PATCH 308/316] Rip out SERVICENET support

It's weird to have such a provider-specific feature, particularly when
there are other reasonable workarounds:

  * As a client, you can specify your own storage URL.
  * As a provider, you can have a separate auth endpoint that only hands
    out internal urls.

Change-Id: I1050c4f16786e1227793c0548423118657f64b79
Signed-off-by: Tim Burke <tim.burke@gmail.com>
---
 doc/manpages/swift.1     |  1 -
 doc/source/cli/index.rst |  5 +----
 swiftclient/client.py    | 22 +++-------------------
 swiftclient/service.py   |  2 --
 swiftclient/shell.py     |  4 +---
 5 files changed, 5 insertions(+), 29 deletions(-)

diff --git a/doc/manpages/swift.1 b/doc/manpages/swift.1
index 00e1440e..f4e9804d 100644
--- a/doc/manpages/swift.1
+++ b/doc/manpages/swift.1
@@ -177,7 +177,6 @@ For examples see swift auth \-\-help.
 .PD 0
 .IP "--version              Show program's version number and exit"
 .IP "-h, --help             Show this (or any subcommand if after command) help message and exit"
-.IP "-s, --snet             Use SERVICENET internal network"
 .IP "-v, --verbose          Print more info"
 .IP "-q, --quiet            Suppress status output"
 .IP "-A AUTH, --auth=AUTH   URL for obtaining an auth token "
diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst
index 1762989b..13d20cf4 100644
--- a/doc/source/cli/index.rst
+++ b/doc/source/cli/index.rst
@@ -20,7 +20,7 @@ swift usage
 
 .. code-block:: console
 
-   Usage: swift [--version] [--help] [--os-help] [--snet] [--verbose]
+   Usage: swift [--version] [--help] [--os-help] [--verbose]
                 [--debug] [--info] [--quiet] [--auth <auth_url>]
                 [--auth-version <auth_version> |
                     --os-identity-api-version <auth_version> ]
@@ -95,9 +95,6 @@ swift optional arguments
 ``--os-help``
   Show OpenStack authentication options.
 
-``-s, --snet``
-  Use SERVICENET internal network.
-
 ``-v, --verbose``
   Print more info.
 
diff --git a/swiftclient/client.py b/swiftclient/client.py
index 263aaa8c..6b8f457b 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -490,7 +490,7 @@ def http_connection(*arg, **kwarg):
     return conn.parsed_url, conn
 
 
-def get_auth_1_0(url, user, key, snet, **kwargs):
+def get_auth_1_0(url, user, key, **kwargs):
     cacert = kwargs.get('cacert', None)
     insecure = kwargs.get('insecure', False)
     cert = kwargs.get('cert')
@@ -514,12 +514,6 @@ def get_auth_1_0(url, user, key, snet, **kwargs):
     # if we don't have a x-storage-url header and if we get a body.
     if resp.status < 200 or resp.status >= 300 or (body and not url):
         raise ClientException.from_response(resp, 'Auth GET failed', body)
-    if snet:
-        parsed = list(urlparse(url))
-        # Second item in the list is the netloc
-        netloc = parsed[1]
-        parsed[1] = 'snet-' + netloc
-        url = urlunparse(parsed)
 
     token = resp.getheader('x-storage-token', resp.getheader('x-auth-token'))
     return url, token
@@ -671,12 +665,6 @@ def get_auth(auth_url, user, key, **kwargs):
     N.B. if the optional os_options parameter includes a non-empty
     'object_storage_url' key it will override the default storage url returned
     by the auth service.
-
-    The snet parameter is used for Rackspace's ServiceNet internal network
-    implementation. In this function, it simply adds *snet-* to the beginning
-    of the host name for the returned storage URL. With Rackspace Cloud Files,
-    use of this network path causes no bandwidth charges but requires the
-    client to be running on Rackspace's ServiceNet network.
     """
     session = kwargs.get('session', None)
     auth_version = kwargs.get('auth_version', '1')
@@ -700,7 +688,6 @@ def get_auth(auth_url, user, key, **kwargs):
         storage_url, token = get_auth_1_0(auth_url,
                                           user,
                                           key,
-                                          kwargs.get('snet'),
                                           cacert=cacert,
                                           insecure=insecure,
                                           cert=cert,
@@ -1654,7 +1641,7 @@ class Connection:
     """
 
     def __init__(self, authurl=None, user=None, key=None, retries=5,
-                 preauthurl=None, preauthtoken=None, snet=False,
+                 preauthurl=None, preauthtoken=None,
                  starting_backoff=1, max_backoff=64, tenant_name=None,
                  os_options=None, auth_version="1", cacert=None,
                  insecure=False, cert=None, cert_key=None,
@@ -1669,7 +1656,6 @@ def __init__(self, authurl=None, user=None, key=None, retries=5,
         :param preauthtoken: authentication token (if you have already
                              authenticated) note authurl/user/key/tenant_name
                              are not required when specifying preauthtoken
-        :param snet: use SERVICENET internal network default is False
         :param starting_backoff: initial delay between retries (seconds)
         :param max_backoff: maximum delay between retries (seconds)
         :param auth_version: OpenStack auth version, default is 1.0
@@ -1705,7 +1691,6 @@ def __init__(self, authurl=None, user=None, key=None, retries=5,
         self.retries = retries
         self.http_conn = None
         self.attempts = 0
-        self.snet = snet
         self.starting_backoff = starting_backoff
         self.max_backoff = max_backoff
         self.auth_version = auth_version
@@ -1740,7 +1725,7 @@ def close(self):
 
     def get_auth(self):
         self.url, self.token = get_auth(self.authurl, self.user, self.key,
-                                        session=self.session, snet=self.snet,
+                                        session=self.session,
                                         auth_version=self.auth_version,
                                         os_options=self.os_options,
                                         cacert=self.cacert,
@@ -1761,7 +1746,6 @@ def get_service_auth(self):
         service_key = opts.get('service_key', None)
         return get_auth(self.authurl, service_user, service_key,
                         session=self.session,
-                        snet=self.snet,
                         auth_version=self.auth_version,
                         os_options=service_options,
                         cacert=self.cacert,
diff --git a/swiftclient/service.py b/swiftclient/service.py
index d0e93075..1d73d15d 100644
--- a/swiftclient/service.py
+++ b/swiftclient/service.py
@@ -163,7 +163,6 @@ def process_options(options):
 
 def _build_default_global_options():
     return {
-        "snet": False,
         "verbose": 1,
         "debug": False,
         "info": False,
@@ -298,7 +297,6 @@ def get_conn(options):
                       retries=options['retries'],
                       auth_version=options['auth_version'],
                       os_options=options['os_options'],
-                      snet=options['snet'],
                       cacert=options['os_cacert'],
                       insecure=options['insecure'],
                       cert=options['os_cert'],
diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 23691f25..321fecf9 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -1727,8 +1727,6 @@ def add_default_args(parser):
                         help='Show OpenStack authentication options.')
     parser.add_argument('--os_help', action='store_true',
                         help=argparse.SUPPRESS)
-    parser.add_argument('-s', '--snet', action='store_true', dest='snet',
-                        default=False, help='Use SERVICENET internal network.')
     parser.add_argument('-v', '--verbose', action='count', dest='verbose',
                         default=1, help='Print more info.')
     parser.add_argument('--debug', action='store_true', dest='debug',
@@ -1965,7 +1963,7 @@ def main(arguments=None):
 
     parser = argparse.ArgumentParser(
         add_help=False, formatter_class=HelpFormatter, usage='''
-%(prog)s [--version] [--help] [--os-help] [--snet] [--verbose]
+%(prog)s [--version] [--help] [--os-help] [--verbose]
              [--debug] [--debug-with-secrets] [--info] [--quiet]
              [--auth <auth_url>] [--auth-version <auth_version> |
                  --os-identity-api-version <auth_version> ]

From 64be904fda5253d7ed0b3e740d6953de8ea613bf Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Tue, 24 Feb 2026 16:20:28 -0800
Subject: [PATCH 309/316] AUTHORS/ChangeLog for 4.9.1 release

Change-Id: I36cde18651a4b0424cd4377f27493d3482282e10
Signed-off-by: Tim Burke <tim.burke@gmail.com>
---
 AUTHORS                                         |  2 ++
 ChangeLog                                       | 14 ++++++++++++++
 .../notes/4_9_1_release-8370f0dcdb8a0e11.yaml   | 17 +++++++++++++++++
 3 files changed, 33 insertions(+)
 create mode 100644 releasenotes/notes/4_9_1_release-8370f0dcdb8a0e11.yaml

diff --git a/AUTHORS b/AUTHORS
index ec6e5bc8..01c2a8a2 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -10,6 +10,7 @@ Andrew Welleck (awellec@us.ibm.com)
 Andy McCrae (andy.mccrae@gmail.com)
 Anh Tran (anhtt@vn.fujitsu.com)
 Anne Gentle (anne@openstack.org)
+Anthony Roussel (anthony@roussel.dev)
 Ben McCann (ben@benmccann.com)
 Cedric Brandily (zzelle@gmail.com)
 Chaozhe.Chen (chaozhe.chen@easystack.cn)
@@ -59,6 +60,7 @@ Hiroshi Miura (miurahr@nttdata.co.jp)
 howardlee (lihongweibj@inspur.com)
 Hu Bing (hubingsh@cn.ibm.com)
 Ian Cordasco (ian.cordasco@rackspace.com)
+Ivan Anfimov (lazekteam@gmail.com)
 Ivan Kolodyazhny (e0ne@e0ne.info)
 jacky06 (zhang.min@99cloud.net)
 Jaivish Kothari (jaivish.kothari@nectechnologies.in)
diff --git a/ChangeLog b/ChangeLog
index c889d621..f861099b 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,17 @@
+4.9.1
+-----
+
+* The "v1password" plugin for keystoneauth now returns v3-compatible service
+  catalogs, fixing some issues seen when using v1 auth with openstackclient.
+
+* Now tested under Python 3.14.
+
+* Removed support for the provider-specific SERVICENET. Explicitly override
+  your storage URLs if you were previously using this feature.
+
+* Various other minor improvements.
+
+
 4.9.0
 -----
 
diff --git a/releasenotes/notes/4_9_1_release-8370f0dcdb8a0e11.yaml b/releasenotes/notes/4_9_1_release-8370f0dcdb8a0e11.yaml
new file mode 100644
index 00000000..fa7eca6a
--- /dev/null
+++ b/releasenotes/notes/4_9_1_release-8370f0dcdb8a0e11.yaml
@@ -0,0 +1,17 @@
+---
+features:
+  - |
+    Now tested under Python 3.14.
+
+upgrade:
+  - |
+    Removed support for the provider-specific SERVICENET. Explicitly override
+    your storage URLs if you were previously using this feature.
+
+fixes:
+  - |
+    The "v1password" plugin for keystoneauth now returns v3-compatible service
+    catalogs, fixing some issues seen when using v1 auth with openstackclient.
+
+  - |
+    Various other minor improvements.

From 70e110988c93160031e8aad42b404f9146497cff Mon Sep 17 00:00:00 2001
From: Tim Burke <tim.burke@gmail.com>
Date: Wed, 25 Feb 2026 09:31:01 -0800
Subject: [PATCH 310/316] Release 4.10.0, not 4.9.1

Change-Id: I4c3bc10c9e307b6f7745c25bfa3369e4664fbcc9
Signed-off-by: Tim Burke <tim.burke@gmail.com>
---
 ChangeLog                                                       | 2 +-
 ...70f0dcdb8a0e11.yaml => 4_10_0_release-8370f0dcdb8a0e11.yaml} | 0
 2 files changed, 1 insertion(+), 1 deletion(-)
 rename releasenotes/notes/{4_9_1_release-8370f0dcdb8a0e11.yaml => 4_10_0_release-8370f0dcdb8a0e11.yaml} (100%)

diff --git a/ChangeLog b/ChangeLog
index f861099b..4b8a8fea 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,4 +1,4 @@
-4.9.1
+4.10.0
 -----
 
 * The "v1password" plugin for keystoneauth now returns v3-compatible service
diff --git a/releasenotes/notes/4_9_1_release-8370f0dcdb8a0e11.yaml b/releasenotes/notes/4_10_0_release-8370f0dcdb8a0e11.yaml
similarity index 100%
rename from releasenotes/notes/4_9_1_release-8370f0dcdb8a0e11.yaml
rename to releasenotes/notes/4_10_0_release-8370f0dcdb8a0e11.yaml

From 77e4ac9957e08d22a3fb08219abc7231a98703f2 Mon Sep 17 00:00:00 2001
From: OpenStack Release Bot <infra-root@openstack.org>
Date: Fri, 6 Mar 2026 13:22:46 +0000
Subject: [PATCH 311/316] Update master for stable/2026.1

Add file to the reno documentation build to show release notes for
stable/2026.1.

Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/2026.1.

Sem-Ver: feature
Change-Id: I6d51d85a25a47b381fcda734817397f1fa2693c4
Signed-off-by: OpenStack Release Bot <infra-root@openstack.org>
Generated-By: openstack/project-config:roles/copy-release-tools-scripts/files/release-tools/add_release_note_page.sh
---
 releasenotes/source/2026.1.rst | 6 ++++++
 releasenotes/source/index.rst  | 1 +
 2 files changed, 7 insertions(+)
 create mode 100644 releasenotes/source/2026.1.rst

diff --git a/releasenotes/source/2026.1.rst b/releasenotes/source/2026.1.rst
new file mode 100644
index 00000000..3d286158
--- /dev/null
+++ b/releasenotes/source/2026.1.rst
@@ -0,0 +1,6 @@
+===========================
+2026.1 Series Release Notes
+===========================
+
+.. release-notes::
+   :branch: stable/2026.1
diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst
index c6ced8f8..f736698f 100644
--- a/releasenotes/source/index.rst
+++ b/releasenotes/source/index.rst
@@ -6,6 +6,7 @@
    :maxdepth: 1
 
    current
+   2026.1
    2025.2
    2025.1
    2024.2

From 9752e22bb2c7dd6aed6e0ea410d9ad43f71d8c08 Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <kajinamit@oss.nttdata.com>
Date: Fri, 31 Jul 2026 17:57:55 +0900
Subject: [PATCH 312/316] Add minimum pyproject.toml

... which is not required by the requirements-check job.

Change-Id: I94d3a3e961284e3981ca0fe244e443ae944fd353
Signed-off-by: Takashi Kajinami <kajinamit@oss.nttdata.com>
---
 pyproject.toml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/pyproject.toml b/pyproject.toml
index 6194cd34..e63322f9 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,3 +1,3 @@
 [build-system]
-requires = ["setuptools", "pbr"]
-build-backend = "setuptools.build_meta"
+requires = ["pbr>=6.0.0", "setuptools>=64"]
+build-backend = "pbr.build"

From dbdd68515c209ba443c57a0cdd7a75e254928001 Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <kajinamit@oss.nttdata.com>
Date: Fri, 31 Jul 2026 15:59:40 +0900
Subject: [PATCH 313/316] Bump upper cap of hacking

This is required to run pep8 check in Python 3.14.

Change-Id: Id91bf41b2bac9365fb5013c0444c06069f6d5bdf
Signed-off-by: Takashi Kajinami <kajinamit@oss.nttdata.com>
---
 swiftclient/shell.py  | 1 -
 test-requirements.txt | 2 +-
 2 files changed, 1 insertion(+), 2 deletions(-)

diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 321fecf9..485792d9 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -1533,7 +1533,6 @@ def st_bash_completion(parser, args, thread_manager, return_parser=False):
     if return_parser:
         return parser
 
-    global commands
     com = args[1] if len(args) > 1 else None
 
     if com:
diff --git a/test-requirements.txt b/test-requirements.txt
index 9049f52b..11969102 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -1,4 +1,4 @@
-hacking>=3.2.0,<6.2.0 # Apache-2.0
+hacking>=3.2.0,<8.2.0 # Apache-2.0
 
 coverage!=4.4,>=4.0   # Apache-2.0
 python-keystoneclient>=0.7.0

From d3bfd6ac71359a00217ba8acd9af24f72fd870a5 Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <kajinamit@oss.nttdata.com>
Date: Fri, 31 Jul 2026 16:00:35 +0900
Subject: [PATCH 314/316] Enable H904 check

... to make sure we delay string interpolation in logs.

This is a known good practise to avoid unnecessary string interpolation
overhead, especially in debug logs.

Change-Id: If79e275eab0e8660af7713dba168cda44575cdb8
Signed-off-by: Takashi Kajinami <kajinamit@oss.nttdata.com>
---
 tox.ini | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/tox.ini b/tox.ini
index f991fd66..897ad0d3 100644
--- a/tox.ini
+++ b/tox.ini
@@ -79,7 +79,8 @@ commands=
 ignore = H101,H301,H306,H401,H403,H404,H405,W504,F811
 # H106: Don’t put vim configuration in source files
 # H203: Use assertIs(Not)None to check for None
-enable-extensions=H106,H203
+# H904: Delay string interpolations at logging calls.
+enable-extensions=H106,H203,H904
 show-source = True
 exclude = .venv,.tox,dist,doc,*egg
 

From 52ffa51d1c5fe38994f34c4077e0379d5e0af2a9 Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <kajinamit@oss.nttdata.com>
Date: Wed, 12 Aug 2026 13:04:21 +0900
Subject: [PATCH 315/316] Remove unused executable script

It has been unused since it was replaced by the one generated during
installation.

Change-Id: I5e95f887d984d97146562e458823d53d7d355491
Signed-off-by: Takashi Kajinami <kajinamit@oss.nttdata.com>
---
 bin/swift | 24 ------------------------
 1 file changed, 24 deletions(-)
 delete mode 100755 bin/swift

diff --git a/bin/swift b/bin/swift
deleted file mode 100755
index 77102cfa..00000000
--- a/bin/swift
+++ /dev/null
@@ -1,24 +0,0 @@
-#!/usr/bin/python
-# Copyright (c) 2014 Christian Schwede <christian.schwede@enovance.com>
-#
-# 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 sys
-
-from swiftclient.shell import main
-
-
-if __name__ == "__main__":
-    sys.exit(main())

From 7486fb7e7d7c01b40a20ceb5b32f1540c0e57312 Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <kajinamit@oss.nttdata.com>
Date: Wed, 12 Aug 2026 13:08:56 +0900
Subject: [PATCH 316/316] Remove unused fallback to pipes module

The shlex.quote method was added in Python 3.3 .

Change-Id: Ife4c3847bb308510db10aabd6df3fd601ce438b9
Signed-off-by: Takashi Kajinami <kajinamit@oss.nttdata.com>
---
 swiftclient/shell.py | 24 ++++++++++--------------
 1 file changed, 10 insertions(+), 14 deletions(-)

diff --git a/swiftclient/shell.py b/swiftclient/shell.py
index 321fecf9..f0e53b01 100755
--- a/swiftclient/shell.py
+++ b/swiftclient/shell.py
@@ -19,6 +19,7 @@
 import io
 import json
 import logging
+from shlex import quote
 import signal
 import socket
 import warnings
@@ -42,11 +43,6 @@
 from swiftclient.command_helpers import print_account_stats, \
     print_container_stats, print_object_stats
 
-try:
-    from shlex import quote as sh_quote
-except ImportError:
-    from pipes import quote as sh_quote
-
 BASENAME = 'swift'
 commands = ('delete', 'download', 'list', 'post', 'copy', 'stat', 'upload',
             'capabilities', 'info', 'tempurl', 'auth', 'bash_completion')
@@ -1365,24 +1361,24 @@ def st_auth(parser, args, thread_manager, return_parser=False):
     (options, args) = parse_args(parser, args)
     if options['verbose'] > 1:
         if options['auth_version'] in ('1', '1.0'):
-            print('export ST_AUTH=%s' % sh_quote(options['auth']))
-            print('export ST_USER=%s' % sh_quote(options['user']))
-            print('export ST_KEY=%s' % sh_quote(options['key']))
+            print('export ST_AUTH=%s' % quote(options['auth']))
+            print('export ST_USER=%s' % quote(options['user']))
+            print('export ST_KEY=%s' % quote(options['key']))
         else:
-            print('export OS_IDENTITY_API_VERSION=%s' % sh_quote(
+            print('export OS_IDENTITY_API_VERSION=%s' % quote(
                 options['auth_version']))
-            print('export OS_AUTH_VERSION=%s' % sh_quote(
+            print('export OS_AUTH_VERSION=%s' % quote(
                 options['auth_version']))
-            print('export OS_AUTH_URL=%s' % sh_quote(options['auth']))
+            print('export OS_AUTH_URL=%s' % quote(options['auth']))
             for k, v in sorted(options.items()):
                 if v and k.startswith('os_') and \
                         k not in ('os_auth_url', 'os_options'):
-                    print('export %s=%s' % (k.upper(), sh_quote(v)))
+                    print('export %s=%s' % (k.upper(), quote(v)))
     else:
         conn = get_conn(options)
         url, token = conn.get_auth()
-        print('export OS_STORAGE_URL=%s' % sh_quote(url))
-        print('export OS_AUTH_TOKEN=%s' % sh_quote(token))
+        print('export OS_STORAGE_URL=%s' % quote(url))
+        print('export OS_AUTH_TOKEN=%s' % quote(token))
 
 
 st_tempurl_options = '''[--absolute] [--prefix-based] [--iso8601]