Pylint plugin to check that return type annotation for __init__ functions is -> None
#978
Conversation
There was a problem hiding this comment.
can we rename this to make it obvious it's a pylint plugin? e.g. something like pylint_init_return.py
| @@ -0,0 +1,58 @@ | |||
| """Check type type annotation of __init__ functions""" | |||
There was a problem hiding this comment.
| """Check type type annotation of __init__ functions""" | |
| """Check type annotation of __init__ functions""" |
| """Called for function and method definitions (def). | ||
| Checks if the return type annotation for __init__ is explicity None or incorrect. |
There was a problem hiding this comment.
| """Called for function and method definitions (def). | |
| Checks if the return type annotation for __init__ is explicity None or incorrect. | |
| """Called for function and method definitions (def). | |
| Checks if the return type annotation for __init__ is explicitly None or incorrect. |
|
|
||
| name = "init-return-check" | ||
| msgs = { | ||
| "W9022": ( |
There was a problem hiding this comment.
out of curiosity - where did the codes come from?
There was a problem hiding this comment.
The largest code I found was W9021 which was being used for one of the docstring pylint checks. The next available one was W9022.
There was a problem hiding this comment.
ah ok thanks. is there any risk that a future pylint update might introduce a new warning conflicting with this?
There was a problem hiding this comment.
If there is a future pylint change that leads to a new warning with the same code, pylint will throw an error whenever it is called and it will state the conflicting codes. I can check if there are conventions for what the codes should be for custom plugins so that they don't cause conflicts or if there are ways of checking for free warning codes.
| Checks if the return type annotation for __init__ is explicity None or incorrect. | ||
|
|
||
| Args: | ||
| node: Node for a function or method definition in the AST |
There was a problem hiding this comment.
| node: Node for a function or method definition in the AST | |
| node: Node for a function or method definition in the AST. |
|
|
||
|
|
||
| def register(linter: PyLinter) -> None: | ||
| """Registers plugin to be accessed by pylint |
There was a problem hiding this comment.
| """Registers plugin to be accessed by pylint | |
| """Registers plugin to be accessed by pylint. |
| """Registers plugin to be accessed by pylint | ||
|
|
||
| Args: | ||
| linter: The base pylinter which the custom checker will inherit from |
There was a problem hiding this comment.
| linter: The base pylinter which the custom checker will inherit from | |
| linter: The base pylinter which the custom checker will inherit from. |
| @@ -58,7 +58,7 @@ def __init__( | |||
| ibmq_instance: str | None = None, | |||
| ibmq_channel: str | None = None, | |||
| **kwargs: Any, | |||
| ): | |||
| ) -> None: | |||
There was a problem hiding this comment.
That's one way to find out it works!
Changes include: - Remove Monthly Benchmark Action (#972) - Integration test inconsistencies fix (#974) - Pylint plugin to check that return type annotation for __init__ functions is -> None (#978) - Add mulitcore support for pytest (#976) - support both <x>_test.py and test_<x>.py for test discovery (#985) - drop qiskit-ibm-provider from qss (#986)
The return type annotation for
__init__is inconsistently enforced bymypy. The plugin will warn when there is no explicit return type annotation and when the return type in the annotation is notNone.