o io@snddlmZddlmZddlmZddlmZddlm Z er,ddl m Z ddl m Z e Gdd d Zd S) ) annotations) TYPE_CHECKING) deprecated)wrap_s) expr_dispatch)Series)PySeriesc@seZdZdZdZd&ddZd'd d Zed d(d dZd'ddZ edd(ddZ d'ddZ d'ddZ d)ddZ d*ddZd+d,d$d%ZdS)- CatNameSpacez)Namespace for categorical related series.catseriesrreturnNonecCs |j|_dSN)_s)selfr rP/home/app/Keep/.python/lib/python3.10/site-packages/polars/series/categorical.py__init__s zCatNameSpace.__init__cCdS)ab Get the categories stored in this data type. Examples -------- >>> s = pl.Series(["foo", "bar", "foo", "foo", "ham"], dtype=pl.Categorical) >>> s.cat.get_categories() # doctest: +SKIP shape: (3,) Series: '' [str] [ "foo" "bar" "ham" ] Nrrrrrget_categorieszCatNameSpace.get_categorieszu`cat.is_local()` is deprecated; Categoricals no longer have a local scope. This method will be removed in Polars 2.0.boolcC |jS)zi Return whether or not the column is a local categorical. Always returns false. )rZ cat_is_localrrrris_local(s zCatNameSpace.is_localcCst|jS)zFSimply returns the column as-is, local representations are deprecated.)rrZ cat_to_localrrrrto_local4szCatNameSpace.to_localz`cat.uses_lexical_ordering()` is deprecated; Categoricals are now always ordered lexically. This method will be removed in Polars 2.0.cCr)z Indicate whether the Series uses lexical ordering. Always returns true. Examples -------- >>> s = pl.Series(["b", "a", "b"]).cast(pl.Categorical) >>> s.cat.uses_lexical_ordering() True )rZcat_uses_lexical_orderingrrrruses_lexical_ordering8s z"CatNameSpace.uses_lexical_orderingcCr)u& Return the byte-length of the string representation of each value. Returns ------- Series Series of data type :class:`UInt32`. See Also -------- len_chars Notes ----- When working with non-ASCII text, the length in bytes is not the same as the length in characters. You may want to use :func:`len_chars` instead. Note that :func:`len_bytes` is much more performant (_O(1)_) than :func:`len_chars` (_O(n)_). Examples -------- >>> s = pl.Series(["Café", "345", "東京", None], dtype=pl.Categorical) >>> s.cat.len_bytes() shape: (4,) Series: '' [u32] [ 5 3 6 null ] Nrrrrr len_bytesJrzCatNameSpace.len_bytescCr)u Return the number of characters of the string representation of each value. Returns ------- Series Series of data type :class:`UInt32`. See Also -------- len_bytes Notes ----- When working with ASCII text, use :func:`len_bytes` instead to achieve equivalent output with much better performance: :func:`len_bytes` runs in _O(1)_, while :func:`len_chars` runs in (_O(n)_). A character is defined as a `Unicode scalar value`_. A single character is represented by a single byte when working with ASCII text, and a maximum of 4 bytes otherwise. .. _Unicode scalar value: https://www.unicode.org/glossary/#unicode_scalar_value Examples -------- >>> s = pl.Series(["Café", "345", "東京", None], dtype=pl.Categorical) >>> s.cat.len_chars() shape: (4,) Series: '' [u32] [ 4 3 2 null ] Nrrrrr len_charslrzCatNameSpace.len_charsprefixstrcCr)a{ Check if string representations of values start with a substring. Parameters ---------- prefix Prefix substring. See Also -------- contains : Check if the string repr contains a substring that matches a pattern. ends_with : Check if string repr ends with a substring. Examples -------- >>> s = pl.Series("fruits", ["apple", "mango", None], dtype=pl.Categorical) >>> s.cat.starts_with("app") shape: (3,) Series: 'fruits' [bool] [ true false null ] Nr)rrrrr starts_withrzCatNameSpace.starts_withsuffixcCr)az Check if string representations of values end with a substring. Parameters ---------- suffix Suffix substring. See Also -------- contains : Check if the string repr contains a substring that matches a pattern. starts_with : Check if string repr starts with a substring. Examples -------- >>> s = pl.Series("fruits", ["apple", "mango", None], dtype=pl.Categorical) >>> s.cat.ends_with("go") shape: (3,) Series: 'fruits' [bool] [ false true null ] Nr)rr"rrr ends_withrzCatNameSpace.ends_withNoffsetintlength int | NonecCr)aV Extract a substring from the string representation of each string value. Parameters ---------- offset Start index. Negative indexing is supported. length Length of the slice. If set to `None` (default), the slice is taken to the end of the string. Returns ------- Series Series of data type :class:`String`. Notes ----- Both the `offset` and `length` inputs are defined in terms of the number of characters in the (UTF8) string. A character is defined as a `Unicode scalar value`_. A single character is represented by a single byte when working with ASCII text, and a maximum of 4 bytes otherwise. .. _Unicode scalar value: https://www.unicode.org/glossary/#unicode_scalar_value Examples -------- >>> s = pl.Series(["pear", None, "papaya", "dragonfruit"], dtype=pl.Categorical) >>> s.cat.slice(-3) shape: (4,) Series: '' [str] [ "ear" null "aya" "uit" ] Using the optional `length` parameter >>> s.cat.slice(4, length=3) shape: (4,) Series: '' [str] [ "" null "ya" "onf" ] Nr)rr$r&rrrslicerzCatNameSpace.slice)r rr r )r r)r r)rr r r)r"r r rr)r$r%r&r'r r)__name__ __module__ __qualname____doc__ _accessorrrrrrrrrr!r#r(rrrrr s&       " ' r N) __future__rtypingrZpolars._utils.deprecationrZpolars._utils.wraprZpolars.series.utilsrZpolarsrZ polars._plrrr rrrrs