openstack/python-keystoneclient
Code Issues Proposed changes

Proper deprecation for is_ans1_token

Browse Source 
is_ans1_token wasn't properly deprecated since it used LOG.warn
rather than warnings/debtcollector. Proper deprecation requires use
of warnings and documentation.

bp deprecations

Change-Id: I81be2844014745a5951ce91a336e9e9ecf4d5328
This commit is contained in:
Brant Knudson
2015-07-24 14:25:05 -05:00
parent ce58b07eea
commit 5547fe80b0
1 changed files with 9 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
keystoneclient/common/cms.py
View File

@@ -26,10 +26,11 @@ import logging
import textwrap
import zlib
from debtcollector import removals
import six
from keystoneclient import exceptions
from keystoneclient.i18n import _, _LE, _LW
from keystoneclient.i18n import _, _LE
subprocess = None
@@ -297,10 +298,14 @@ def is_asn1_token(token):
return token[:3] == PKI_ASN1_PREFIX
@removals.remove(message='Use is_asn1_token() instead.', version='1.7.0',
removal_version='2.0.0')
def is_ans1_token(token):
"""Deprecated. Use is_asn1_token() instead."""
LOG.warning(_LW('The function is_ans1_token() is deprecated, '
'use is_asn1_token() instead.'))
"""Deprecated.
This function is deprecated as of the 1.7.0 release in favor of
:func:`is_asn1_token` and may be removed in the 2.0.0 release.
"""
return is_asn1_token(token)