pyspark.pandas.get_option

pyspark.pandas.get_option(key: str, default: Union[Any, pyspark._globals._NoValueType] = <no value>) → Any

Retrieves the value of the specified option.

Parameters

keystr

The key which should match a single option.

defaultobject

The default value if the option is not set yet. The value should be JSON serializable.

Returns

resultthe value of the option

Raises

OptionErrorif no such option exists and the default is not provided

pyspark.pandas.reset_option pyspark.pandas.set_option