ak.str.capitalize#

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

ak.str.capitalize(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 a capitalized version (correctly transforming Unicode characters), with the first character uppercased and the others lowercased.

Replaces any bytestring-valued data with a capitalized version (transforming ASCII characters only).

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