The cinderclient.openstack.common.strutils Module

System-level utilities and helper functions.

cinderclient.openstack.common.strutils.bool_from_string(subject)

Interpret a string as a boolean.

Any string value in:

(‘True’, ‘true’, ‘On’, ‘on’, ‘Yes’, ‘yes’, ‘1’)

is interpreted as a boolean True.

Useful for JSON-decoded stuff and config file parsing

cinderclient.openstack.common.strutils.int_from_bool_as_string(subject)

Interpret a string as a boolean and return either 1 or 0.

Any string value in:

(‘True’, ‘true’, ‘On’, ‘on’, ‘1’)

is interpreted as a boolean True.

Useful for JSON-decoded stuff and config file parsing

cinderclient.openstack.common.strutils.safe_decode(text, incoming=None, errors='strict')

Decodes incoming str using incoming if they’re not already unicode.

Parameters:

• incoming – Text’s current encoding
• errors – Errors handling policy. See here for valid values http://docs.python.org/2/library/codecs.html

Returns:

text or a unicode incoming encoded representation of it.

Raises TypeError:  

If text is not an isntance of basestring

cinderclient.openstack.common.strutils.safe_encode(text, incoming=None, encoding='utf-8', errors='strict')

Encodes incoming str/unicode using encoding. If incoming is not specified, text is expected to be encoded with current python’s default encoding. (sys.getdefaultencoding)

Parameters:

• incoming – Text’s current encoding
• encoding – Expected encoding for text (Default UTF-8)
• errors – Errors handling policy. See here for valid values http://docs.python.org/2/library/codecs.html

Returns:

text or a bytestring encoding encoded representation of it.

Raises TypeError:  

If text is not an isntance of basestring