API: change Index set ops sort=True -> sort=None #25063

jorisvandenbossche · 2019-01-31T20:51:39Z

See discussion in #25007, and particularly #25007 (comment)

This changes the parameter value of True to None (without any change in behaviour), so we keep the possibility open to have sort=True to mean "always sorting" in the future.

I started from the branch of Tom in #25007 (as there were already useful doc changes + new tests), and changed the value + updated the tests from there.

cc @TomAugspurger @jreback

closes #24959

Closes pandas-dev#24959

pep8speaks · 2019-01-31T20:51:56Z

Hello @jorisvandenbossche! Thanks for updating the PR.

Cheers ! There are no PEP8 issues in this Pull Request. 🍻

Comment last updated on February 01, 2019 at 20:06 Hours UTC

pandas/core/indexes/api.py

TomAugspurger · 2019-01-31T21:02:30Z

pandas/core/indexes/base.py


            .. versionadded:: 0.24.0

+            .. versionchanged:: 0.24.1
+
+               Changed `True` to `None`, which matches the behavior of


May not be obvious to users what "Changed True to None" means. Maybe something like "Changed the default from True to False, and disallowed True?" That's not terribly clear either.

Changed it to:

.. versionchanged:: 0.24.1 Changed the default value from ``True`` to ``None`` (without change in behaviour).

pandas/core/indexes/multi.py

codecov · 2019-01-31T21:21:18Z

Codecov Report

Merging #25063 into master will decrease coverage by 49.49%.
The diff coverage is 50%.

@@            Coverage Diff             @@
##           master   #25063      +/-   ##
==========================================
- Coverage   92.37%   42.87%   -49.5%     
==========================================
  Files         166      166              
  Lines       52403    52418      +15     
==========================================
- Hits        48405    22476   -25929     
- Misses       3998    29942   +25944

Flag	Coverage Δ
#multiple	`?`
#single	`42.87% <50%> (ø)`	⬆️

Impacted Files	Coverage Δ
pandas/core/indexes/api.py	`84.15% <0%> (-14.86%)`	⬇️
pandas/core/indexes/range.py	`52.63% <0%> (-44.73%)`	⬇️
pandas/core/indexes/datetimes.py	`48.54% <100%> (-47.73%)`	⬇️
pandas/core/indexes/interval.py	`35.14% <100%> (-60.11%)`	⬇️
pandas/core/indexes/multi.py	`34.17% <18.18%> (-61.43%)`	⬇️
pandas/core/indexes/base.py	`56.32% <78.57%> (-40%)`	⬇️
pandas/io/formats/latex.py	`0% <0%> (-100%)`	⬇️
pandas/core/categorical.py	`0% <0%> (-100%)`	⬇️
pandas/io/sas/sas_constants.py	`0% <0%> (-100%)`	⬇️
pandas/tseries/plotting.py	`0% <0%> (-100%)`	⬇️
... and 129 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update da5f5eb...5e1b831. Read the comment docs.

codecov · 2019-01-31T21:21:27Z

Codecov Report

Merging #25063 into master will increase coverage by <.01%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master   #25063      +/-   ##
==========================================
+ Coverage   92.37%   92.38%   +<.01%     
==========================================
  Files         166      166              
  Lines       52403    52416      +13     
==========================================
+ Hits        48405    48422      +17     
+ Misses       3998     3994       -4

Flag	Coverage Δ
#multiple	`90.8% <100%> (ø)`	⬆️
#single	`42.87% <57.69%> (ø)`	⬆️

