Add diff() and round() methods for Index and a test for each #52551

GrammatikakisDimitris · 2023-04-09T17:28:17Z

closes ENH: Index should have diff() method #19708
Tests added and passed if fixing a bug or adding a new feature
All code checks passed.
Added type annotations to new arguments/methods/functions.
Added an entry in the latest doc/source/whatsnew/vX.X.X.rst file if fixing a bug or adding a new feature.

mroeschke · 2023-04-10T18:00:26Z

pandas/core/indexes/base.py

+        If periods is greater than 1, computes the difference between values that
+        are `periods` number of positions apart.
+
+        Parameters:


Looks the formatting here is off

mroeschke · 2023-04-10T18:01:06Z

pandas/tests/indexes/test_base.py

+        # GH#19708
+        idx = Index([10, 20, 30, 40, 50])
+        diffs = idx.diff()
+        diffs_period2 = idx.diff(periods=2)


Could you use pytest.mark.parameterize to test different periods?

Would you like pytest.mark.parametrize for the round_test as well?

mroeschke · 2023-04-10T18:01:33Z

pandas/tests/indexes/test_base.py

+        diffs = idx.diff()
+        diffs_period2 = idx.diff(periods=2)
+
+        assert diffs.equals(Index([np.nan, 10, 10, 10, 10]))


Could you make an expected = variable and then call tm.assert_index_equal(result, expected)?

mroeschke · 2023-04-10T20:41:08Z

pandas/tests/indexes/test_base.py

