Class StringDtype (1.27.0)

Version latest

• 1.27.0 (latest)
• 1.26.0
• 1.25.0
• 1.24.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.1
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.1
• 0.19.2
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.1
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0

StringDtype(storage=None)

Extension dtype for string data.

Warning: StringDtype is considered experimental. The implementation and parts of the API may change without warning.

Parameter
Name	Description
storage	{"python", "pyarrow", "pyarrow_numpy"}, optional .. attribute:: None :noindex: .. method:: None :noindex: .. rubric:: Examples >>> pd.StringDtype() string[python] >>> pd.StringDtype(storage="pyarrow") string[pyarrow] If not given, the value of pd.options.mode.string_storage.

Properties

na_value

Default NA value to use for this type.

This is used in e.g. ExtensionArray.take. This should be the user-facing "boxed" version of the NA value, not the physical NA value for storage. e.g. for JSONArray, this is an empty dictionary.

type

The scalar type for the array, e.g. int

It's expected ExtensionArray[item] returns an instance of ExtensionDtype.type for scalar item, assuming that value is valid (not NA). NA values do not need to be instances of type.

Methods

__from_arrow__

__from_arrow__(array: pyarrow.Array | pyarrow.ChunkedArray) -> BaseStringArray

Construct StringArray from pyarrow Array/ChunkedArray.

construct_array_type

construct_array_type() -> type_t[BaseStringArray]

Return the array type associated with this dtype.

construct_from_string

construct_from_string(string) -> Self

Construct a StringDtype from a string.

Parameter
Name	Description
string	str The type of the name. The storage type will be taking from string. Valid options and their storage types are ========================== ============================================== string result storage ========================== ============================================== 'string' pd.options.mode.string_storage, default python 'string[python]' python 'string[pyarrow]' pyarrow ========================== ==============================================

Exceptions
Type	Description
TypeError	If the string is not a valid option.