pylint: disable invalid-repr-returned in Series.__repr__

[vamsi-verma-s]

• closed one of the issues in STYLE fix pylint issues #48855
• All code checks passed.

Since the params passed are for getting the repr string. This should not be an issue and to_string will return a str

[vamsi-verma-s]

Hi @MarcoGorelli

Will the cancelled test be re-run?

[MarcoGorelli]

yeah, don't worry about it - I'll take a look later in the week, curious to see if there's a way to avoid having to turn off the warning at all

[vamsi-verma-s]

This seems to solve the issue. Should we go for this?

Suggested change

	return self.to_string(**repr_params)
	return str(self.to_string(**repr_params)) # GH#49025

Also, self.to_string method has a validation to ensure only str values are returned.

pandas/pandas/core/series.py

Lines 1700 to 1709 in 2a0e3fe

	# catch contract violations
	if not isinstance(result, str):
	raise AssertionError(
	"result must be of type str, type "
	f"of result is {repr(type(result).__name__)}"
	)
	if buf is None:
	return result

[vamsi-verma-s]

Suggested change

# pylint: disable=invalid-repr-returned

[MarcoGorelli]

🤔 not sure what the issue is - if it's already string, I'd rather not add an unnecessary str( to please pylint. I'm surprised that no error is caught in frame.py in the same function. I'll take a look

[MarcoGorelli]

Looks like a bug in pylint, seems like just the presence of an overload throws it off

from __future__ import annotations

from typing import overload

class Foo:
    def __repr__(self) -> str:
        return self.foo()

    @overload
    def foo(self) -> str:
        ...

    def foo(self) -> str:
        return 'foo'

I'll report there - marking as draft for now then, once/if we can hear back we can move forwards

[MarcoGorelli]

Thanks @vamsi-verma-s , looks good to me pending green!

pylint linked my report to this issue pylint-dev/astroid#1015, which has been open since 2021, so I don't think it'll get addressed anytime soon

Happy to just turn off the check inline then

[mroeschke]

Thanks @vamsi-verma-s