Skip to content

BUG: Impossible creation of array with dtype=string #61263

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 11 commits into
base: main
Choose a base branch
from

Conversation

Manju080
Copy link
Contributor

@Manju080 Manju080 commented Apr 9, 2025

closes #61155

Hello @rhshadrach ,

I’ve created a fix that raises a ValueError when trying to create a StringArray from a list of lists with inconsistent lengths or non-character elements. This aligns the behavior for both consistent and inconsistent input formats and also tested.

I've would like to hear opinion to raise an error when a list of lists is passed for dtype=StringDtype, to avoid ambiguous behavior. If preferred, we could instead join the inner lists into strings automatically — happy to adjust based on guidance.
Example case : pd.array([["t", "e", "s", "t"], ["w", "o", "r", "d"]], dtype="string")
output : <StringArray> ['test', 'word'] Length: 2, dtype: string

Thanks

Comment on lines +658 to +659
if isinstance(scalars, list) and all(isinstance(x, list) for x in scalars):
scalars = [str(x) for x in scalars]
Copy link
Member

@rhshadrach rhshadrach Apr 13, 2025

Choose a reason for hiding this comment

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

Instead of this, can you modify ensure_string_array in pandas._libs.lib.pyx as follows. Instead of

elif not util.is_array(arr):
    arr = np.array(arr, dtype="object")

do

elif not util.is_array(arr):
    # GH#61155: Guarantee a 1-d result when array is a list of lists
    arr = np.empty(len(array), dtype="object")
    arr[:] = array

Will has almost no performance impact.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you very much for the suggestions, I have made the necessary changes as per the guidance.

Copy link
Member

Choose a reason for hiding this comment

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

Thanks for making the update. The changes in this file should now be reverted.

@rhshadrach
Copy link
Member

Also, please add a test for this.

@Manju080 Manju080 requested a review from WillAyd as a code owner April 15, 2025 17:05
@simonjayhawkins simonjayhawkins changed the title Bugfix 61155 BUG: Impossible creation of array with dtype=string Apr 16, 2025
@simonjayhawkins simonjayhawkins added Bug Strings String extension data type and string data labels Apr 16, 2025
@Manju080
Copy link
Contributor Author

pre-commit.ci autofix

Copy link
Member

@rhshadrach rhshadrach left a comment

Choose a reason for hiding this comment

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

We use pytest for testing, you'll need to add a test using that format. See here:

https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#using-pytest

The general pytest introduction may also be useful:

https://docs.pytest.org/en/7.1.x/getting-started.html

@Manju080
Copy link
Contributor Author

We use pytest for testing, you'll need to add a test using that format. See here:

https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#using-pytest

The general pytest introduction may also be useful:

https://docs.pytest.org/en/7.1.x/getting-started.html

Thank you for the details, will work on it

@Manju080
Copy link
Contributor Author

@rhshadrach I’ve been testing the following case in test_lib.py

def test_ensure_string_array_list_of_lists():
# GH#61155: ensure list of lists doesn't get converted to string
arr = [['t', 'e', 's', 't'], ['w', 'o', 'r', 'd']]
result = lib.ensure_string_array(arr)

# Each item in result should still be a list, not a stringified version
assert isinstance(result[0], list)
assert isinstance(result[1], list)
assert result[0] == ['t', 'e', 's', 't']
assert result[1] == ['w', 'o', 'r', 'd']

However, the test fails with
FAILED pandas/tests/libs/test_lib.py::test_ensure_string_array_list_of_lists - AssertionError
DEBUG RESULT: ["['t', 'e', 's', 't']" "['w', 'o', 'r', 'd']"] <class 'numpy.ndarray'> <class 'str'>

So currently, the list of lists gets converted into a 1D NumPy array of strings.
With the current implementation, arr becomes a 1D object array of lists (as intended), but it seems that downstream processing stringifies each list.
Do you want me to guard against this case inside ensure_string_array to preserve the list structure? Or is the stringification expected behavior in this context?

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Strings String extension data type and string data
Projects
None yet
Development

Successfully merging this pull request may close these issues.

BUG: Impossible creation of array with dtype=string
3 participants