Method split

pandas/core/strings/accessor.py:701–899

r""" Split strings around given separator/delimiter. Splits the string in the Series/Index from the beginning, at the specified delimiter string. Parameters ---------- pat : str or compiled regex, optional String or regular expression to

(
        self,
        pat: str | re.Pattern | None = None,
        *,
        n=-1,
        expand: bool = False,
        regex: bool | None = None,
    )

    @forbid_nonstring_types(["bytes"])
    def split(
        self,
        pat: str | re.Pattern | None = None,
        *,
        n=-1,
        expand: bool = False,
        regex: bool | None = None,
    ):
        r"""
        Split strings around given separator/delimiter.

        Splits the string in the Series/Index from the beginning,
        at the specified delimiter string.

        Parameters
        ----------
        pat : str or compiled regex, optional
            String or regular expression to split on.
            If not specified, split on whitespace.
        n : int, default -1 (all)
            Limit number of splits in output.
            ``None``, 0 and -1 will be interpreted as return all splits.
        expand : bool, default False
            Expand the split strings into separate columns.

            - If ``True``, return DataFrame/MultiIndex expanding dimensionality.
            - If ``False``, return Series/Index, containing lists of strings.

        regex : bool, default None
            Determines if the passed-in pattern is a regular expression:

            - If ``True``, assumes the passed-in pattern is a regular expression
            - If ``False``, treats the pattern as a literal string.
            - If ``None`` and `pat` length is 1, treats `pat` as a literal string.
            - If ``None`` and `pat` length is not 1, treats `pat` as a regular
              expression.
            - Cannot be set to False if `pat` is a compiled regex

        Returns
        -------
        Series, Index, DataFrame or MultiIndex
            Type matches caller unless ``expand=True`` (see Notes).

        Raises
        ------
        ValueError
            * if `regex` is False and `pat` is a compiled regex

        See Also
        --------
        Series.str.split : Split strings around given separator/delimiter.
        Series.str.rsplit : Splits string around given separator/delimiter,
            starting from the right.
        Series.str.join : Join lists contained as elements in the Series/Index
            with passed delimiter.
        str.split : Standard library version for split.
        str.rsplit : Standard library version for rsplit.