Extend allowed dunder methods (PLW3201)

[bswck]

Opened as a followup to discussion at #9706.

Kudos to @AlexWaygood for scraping all dunders from CPython:

This is the set of dunders that were surfaced in my script and are not currently listed by ruff as excluded from this rule:

['__cmp__',
 '__conform__',
 '__getinitargs__',
 '__getitem_inner__',
 '__getslice__',
 '__import__',
 '__isabstractmethod__',
 '__members__',
 '__newobj__',
 '__newobj_ex__',
 '__nonzero__',
 '__parameters__',
 '__rich__',
 '__rich_console__',
 '__rich_measure__',
 '__rich_repr__',
 '__setslice__',
 '__signature__',
 '__tp_del__',
 '__typing_is_unpacked_typevartuple__',
 '__typing_unpacked_tuple_args__',
 '__unicode__',
 '__version__',
 '__wrapped__']

Most of them seem to be definitions in tests, internal implementation details that are undocumented, and/or leftovers from Python 2 that still haven't been cleaned up. The __rich_*__ ones are because I have rich installed in a venv inside my cpython local clone, I think?

I like that the script surfaced __import__ -- that's the literal definition of Python's import statement right there 😄

In my opinion, it would be useful to add __wrapped__ , __isabstractmethod__ and __signature__ to the list in case one wants to define those as properties (it's a niche use case though), especially since __class__ is in the list.
__rich_*__ should definitely be supported, a lot of critical tools & libraries have integrations with rich (including pip or Pydantic).

Some external libraries also implement their own dunders, such as pyarrow's __arrow_array__ used in pandas or __attrs_post_init__ from attrs (among others) which I can see being supported now.
How should we research and collect them? What criteria should we have?

[bswck]

Current list of known dunder methods:

ruff/crates/ruff_linter/src/rules/pylint/helpers.rs

Lines 205 to 337 in 541aef4

	"__abs__"
	| "__add__"
	| "__aenter__"
	| "__aexit__"
	| "__aiter__"
	| "__and__"
	| "__anext__"
	| "__attrs_init__"
	| "__attrs_post_init__"
	| "__attrs_pre_init__"
	| "__await__"
	| "__bool__"
	| "__buffer__"
	| "__bytes__"
	| "__call__"
	| "__ceil__"
	| "__class__"
	| "__class_getitem__"
	| "__complex__"
	| "__contains__"
	| "__copy__"
	| "__deepcopy__"
	| "__del__"
	| "__delattr__"
	| "__delete__"
	| "__delitem__"
	| "__dict__"
	| "__dir__"
	| "__divmod__"
	| "__doc__"
	| "__enter__"
	| "__eq__"
	| "__exit__"
	| "__float__"
	| "__floor__"
	| "__floordiv__"
	| "__format__"
	| "__fspath__"
	| "__ge__"
	| "__get__"
	| "__getattr__"
	| "__getattribute__"
	| "__getitem__"
	| "__getnewargs__"
	| "__getnewargs_ex__"
	| "__getstate__"
	| "__gt__"
	| "__hash__"
	| "__html__"
	| "__iadd__"
	| "__iand__"
	| "__ifloordiv__"
	| "__ilshift__"
	| "__imatmul__"
	| "__imod__"
	| "__imul__"
	| "__index__"
	| "__init__"
	| "__init_subclass__"
	| "__instancecheck__"
	| "__int__"
	| "__invert__"
	| "__ior__"
	| "__ipow__"
	| "__irshift__"
	| "__isub__"
	| "__iter__"
	| "__itruediv__"
	| "__ixor__"
	| "__le__"
	| "__len__"
	| "__length_hint__"
	| "__lshift__"
	| "__lt__"
	| "__matmul__"
	| "__missing__"
	| "__mod__"
	| "__module__"
	| "__mro_entries__"
	| "__mul__"
	| "__ne__"
	| "__neg__"
	| "__new__"
	| "__next__"
	| "__or__"
	| "__pos__"
	| "__post_init__"
	| "__pow__"
	| "__prepare__"
	| "__radd__"
	| "__rand__"
	| "__rdivmod__"
	| "__reduce__"
	| "__reduce_ex__"
	| "__release_buffer__"
	| "__repr__"
	| "__reversed__"
	| "__rfloordiv__"
	| "__rlshift__"
	| "__rmatmul__"
	| "__rmod__"
	| "__rmul__"
	| "__ror__"
	| "__round__"
	| "__rpow__"
	| "__rrshift__"
	| "__rshift__"
	| "__rsub__"
	| "__rtruediv__"
	| "__rxor__"
	| "__set__"
	| "__set_name__"
	| "__setattr__"
	| "__setitem__"
	| "__setstate__"
	| "__sizeof__"
	| "__str__"
	| "__sub__"
	| "__subclasscheck__"
	| "__subclasses__"
	| "__subclasshook__"
	| "__truediv__"
	| "__trunc__"
	| "__weakref__"
	| "__xor__"
	// Overridable sunder names from the `Enum` class.
	// See: https://docs.python.org/3/library/enum.html#supported-sunder-names
	| "_name_"
	| "_value_"
	| "_missing_"
	| "_ignore_"
	| "_order_"
	| "_generate_next_value_"

[AlexWaygood]

I feel like the __rich_*__ methods (and __arrow_array__ for PyArrow) would be good candidates for the tool.pylint.allow-dunder-method-names setting that you can use in your pyproject.toml file. I love rich, I think it's a fantastic library, but as a CPython core dev I have to point out that they are violating the contract specified by the Python reference documentation, which states that all dunders are reserved for use by CPython internals and the CPython standard library:

__*__

System-defined names, informally known as “dunder” names. These names are defined by the interpreter and its implementation (including the standard library). Current system names are discussed in the Special method names section and elsewhere. More will likely be defined in future versions of Python. Any use of __*__ names, in any context, that does not follow explicitly documented use, is subject to breakage without warning.

But having said that, I see we already include some third-party dunders in our list -- the __attrs_*__ dunders are all included :)

In my opinion, it would be useful to add __wrapped__ , __isabstractmethod__ and __signature__ to the list in case one wants to define those as properties (it's a niche use case though), especially since __class__ is in the list.

I have no objection to adding exemptions for these, since they're all ~public (some of them have less-than-ideal docs, but that's probably a CPython issue really). But I think they should only be allowed as properties -- defining them as methods would likely be a mistake. I see we treat methods decorated with @property exactly the same way as other methods for this rule currently -- do you happen to know if pylint does the same thing?