numpy.core.defchararray.lstrip

numpy.core.defchararray.lstrip(a, chars=None)

For each element in a, return a copy with the leading characters removed.

Calls str.lstrip element-wise.

Parameters:

a : array-like of str or unicode

chars : str or unicode, optional

The chars argument is a string specifying the set of characters to be removed. If omitted or None, the chars argument defaults to removing whitespace. The chars argument is not a prefix; rather, all combinations of its values are stripped.

Returns:

out : ndarray, str or unicode

Output array of str or unicode, depending on input type

See also

str.lstrip

Examples

>>> c = np.array(['aAaAaA', '  aA  ', 'abBABba'])
>>> c
array(['aAaAaA', '  aA', 'abBABba'],
    dtype='|S7')
>>> np.char.lstrip(c, 'a') # 'a' unstripped from c[1] because whitespace leading
array(['AaAaA', '  aA', 'bBABba'],
    dtype='|S6')
>>> np.char.lstrip(c, 'A') # leaves c unchanged
array(['aAaAaA', '  aA', 'abBABba'],
    dtype='|S7')
>>> (np.char.lstrip(c, ' ') == np.char.lstrip(c, '')).all()
True
>>> (np.char.lstrip(c, ' ') == np.char.lstrip(c, None)).all()
True