pyspark.pandas.DataFrame.bool

DataFrame.bool()

Return the bool of a single element in the current object.

This must be a boolean scalar value, either True or False. Raise a ValueError if the object does not have exactly 1 element, or that element is not boolean

Deprecated since version 4.0.0.

Returns

bool

Examples

>>> ps.DataFrame({'a': [True]}).bool()
True

>>> ps.Series([False]).bool()
False

If there are non-boolean or multiple values exist, it raises an exception in all cases as below.

>>> ps.DataFrame({'a': ['a']}).bool()
Traceback (most recent call last):
  ...
ValueError: bool cannot act on a non-boolean single element DataFrame

>>> ps.DataFrame({'a': [True], 'b': [False]}).bool()  
Traceback (most recent call last):
  ...
ValueError: The truth value of a DataFrame is ambiguous. Use a.empty, a.bool(),
a.item(), a.any() or a.all().

>>> ps.Series([1]).bool()
Traceback (most recent call last):
  ...
ValueError: bool cannot act on a non-boolean single element DataFrame