o
    ¹­§i›"  ã                   @  sr   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	 d dl
mZmZmZmZmZ eG dd„ dƒƒZd	S )
é    )Úannotations)ÚTYPE_CHECKING)Úexpr_dispatch)ÚSeries)ÚPySeries)Ú
EndiannessÚIntoExprÚPolarsDataTypeÚSizeUnitÚTransferEncodingc                   @  s–   e Zd ZdZdZd7dd„Zd8dd„Zd9dd„Zd:dd„Zddœd;dd„Z	d<dd„Z
d=d>d d!„Zd"d#œd?d(d)„Zd@dAd/d0„ZdBdCd3d4„ZdBdCd5d6„Zd*S )DÚBinaryNameSpacezSeries.bin namespace.ÚbinÚseriesr   ÚreturnÚNonec                 C  s   |j | _ d S ©N)Z_s)Úselfr   © r   úK/home/app/Keep/.python/lib/python3.10/site-packages/polars/series/binary.pyÚ__init__   s   zBinaryNameSpace.__init__Úliteralr   c                 C  ó   dS )a+  
        Check if binaries in Series contain a binary substring.

        Parameters
        ----------
        literal
            The binary substring to look for

        Returns
        -------
        Series
            Series of data type :class:`Boolean`.

        Examples
        --------
        >>> s = pl.Series("colors", [b"\x00\x00\x00", b"\xff\xff\x00", b"\x00\x00\xff"])
        >>> s.bin.contains(b"\xff")
        shape: (3,)
        Series: 'colors' [bool]
        [
            false
            true
            true
        ]
        Nr   )r   r   r   r   r   Úcontains   ó    zBinaryNameSpace.containsÚsuffixc                 C  r   )a¶  
        Check if string values end with a binary substring.

        Parameters
        ----------
        suffix
            Suffix substring.

        Examples
        --------
        >>> s = pl.Series("colors", [b"\x00\x00\x00", b"\xff\xff\x00", b"\x00\x00\xff"])
        >>> s.bin.ends_with(b"\x00")
        shape: (3,)
        Series: 'colors' [bool]
        [
            true
            true
            false
        ]
        Nr   )r   r   r   r   r   Ú	ends_with7   r   zBinaryNameSpace.ends_withÚprefixc                 C  r   )a³  
        Check if values start with a binary substring.

        Parameters
        ----------
        prefix
            Prefix substring.

        Examples
        --------
        >>> s = pl.Series("colors", [b"\x00\x00\x00", b"\xff\xff\x00", b"\x00\x00\xff"])
        >>> s.bin.starts_with(b"\x00")
        shape: (3,)
        Series: 'colors' [bool]
        [
            true
            false
            true
        ]
        Nr   )r   r   r   r   r   Ústarts_withM   r   zBinaryNameSpace.starts_withT)ÚstrictÚencodingr   r   Úboolc                C  r   )a„  
        Decode values using the provided encoding.

        Parameters
        ----------
        encoding : {'hex', 'base64'}
            The encoding to use.
        strict
            Raise an error if the underlying value cannot be decoded,
            otherwise mask out with a null value.

        Returns
        -------
        Series
            Series of data type :class:`String`.

        Examples
        --------
        Decode values using hexadecimal encoding.

        >>> s = pl.Series("colors", [b"000000", b"ffff00", b"0000ff"])
        >>> s.bin.decode("hex")
        shape: (3,)
        Series: 'colors' [binary]
        [
            b"\x00\x00\x00"
            b"\xff\xff\x00"
            b"\x00\x00\xff"
        ]

        Decode values using Base64 encoding.

        >>> s = pl.Series("colors", [b"AAAA", b"//8A", b"AAD/"])
        >>> s.bin.decode("base64")
        shape: (3,)
        Series: 'colors' [binary]
        [
            b"\x00\x00\x00"
            b"\xff\xff\x00"
            b"\x00\x00\xff"
        ]

        Set `strict=False` to set invalid values to null instead of raising an error.

        >>> s = pl.Series("colors", [b"000000", b"ffff00", b"invalid_value"])
        >>> s.bin.decode("hex", strict=False)
        shape: (3,)
        Series: 'colors' [binary]
        [
            b"\x00\x00\x00"
            b"\xff\xff\x00"
            null
        ]
        Nr   )r   r   r   r   r   r   Údecodec   r   zBinaryNameSpace.decodec                 C  r   )a1  
        Encode values using the provided encoding.

        Parameters
        ----------
        encoding : {'hex', 'base64'}
            The encoding to use.

        Returns
        -------
        Series
            Series of data type :class:`String`.

        Examples
        --------
        Encode values using hexadecimal encoding.

        >>> s = pl.Series("colors", [b"\x00\x00\x00", b"\xff\xff\x00", b"\x00\x00\xff"])
        >>> s.bin.encode("hex")
        shape: (3,)
        Series: 'colors' [str]
        [
            "000000"
            "ffff00"
            "0000ff"
        ]

        Encode values using Base64 encoding.

        >>> s.bin.encode("base64")
        shape: (3,)
        Series: 'colors' [str]
        [
            "AAAA"
            "//8A"
            "AAD/"
        ]
        Nr   )r   r   r   r   r   Úencode›   r   zBinaryNameSpace.encodeÚbÚunitr
   c                 C  r   )aì  
        Get the size of the binary values in a Series in the given unit.

        Returns
        -------
        Series
            Series of data type :class:`UInt32`.

        Examples
        --------
        >>> from os import urandom
        >>> s = pl.Series("data", [urandom(n) for n in (512, 256, 2560, 1024)])
        >>> s.bin.size("kb")
        shape: (4,)
        Series: 'data' [f64]
        [
            0.5
            0.25
            2.5
            1.0
        ]
        Nr   )r   r$   r   r   r   ÚsizeÃ   r   zBinaryNameSpace.sizeÚlittle)Ú
