ak.is_valid#

Defined in awkward.operations.ak_is_valid on line 12.

ak.is_valid(array, *, exception=False)#

Returns True if the array has no structural errors and False otherwise.

Checks for errors in the structure of the array, such as indexes that run beyond the length of a node’s content, etc. Either an error is raised or the function returns a boolean.

See also ak.validity_error.

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

  • exception (bool) – If True, validity errors raise exceptions.

Returns:

True if array has no structural errors, False otherwise.