Skip to content

Commit 677348c

Browse files
DOC: Add docstring for asarray_tuplesafe in common.py
1 parent 7863029 commit 677348c

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

pandas/core/common.py

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -232,6 +232,27 @@ def asarray_tuplesafe(values: Iterable, dtype: NpDtype | None = ...) -> ArrayLik
232232

233233

234234
def asarray_tuplesafe(values: Iterable, dtype: NpDtype | None = None) -> ArrayLike:
235+
"""
236+
Convert input values to a NumPy array or ExtensionArray,
237+
preserving tuples as single elements.
238+
239+
Parameters
240+
----------
241+
values : iterable or array-like
242+
The data to be converted. Tuples preserved as single elements.
243+
dtype : numpy.dtype or None, default None
244+
Data type for the result. If None, the dtype is inferred.
245+
246+
Returns
247+
-------
248+
ndarray or ExtensionArray
249+
The converted array or extension array.
250+
251+
Notes
252+
-----
253+
For object dtype lists, uses
254+
`construct_1d_object_array_from_listlike` to preserve structure.
255+
"""
235256
if not (isinstance(values, (list, tuple)) or hasattr(values, "__array__")):
236257
values = list(values)
237258
elif isinstance(values, ABCIndex):

0 commit comments

Comments
 (0)