"""
|
Utility functions related to concat.
|
"""
|
from __future__ import annotations
|
|
from typing import TYPE_CHECKING
|
|
import numpy as np
|
|
from pandas._typing import AxisInt
|
|
from pandas.core.dtypes.astype import astype_array
|
from pandas.core.dtypes.cast import (
|
common_dtype_categorical_compat,
|
find_common_type,
|
)
|
from pandas.core.dtypes.common import is_dtype_equal
|
from pandas.core.dtypes.dtypes import (
|
DatetimeTZDtype,
|
ExtensionDtype,
|
)
|
from pandas.core.dtypes.generic import (
|
ABCCategoricalIndex,
|
ABCExtensionArray,
|
ABCSeries,
|
)
|
|
if TYPE_CHECKING:
|
from pandas.core.arrays import Categorical
|
|
|
def concat_compat(to_concat, axis: AxisInt = 0, ea_compat_axis: bool = False):
|
"""
|
provide concatenation of an array of arrays each of which is a single
|
'normalized' dtypes (in that for example, if it's object, then it is a
|
non-datetimelike and provide a combined dtype for the resulting array that
|
preserves the overall dtype if possible)
|
|
Parameters
|
----------
|
to_concat : array of arrays
|
axis : axis to provide concatenation
|
ea_compat_axis : bool, default False
|
For ExtensionArray compat, behave as if axis == 1 when determining
|
whether to drop empty arrays.
|
|
Returns
|
-------
|
a single array, preserving the combined dtypes
|
"""
|
|
# filter empty arrays
|
# 1-d dtypes always are included here
|
def is_nonempty(x) -> bool:
|
if x.ndim <= axis:
|
return True
|
return x.shape[axis] > 0
|
|
# If all arrays are empty, there's nothing to convert, just short-cut to
|
# the concatenation, #3121.
|
#
|
# Creating an empty array directly is tempting, but the winnings would be
|
# marginal given that it would still require shape & dtype calculation and
|
# np.concatenate which has them both implemented is compiled.
|
non_empties = [x for x in to_concat if is_nonempty(x)]
|
if non_empties and axis == 0 and not ea_compat_axis:
|
# ea_compat_axis see GH#39574
|
to_concat = non_empties
|
|
dtypes = {obj.dtype for obj in to_concat}
|
kinds = {obj.dtype.kind for obj in to_concat}
|
contains_datetime = any(
|
isinstance(dtype, (np.dtype, DatetimeTZDtype)) and dtype.kind in ["m", "M"]
|
for dtype in dtypes
|
) or any(isinstance(obj, ABCExtensionArray) and obj.ndim > 1 for obj in to_concat)
|
|
all_empty = not len(non_empties)
|
single_dtype = len({x.dtype for x in to_concat}) == 1
|
any_ea = any(isinstance(x.dtype, ExtensionDtype) for x in to_concat)
|
|
if contains_datetime:
|
return _concat_datetime(to_concat, axis=axis)
|
|
if any_ea:
|
# we ignore axis here, as internally concatting with EAs is always
|
# for axis=0
|
if not single_dtype:
|
target_dtype = find_common_type([x.dtype for x in to_concat])
|
target_dtype = common_dtype_categorical_compat(to_concat, target_dtype)
|
to_concat = [
|
astype_array(arr, target_dtype, copy=False) for arr in to_concat
|
]
|
|
if isinstance(to_concat[0], ABCExtensionArray):
|
# TODO: what about EA-backed Index?
|
cls = type(to_concat[0])
|
return cls._concat_same_type(to_concat)
|
else:
|
return np.concatenate(to_concat)
|
|
elif all_empty:
|
# we have all empties, but may need to coerce the result dtype to
|
# object if we have non-numeric type operands (numpy would otherwise
|
# cast this to float)
|
if len(kinds) != 1:
|
if not len(kinds - {"i", "u", "f"}) or not len(kinds - {"b", "i", "u"}):
|
# let numpy coerce
|
pass
|
else:
|
# coerce to object
|
to_concat = [x.astype("object") for x in to_concat]
|
kinds = {"o"}
|
|
result = np.concatenate(to_concat, axis=axis)
|
if "b" in kinds and result.dtype.kind in ["i", "u", "f"]:
|
# GH#39817 cast to object instead of casting bools to numeric
|
result = result.astype(object, copy=False)
|
return result
|
|
|
def union_categoricals(
|
to_union, sort_categories: bool = False, ignore_order: bool = False
|
) -> Categorical:
|
"""
|
Combine list-like of Categorical-like, unioning categories.
|
|
All categories must have the same dtype.
|
|
Parameters
|
----------
|
to_union : list-like
|
Categorical, CategoricalIndex, or Series with dtype='category'.
|
sort_categories : bool, default False
|
If true, resulting categories will be lexsorted, otherwise
|
they will be ordered as they appear in the data.
|
ignore_order : bool, default False
|
If true, the ordered attribute of the Categoricals will be ignored.
|
Results in an unordered categorical.
|
|
Returns
|
-------
|
Categorical
|
|
Raises
|
------
|
TypeError
|
- all inputs do not have the same dtype
|
- all inputs do not have the same ordered property
|
- all inputs are ordered and their categories are not identical
|
- sort_categories=True and Categoricals are ordered
|
ValueError
|
Empty list of categoricals passed
|
|
Notes
|
-----
|
To learn more about categories, see `link
|
<https://pandas.pydata.org/pandas-docs/stable/user_guide/categorical.html#unioning>`__
|
|
Examples
|
--------
|
If you want to combine categoricals that do not necessarily have
|
the same categories, `union_categoricals` will combine a list-like
|
of categoricals. The new categories will be the union of the
|
categories being combined.
|
|
>>> a = pd.Categorical(["b", "c"])
|
>>> b = pd.Categorical(["a", "b"])
|
>>> pd.api.types.union_categoricals([a, b])
|
['b', 'c', 'a', 'b']
|
Categories (3, object): ['b', 'c', 'a']
|
|
By default, the resulting categories will be ordered as they appear
|
in the `categories` of the data. If you want the categories to be
|
lexsorted, use `sort_categories=True` argument.
|
|
>>> pd.api.types.union_categoricals([a, b], sort_categories=True)
|
['b', 'c', 'a', 'b']
|
Categories (3, object): ['a', 'b', 'c']
|
|
`union_categoricals` also works with the case of combining two
|
categoricals of the same categories and order information (e.g. what
|
you could also `append` for).
|
|
>>> a = pd.Categorical(["a", "b"], ordered=True)
|
>>> b = pd.Categorical(["a", "b", "a"], ordered=True)
|
>>> pd.api.types.union_categoricals([a, b])
|
['a', 'b', 'a', 'b', 'a']
|
Categories (2, object): ['a' < 'b']
|
|
Raises `TypeError` because the categories are ordered and not identical.
|
|
>>> a = pd.Categorical(["a", "b"], ordered=True)
|
>>> b = pd.Categorical(["a", "b", "c"], ordered=True)
|
>>> pd.api.types.union_categoricals([a, b])
|
Traceback (most recent call last):
|
...
|
TypeError: to union ordered Categoricals, all categories must be the same
|
|
New in version 0.20.0
|
|
Ordered categoricals with different categories or orderings can be
|
combined by using the `ignore_ordered=True` argument.
|
|
>>> a = pd.Categorical(["a", "b", "c"], ordered=True)
|
>>> b = pd.Categorical(["c", "b", "a"], ordered=True)
|
>>> pd.api.types.union_categoricals([a, b], ignore_order=True)
|
['a', 'b', 'c', 'c', 'b', 'a']
|
Categories (3, object): ['a', 'b', 'c']
|
|
`union_categoricals` also works with a `CategoricalIndex`, or `Series`
|
containing categorical data, but note that the resulting array will
|
always be a plain `Categorical`
|
|
>>> a = pd.Series(["b", "c"], dtype='category')
|
>>> b = pd.Series(["a", "b"], dtype='category')
|
>>> pd.api.types.union_categoricals([a, b])
|
['b', 'c', 'a', 'b']
|
Categories (3, object): ['b', 'c', 'a']
|
"""
|
from pandas import Categorical
|
from pandas.core.arrays.categorical import recode_for_categories
|
|
if len(to_union) == 0:
|
raise ValueError("No Categoricals to union")
|
|
def _maybe_unwrap(x):
|
if isinstance(x, (ABCCategoricalIndex, ABCSeries)):
|
return x._values
|
elif isinstance(x, Categorical):
|
return x
|
else:
|
raise TypeError("all components to combine must be Categorical")
|
|
to_union = [_maybe_unwrap(x) for x in to_union]
|
first = to_union[0]
|
|
if not all(
|
is_dtype_equal(other.categories.dtype, first.categories.dtype)
|
for other in to_union[1:]
|
):
|
raise TypeError("dtype of categories must be the same")
|
|
ordered = False
|
if all(first._categories_match_up_to_permutation(other) for other in to_union[1:]):
|
# identical categories - fastpath
|
categories = first.categories
|
ordered = first.ordered
|
|
all_codes = [first._encode_with_my_categories(x)._codes for x in to_union]
|
new_codes = np.concatenate(all_codes)
|
|
if sort_categories and not ignore_order and ordered:
|
raise TypeError("Cannot use sort_categories=True with ordered Categoricals")
|
|
if sort_categories and not categories.is_monotonic_increasing:
|
categories = categories.sort_values()
|
indexer = categories.get_indexer(first.categories)
|
|
from pandas.core.algorithms import take_nd
|
|
new_codes = take_nd(indexer, new_codes, fill_value=-1)
|
elif ignore_order or all(not c.ordered for c in to_union):
|
# different categories - union and recode
|
cats = first.categories.append([c.categories for c in to_union[1:]])
|
categories = cats.unique()
|
if sort_categories:
|
categories = categories.sort_values()
|
|
new_codes = [
|
recode_for_categories(c.codes, c.categories, categories) for c in to_union
|
]
|
new_codes = np.concatenate(new_codes)
|
else:
|
# ordered - to show a proper error message
|
if all(c.ordered for c in to_union):
|
msg = "to union ordered Categoricals, all categories must be the same"
|
raise TypeError(msg)
|
raise TypeError("Categorical.ordered must be the same")
|
|
if ignore_order:
|
ordered = False
|
|
return Categorical(new_codes, categories=categories, ordered=ordered, fastpath=True)
|
|
|
def _concatenate_2d(to_concat, axis: AxisInt):
|
# coerce to 2d if needed & concatenate
|
if axis == 1:
|
to_concat = [np.atleast_2d(x) for x in to_concat]
|
return np.concatenate(to_concat, axis=axis)
|
|
|
def _concat_datetime(to_concat, axis: AxisInt = 0):
|
"""
|
provide concatenation of an datetimelike array of arrays each of which is a
|
single M8[ns], datetime64[ns, tz] or m8[ns] dtype
|
|
Parameters
|
----------
|
to_concat : array of arrays
|
axis : axis to provide concatenation
|
|
Returns
|
-------
|
a single array, preserving the combined dtypes
|
"""
|
from pandas.core.construction import ensure_wrapped_if_datetimelike
|
|
to_concat = [ensure_wrapped_if_datetimelike(x) for x in to_concat]
|
|
single_dtype = len({x.dtype for x in to_concat}) == 1
|
|
# multiple types, need to coerce to object
|
if not single_dtype:
|
# ensure_wrapped_if_datetimelike ensures that astype(object) wraps
|
# in Timestamp/Timedelta
|
return _concatenate_2d([x.astype(object) for x in to_concat], axis=axis)
|
|
result = type(to_concat[0])._concat_same_type(to_concat, axis=axis)
|
return result
|
