Skip to content

API: change default for sep in str.cat (in docstring) #23443

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.

Sign up for GitHub

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 11 commits into from
Nov 6, 2018
Merged

API: change default for sep in str.cat (in docstring) #23443

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
5e2bd40
API: change default for sep in str.cat
h-vetinari Nov 1, 2018
8f595e0
Merge remote-tracking branch 'upstream/master' into str_cat_sep
h-vetinari Nov 2, 2018
d361dce
Review (jschendel & jreback)
h-vetinari Nov 2, 2018
af66b94
Retrigger Circle
h-vetinari Nov 2, 2018
f39416e
Merge remote-tracking branch 'upstream/master' into str_cat_sep
h-vetinari Nov 3, 2018
ae638b9
Review (jreback)
h-vetinari Nov 3, 2018
712642b
Retrigger CircleCI
h-vetinari Nov 3, 2018
29be975
Retrigger CircleCI
h-vetinari Nov 3, 2018
0f32510
Review (jreback)
h-vetinari Nov 5, 2018
608f2d2
Retrigger CircleCI
h-vetinari Nov 5, 2018
2d1bf05
Retrigger Circle
h-vetinari Nov 5, 2018
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
13 changes: 9 additions & 4 deletions pandas/core/strings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2051,7 +2051,7 @@ def _get_series_list(self, others, ignore_index=False):
return ([Series(others, index=idx)], False)
raise TypeError(err_msg)

def cat(self, others=None, sep=None, na_rep=None, join=None):
def cat(self, others=None, sep='', na_rep=None, join=None):
Copy link
Contributor

Choose a reason for hiding this comment

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

there is likely some other check for sep is None in the codebase, this shouldn't pass, and as I said pls change back to the original modulo the doc-string.

"""
Concatenate strings in the Series/Index with given separator.

Expand All @@ -2074,9 +2074,10 @@ def cat(self, others=None, sep=None, na_rep=None, join=None):

If others is None, the method returns the concatenation of all
strings in the calling Series/Index.
sep : string or None, default None
If None, concatenates without any separator.
na_rep : string or None, default None
sep : str, default ''
The separator between the different elements/columns. By default
the empty string `''` is used.
na_rep : str or None, default None
Representation that is inserted for all missing values:

- If `na_rep` is None, and `others` is None, missing values in the
Expand Down Expand Up @@ -2197,6 +2198,10 @@ def cat(self, others=None, sep=None, na_rep=None, join=None):
if isinstance(others, compat.string_types):
raise ValueError("Did you mean to supply a `sep` keyword?")
if sep is None:
Copy link
Contributor

Choose a reason for hiding this comment

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

I think just adding the doc-string update is enough. we commondly accept none, then actuall do this check here. The reason is if you actually pass None your change will fail (pls add a test to check that)

warnings.warn('Passing `sep=None` to .str.cat is deprecated and '
Copy link
Contributor

Choose a reason for hiding this comment

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

pls remove this and just update as I suggested.

'will be removed in a future version. Please use '
'`sep=''` to pass the default explicitly',
FutureWarning, stacklevel=2)
sep = ''

if isinstance(self._orig, Index):
Expand Down
5 changes: 5 additions & 0 deletions pandas/tests/test_strings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,11 @@ def test_str_cat_raises_intuitive_error(self, box):
with tm.assert_raises_regex(ValueError, message):
s.str.cat(' ')

# GH 23443
with tm.assert_produces_warning(expected_warning=FutureWarning):
# FutureWarning to switch to default sep='' (instead of None)
s.str.cat(sep=None)

@pytest.mark.parametrize('dtype_target', ['object', 'category'])
@pytest.mark.parametrize('dtype_caller', ['object', 'category'])
@pytest.mark.parametrize('box', [Series, Index])
Expand Down