
    j                        d dl mZ d dlmZ d dlmZ d dlmZ d dlm	Z	 erd dl
mZ d dlmZ e	 G d d	                      Zd
S )    )annotations)TYPE_CHECKING)
deprecated)wrap_s)expr_dispatch)Series)PySeriesc                      e Zd ZdZdZddZddZ ed	          dd            ZddZ	 ed          dd            Z
ddZddZddZd dZd!d"dZdS )#CatNameSpacez)Namespace for categorical related series.catseriesr   returnNonec                    |j         | _         d S N)_s)selfr   s     ^/home/longshao/multi-rider-rag/.venv/lib/python3.11/site-packages/polars/series/categorical.py__init__zCatNameSpace.__init__   s    "I    c                    dS )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"
        ]
        N r   s    r   get_categorieszCatNameSpace.get_categories         r   zu`cat.is_local()` is deprecated; Categoricals no longer have a local scope. This method will be removed in Polars 2.0.boolc                4    | j                                         S )zi
        Return whether or not the column is a local categorical.

        Always returns false.
        )r   cat_is_localr   s    r   is_localzCatNameSpace.is_local(   s     w##%%%r   c                N    t          | j                                                  S )zFSimply returns the column as-is, local representations are deprecated.)r   r   cat_to_localr   s    r   to_localzCatNameSpace.to_local4   s    dg**,,---r   z`cat.uses_lexical_ordering()` is deprecated; Categoricals are now always ordered lexically. This method will be removed in Polars 2.0.c                4    | j                                         S )a  
        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()  # doctest: +SKIP
        True
        )r   cat_uses_lexical_orderingr   s    r   uses_lexical_orderingz"CatNameSpace.uses_lexical_ordering8   s      w00222r   c                    dS )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
        ]
        Nr   r   s    r   	len_byteszCatNameSpace.len_bytesJ   r   r   c                    dS )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
        ]
        Nr   r   s    r   	len_charszCatNameSpace.len_charsl   r   r   prefixstrc                    dS )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   )r   r*   s     r   starts_withzCatNameSpace.starts_with   r   r   suffixc                    dS )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   )r   r.   s     r   	ends_withzCatNameSpace.ends_with   r   r   Noffsetintlength
int | Nonec                    dS )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   )r   r1   r3   s      r   slicezCatNameSpace.slice   r   r   )r   r   r   r   )r   r   )r   r   )r*   r+   r   r   )r.   r+   r   r   r   )r1   r2   r3   r4   r   r   )__name__
__module____qualname____doc__	_accessorr   r   r   r   r"   r%   r'   r)   r-   r0   r6   r   r   r   r   r      s.       33I& & & &   " Z	5 & & &	 &. . . . Z	5 3 3 3	 3       D% % % %N   6   62 2 2 2 2 2 2r   r   N)
__future__r   typingr   polars._utils.deprecationr   polars._utils.wrapr   polars.series.utilsr   polarsr   polars._plrr	   r   r   r   r   <module>rC      s    " " " " " "             0 0 0 0 0 0 % % % % % % - - - - - - %$$$$$$ l l l l l l l l l lr   