openstack/python-keystoneclient
Code Issues Proposed changes

Proper deprecation for httpclient.USER_AGENT

Browse Source 
httpclient's USER_AGENT constant wasn't properly deprecated since
the deprecation was only a comment. Proper deprecation requires use
of warnings/debtcollector and documentation, but since this is a
module symbol there's no way to put out a warning, so it's just
documentation in this case.

bp deprecations

Change-Id: I02c77c690a31eea40935d2756748382abec86867
This commit is contained in:
Brant Knudson
2015-07-26 10:00:01 -05:00
parent 42bd016e1f
commit e76423f783
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
keystoneclient/httpclient.py
View File

@@ -67,9 +67,13 @@ from keystoneclient import utils
_logger = logging.getLogger(__name__)
# This variable is moved and using it via httpclient is deprecated.
# Maintain here for compatibility.
USER_AGENT = client_session.USER_AGENT
"""Default user agent string.
This property is deprecated as of the 1.7.0 release in favor of
:data:`keystoneclient.session.USER_AGENT` and may be removed in the 2.0.0
release.
"""
@removals.remove(message='Use keystoneclient.session.request instead.',