endiannessÚdtyper	   r'   r   c                C  r   )aÏ  
        Interpret bytes as another type.

        Supported types are numerical or temporal dtypes, or an ``Array`` of
        these dtypes.

        Parameters
        ----------
        dtype : PolarsDataType
            Which type to interpret binary column into.
        endianness : {"big", "little"}, optional
            Which endianness to use when interpreting bytes, by default "little".

        Returns
        -------
        Series
            Series of data type `dtype`.
            Note that rows of the binary array where the length does not match
            the size in bytes of the output array (number of items * byte size
            of item) will become NULL.

        Examples
        --------
        >>> s = pl.Series("data", [b"\x05\x00\x00\x00", b"\x10\x00\x01\x00"])
        >>> s.bin.reinterpret(dtype=pl.Int32, endianness="little")
        shape: (2,)
        Series: 'data' [i32]
        [
            5
            65552
        ]

        Nr   )r   r(   r'   r   r   r   ÚreinterpretÛ   r   zBinaryNameSpace.reinterpretNÚoffsetÚintÚlengthú
int | Nonec                 C  r   )a²  
        Slice the binary values.

        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 value.

        Returns
        -------
        Series
            Series of data type :class:`Binary`.

        Examples
        --------
        >>> colors = pl.Series([b"\x00\x00\x00", b"\xff\xff\x00", b"\x00\x00\xff"])
        >>> colors.bin.slice(1, 2)
        shape: (3,)
        Series: '' [binary]
        [
                b"\x00\x00"
                b"\xff\x00"
                b"\x00\xff"
        ]
        Nr   )r   r*   r,   r   r   r   Úslice   r   zBinaryNameSpace.sliceé   Únc                 C  r   )a`  
        Take the first `n` bytes of the binary values.

        Parameters
        ----------
        n
            Length of the slice. Negative indexing is supported; see note (2) below.

        Returns
        -------
        Series
            Series of data type :class:`Binary`.

        Notes
        -----
        (1) A similar method exists for taking the last `n` bytes: :func:`tail`.
        (2) If `n` is negative, it is interpreted as "until the nth byte from the end",
            e.g., ``head(-3)`` returns all but the last three bytes.

        Examples
        --------
        >>> colors = pl.Series([b"\x00\x00\x00", b"\xff\xff\x00", b"\x00\x00\xff"])
        >>> colors.bin.head(2)
        shape: (3,)
        Series: '' [binary]
        [
                b"\x00\x00"
                b"\xff\xff"
                b"\x00\x00"
        ]
        Nr   ©r   r0   r   r   r   Úhead  r   zBinaryNameSpace.headc                 C  r   )aZ  
        Take the last `n` bytes of the binary values.

        Parameters
        ----------
        n
            Length of the slice. Negative indexing is supported; see note (2) below.

        Returns
        -------
        Series
            Series of data type :class:`Binary`.

        Notes
        -----
        (1) A similar method exists for taking the first `n` bytes: :func:`head`.
        (2) If `n` is negative, it is interpreted as "starting at the nth byte",
            e.g., ``tail(-3)`` returns all but the first three bytes.

        Examples
        --------
        >>> colors = pl.Series([b"\x00\x00\x00", b"\xff\xff\x00", b"\x00\x00\xff"])
        >>> colors.bin.tail(2)
        shape: (3,)
        Series: '' [binary]
        [
                b"\x00\x00"
                b"\xff\x00"
                b"\x00\xff"
        ]
        Nr   r1   r   r   r   Útail?  r   zBinaryNameSpace.tail)r   r   r   r   )r   r   r   r   )r   r   r   r   )r   r   r   r   )r   r   r   r    r   r   )r   r   r   r   )r#   )r$   r
   r   r   )r(   r	   r'   r   r   r   r   )r*   r+   r,   r-   r   r   )r/   )r0   r+   r   r   )Ú__name__Ú
__module__Ú__qualname__Ú__doc__Ú	_accessorr   r   r   r   r!   r"   r%   r)   r.   r2   r3   r   r   r   r   r      s    




8(ÿ%!r   N)Ú
__future__r   Útypingr   Zpolars.series.utilsr   Zpolarsr   Zpolars._plrr   Zpolars._typingr   r   r	   r
   r   r   r   r   r   r   Ú<module>   s    	