pyarrow.DictionaryScalar #

classpyarrow.DictionaryScalar#

Bases:Scalar

Concrete class for dictionary-encoded scalars.

__init__(*args,**kwargs)#

Methods

`__init__`(args, *kwargs)
`as_py`(self, *[, maps_as_pydicts])	Return this encoded value as a Python object.
`cast`(self[, target_type, safe, options, ...])	Cast scalar value to another data type.
`equals`(self, Scalar other)
`validate`(self, *[, full])	Perform validation checks.

Attributes

`dictionary`
`index`	Return this value's underlying index as a scalar.
`is_valid`	Holds a valid (non-null) value.
`type`	Data type of the Scalar object.
`value`	Return the encoded value as a scalar.

as_py(self,*,maps_as_pydicts=None)#

Return this encoded value as a Python object.

Parameters:

maps_as_pydictsstr, optional, defaultNone

Valid values areNone, ‘lossy’, or ‘strict’.The default behavior (None), is to convert Arrow Map arrays toPython association lists (list-of-tuples) in the same order as theArrow Map, as in [(key1, value1), (key2, value2), …].

If ‘lossy’ or ‘strict’, convert Arrow Map arrays to native Python dicts.

If ‘lossy’, whenever duplicate keys are detected, a warning will be printed.The last seen value of a duplicate key will be in the Python dictionary.If ‘strict’, this instead results in an exception being raised when detected.

cast(self,target_type=None,safe=None,options=None,memory_pool=None)#

Cast scalar value to another data type.

Seepyarrow.compute.cast() for usage.

Parameters:

target_typeDataType, defaultNone: Type to cast scalar to.
safebool, defaultTrue: Whether to check for conversion errors such as overflow.
optionsCastOptions, defaultNone: Additional checks pass by CastOptions
memory_poolMemoryPool, optional: memory pool to use for allocations during function execution.

Returns: