Skip to content

TST: add test for dtype argument in str.decode #61872

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

hippowm
Copy link

@hippowm hippowm commented Jul 16, 2025

This PR adds a test case for str.decode and ensures it correctly infers the string datatype, when dtype=None and the option future.infer_string is used. This argument was introduced in PR #60940 but has no test for None. This test adds coverage to the following line:

    def decode(
        self, encoding, errors: str = "strict", dtype: str | DtypeObj | None = None
    ):
        ...
        if dtype is not None and not is_string_dtype(dtype):
            raise ValueError(f"dtype must be string or object, got {dtype=}")
        if dtype is None and get_option("future.infer_string"):
            dtype = "str" #✅ NOW COVERED
        # TODO: Add a similar _bytes interface.
        if encoding in _cpython_optimized_decoders:
            # CPython optimized implementation
            f = lambda x: x.decode(encoding, errors)
        ...

Note: Parts of this test have been automatically generated by a novel technique that we're currently developing as part of an academic research project aiming at improving test coverage. To not waste developer time, two researchers manually checked the test before submitting it. We appreciate the developers' time and any feedback is welcomed.

def test_decode_with_dtype_none():
# Ensure that future.infer_string is enabled
set_option("future.infer_string", True)
ser = Series([b"a", b"b", b"c"]) # Use byte strings
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
ser = Series([b"a", b"b", b"c"]) # Use byte strings
ser = Series([b"a", b"b", b"c"])


def test_decode_with_dtype_none():
# Ensure that future.infer_string is enabled
set_option("future.infer_string", True)
Copy link
Member

Choose a reason for hiding this comment

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

Please use the option_context context manager

@mroeschke mroeschke added the Testing pandas testing functions or related to the test suite label Jul 16, 2025
@hippowm hippowm requested a review from mroeschke July 17, 2025 06:04
def test_decode_with_dtype_none():
# Ensure that future.infer_string is enabled
with option_context("future.infer_string", True):
ser = Series([b"a", b"b", b"c"]) # Use byte strings
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
ser = Series([b"a", b"b", b"c"]) # Use byte strings
ser = Series([b"a", b"b", b"c"])

Co-authored-by: Matthew Roeschke <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Testing pandas testing functions or related to the test suite
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants