ak.str.is_title#

Defined in awkward.operations.str.akstr_is_title on line 13.

ak.str.is_title(array, *, highlevel=True, behavior=None, attrs=None)#
Parameters:

  • array – Array-like data (anything ak.to_layout recognizes).

  • highlevel (bool) – If True, return an ak.Array; otherwise, return a low-level ak.contents.Content subclass.

  • behavior (None or dict) – Custom ak.behavior for the output array, if high-level.

  • attrs (None or dict) – Custom attributes for the output array, if high-level.

Replaces any string-valued data with True if the string is title-cased, i.e. it has at least one cased character, each uppercase character follows an uncased character, and each lowercase character follows an uppercase character, otherwise False.

Replaces any bytestring-valued data with True if the string is title-cased, i.e. it has at least one cased character, each uppercase character follows an uncased character, and each lowercase character follows an uppercase character, otherwise False.

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_is_title or pyarrow.compute.ascii_is_title on strings and bytestrings, respectively.