Add `bad-dunder-name` checker #7642

clavedeluna · 2022-10-17T18:45:08Z

Type of Changes

	Type
✓	✨ New feature

Description

The new bad-dunder-name checker flags any potentially misspelled known dunder name method and flags any method defined with _..._ that's not one of the pre-defined ones.

If you can think of more test cases, happy to add them.

Closes #3038

pylint/checkers/dunder_methods.py

tests/functional/b/bad_dunder_name.py

pylint/checkers/dunder_methods.py

coveralls · 2022-10-18T12:53:14Z

Pull Request Test Coverage Report for Build 3359652883

27 of 27 (100.0%) changed or added relevant lines in 3 files are covered.
21 unchanged lines in 2 files lost coverage.
Overall coverage increased (+0.02%) to 95.377%

Files with Coverage Reduction	New Missed Lines	%
pylint/extensions/docparams.py	2	98.51%
pylint/checkers/variables.py	19	97.43%

Totals
Change from base Build 3328032636:	0.02%
Covered Lines:	17205
Relevant Lines:	18039

💛 - Coveralls

Pierre-Sassoulas

It starts to look pretty good 👍

pylint/checkers/dunder_methods.py

tests/functional/a/arguments_differ.py

Pierre-Sassoulas · 2022-10-18T13:01:13Z

tests/functional/b/bad_dunder_name.py

+        # author likely unintentionally misspelled the correct init dunder.
+        pass
+
+    def _init_(self):


This would raise with the change suggested earlier, I think it make sense.

tests/functional/b/bad_dunder_name.py

pylint/checkers/dunder_methods.py

DanielNoord · 2022-10-18T21:14:57Z

I haven't followed discussion or review but was just triggered by the primer. Is this something for an extension? It seems many plugins and packages define non standard dunders (and that's technically allowed by the Python spec just without guarantee that it will always work).

clavedeluna · 2022-10-18T21:37:56Z

I haven't followed discussion or review but was just triggered by the primer. Is this something for an extension? It seems many plugins and packages define non standard dunders (and that's technically allowed by the Python spec just without guarantee that it will always work).

Ok cool, I can make it an extension. @Pierre-Sassoulas does that make the config for good dunder names moot, or do we want both?

Pierre-Sassoulas · 2022-10-24T12:19:26Z

I think that if we want this check to be used at all, it needs an option to define what good dunder name are (django for example would probably add __conform__, __html__, etc.). We probably means to define it better somewhere but extensions is something we need to maintain too, so they should at least provide some value.

clavedeluna · 2022-10-24T12:52:05Z

I think that if we want this check to be used at all, it needs an option to define what good dunder name are (django for example would probably add __conform__, __html__, etc.). We probably means to define it better somewhere but extensions is something we need to maintain too, so they should at least provide some value.

Makes sense, so...

does that make the config for good dunder names moot, or do we want both?

? What's your decision?

Pierre-Sassoulas · 2022-10-24T19:43:57Z

? What's your decision?

We need the option for good dunder name.

Pierre-Sassoulas

Pretty nice checker @clavedeluna, I think the refactor to put in pylint.constants also make a lot of sense. I'll wait for another reviewer before merging, new checker are always what bring the most issue in a release.

DanielNoord · 2022-10-30T20:26:46Z

pylint/extensions/dunder.py

