CLN: enforce deprecation of the `method` keyword on `df.fillna` #57760

natmokval · 2024-03-07T09:45:25Z

enforced deprecation of the method keyword on df.fillna/ser.fillna

… fix tests

natmokval · 2024-03-08T16:57:46Z

I enforced deprecation of the method keyword on df.fillna/ser.fillna. We deprecated the method keyword on EA.fillna as well. Is it OK if I enforce this deprecation in separate PR?

@jbrockmendel, could you please take a look at this PR? I think CI failures are unrelated to my changes.

jbrockmendel · 2024-03-12T02:11:12Z

pandas/tests/series/methods/test_fillna.py

@@ -909,14 +893,14 @@ def test_bfill(self):
            [0.0, 1.0, 2.0, 3.0, 4.0], index=date_range("2020-01-01", periods=5)
        )
        ts.iloc[2] = np.nan
-        tm.assert_series_equal(ts.bfill(), ts.fillna(method="bfill"))
+        tm.assert_series_equal(ts.bfill(), ts.bfill())


this assertion looks no-longer-useful

same on L883

Thank you for reviewing this PR. I removed these useless tests.

jbrockmendel · 2024-03-12T02:11:55Z

pandas/tests/series/methods/test_fillna.py

@@ -809,7 +797,7 @@ def test_fillna_f32_upcast_with_dict(self):

    def test_fillna_invalid_method(self, datetime_series):
        try:
-            datetime_series.fillna(method="ffil")
+            datetime_series.ffill()


this is missing the point of the test

thanks, I removed the test

jbrockmendel · 2024-03-12T02:12:44Z

pandas/tests/frame/methods/test_replace.py

-            tm.assert_frame_equal(result, tsframe.fillna(method="bfill"))
+        # TODO: what is this even testing?
+        result = tsframe.bfill()
+        tm.assert_frame_equal(result, tsframe.bfill())


this is not a useful test (per the comment), can just be removed

mroeschke · 2024-03-12T17:55:08Z

pandas/core/generic.py

-                "instead.",
-                FutureWarning,
-                stacklevel=find_stack_level(),
+        if isinstance(value, (list, tuple)):


Could you check if we have a test where value is a np.array or pd.Series? Given the error message, I would expect this check to be something like if not (is_scalar(value) or isinstance(value, dict))

we have test_fillna_series in pandas/tests/extension/base/missing.py where we fill with a series

pandas/pandas/tests/extension/base/missing.py

Lines 123 to 141 in 3132971

def test_fillna_series(self, data_missing):

fill_value = data_missing[1]

ser = pd.Series(data_missing)

result = ser.fillna(fill_value)

expected = pd.Series(

data_missing._from_sequence(

[fill_value, fill_value], dtype=data_missing.dtype

)

)

tm.assert_series_equal(result, expected)

# Fill with a series

result = ser.fillna(expected)

tm.assert_series_equal(result, expected)

# Fill with a series not affecting the missing values

result = ser.fillna(ser)

tm.assert_series_equal(result, ser)

in pandas/tests/frame/methods/test_fillna.py I found test_fillna_invalid_value.

pandas/pandas/tests/frame/methods/test_fillna.py

Lines 563 to 577 in 97c31a6

def test_fillna_invalid_value(self, float_frame):

# list

msg = '"value" parameter must be a scalar or dict, but you passed a "{}"'

with pytest.raises(TypeError, match=msg.format("list")):

float_frame.fillna([1, 2])

# tuple

with pytest.raises(TypeError, match=msg.format("tuple")):

float_frame.fillna((1, 2))

# frame with series

msg = (

'"value" parameter must be a scalar, dict or Series, but you '

'passed a "DataFrame"'

)

with pytest.raises(TypeError, match=msg):

float_frame.iloc[:, 0].fillna(float_frame)

In this test we check if for value: list, tuple or DataFrame fillna raises TypeError.
We don't validate values: np.array and Series in this tests though. I checked, for examples below

df = DataFrame({"a": [1, None, 3]}) df.iloc[:, 0].fillna(value=np.array([1, 0]))

we get the TypeError: TypeError: "value" parameter must be a scalar, dict or Series, but you passed a "ndarray"

Should I add a check for np.array and maybe correct the condition in if statement?

Thanks for looking! Since we have a test with np.array and check that we're raising the error correctly so no need to add the check

mroeschke · 2024-03-14T16:19:25Z

Thanks @natmokval

natmokval · 2024-03-14T21:08:19Z

Thanks @mroeschke for reviewing this PR.

