papyri
{ } Raw JSON

bundles / numpy 2.4.4 / numpy / strings / lstrip

function

numpy.strings:lstrip

source: /numpy/_core/strings.py :942

Signature

def   lstrip ( a ,  chars = None )

Summary

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

Parameters

a : array-like, with ``StringDType``, ``bytes_``, or ``str_`` dtype
chars : scalar with the same dtype as ``a``, optional

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

Returns

out : ndarray

Output array of StringDType, bytes_ or str_ dtype, depending on input types

Examples

import numpy as np
c = np.array(['aAaAaA', '  aA  ', 'abBABba'])
✓
c
✗
np.strings.lstrip(c, 'a')
np.strings.lstrip(c, 'A') # leaves c unchanged
(np.strings.lstrip(c, ' ') == np.strings.lstrip(c, '')).all()
(np.strings.lstrip(c, ' ') == np.strings.lstrip(c)).all()
✓

See also

str.lstrip

Aliases

  • numpy.char.lstrip