+            return
+
+        # Detect something that could be a bad dunder method
+        if (


I missed the discussion here, but is there a reason why we don't check for __? Could _test_ be something private?

A function starting with _ is protected, a function starting with __ is private those should not raise. But _init__ is a bad dunder name that we should detect so a single underscore is enough.

doc/whatsnew/fragments/3038.new_check

Pierre-Sassoulas · 2022-10-31T08:18:51Z

Thank you for your work on this checker @clavedeluna, I think this is a nice addition to pylint ! Let's see how it goes, but I'm pretty confident we won't have too much issues opened for this one.

github-actions · 2022-10-31T08:48:12Z

🤖 Effect of this PR on checked open source code: 🤖

Effect on django:
The following messages are now emitted:

bad-dunder-name:
Bad or misspelled dunder method name prepare_class.
https://github.com/django/django/blob/970f61fefb148284fb2af63b5cc844279254111a/django/utils/functional.py#L122
bad-dunder-name:
Bad or misspelled dunder method name promise.
https://github.com/django/django/blob/970f61fefb148284fb2af63b5cc844279254111a/django/utils/functional.py#L144
bad-dunder-name:
Bad or misspelled dunder method name html.
https://github.com/django/django/blob/970f61fefb148284fb2af63b5cc844279254111a/django/utils/safestring.py#L16
bad-dunder-name:
Bad or misspelled dunder method name generate_next_value.
https://github.com/django/django/blob/970f61fefb148284fb2af63b5cc844279254111a/django/db/models/enums.py#L91
bad-dunder-name:
Bad or misspelled dunder method name aiter.
https://github.com/django/django/blob/970f61fefb148284fb2af63b5cc844279254111a/django/db/models/query.py#L74
bad-dunder-name:
Bad or misspelled dunder method name aiter.
https://github.com/django/django/blob/970f61fefb148284fb2af63b5cc844279254111a/django/db/models/query.py#L397
bad-dunder-name:
Bad or misspelled dunder method name aiter.
https://github.com/django/django/blob/970f61fefb148284fb2af63b5cc844279254111a/django/db/models/query.py#L2096
bad-dunder-name:
Bad or misspelled dunder method name conform.
https://github.com/django/django/blob/970f61fefb148284fb2af63b5cc844279254111a/django/contrib/gis/db/backends/spatialite/adapter.py#L8
bad-dunder-name:
Bad or misspelled dunder method name conform.
https://github.com/django/django/blob/970f61fefb148284fb2af63b5cc844279254111a/django/contrib/gis/db/backends/postgis/adapter.py#L29

Effect on pandas:
The following messages are now emitted:

bad-dunder-name:
Bad or misspelled dunder method name nonzero.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/generic.py#L1518
bad-dunder-name:
Bad or misspelled dunder method name array.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/generic.py#L2061
bad-dunder-name:
Bad or misspelled dunder method name array_wrap.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/generic.py#L2064
bad-dunder-name:
Bad or misspelled dunder method name array_ufunc.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/generic.py#L2102
bad-dunder-name:
Bad or misspelled dunder method name repr_latex.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/generic.py#L2168
bad-dunder-name:
Bad or misspelled dunder method name repr_data_resource.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/generic.py#L2179
bad-dunder-name:
Bad or misspelled dunder method name finalize.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/generic.py#L5858
bad-dunder-name:
Bad or misspelled dunder method name dataframe.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/frame.py#L843
bad-dunder-name:
Bad or misspelled dunder method name repr_fits_vertical.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/frame.py#L1006
bad-dunder-name:
Bad or misspelled dunder method name repr_fits_horizontal.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/frame.py#L1013
bad-dunder-name:
Bad or misspelled dunder method name repr_html.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/frame.py#L1087
bad-dunder-name:
Bad or misspelled dunder method name array.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/series.py#L822
bad-dunder-name:
Bad or misspelled dunder method name str_find.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/strings/object_array.py#L241
bad-dunder-name:
Bad or misspelled dunder method name nonzero.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/internals/managers.py#L215
bad-dunder-name:
Bad or misspelled dunder method name dlpack.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/interchange/buffer.py#L52
bad-dunder-name:
Bad or misspelled dunder method name dlpack_device.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/interchange/buffer.py#L60
bad-dunder-name:
Bad or misspelled dunder method name dlpack.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/interchange/dataframe_protocol.py#L148
bad-dunder-name:
Bad or misspelled dunder method name dlpack_device.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/interchange/dataframe_protocol.py#L163
bad-dunder-name:
Bad or misspelled dunder method name dataframe.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/interchange/dataframe_protocol.py#L392
bad-dunder-name:
Bad or misspelled dunder method name dataframe.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/interchange/dataframe.py#L38
bad-dunder-name:
Bad or misspelled dunder method name from_arrow.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/arrays/string_.py#L181
bad-dunder-name:
Bad or misspelled dunder method name arrow_array.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/arrays/string_.py#L373
bad-dunder-name:
Bad or misspelled dunder method name array.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/arrays/numpy_.py#L130
bad-dunder-name:
Bad or misspelled dunder method name array_ufunc.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/arrays/numpy_.py#L133
bad-dunder-name:
Bad or misspelled dunder method name from_arrow.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/arrays/numeric.py#L66
bad-dunder-name:
Bad or misspelled dunder method name array.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/arrays/interval.py#L1426
bad-dunder-name:
Bad or misspelled dunder method name arrow_array.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/arrays/interval.py#L1444
bad-dunder-name:
Bad or misspelled dunder method name array.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/arrays/period.py#L365
bad-dunder-name:
Bad or misspelled dunder method name arrow_array.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/arrays/period.py#L374
bad-dunder-name:
Bad or misspelled dunder method name array_ufunc.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/arrays/base.py#L1652
bad-dunder-name:
Bad or misspelled dunder method name array.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/arrays/datetimes.py#L596
bad-dunder-name:
Bad or misspelled dunder method name array.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/arrays/string_arrow.py#L154
bad-dunder-name:
Bad or misspelled dunder method name array.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/arrays/datetimelike.py#L330
bad-dunder-name:
Bad or misspelled dunder method name array_ufunc.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/arrays/datetimelike.py#L2050
bad-dunder-name:
Bad or misspelled dunder method name array.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/arrays/masked.py#L500
bad-dunder-name:
Bad or misspelled dunder method name array_ufunc.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/arrays/masked.py#L509
bad-dunder-name:
Bad or misspelled dunder method name arrow_array.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/arrays/masked.py#L586
bad-dunder-name:
Bad or misspelled dunder method name from_arrow.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/arrays/boolean.py#L104
bad-dunder-name:
Bad or misspelled dunder method name array.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/arrays/categorical.py#L1346
bad-dunder-name:
Bad or misspelled dunder method name array_ufunc.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/arrays/categorical.py#L1365
bad-dunder-name:
Bad or misspelled dunder method name array.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/arrays/sparse/array.py#L590
bad-dunder-name:
Bad or misspelled dunder method name array_ufunc.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/arrays/sparse/array.py#L1713
bad-dunder-name:
Bad or misspelled dunder method name from_arrow.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/arrays/arrow/dtype.py#L199
bad-dunder-name:
Bad or misspelled dunder method name arrow_array.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/arrays/arrow/array.py#L335
bad-dunder-name:
Bad or misspelled dunder method name arrow_ext_serialize.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/arrays/arrow/extension_types.py#L23
bad-dunder-name:
Bad or misspelled dunder method name arrow_ext_deserialize.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/arrays/arrow/extension_types.py#L28
bad-dunder-name:
Bad or misspelled dunder method name arrow_ext_serialize.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/arrays/arrow/extension_types.py#L73
bad-dunder-name:
Bad or misspelled dunder method name arrow_ext_deserialize.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/arrays/arrow/extension_types.py#L78
bad-dunder-name:
Bad or misspelled dunder method name from_arrow.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/dtypes/dtypes.py#L1009
bad-dunder-name:
Bad or misspelled dunder method name from_arrow.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/dtypes/dtypes.py#L1261
bad-dunder-name:
Bad or misspelled dunder method name array.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/indexes/base.py#L881
bad-dunder-name:
Bad or misspelled dunder method name array_ufunc.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/indexes/base.py#L887
bad-dunder-name:
Bad or misspelled dunder method name array_wrap.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/indexes/base.py#L926
bad-dunder-name:
Bad or misspelled dunder method name nonzero.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/indexes/base.py#L3047
bad-dunder-name:
Bad or misspelled dunder method name array.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/core/indexes/multi.py#L1190
bad-dunder-name:
Bad or misspelled dunder method name array.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/tests/frame/test_arithmetic.py#L49
bad-dunder-name:
Bad or misspelled dunder method name array.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/tests/frame/methods/test_select_dtypes.py#L35
bad-dunder-name:
Bad or misspelled dunder method name array.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/tests/dtypes/test_inference.py#L110
bad-dunder-name:
Bad or misspelled dunder method name array.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/tests/extension/test_common.py#L20
bad-dunder-name:
Bad or misspelled dunder method name array_ufunc.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/tests/extension/decimal/array.py#L119
bad-dunder-name:
Bad or misspelled dunder method name array.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/tests/extension/json/array.py#L145
bad-dunder-name:
Bad or misspelled dunder method name array.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/tests/indexes/test_index_new.py#L358
bad-dunder-name:
Bad or misspelled dunder method name repr_html.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/io/formats/style.py#L379
bad-dunder-name:
Bad or misspelled dunder method name repr_latex.
https://github.com/pandas-dev/pandas/blob/4b98e0b99ad3064463f9dc777e46d0b2f249e248/pandas/io/formats/style.py#L388

Effect on pytest:
The following messages are now emitted:

inconsistent-return-statements:
Either all return statements in a function should return an expression, or none of them should.
https://github.com/pytest-dev/pytest/blob/646a46e5f4b1f1ae5a06dcbc91fcdebfc235a28a/src/_pytest/pytester.py#L301
no-name-in-module:
No name 'NOSE_SUPPORT_METHOD' in module '_pytest.deprecated'
https://github.com/pytest-dev/pytest/blob/646a46e5f4b1f1ae5a06dcbc91fcdebfc235a28a/src/_pytest/python.py#L62
no-name-in-module:
No name 'PytestReturnNotNoneWarning' in module '_pytest.warning_types'
https://github.com/pytest-dev/pytest/blob/646a46e5f4b1f1ae5a06dcbc91fcdebfc235a28a/src/_pytest/python.py#L81
inconsistent-return-statements:
Either all return statements in a function should return an expression, or none of them should.
https://github.com/pytest-dev/pytest/blob/646a46e5f4b1f1ae5a06dcbc91fcdebfc235a28a/src/_pytest/python.py#L1085
inconsistent-return-statements:
Either all return statements in a function should return an expression, or none of them should.
https://github.com/pytest-dev/pytest/blob/646a46e5f4b1f1ae5a06dcbc91fcdebfc235a28a/src/_pytest/fixtures.py#L130
inconsistent-return-statements:
Either all return statements in a function should return an expression, or none of them should.
https://github.com/pytest-dev/pytest/blob/646a46e5f4b1f1ae5a06dcbc91fcdebfc235a28a/src/_pytest/python_api.py#L798
no-name-in-module:
No name 'NOSE_SUPPORT' in module '_pytest.deprecated'
https://github.com/pytest-dev/pytest/blob/646a46e5f4b1f1ae5a06dcbc91fcdebfc235a28a/src/_pytest/nose.py#L5
no-name-in-module:
No name 'warn_explicit_for' in module '_pytest.warning_types'
https://github.com/pytest-dev/pytest/blob/646a46e5f4b1f1ae5a06dcbc91fcdebfc235a28a/src/_pytest/config/__init__.py#L62
no-member:
Module '_pytest.deprecated' has no 'HOOK_LEGACY_MARKING' member
https://github.com/pytest-dev/pytest/blob/646a46e5f4b1f1ae5a06dcbc91fcdebfc235a28a/src/_pytest/config/__init__.py#L369
bad-dunder-name:
Bad or misspelled dunder method name div.
https://github.com/pytest-dev/pytest/blob/646a46e5f4b1f1ae5a06dcbc91fcdebfc235a28a/src/_pytest/_py/path.py#L339
bad-dunder-name:
Bad or misspelled dunder method name attrs_post_init.
https://github.com/pytest-dev/pytest/blob/646a46e5f4b1f1ae5a06dcbc91fcdebfc235a28a/src/_pytest/_code/code.py#L1005
bad-dunder-name:
Bad or misspelled dunder method name attrs_post_init.
https://github.com/pytest-dev/pytest/blob/646a46e5f4b1f1ae5a06dcbc91fcdebfc235a28a/src/_pytest/_code/code.py#L1021

Effect on sentry:
The following messages are now emitted:

bad-dunder-name:
Bad or misspelled dunder method name post__init.
https://github.com/getsentry/sentry/blob/4be98deb27375dac541740b9c8d7ce871ff2bc99/src/sentry/ratelimits/cardinality.py#L33
bad-dunder-name:
Bad or misspelled dunder method name post__init.
https://github.com/getsentry/sentry/blob/4be98deb27375dac541740b9c8d7ce871ff2bc99/src/sentry/ratelimits/sliding_windows.py#L112

This comment was generated for commit 6c940a3

This comment has been minimized.

Sign in to view

Pierre-Sassoulas added the Enhancement ✨ Improvement to a component label Oct 17, 2022

Pierre-Sassoulas added this to the 2.16.0 milestone Oct 17, 2022

Pierre-Sassoulas requested changes Oct 17, 2022

View reviewed changes

pylint/checkers/dunder_methods.py Outdated Show resolved Hide resolved

tests/functional/b/bad_dunder_name.py Outdated Show resolved Hide resolved

clavedeluna force-pushed the 3038-special-dunder branch from b9a5b9c to ed43df2 Compare October 18, 2022 12:44

clavedeluna commented Oct 18, 2022

View reviewed changes

pylint/checkers/dunder_methods.py Outdated Show resolved Hide resolved

clavedeluna force-pushed the 3038-special-dunder branch from 9f8ca4b to e1e44dd Compare October 18, 2022 12:47

clavedeluna force-pushed the 3038-special-dunder branch from e1e44dd to 80363f7 Compare October 18, 2022 12:53

Pierre-Sassoulas requested changes Oct 18, 2022

View reviewed changes

This comment has been minimized.

Sign in to view

clavedeluna force-pushed the 3038-special-dunder branch from 80363f7 to 3bd3f61 Compare October 18, 2022 18:59

This comment has been minimized.

Sign in to view

Pierre-Sassoulas reviewed Oct 18, 2022

View reviewed changes

pylint/checkers/dunder_methods.py Outdated Show resolved Hide resolved

Pierre-Sassoulas added the Needs review 🔍 Needs to be reviewed by one or multiple more persons label Oct 18, 2022

clavedeluna requested a review from Pierre-Sassoulas October 24, 2022 11:53

clavedeluna added 8 commits October 26, 2022 09:09

add bad-dunder-name check

40b0d77

should flag private, not protected, methods

d6c7557

add extra dunder methods to check for names

d28502d

bad-dunder-name recognizes properties

720bfba

detect __post_init__ name

54db3e4

add more test examples

682f6c1

bad dunder can start with _

4826538

move checker to an extension

37ca3dd

clavedeluna force-pushed the 3038-special-dunder branch from 3bd3f61 to 37ca3dd Compare October 26, 2022 12:11

This comment has been minimized.

Sign in to view

clavedeluna force-pushed the 3038-special-dunder branch from 9296f29 to 84f410e Compare October 26, 2022 12:56

This comment has been minimized.

Sign in to view

add good-dunder-names option

43ba022

clavedeluna force-pushed the 3038-special-dunder branch from 658b28c to 43ba022 Compare October 26, 2022 16:03

This comment has been minimized.

Sign in to view

Pierre-Sassoulas previously approved these changes Oct 26, 2022

View reviewed changes

DanielNoord reviewed Oct 30, 2022

View reviewed changes

DanielNoord previously approved these changes Oct 30, 2022

View reviewed changes

Pierre-Sassoulas reviewed Oct 31, 2022

View reviewed changes

doc/whatsnew/fragments/3038.new_check Outdated Show resolved Hide resolved

Update doc/whatsnew/fragments/3038.new_check

6c940a3

Pierre-Sassoulas dismissed stale reviews from DanielNoord and themself via 6c940a3 October 31, 2022 08:15

Pierre-Sassoulas removed the Needs review 🔍 Needs to be reviewed by one or multiple more persons label Oct 31, 2022

Pierre-Sassoulas enabled auto-merge (squash) October 31, 2022 08:17

Pierre-Sassoulas approved these changes Oct 31, 2022

View reviewed changes

Pierre-Sassoulas merged commit 004fc74 into pylint-dev:main Oct 31, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `bad-dunder-name` checker #7642

Add `bad-dunder-name` checker #7642

clavedeluna commented Oct 17, 2022

This comment has been minimized.

coveralls commented Oct 18, 2022 •

edited

Loading

Pierre-Sassoulas left a comment

Pierre-Sassoulas Oct 18, 2022

This comment has been minimized.

This comment has been minimized.

DanielNoord commented Oct 18, 2022

clavedeluna commented Oct 18, 2022

Pierre-Sassoulas commented Oct 24, 2022

clavedeluna commented Oct 24, 2022

Pierre-Sassoulas commented Oct 24, 2022

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

Pierre-Sassoulas left a comment

DanielNoord Oct 30, 2022

Pierre-Sassoulas Oct 30, 2022

Pierre-Sassoulas commented Oct 31, 2022

github-actions bot commented Oct 31, 2022

Add bad-dunder-name checker #7642

Add bad-dunder-name checker #7642

Conversation

clavedeluna commented Oct 17, 2022

Type of Changes

Description

This comment has been minimized.

coveralls commented Oct 18, 2022 • edited Loading

Pull Request Test Coverage Report for Build 3359652883

💛 - Coveralls

Pierre-Sassoulas left a comment

Choose a reason for hiding this comment

Pierre-Sassoulas Oct 18, 2022

Choose a reason for hiding this comment

This comment has been minimized.

This comment has been minimized.

DanielNoord commented Oct 18, 2022

clavedeluna commented Oct 18, 2022

Pierre-Sassoulas commented Oct 24, 2022

clavedeluna commented Oct 24, 2022

Pierre-Sassoulas commented Oct 24, 2022

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

Pierre-Sassoulas left a comment

Choose a reason for hiding this comment

DanielNoord Oct 30, 2022

Choose a reason for hiding this comment

Pierre-Sassoulas Oct 30, 2022

Choose a reason for hiding this comment

Pierre-Sassoulas commented Oct 31, 2022

github-actions bot commented Oct 31, 2022

Add `bad-dunder-name` checker #7642

Add `bad-dunder-name` checker #7642

coveralls commented Oct 18, 2022 •

edited

Loading