b3j0f.utils.iterable module

Provides tools to manage iterable types

b3j0f.utils.iterable.isiterable(element, exclude=None)

Check whatever or not if input element is an iterable.

Parameters:

• element – element to check among iterable types.
• exclude (type/tuple) – not allowed types in the test.

Example:

>>> isiterable({})
True
>>> isiterable({}, exclude=dict)
False
>>> isiterable({}, exclude=(dict,))
False

b3j0f.utils.iterable.ensureiterable(value, iterable=<type 'list'>, exclude=None)

Convert a value into an iterable if it is not.

Parameters:

• value (object) – object to convert
• iterable (type) – iterable type to apply (default: list)
• exclude (type/tuple) – types to not convert

Example:

>>> ensureiterable([])
[]
>>> ensureiterable([], iterable=tuple)
()
>>> ensureiterable('test', exclude=str)
['test']
>>> ensureiterable('test')
['t', 'e', 's', 't']

b3j0f.utils.iterable.first(iterable, default=None)

Try to get input iterable first item or default if iterable is empty.

Parameters:

• iterable (Iterable) – iterable to iterate on.
• default – default value to get if input iterable is empty.

Raises TypeError:  

if iterable is not an iterable value

Example:

>>> first('test')
't'
>>> first([])
None
>>> first('', default='test')
'test'