diff options
author | Brant Knudson <bknudson@us.ibm.com> | 2015-07-24 14:21:37 -0500 |
---|---|---|
committer | Brant Knudson <bknudson@us.ibm.com> | 2015-07-26 06:54:23 -0500 |
commit | ce58b07eea29a43ee42655627e78820add16d1f5 (patch) | |
tree | ce1e96fcd69e23ab0efd5063956a22d3b89c6a3a | |
parent | c5b03191b6714fed15bd88769c89e897257c337d (diff) | |
download | python-keystoneclient-ce58b07eea29a43ee42655627e78820add16d1f5.tar.gz |
Proper deprecation for client.HTTPClient
client.HTTPClient wasn't properly deprecated since all it had was
a comment in the code. Proper deprecation requires use of warnings
and documentation.
bp deprecations
Change-Id: I1c50c1441b23a79831e6e1df749084130e4b9af7
-rw-r--r-- | keystoneclient/client.py | 14 |
1 files changed, 12 insertions, 2 deletions
diff --git a/keystoneclient/client.py b/keystoneclient/client.py index f4b9f87..f18db53 100644 --- a/keystoneclient/client.py +++ b/keystoneclient/client.py @@ -10,13 +10,23 @@ # License for the specific language governing permissions and limitations # under the License. +from debtcollector import removals + from keystoneclient import discover from keystoneclient import httpclient from keystoneclient import session as client_session -# Using client.HTTPClient is deprecated. Use httpclient.HTTPClient instead. -HTTPClient = httpclient.HTTPClient +@removals.remove(message='Use keystoneclient.httpclient.HTTPClient instead', + version='1.7.0', removal_version='2.0.0') +class HTTPClient(httpclient.HTTPClient): + """Deprecated alias for httpclient.HTTPClient. + + This class is deprecated as of the 1.7.0 release in favor of + :class:`keystoneclient.httpclient.HTTPClient` and may be removed in the + 2.0.0 release. + + """ def Client(version=None, unstable=False, session=None, **kwargs): |