+    @pytest.mark.parametrize(
+        "periods, expected",
+        [
+            (1, Index([np.nan, 10, 10, 10, 10])),


Could you move the Index call to the body of the test (same as below)

GrammatikakisDimitris · 2023-04-11T07:30:56Z

Forgot to pass parameters periods and decimals in the call of the functions, i will fix this.

pandas/core/indexes/base.py

mroeschke · 2023-04-11T16:50:09Z

pandas/core/indexes/base.py

+            A new Index object with the computed differences.
+
+        """
+        return Index(self.to_series().diff(periods))


Suggested change

return Index(self.to_series().diff(periods))

return self._constructor(self.to_series().diff(periods))

mroeschke · 2023-04-11T16:50:24Z

pandas/core/indexes/base.py

+            A new Index with the rounded values.
+
+        """
+        return Index(self.to_series().round(decimals))


Suggested change

return Index(self.to_series().round(decimals))

return self._constructor(self.to_series().round(decimals))

mroeschke · 2023-04-11T20:46:31Z

pandas/core/indexes/base.py

+        >>> diff_idx = idx.diff()
+        >>> print(diff_idx)


Suggested change

>>> diff_idx = idx.diff()

>>> print(diff_idx)

>>> idx.diff()

mroeschke · 2023-04-11T20:46:49Z

pandas/core/indexes/base.py

+        >>> print(diff_idx)
+        Index([nan, 10.0, 10.0, 10.0, 10.0], dtype='float64')
+
+        This example creates a new `Index` object `idx` with values


The rest of this explanation is not needed

mroeschke · 2023-04-11T20:47:05Z

pandas/core/indexes/base.py

+        Example
+        -------


Suggested change

Example

-------

Examples

--------

mroeschke · 2023-04-11T20:47:20Z

pandas/core/indexes/base.py

+        >>> rounded_idx = idx.round(decimals=2)
+        >>> print(rounded_idx)


Suggested change

>>> rounded_idx = idx.round(decimals=2)

>>> print(rounded_idx)

>>> idx.round(decimals=2)

pandas/core/indexes/base.py

mroeschke · 2023-04-11T20:47:48Z

pandas/core/indexes/base.py

+        Example
+        -------


Suggested change

Example

-------

Examples

--------

mroeschke

Looks good. Could you add a whatsnew entry in v2.1.0.rst?

GrammatikakisDimitris · 2023-04-13T01:30:58Z

What should i do about the conflict?

mroeschke · 2023-04-13T01:32:11Z

The conflict should be resolved without removing someone else's contribution

GrammatikakisDimitris · 2023-04-13T11:13:08Z

Sorry for the mess, i pulled all the changes to fix the conflict. If you like i can open a new PR.

mroeschke · 2023-04-14T23:20:51Z

I think all you need to do is

git fetch upstream
git merge upstream/main

into this branch

mroeschke · 2023-04-17T17:25:08Z

Thanks @GrammatikakisDimitris

GrammatikakisDimitris added 3 commits April 9, 2023 20:25

Add diff() and round() methods for Index and a test for each

f18e96b

Fix code style

c6b63d2

Fix code style

6329f8c

mroeschke reviewed Apr 10, 2023

View reviewed changes

mroeschke added Enhancement Index Related to the Index class or subclasses labels Apr 10, 2023

mroeschke reviewed Apr 10, 2023

View reviewed changes

GrammatikakisDimitris added 2 commits April 10, 2023 23:34

Add pytest.mark.parametrize and fix docstring style

3ce1f72

Move Index call

57032c9

GrammatikakisDimitris added 5 commits April 11, 2023 12:04

Fix diff() and round() call

9f46805

Change Index to float

76742e4

Fix docstring style

1eeab2a

Fix docstring style

fe713fd

Fix pre-commit errors

837ab45

mroeschke reviewed Apr 11, 2023

View reviewed changes

pandas/core/indexes/base.py Show resolved Hide resolved

mroeschke reviewed Apr 11, 2023

View reviewed changes

pandas/core/indexes/base.py Show resolved Hide resolved

mroeschke reviewed Apr 11, 2023

View reviewed changes

GrammatikakisDimitris added 3 commits April 11, 2023 20:49

Add example section in docstring and change return statement

8925aba

Fix docstring example section

7390230

Fix docstring

8cce642

mroeschke reviewed Apr 12, 2023

View reviewed changes

GrammatikakisDimitris added 18 commits April 13, 2023 13:37

Add diff() and round() methods for Index and a test for each

06b8ff8

Fix code style

bedf16d

Fix code style

61086a6

Add pytest.mark.parametrize and fix docstring style

364ae36

Move Index call

3f56973

Fix diff() and round() call

d96196d

Change Index to float

5a65334

Fix docstring style

db30757

Fix docstring style

2b105e9

Fix pre-commit errors

47e9866

Add example section in docstring and change return statement

69d32f7

Fix docstring example section

5475c37

Fix docstring

960540c

Add whatsnew in v2.1.0.rst

e79323f

Fix whatsnew entry

cea737a

Resolve conflict

ca5cd93

Add whatsnew entry

600d46b

Fix whatsnew entry

431c4b2

GrammatikakisDimitris added 2 commits April 15, 2023 11:55

Merge remote-tracking branch 'upstream/main' into pandas_branch_1

56d92af

Add blank line in v2.1.0.rst

a428bc8

mroeschke approved these changes Apr 17, 2023

View reviewed changes

mroeschke added this to the 2.1 milestone Apr 17, 2023

mroeschke merged commit 1567d9e into pandas-dev:main Apr 17, 2023

pierre-haessig mentioned this pull request Oct 30, 2023

BUG: DatetimeIndex.diff() broken (dtype timedelta64[ns] cannot be converted to datetime64[ns]) #55752

Closed

3 tasks

lukemanley mentioned this pull request Oct 31, 2023

BUG: DatetimeIndex.diff raising TypeError #55761

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add diff() and round() methods for Index and a test for each #52551

Add diff() and round() methods for Index and a test for each #52551

GrammatikakisDimitris commented Apr 9, 2023 •

edited

Loading

mroeschke Apr 10, 2023

mroeschke Apr 10, 2023

GrammatikakisDimitris Apr 10, 2023

mroeschke Apr 10, 2023

mroeschke Apr 10, 2023

mroeschke Apr 10, 2023

GrammatikakisDimitris commented Apr 11, 2023

mroeschke Apr 11, 2023

mroeschke Apr 11, 2023

GrammatikakisDimitris Apr 11, 2023

mroeschke Apr 11, 2023

mroeschke Apr 11, 2023

mroeschke Apr 11, 2023

mroeschke Apr 11, 2023

mroeschke Apr 11, 2023

mroeschke left a comment

GrammatikakisDimitris commented Apr 13, 2023

mroeschke commented Apr 13, 2023

GrammatikakisDimitris commented Apr 13, 2023

mroeschke commented Apr 14, 2023

mroeschke commented Apr 17, 2023

	return Index(self.to_series().diff(periods))
	return self._constructor(self.to_series().diff(periods))

	return Index(self.to_series().round(decimals))
	return self._constructor(self.to_series().round(decimals))

-        Example
-        -------
+        Examples
+        --------

		>>> rounded_idx = idx.round(decimals=2)
		>>> print(rounded_idx)

	>>> rounded_idx = idx.round(decimals=2)
	>>> print(rounded_idx)
	>>> idx.round(decimals=2)

Add diff() and round() methods for Index and a test for each #52551

Add diff() and round() methods for Index and a test for each #52551

Conversation

GrammatikakisDimitris commented Apr 9, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GrammatikakisDimitris commented Apr 11, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mroeschke left a comment

Choose a reason for hiding this comment

GrammatikakisDimitris commented Apr 13, 2023

mroeschke commented Apr 13, 2023

GrammatikakisDimitris commented Apr 13, 2023

mroeschke commented Apr 14, 2023

mroeschke commented Apr 17, 2023

GrammatikakisDimitris commented Apr 9, 2023 •

edited

Loading