Class StringDtype (2.17.0)

  StringDtype 
 ( 
 storage 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 na_value 
 : 
 pandas 
 . 
 _libs 
 . 
 missing 
 . 
 NAType 
 | 
 float 
 = 
< NA 
> )

Extension dtype for string data.

Parameters

Name

Description

storage

{"python", "pyarrow"}, optional

If not given, the value of pd.options.mode.string_storage .

na_value

{np.nan, pd.NA}, default pd.NA .. attribute:: None :noindex: .. method:: None :noindex: .. rubric:: Examples >>> pd.StringDtype() string[python] >>> pd.StringDtype(storage="pyarrow") string[pyarrow]

Whether the dtype follows NaN or NA missing value semantics.

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.

name

A string identifying the data type.

Will be used for display in, e.g. Series.dtype

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.

Class StringDtype (2.17.0) Stay organized with collections Save and categorize content based on your preferences.

Parameters

Properties

na_value

name

type

Methods

__from_arrow__

construct_array_type

construct_from_string

Class StringDtype (2.17.0)