DEPR: Changing default of str.extract(expand=False) to str.extract(expand=True) #19118
Conversation
jreback
added
Deprecate
doc/source/whatsnew/v0.23.0.txt
Outdated
| @@ -314,6 +314,7 @@ Removal of prior version deprecations/changes | |||
| - The ``Panel4D`` and ``PanelND`` classes have been removed (:issue:`13776`) | |||
| - The ``Panel``class has dropped the ``to_long``and ``toLong`` methods (:issue:`19077`) | |||
| - The options ``display.line_with`` and ``display.height`` are removed in favor of ``display.width`` and ``display.max_rows`` respectively (:issue:`4391`, :issue:`19107`) | |||
| - The ``expand`` parameter of :func:`str.extract` method is ``True`` by default (it was `False`) | |||
There was a problem hiding this comment.
has changed, previously was default to None. add the issue number and this PR number. Move this instead to a sub-section (of API breaking changes) where you show an example of this.
|
I changed the section in the wantsnew, and updated the text and the issue number, but I left the default parameter. In the signature, |
doc/source/whatsnew/v0.23.0.txt
Outdated
| @@ -208,6 +208,8 @@ Other Enhancements | |||
| Backwards incompatible API changes | |||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |||
|
|
|||
| - The default value of the ``expand`` parameter of :func:`str.extract` method changed from ``False`` to ``True`` (:issue:`11386`) | |||
There was a problem hiding this comment.
well it change from None, which was previously evaluated as False. So None is no longer accepted.
There was a problem hiding this comment.
this is actully a fairly big change, show an example and how to restore previous behavior
|
Thank you for the comments @jreback I understood it now. If you want to take a look, I think it should be much better, and with the examples now. Let me know if any other change is needed. |
There was a problem hiding this comment.
Could you update the prose docs at http://pandas-docs.github.io/pandas-docs-travis/text.html#extract-first-match-in-each-subject-extract
doc/source/whatsnew/v0.23.0.txt
Outdated
|
|
||
| By default, extracting matching patterns from strings with :func:`str.extract` used to return a | ||
| ``Series`` if a single group was being extracted (a ``DataFrame`` if more than one group was | ||
| extracted``). Since Pandas 0.23.0 :func:`str.extract` always returns a ``DataFrame``, unless |
doc/source/whatsnew/v0.23.0.txt
Outdated
| ``expand`` is set to ``False`` (:issue:`11386`). | ||
|
|
||
| Also, ``None`` was an accepted value for the ``expand`` parameter (which was equivalent to | ||
| ``False``), but since 0.23..0 it raises a ``ValueError``. |
There was a problem hiding this comment.
" but now raises a ``ValueError``.
|
Thanks for the comments @TomAugspurger. I made the changes. In text.rst, there was no example with expand unspecified or None, so the text was already correct. I added a quick note about the default value in the warning. Please let me know if that looks good, or you've got a better idea. |
|
All the comments from the reviews were addressed, right? Just double checking that the PR doesn't need anything from my side. |
jorisvandenbossche
changed the title
doc/source/whatsnew/v0.23.0.txt
Outdated
| Out [4]: | ||
| pandas.core.series.Series | ||
|
|
||
| In [5]: s.str.extract('.*(\d\d).*', expand=None) |
There was a problem hiding this comment.
I don't think it is needed to show this one (it just draws attention away from the more important example IMO)
doc/source/whatsnew/v0.23.0.txt
Outdated
|
|
||
| New Behavior: | ||
|
|
||
| .. code-block:: ipython |
There was a problem hiding this comment.
Can you make this a .. ipython:: python directive? (and remove the output below) ?
There was a problem hiding this comment.
Should I use the ..ipython:: python directive in all the 3 cases, right?
I'm not sure what do you mean by "remove the output below", sorry. Can you clarify please?
There was a problem hiding this comment.
To clarify: you can use it for code that can run now, so for the new behaviour. For showing the "old behaviour" you still need to use the literal code-block (there you don't need to change anything).
And by removing output I mean that in an ipython:: python block, you only include the actual code, as the output of the code is generated during the doc build. If you scroll a bit up in the file, you see some examples of that.
|
Thanks for the info @jorisvandenbossche, didn't know about the It should be all right now. |
|
@datapythonista Thanks! |
…o str.extract(expand=True) (#6581)
git diff upstream/master -u -- "*.py" | flake8 --diff