Skip to content

ENH: Add dtype argument to str.decode #60940

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Feb 18, 2025
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/source/whatsnew/v2.3.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ Other enhancements
updated to work correctly with NumPy >= 2 (:issue:`57739`)
- :meth:`Series.str.decode` result now has ``StringDtype`` when ``future.infer_string`` is True (:issue:`60709`)
- :meth:`~Series.to_hdf` and :meth:`~DataFrame.to_hdf` now round-trip with ``StringDtype`` (:issue:`60663`)
- The :meth:`Series.str.decode` has gained the argument ``dtype`` to control the dtype of the result (:issue:`60940`)
- The :meth:`~Series.cumsum`, :meth:`~Series.cummin`, and :meth:`~Series.cummax` reductions are now implemented for ``StringDtype`` columns when backed by PyArrow (:issue:`60633`)
- The :meth:`~Series.sum` reduction is now implemented for ``StringDtype`` columns (:issue:`59853`)

Expand Down
20 changes: 18 additions & 2 deletions pandas/core/strings/accessor.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
is_numeric_dtype,
is_object_dtype,
is_re,
is_string_dtype,
)
from pandas.core.dtypes.dtypes import (
ArrowDtype,
Expand Down Expand Up @@ -2102,7 +2103,9 @@ def slice_replace(self, start=None, stop=None, repl=None):
result = self._data.array._str_slice_replace(start, stop, repl)
return self._wrap_result(result)

def decode(self, encoding, errors: str = "strict"):
def decode(
self, encoding, errors: str = "strict", dtype: str | DtypeObj | None = None
):
"""
Decode character string in the Series/Index using indicated encoding.

Expand All @@ -2116,6 +2119,12 @@ def decode(self, encoding, errors: str = "strict"):
errors : str, optional
Specifies the error handling scheme.
Possible values are those supported by :meth:`bytes.decode`.
dtype : str or dtype, optional
The dtype of the result. When not ``None``, must be either a string or
object dtype. When ``None``, the dtype of the result is determined by
``pd.options.future.infer_string``.

.. versionadded:: 2.3.0

Returns
-------
Expand All @@ -2137,6 +2146,14 @@ def decode(self, encoding, errors: str = "strict"):
2 ()
dtype: object
"""
if (
dtype is not None
and not is_string_dtype(dtype)
and not is_object_dtype(dtype)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FWIW, is_string_dtype currently (confusingly, sometimes, if you really only want StringDtype) also returns True for object dtype, so this final and not is_object_dtype is not strictly needed (although I find it useful for reading the code ;))

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

):
raise ValueError(f"dtype must be string or object, got {dtype=}")
if dtype is None and get_option("future.infer_string"):
dtype = "str"
# TODO: Add a similar _bytes interface.
if encoding in _cpython_optimized_decoders:
# CPython optimized implementation
Expand All @@ -2146,7 +2163,6 @@ def decode(self, encoding, errors: str = "strict"):
f = lambda x: decoder(x, errors)[0]
arr = self._data.array
result = arr._str_map(f)
dtype = "str" if get_option("future.infer_string") else None
return self._wrap_result(result, dtype=dtype)

@forbid_nonstring_types(["bytes"])
Expand Down
24 changes: 24 additions & 0 deletions pandas/tests/strings/test_strings.py
Original file line number Diff line number Diff line change
Expand Up @@ -601,6 +601,30 @@ def test_decode_errors_kwarg():
tm.assert_series_equal(result, expected)


def test_decode_string_dtype(string_dtype):
# https://github.com/pandas-dev/pandas/pull/60940
ser = Series([b"a", b"b"])
result = ser.str.decode("utf-8", dtype=string_dtype)
expected = Series(["a", "b"], dtype=string_dtype)
tm.assert_series_equal(result, expected)


def test_decode_object_dtype(object_dtype):
# https://github.com/pandas-dev/pandas/pull/60940
ser = Series([b"a", rb"\ud800"])
result = ser.str.decode("utf-8", dtype=object_dtype)
expected = Series(["a", r"\ud800"], dtype=object_dtype)
tm.assert_series_equal(result, expected)


def test_decode_bad_dtype():
# https://github.com/pandas-dev/pandas/pull/60940
ser = Series([b"a", b"b"])
msg = "dtype must be string or object, got dtype='int64'"
with pytest.raises(ValueError, match=msg):
ser.str.decode("utf-8", dtype="int64")


@pytest.mark.parametrize(
"form, expected",
[
Expand Down
Loading