Impacted Files	Coverage Δ
pandas/core/indexes/multi.py	`95.6% <100%> (+0.01%)`	⬆️
pandas/core/indexes/datetimes.py	`96.27% <100%> (ø)`	⬆️
pandas/core/indexes/api.py	`99% <100%> (ø)`	⬆️
pandas/core/indexes/base.py	`96.55% <100%> (+0.22%)`	⬆️
pandas/core/indexes/interval.py	`95.25% <100%> (ø)`	⬆️
pandas/core/indexes/range.py	`97.36% <100%> (ø)`	⬆️
pandas/core/frame.py	`96.82% <0%> (ø)`	⬆️
pandas/compat/pickle_compat.py	`75.6% <0%> (ø)`	⬆️
pandas/core/generic.py	`96.63% <0%> (ø)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update da5f5eb...1c5a037. Read the comment docs.

jorisvandenbossche · 2019-01-31T21:36:50Z

@TomAugspurger there is one failure on python 2 (https://travis-ci.org/jorisvandenbossche/pandas/jobs/487130620). Did you see that also on your PR?

TomAugspurger · 2019-01-31T21:39:29Z

I don't recall seeing it, and it's not present on my last run https://travis-ci.org/pandas-dev/pandas/jobs/486980595

jorisvandenbossche · 2019-02-01T07:10:02Z

Not sure why the python 2 error is now solved, as the last commit only did some linting .. Maybe something intermittent.

TomAugspurger

Just some comments on the release note. LGTM otherwise.

TomAugspurger · 2019-02-01T12:28:44Z

doc/source/whatsnew/v0.24.1.rst

+2. ``self`` or ``other`` is empty
+3. ``self`` or ``other`` contain values that can not be compared (a ``RuntimeWarning`` is raised).
+
+This change will allow to preserve ``sort=True`` to mean "always sort" in a future release.


Suggested change

This change will allow to preserve ``sort=True`` to mean "always sort" in a future release.

This change will allow ``sort=True`` to mean "always sort" in a future release.

TomAugspurger · 2019-02-01T12:34:55Z

doc/source/whatsnew/v0.24.1.rst

+would do not sort the result when the values could not be compared.
+
+For :meth:`Index.intersection` the option of ``sort=True`` is also renamed
+to ``sort=None`` (but for :meth:`Index.intersection` it is not the default), as


There's a lot in this sentence. Oh it also isn't quite right... sort=True was the default, but we fixed that in my other PR...

So maybe something like

The `sort` option for :meth:`Index.intersection` has changed in three ways. 1. The default has changed from ``True`` to ``False``, to restore the pandas 0.23.4 and earlier behavior 2. The behavior of ``sort=True`` can now be achieved with ``sort=None``. This will sort the result only if the values in ``self`` and ``other`` are not identical. 3. The value ``sort=True`` is no longer allowed. A future version of pandas will support ``sort=True`` meaning "always sort".

jreback

comments

doc/source/whatsnew/v0.24.1.rst

pandas/tests/indexes/multi/test_set_ops.py

pandas/tests/indexes/test_base.py

TomAugspurger · 2019-02-01T18:57:44Z

@jorisvandenbossche I applied my suggestions to the whatsnew in
41c24f0.

jreback · 2019-02-01T19:18:29Z

looks reasonable

h-vetinari

Some tiny details that may be worth fixing.

doc/source/whatsnew/v0.24.1.rst

h-vetinari · 2019-02-01T19:56:48Z

doc/source/whatsnew/v0.24.1.rst

+   pandas 0.23.4 and earlier behavior of not sorting by default.
+2. The behavior of ``sort=True`` can now be obtained with ``sort=None``.
+   This will sort the result only if the values in ``self`` and ``other``
+   are not identical.


"...are not identical or either is empty."?

For intersection that'd be empty, which we can claim is sorted :)

h-vetinari · 2019-02-01T19:57:47Z

pandas/core/indexes/base.py

+
+            * False : do not sort the result.
+            * None : sort the result, except when `self` and `other` are equal
+              or when the values cannot be compared.


"...are equal, either one is empty, or when ..."

TomAugspurger · 2019-02-01T20:06:50Z

Fixed the typo in the whatsnew. Thanks.

…sort=None

…25083)

* ERR/TST: Add pytest idiom to dtypes/test_cast.py (pandas-dev#24847) * fix MacPython pandas-wheels failue (pandas-dev#24851) * DEPS: Bump pyarrow min version to 0.9.0 (pandas-dev#24854) Closes pandas-devgh-24767 * DOC: Document AttributeError for accessor (pandas-dev#24855) Closes pandas-dev#20579 * Start whatsnew for 0.24.1 and 0.25.0 (pandas-dev#24848) * DEPR/API: Non-ns precision in Index constructors (pandas-dev#24806) * BUG: Format mismatch doesn't coerce to NaT (pandas-dev#24815) * BUG: Properly parse unicode usecols names in CSV (pandas-dev#24856) * CLN: fix typo in asv eval.Query suite (pandas-dev#24865) * BUG: DataFrame respects dtype with masked recarray (pandas-dev#24874) * REF/CLN: Move private method (pandas-dev#24875) * BUG : ValueError in case on NaN value in groupby columns (pandas-dev#24850) * BUG: fix floating precision formatting in presence of inf (pandas-dev#24863) * DOC: Creating top-level user guide section, and moving pages inside (pandas-dev#24677) * DOC: Creating top-level development section, and moving pages inside (pandas-dev#24691) * DOC: Creating top-level getting started section, and moving pages inside (pandas-dev#24678) * DOC: Implementing redirect system, and adding user_guide redirects (pandas-dev#24715) * DOC: Implementing redirect system, and adding user_guide redirects * Using relative urls for the redirect * Validating that no file is overwritten by a redirect * Adding redirects for getting started and development sections * DOC: fixups (pandas-dev#24888) * Fixed heading on whatnew * Remove empty scalars.rst * CLN: fix typo in ctors.SeriesDtypesConstructors setup (pandas-dev#24894) * DOC: No clean in sphinx_build (pandas-dev#24902) Closes pandas-dev#24727 * BUG (output formatting): use fixed with for truncation column instead of inferring from last column (pandas-dev#24905) * DOC: also redirect old whatsnew url (pandas-dev#24906) * Revert BUG-24212 fix usage of Index.take in pd.merge (pandas-dev#24904) * Revert BUG-24212 fix usage of Index.take in pd.merge xref pandas-dev#24733 xref pandas-dev#24897 * test 0.23.4 output * added note about buggy test * DOC: Add experimental note to DatetimeArray and TimedeltaArray (pandas-dev#24882) * DOC: Add experimental note to DatetimeArray and TimedeltaArray * Disable M8 in nanops (pandas-dev#24907) * Disable M8 in nanops Closes pandas-dev#24752 * CLN: fix typo in asv benchmark of non_unique_sorted, which was not sorted (pandas-dev#24917) * API/VIS: remove misc plotting methods from plot accessor (revert pandas-dev#23811) (pandas-dev#24912) * DOC: some 0.24.0 whatsnew clean-up (pandas-dev#24911) * DOC: Final reorganization of documentation pages (pandas-dev#24890) * DOC: Final reorganization of documentation pages * Move ecosystem to top level * DOC: Adding redirects to API moved pages (pandas-dev#24909) * DOC: Adding redirects to API moved pages * DOC: Making home page links more compact and clearer (pandas-dev#24928) * DOC: 0.24 release date (pandas-dev#24930) * DOC: Adding version to the whatsnew section in the home page (pandas-dev#24929) * API: Remove IntervalArray from top-level (pandas-dev#24926) * RLS: 0.24.0 * DEV: Start 0.25 cycle * DOC: State that we support scalars in to_numeric (pandas-dev#24944) We support it and test it already. xref pandas-devgh-24910. * DOC: Minor what's new fix (pandas-dev#24933) * TST: GH#23922 Add missing match params to pytest.raises (pandas-dev#24937) * Add tests for NaT when performing dt.to_period (pandas-dev#24921) * DOC: switch headline whatsnew to 0.25 (pandas-dev#24941) * BUG-24212 fix regression in pandas-dev#24897 (pandas-dev#24916) * CLN: reduce overhead in setup for categoricals benchmarks in asv (pandas-dev#24913) * Excel Reader Refactor - Base Class Introduction (pandas-dev#24829) * TST/REF: Add pytest idiom to test_numeric.py (pandas-dev#24946) * BLD: silence npy_no_deprecated warnings with numpy>=1.16.0 (pandas-dev#24864) * CLN: Refactor cython to use memory views (pandas-dev#24932) * DOC: Clean sort_values and sort_index docstrings (pandas-dev#24843) * STY: use pytest.raises context syntax (indexing) (pandas-dev#24960) * Fixed itertuples usage in to_dict (pandas-dev#24965) * Fixed itertuples usage in to_dict Closes pandas-dev#24940 Closes pandas-dev#24939 * STY: use pytest.raises context manager (resample) (pandas-dev#24977) * DOC: Document breaking change to read_csv (pandas-dev#24989) * DEPR: Fixed warning for implicit registration (pandas-dev#24964) * STY: use pytest.raises context manager (indexes/datetimes) (pandas-dev#24995) * DOC: move whatsnew note of pandas-dev#24916 (pandas-dev#24999) * BUG: Fix broken links (pandas-dev#25002) The previous location of contributing.rst file was /doc/source/contributing.rst but has been moved to /doc/source/development/contributing.rst * fix for BUG: grouping with tz-aware: Values falls after last bin (pandas-dev#24973) * REGR: Preserve order by default in Index.difference (pandas-dev#24967) Closes pandas-dev#24959 * CLN: do not use .repeat asv setting for storing benchmark data (pandas-dev#25015) * CLN: isort asv_bench/benchmark/algorithms.py (pandas-dev#24958) * fix+test to_timedelta('NaT', box=False) (pandas-dev#24961) * PERF: significant speedup in sparse init and ops by using numpy in check_integrity (pandas-dev#24985) * BUG: Fixed merging on tz-aware (pandas-dev#25033) * Test nested PandasArray (pandas-dev#24993) * DOC: fix error in documentation pandas-dev#24981 (pandas-dev#25038) * BUG: support dtypes in column_dtypes for to_records() (pandas-dev#24895) * Makes example from docstring work (pandas-dev#25035) * CLN: typo fixups (pandas-dev#25028) * BUG: to_datetime(strs, utc=True) used previous UTC offset (pandas-dev#25020) * BUG: Better handle larger numbers in to_numeric (pandas-dev#24956) * BUG: Better handle larger numbers in to_numeric * Warn about lossiness when passing really large numbers that exceed (u)int64 ranges. * Coerce negative numbers to float when requested instead of crashing and returning object. * Consistently parse numbers as integers / floats, even if we know that the resulting container has to be float. This is to ensure consistent error behavior when inputs numbers are too large. Closes pandas-devgh-24910. * MAINT: Address comments * BUG: avoid usage in_qtconsole for recent IPython versions (pandas-dev#25039) * Drop IPython<4.0 compat * Revert "Drop IPython<4.0 compat" This reverts commit 0cb0452. * update a * whatsnew * REGR: fix read_sql delegation for queries on MySQL/pymysql (pandas-dev#25024) * DOC: Start 0.24.2.rst (pandas-dev#25026) [ci skip] * REGR: rename_axis with None should remove axis name (pandas-dev#25069) * clarified the documentation for DF.drop_duplicates (pandas-dev#25056) * Clarification in docstring of Series.value_counts (pandas-dev#25062) * ENH: Support fold argument in Timestamp.replace (pandas-dev#25046) * CLN: to_pickle internals (pandas-dev#25044) * Implement+Test Tick.__rtruediv__ (pandas-dev#24832) * API: change Index set ops sort=True -> sort=None (pandas-dev#25063) * BUG: to_clipboard text truncated for Python 3 on Windows for UTF-16 text (pandas-dev#25040) * PERF: use new to_records() argument in to_stata() (pandas-dev#25045) * DOC: Cleanup 0.24.1 whatsnew (pandas-dev#25084) * Fix quotes position in pandas.core, typos and misspelled parameters. (pandas-dev#25093) * CLN: Remove sentinel_factory() in favor of object() (pandas-dev#25074) * TST: remove DST transition scenarios from tc pandas-dev#24689 (pandas-dev#24736) * BLD: remove spellcheck from Makefile (pandas-dev#25111) * DOC: small clean-up of 0.24.1 whatsnew (pandas-dev#25096) * DOC: small doc fix to Series.repeat (pandas-dev#25115) * TST: tests for categorical apply (pandas-dev#25095) * CLN: use dtype in constructor (pandas-dev#25098) * DOC: frame.py doctest fixing (pandas-dev#25097) * DOC: 0.24.1 release (pandas-dev#25125) [ci skip] * Revert set_index inspection/error handling for 0.24.1 (pandas-dev#25085) * DOC: Minor what's new fix (pandas-dev#24933) * Backport PR pandas-dev#24916: BUG-24212 fix regression in pandas-dev#24897 (pandas-dev#24951) * Revert "Backport PR pandas-dev#24916: BUG-24212 fix regression in pandas-dev#24897 (pandas-dev#24951)" This reverts commit 84056c5. * DOC/CLN: Timezone section in timeseries.rst (pandas-dev#24825) * DOC: Improve timezone documentation in timeseries.rst * edit some of the examples * Address review * DOC: Fix validation type error RT04 (pandas-dev#25107) (pandas-dev#25129) * Reading a HDF5 created in py2 (pandas-dev#25058) * BUG: Fixing regression in DataFrame.all and DataFrame.any with bool_only=True (pandas-dev#25102) * Removal of return variable names (pandas-dev#25123) * DOC: Improve docstring of Series.mul (pandas-dev#25136) * TST/REF: collect DataFrame reduction tests (pandas-dev#24914) * Fix validation error type `SS05` and check in CI (pandas-dev#25133) * Fixed tuple to List Conversion in Dataframe class (pandas-dev#25089) * STY: use pytest.raises context manager (indexes/multi) (pandas-dev#25175) * DOC: Updates to Timestamp document (pandas-dev#25163) * BLD: pin cython language level to '2' (pandas-dev#25145) Not explicitly pinning the language level has been producing future warnings from cython. The next release of cython is going to change the default level to '3str' under which the pandas cython extensions do not compile. The long term solution is to update the cython files to the next language level, but this is a stop-gap to keep pandas building. * CLN: Use ABCs in set_index (pandas-dev#25128) * DOC: update docstring for series.nunique (pandas-dev#25116) * DEPR: remove PanelGroupBy, disable DataFrame.to_panel (pandas-dev#25047) * BUG: DataFrame.merge(suffixes=) does not respect None (pandas-dev#24819) * fix MacPython pandas-wheels failure (pandas-dev#25186) * modernize compat imports (pandas-dev#25192) * TST: follow-up to Test nested pandas array pandas-dev#24993 (pandas-dev#25155) * revert changes to tests in pandas-devgh-24993 * Test nested PandasArray * isort test_numpy.py * change NP_VERSION_INFO * use LooseVersion * add _np_version_under1p16 * remove blank line from merge master * add doctstrings to fixtures * DOC/CLN: Fix errors in Series docstrings (pandas-dev#24945) * REF: Add more pytest idiom to test_holiday.py (pandas-dev#25204) * DOC: Fix validation type error SA05 (pandas-dev#25208) Create check for SA05 errors in CI * BUG: Fix Series.is_unique with single occurrence of NaN (pandas-dev#25182) * REF: Remove many Panel tests (pandas-dev#25191) * DOC: Fixes to docstrings and add PR10 (space before colon) to validation (pandas-dev#25109) * DOC: exclude autogenerated c/cpp/html files from 'trailing whitespace' checks (pandas-dev#24549) * STY: use pytest.raises context manager (indexes/period) (pandas-dev#25199) * fix ci failures (pandas-dev#25225) * DEPR: remove tm.makePanel and all usages (pandas-dev#25231) * DEPR: Remove Panel-specific parts of io.pytables (pandas-dev#25233) * DEPR: Add Deprecated warning for timedelta with passed units M and Y (pandas-dev#23264) * BUG-25061 fix printing indices with NaNs (pandas-dev#25202) * BUG: Fix regression in DataFrame.apply causing RecursionError (pandas-dev#25230) * BUG: Fix regression in DataFrame.apply causing RecursionError * Add feedback from PR * Add feedback after further code review * Add feedback after further code review 2 * BUG: Fix read_json orient='table' without index (pandas-dev#25170) (pandas-dev#25171) * BLD: prevent asv from calling sys.stdin.close() by using different launch method (pandas-dev#25237) * (Closes pandas-dev#25029) Removed extra bracket from cheatsheet code example. (pandas-dev#25032) * CLN: For loops, boolean conditions, misc. (pandas-dev#25206) * Refactor groupby group_add from tempita to fused types (pandas-dev#24954) * CLN: Remove ipython 2.x compat (pandas-dev#25150) * CLN: Remove ipython 2.x compat * trivial change to trigger asv * Update v0.25.0.rst * revert whatsnew * BUG: Duplicated returns boolean dataframe (pandas-dev#25234) * REF/TST: resample/test_base.py (pandas-dev#25262) * Revert "BLD: prevent asv from calling sys.stdin.close() by using different launch method (pandas-dev#25237)" (pandas-dev#25253) This reverts commit f67b7fd. * BUG: pandas Timestamp tz_localize and tz_convert do not preserve `freq` attribute (pandas-dev#25247) * DEPR: remove assert_panel_equal (pandas-dev#25238) * PR04 errors fix (pandas-dev#25157) * Split Excel IO Into Sub-Directory (pandas-dev#25153) * API: Ensure DatetimeTZDtype standardizes pytz timezones (pandas-dev#25254) * API: Ensure DatetimeTZDtype standardizes pytz timezones * Add whatsnew * BUG: Fix exceptions when Series.interpolate's `order` parameter is missing or invalid (pandas-dev#25246) * BUG: raise accurate exception from Series.interpolate (pandas-dev#24014) * Actually validate `order` before use in spline * Remove unnecessary check and dead code * Clean up comparison/tests based on feedback * Include invalid order value in exception * Check for NaN order in spline validation * Add whatsnew entry for bug fix * CLN: Make unit tests assert one error at a time * CLN: break test into distinct test case * PEP8 fix in test module * CLN: Test fixture for interpolate methods * BUG: DataFrame.join on tz-aware DatetimeIndex (pandas-dev#25260) * REF: use _constructor and ABCFoo to avoid runtime imports (pandas-dev#25272) * Refactor groupby group_prod, group_var, group_mean, group_ohlc (pandas-dev#25249) * Fix typo in Cheat sheet with regex (pandas-dev#25215) * Edit parameter type in pandas.core.frame.py DataFrame.count (pandas-dev#25198) * TST/CLN: remove test_slice_ints_with_floats_raises (pandas-dev#25277) * Removed Panel class from HDF ASVs (pandas-dev#25281) * DOC: Fix minor typo in docstring (pandas-dev#25285) * DOC/CLN: Fix errors in DataFrame docstrings (pandas-dev#24952) * Skipped broken Py2 / Windows test (pandas-dev#25323) * Rt05 documentation error fix issue 25108 (pandas-dev#25309) * Fix typos in docs (pandas-dev#25305) * Doc: corrects spelling in generic.py (pandas-dev#25333) * BUG: groupby.transform retains timezone information (pandas-dev#25264) * Fixes Formatting Exception (pandas-dev#25088) * Bug: OverflowError in resample.agg with tz data (pandas-dev#25297) * DOC/CLN: Fix various docstring errors (pandas-dev#25295) * COMPAT: alias .to_numpy() for timestamp and timedelta scalars (pandas-dev#25142) * ENH: Support times with timezones in at_time (pandas-dev#25280) * BUG: Fix passing of numeric_only argument for categorical reduce (pandas-dev#25304) * TST: use a fixed seed to have the same uniques across python versions (pandas-dev#25346) TST: add pytest-mock to handle mocker fixture * TST: xfail excel styler tests, xref GH25351 (pandas-dev#25352) * TST: xfail excel styler tests, xref GH25351 * CI: cleanup .c files for cpplint>1.4 * DOC: Correct doc mistake in combiner func (pandas-dev#25360) Closes pandas-devgh-25359. * DOC/BLD: fix --no-api option (pandas-dev#25209) * DOC: modify typos in Contributing section (pandas-dev#25365) * Remove spurious MultiIndex creation in `_set_axis_name` (pandas-dev#25371) * Resovles pandas-dev#25370 * Introduced by pandas-dev#22969 * pandas-dev#23049: test for Fatal Stack Overflow stemming From Misuse of astype('category') (pandas-dev#25366) * 9236: test for the DataFrame.groupby with MultiIndex having pd.NaT (pandas-dev#25310) * [BUG] exception handling of MultiIndex.__contains__ too narrow (pandas-dev#25268) * 14873: test for groupby.agg coercing booleans (pandas-dev#25327) * BUG/ENH: Timestamp.strptime (pandas-dev#25124) * BUG: constructor Timestamp.strptime() does not support %z. * Add doc string to NaT and Timestamp * updated the error message * Updated whatsnew entry. * Interval dtype fix (pandas-dev#25338) * [CLN] Excel Module Cleanups (pandas-dev#25275) Closes pandas-devgh-25153 Authored-By: tdamsma <tdamsma@gmail.com> * ENH: indexing and __getitem__ of dataframe and series accept zerodim integer np.array as int (pandas-dev#24924) * REGR: fix TimedeltaIndex sum and datetime subtraction with NaT (pandas-dev#25282, pandas-dev#25317) (pandas-dev#25329) * edited whatsnew typo (pandas-dev#25381) * fix typo of see also in DataFrame stat funcs (pandas-dev#25388) * API: more consistent error message for MultiIndex.from_arrays (pandas-dev#25189) * CLN: (re-)enable infer_dtype to catch complex (pandas-dev#25382) * DOC: Edited docstring of Interval (pandas-dev#25410) The docstring contained a repeated segment, which I removed. * Mark test_pct_max_many_rows as high memory (pandas-dev#25400) Fixes issue pandas-dev#25384 * Correct a typo of version number for interpolate() (pandas-dev#25418) * DEP: add pytest-mock to environment.yml (pandas-dev#25417) * BUG: Fix type coercion in read_json orient='table' (pandas-dev#21345) (pandas-dev#25219) * ERR: doc update for ParsingError (pandas-dev#25414) Closes pandas-devgh-22881 * ENH: Add in sort keyword to DatetimeIndex.union (pandas-dev#25110) * DOC: Rewriting of ParserError doc + minor spacing (pandas-dev#25421) Follow-up to pandas-devgh-25414. * API/ERR: allow iterators in df.set_index & improve errors (pandas-dev#24984) * BUG: Indexing with UTC offset string no longer ignored (pandas-dev#25263) * PERF/REF: improve performance of Series.searchsorted, PandasArray.searchsorted, collect functionality (pandas-dev#22034) * TST: remove never-used singleton fixtures (pandas-dev#24885) * BUG: fixed merging with empty frame containing an Int64 column (pandas-dev#25183) (pandas-dev#25289) * DOC: fixed geo accessor example in extending.rst (pandas-dev#25420) I realised "lon" and "lat" had just been switched with "longitude" and "latitude" in the following code block. So I used those names here as well. * TST: numpy RuntimeWarning with Series.round() (pandas-dev#25432) * CI: add __init__.py to isort skip list (pandas-dev#25455) * DOC: CategoricalIndex doc string (pandas-dev#24852) * DataFrame.drop Raises KeyError definition (pandas-dev#25474) * BUG: Keep column level name in resample nunique (pandas-dev#25469) Closes pandas-devgh-23222 xref pandas-devgh-23645 * ERR: Correct error message in to_datetime (pandas-dev#25467) * ERR: Correct error message in to_datetime Closes pandas-devgh-23830 xref pandas-devgh-23969 * Fix minor typo (pandas-dev#25458) Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * CI: Set pytest minversion to 4.0.2 (pandas-dev#25402) * CI: Set pytest minversion to 4.0.2 * STY: use pytest.raises context manager (indexes) (pandas-dev#25447) * STY: use pytest.raises context manager (tests/test_*) (pandas-dev#25452) * STY: use pytest.raises context manager (tests/test_*) * fix ci failures * skip py2 ci failure * Fix minor error in dynamic load function (pandas-dev#25256) * Cythonized GroupBy Quantile (pandas-dev#20405) * BUG: Fix regression on DataFrame.replace for regex (pandas-dev#25266) * BUG: Fix regression on DataFrame.replace for regex The commit ensures that the replacement for regex is not confined to the beginning of the string but spans all the characters within. The behaviour is then consistent with versions prior to 0.24.0. One test has been added to account for character replacement when the character is not at the beginning of the string. * Correct contribution guide docbuild instruction (pandas-dev#25479) * TST/REF: Add pytest idiom to test_frequencies.py (pandas-dev#25430) * BUG: Fix index type casting in read_json with orient='table' and float index (pandas-dev#25433) (pandas-dev#25434) * BUG: Groupby.agg with reduction function with tz aware data (pandas-dev#25308) * BUG: Groupby.agg cannot reduce with tz aware data * Handle output always as UTC * Add whatsnew * isort and add another fixed groupby.first/last issue * bring condition at a higher level * Add try for _try_cast * Add comments * Don't pass the utc_dtype explicitly * Remove unused import * Use string dtype instead * DOC: Fix docstring for read_sql_table (pandas-dev#25465) * ENH: Add Series.str.casefold (pandas-dev#25419) * Fix PR10 error and Clean up docstrings from functions related to RT05 errors (pandas-dev#25132) * Fix unreliable test (pandas-dev#25496) * DOC: Clarifying doc/make.py --single parameter (pandas-dev#25482) * fix MacPython / pandas-wheels ci failures (pandas-dev#25505) * DOC: Reword Series.interpolate docstring for clarity (pandas-dev#25491) * Changed insertion order to sys.path (pandas-dev#25486) * TST: xfail non-writeable pytables tests with numpy 1.16x (pandas-dev#25517) * STY: use pytest.raises context manager (arithmetic, arrays, computati… (pandas-dev#25504) * BUG: Fix RecursionError during IntervalTree construction (pandas-dev#25498) * STY: use pytest.raises context manager (plotting, reductions, scalar...) (pandas-dev#25483) * STY: use pytest.raises context manager (plotting, reductions, scalar...) * revert removed testing in test_timedelta.py * remove TODO from test_frame.py * skip py2 ci failure * BUG: Fix potential segfault after pd.Categorical(pd.Series(...), categories=...) (pandas-dev#25368) * Make DataFrame.to_html output full content (pandas-dev#24841) * BUG-16807-1 SparseFrame fills with default_fill_value if data is None (pandas-dev#24842) Closes pandas-devgh-16807. * DOC: Add conda uninstall pandas to contributing guide (pandas-dev#25490) * fix pandas-dev#25487 add modify documentation * fix segfault when running with cython coverage enabled, xref cython#2879 (pandas-dev#25529) * TST: inline empty_frame = DataFrame({}) fixture (pandas-dev#24886) * DOC: Polishing typos out of doc/source/user_guide/indexing.rst (pandas-dev#25528) * STY: use pytest.raises context manager (frame) (pandas-dev#25516) * DOC: Fix pandas-dev#24268 by updating description for keep in Series.nlargest (pandas-dev#25358) * DOC: Fix pandas-dev#24268 by updating description for keep * fix MacPython / pandas-wheels ci failures (pandas-dev#25537) * TST/CLN: Remove more Panel tests (pandas-dev#25550) * BUG: caught typeError in series.at (pandas-dev#25506) (pandas-dev#25533) * ENH: Add errors parameter to DataFrame.rename (pandas-dev#25535) * ENH: GH13473 Add errors parameter to DataFrame.rename * TST: Skip IntervalTree construction overflow test on 32bit (pandas-dev#25558) * DOC: Small fixes to 0.24.2 whatsnew (pandas-dev#25559) * minor typo error (pandas-dev#25574) * BUG: in error message raised when invalid axis parameter (pandas-dev#25553) * BLD: Fixed pip install with no numpy (pandas-dev#25568) * Document the behavior of `axis=None` with `style.background_gradient` (pandas-dev#25551) * fix minor typos in dsintro.rst (pandas-dev#25579) * BUG: Handle readonly arrays in period_array (pandas-dev#25556) * BUG: Handle readonly arrays in period_array Closes pandas-dev#25403 * DOC: Fix typo in tz_localize (pandas-dev#25598) * BUG: secondary y axis could not be set to log scale (pandas-dev#25545) (pandas-dev#25586) * TST: add test for groupby on list of empty list (pandas-dev#25589) * TYPING: Small fixes to make stubgen happy (pandas-dev#25576) * CLN: Parmeterize test cases (pandas-dev#25355)

jbrockmendel · 2020-05-09T01:12:11Z

pandas/tests/indexes/multi/test_set_ops.py

+
+@pytest.mark.xfail(reason="Not implemented.")
+def test_difference_sort_special_true():
+    # TODO decide on True behaviour


@TomAugspurger thoughts on what it would take to reach a conclusion about this? worth adding to the agenda for next week? I think without a specific effort this is liable to stay failing indefinitely

Perhaps I misunderstand, but should the expected result be the current result with .sort_values() called on it?

TomAugspurger and others added 16 commits January 29, 2019 11:59

[WIP]: API: Change default for Index.union sort

aac172c

Closes pandas-dev#24959

update test

d4bcc55

fixups

45c827c

Merge remote-tracking branch 'upstream/master' into 24959-union-default

68b72a6

multi

8716f97

doc typo

f7056d5

intersection

e82cbb1

whatsnew

2a2de25

update whatsnew

5c3da74

Merge remote-tracking branch 'upstream/master' into 24959-union-default

ce6d1db

symdiff

52a2f2f

whatsnew

bb848f1

doc

b15dc7e

index multi

27b5b16

Change True to None; disallow True

1564d4f

fix concat tests

cb54640

pep8

05a0ed0

TomAugspurger reviewed Jan 31, 2019

View reviewed changes

TomAugspurger added this to the 0.24.1 milestone Jan 31, 2019

keep inconsistent behaviour for MultiIndex.difference

5e1b831

docstring updates

32a5966

jorisvandenbossche added 2 commits January 31, 2019 22:49

fix linting + catch remaining RuntimeWarning

d234a1d

more linting

260aba2

TomAugspurger approved these changes Feb 1, 2019

View reviewed changes

jreback requested changes Feb 1, 2019

View reviewed changes

doc/source/whatsnew/v0.24.1.rst Outdated Show resolved Hide resolved

pandas/tests/indexes/multi/test_set_ops.py Show resolved Hide resolved

pandas/tests/indexes/multi/test_set_ops.py Show resolved Hide resolved

pandas/tests/indexes/test_base.py Show resolved Hide resolved

TomAugspurger added 2 commits February 1, 2019 12:56

update whatsnew

41c24f0

xfail trues

2e181ac

jreback added API Design Deprecate Functionality to remove in pandas labels Feb 1, 2019

jreback approved these changes Feb 1, 2019

View reviewed changes

h-vetinari reviewed Feb 1, 2019

View reviewed changes

fixup [ci skip]

1c5a037

TomAugspurger merged commit 25ff472 into pandas-dev:master Feb 1, 2019

meeseeksmachine pushed a commit to meeseeksmachine/pandas that referenced this pull request Feb 1, 2019

Backport PR pandas-dev#25063: API: change Index set ops sort=True -> …

570cabd

…sort=None

meeseeksmachine mentioned this pull request Feb 1, 2019

Backport PR #25063 on branch 0.24.x (API: change Index set ops sort=True -> sort=None) #25083

Merged

TomAugspurger pushed a commit that referenced this pull request Feb 1, 2019

Backport PR #25063: API: change Index set ops sort=True -> sort=None (#…

c24df00

…25083)

jorisvandenbossche deleted the TomAugspurger-24959-union-default_0241 branch February 2, 2019 10:10

reidy-p mentioned this pull request Feb 3, 2019

ENH: Add in sort keyword to DatetimeIndex.union #25110

Merged

4 tasks

TomAugspurger mentioned this pull request Feb 4, 2019

Implement sort=True for Index setops #25151

Closed

Pingviinituutti pushed a commit to Pingviinituutti/pandas that referenced this pull request Feb 28, 2019

API: change Index set ops sort=True -> sort=None (pandas-dev#25063)

950e852

Pingviinituutti pushed a commit to Pingviinituutti/pandas that referenced this pull request Feb 28, 2019

API: change Index set ops sort=True -> sort=None (pandas-dev#25063)

1574efa

jbrockmendel reviewed May 9, 2020

View reviewed changes

jbrockmendel mentioned this pull request Mar 25, 2023

API: Index.intersection sort keyword default different from other set methods #51351

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

API: change Index set ops sort=True -> sort=None #25063

API: change Index set ops sort=True -> sort=None #25063

jorisvandenbossche commented Jan 31, 2019 •

edited by TomAugspurger

Loading

pep8speaks commented Jan 31, 2019 •

edited

Loading

TomAugspurger Jan 31, 2019

jorisvandenbossche Jan 31, 2019

codecov bot commented Jan 31, 2019

codecov bot commented Jan 31, 2019 •

edited

Loading

jorisvandenbossche commented Jan 31, 2019

TomAugspurger commented Jan 31, 2019

jorisvandenbossche commented Feb 1, 2019

TomAugspurger left a comment

TomAugspurger Feb 1, 2019

TomAugspurger Feb 1, 2019

jreback left a comment

TomAugspurger commented Feb 1, 2019

jreback commented Feb 1, 2019

h-vetinari left a comment

h-vetinari Feb 1, 2019 •

edited

Loading

TomAugspurger Feb 1, 2019

h-vetinari Feb 1, 2019 •

edited

Loading

TomAugspurger commented Feb 1, 2019

jbrockmendel May 9, 2020

TomAugspurger May 11, 2020

	This change will allow to preserve ``sort=True`` to mean "always sort" in a future release.
	This change will allow ``sort=True`` to mean "always sort" in a future release.

API: change Index set ops sort=True -> sort=None #25063

API: change Index set ops sort=True -> sort=None #25063

Conversation

jorisvandenbossche commented Jan 31, 2019 • edited by TomAugspurger Loading

pep8speaks commented Jan 31, 2019 • edited Loading

Comment last updated on February 01, 2019 at 20:06 Hours UTC

TomAugspurger Jan 31, 2019

Choose a reason for hiding this comment

jorisvandenbossche Jan 31, 2019

Choose a reason for hiding this comment

codecov bot commented Jan 31, 2019

Codecov Report

codecov bot commented Jan 31, 2019 • edited Loading

Codecov Report

jorisvandenbossche commented Jan 31, 2019

TomAugspurger commented Jan 31, 2019

jorisvandenbossche commented Feb 1, 2019

TomAugspurger left a comment

Choose a reason for hiding this comment

TomAugspurger Feb 1, 2019

Choose a reason for hiding this comment

TomAugspurger Feb 1, 2019

Choose a reason for hiding this comment

jreback left a comment

Choose a reason for hiding this comment

TomAugspurger commented Feb 1, 2019

jreback commented Feb 1, 2019

h-vetinari left a comment

Choose a reason for hiding this comment

h-vetinari Feb 1, 2019 • edited Loading

Choose a reason for hiding this comment

TomAugspurger Feb 1, 2019

Choose a reason for hiding this comment

h-vetinari Feb 1, 2019 • edited Loading

Choose a reason for hiding this comment

TomAugspurger commented Feb 1, 2019

jbrockmendel May 9, 2020

Choose a reason for hiding this comment

TomAugspurger May 11, 2020

Choose a reason for hiding this comment

jorisvandenbossche commented Jan 31, 2019 •

edited by TomAugspurger

Loading

pep8speaks commented Jan 31, 2019 •

edited

Loading

codecov bot commented Jan 31, 2019 •

edited

Loading

h-vetinari Feb 1, 2019 •

edited

Loading

h-vetinari Feb 1, 2019 •

edited

Loading