…as-dev#57760) * enforce deprecation of param method in df.fillna: correct def fillna, fix tests * correct def fillna, fix tests * correct an example in v0.10.0, fix test * add a note to v3.0.0 * remove an entry from ignored_doctest_warnings * fix pylint error in test_sparse.py * correct fillna docstring * correct fillna docstring II * correct tests

natmokval added 2 commits March 7, 2024 10:41

enforce deprecation of param method in df.fillna: correct def fillna,…

ddbe93b

… fix tests

correct def fillna, fix tests

9412e7f

natmokval added Clean Transformations e.g. cumsum, diff, rank labels Mar 7, 2024

natmokval added 2 commits March 8, 2024 01:17

correct an example in v0.10.0, fix test

a326ff3

add a note to v3.0.0

72a30a7

natmokval changed the title ~~CLN: enforce deprecation of param method in df.fillna~~ CLN: enforce deprecation of the method keyword on df.fillna Mar 8, 2024

remove an entry from ignored_doctest_warnings

8567e49

natmokval marked this pull request as ready for review March 8, 2024 00:31

natmokval added 3 commits March 8, 2024 11:45

fix pylint error in test_sparse.py

d14fdb2

correct fillna docstring

d452f62

correct fillna docstring II

c6490a2

natmokval requested a review from jbrockmendel March 8, 2024 16:59

jbrockmendel reviewed Mar 12, 2024

View reviewed changes

correct tests

c570619

mroeschke reviewed Mar 12, 2024

View reviewed changes

mroeschke added this to the 3.0 milestone Mar 14, 2024

mroeschke approved these changes Mar 14, 2024

View reviewed changes

mroeschke merged commit d2bf501 into pandas-dev:main Mar 14, 2024
47 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CLN: enforce deprecation of the `method` keyword on `df.fillna` #57760

CLN: enforce deprecation of the `method` keyword on `df.fillna` #57760

natmokval commented Mar 7, 2024 •

edited

Loading

natmokval commented Mar 8, 2024

jbrockmendel Mar 12, 2024

jbrockmendel Mar 12, 2024

natmokval Mar 12, 2024

jbrockmendel Mar 12, 2024

natmokval Mar 12, 2024

jbrockmendel Mar 12, 2024

natmokval Mar 12, 2024

mroeschke Mar 12, 2024

natmokval Mar 13, 2024 •

edited

Loading

natmokval Mar 14, 2024 •

edited

Loading

mroeschke Mar 14, 2024

mroeschke commented Mar 14, 2024

natmokval commented Mar 14, 2024

	def test_fillna_series(self, data_missing):
	fill_value = data_missing[1]
	ser = pd.Series(data_missing)

	result = ser.fillna(fill_value)
	expected = pd.Series(
	data_missing._from_sequence(
	[fill_value, fill_value], dtype=data_missing.dtype
	)
	)
	tm.assert_series_equal(result, expected)

	# Fill with a series
	result = ser.fillna(expected)
	tm.assert_series_equal(result, expected)

	# Fill with a series not affecting the missing values
	result = ser.fillna(ser)
	tm.assert_series_equal(result, ser)

	def test_fillna_invalid_value(self, float_frame):
	# list
	msg = '"value" parameter must be a scalar or dict, but you passed a "{}"'
	with pytest.raises(TypeError, match=msg.format("list")):
	float_frame.fillna([1, 2])
	# tuple
	with pytest.raises(TypeError, match=msg.format("tuple")):
	float_frame.fillna((1, 2))
	# frame with series
	msg = (
	'"value" parameter must be a scalar, dict or Series, but you '
	'passed a "DataFrame"'
	)
	with pytest.raises(TypeError, match=msg):
	float_frame.iloc[:, 0].fillna(float_frame)

CLN: enforce deprecation of the method keyword on df.fillna #57760

CLN: enforce deprecation of the method keyword on df.fillna #57760

Conversation

natmokval commented Mar 7, 2024 • edited Loading

natmokval commented Mar 8, 2024

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

natmokval Mar 13, 2024 • edited Loading

Choose a reason for hiding this comment

natmokval Mar 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mroeschke commented Mar 14, 2024

natmokval commented Mar 14, 2024

CLN: enforce deprecation of the `method` keyword on `df.fillna` #57760

CLN: enforce deprecation of the `method` keyword on `df.fillna` #57760

natmokval commented Mar 7, 2024 •

edited

Loading

natmokval Mar 13, 2024 •

edited

Loading

natmokval Mar 14, 2024 •

edited

Loading