ak.str.ltrim
------------

.. py:module: ak.str.ltrim

Defined in `awkward.operations.str.akstr_ltrim <https://github.com/scikit-hep/awkward/blob/ecb41df1a0678f2c38387f6f91203f0122fd0906/src/awkward/operations/str/akstr_ltrim.py>`__ on `line 13 <https://github.com/scikit-hep/awkward/blob/ecb41df1a0678f2c38387f6f91203f0122fd0906/src/awkward/operations/str/akstr_ltrim.py#L13>`__.

.. py:function:: ak.str.ltrim(array, characters, *, highlevel=True, behavior=None, attrs=None)


    :param array: Array-like data (anything :py:obj:`ak.to_layout` recognizes).
    :param characters: Individual characters to be trimmed
                   from the string.
    :type characters: str or bytes
    :param highlevel: If True, return an :py:obj:`ak.Array`; otherwise, return
                  a low-level :py:obj:`ak.contents.Content` subclass.
    :type highlevel: bool
    :param behavior: Custom :py:obj:`ak.behavior` for the output array, if
                 high-level.
    :type behavior: None or dict
    :param attrs: Custom attributes for the output array, if
              high-level.
    :type attrs: None or dict

Removes any leading characters of ``characters`` from any string or
bytestring-valued data.

If the data are strings, ``characters`` are interpreted as unordered,
individual codepoints.

If the data are bytestrings, ``characters`` are interpreted as unordered,
individual bytes.

Note: this function does not raise an error if the ``array`` does not
contain any string or bytestring data.

Requires the pyarrow library and calls
`pyarrow.compute.utf8_ltrim <https://arrow.apache.org/docs/python/generated/pyarrow.compute.utf8_ltrim.html>`__
or
`pyarrow.compute.ascii_ltrim <https://arrow.apache.org/docs/python/generated/pyarrow.compute.ascii_ltrim.html>`__
on strings and bytestrings, respectively.

See also: :py:obj:`ak.str.ltrim_whitespace`.