Modify S2734: LaYC format (#2297)
This commit is contained in:
parent
8de10e92d6
commit
b545853971
@ -1,31 +1,41 @@
|
|||||||
|
This rule raises an issue when the ``++__init__++`` method of a class contains a `return` or a `yield` statement.
|
||||||
|
|
||||||
== Why is this an issue?
|
== Why is this an issue?
|
||||||
|
|
||||||
By contract, every Python function returns something, even if it's the ``++None++`` value, which can be returned implicitly by omitting the ``++return++`` statement, or explicitly.
|
By contract, every Python function returns something, even if it is the ``++None++`` value, which can be returned implicitly by omitting the ``++return++`` statement, or explicitly.
|
||||||
|
|
||||||
|
|
||||||
The ``++__init__++`` method is required to return ``++None++``. A ``++TypeError++`` will be raised if the ``++__init__++`` method either ``++yield++``s or ``++return++``s any expression other than ``++None++``. Returning some expression that evaluates to ``++None++`` will not raise an error, but is considered bad practice.
|
The ``++__init__++`` method is required to return ``++None++``. A ``++TypeError++`` will be raised if the ``++__init__++`` method either yields or returns any expression other than ``++None++``. While explicitly returning an expression that evaluates to ``++None++`` will not raise an error, it is considered bad practice.
|
||||||
|
|
||||||
|
To fix this issue, make sure that the ``++__init__++`` method does not contain any return statement.
|
||||||
|
|
||||||
=== Noncompliant code example
|
=== Code examples
|
||||||
|
|
||||||
[source,python]
|
==== Noncompliant code example
|
||||||
|
|
||||||
|
[source,python,diff-id=1,diff-type=noncompliant]
|
||||||
----
|
----
|
||||||
class MyClass(object):
|
class MyClass(object):
|
||||||
def __init__(self):
|
def __init__(self):
|
||||||
self.message = 'Hello'
|
self.message = 'Hello'
|
||||||
return self # Noncompliant
|
return self # Noncompliant: a TypeError will be raised
|
||||||
----
|
----
|
||||||
|
|
||||||
|
|
||||||
=== Compliant solution
|
==== Compliant solution
|
||||||
|
|
||||||
[source,python]
|
[source,python,diff-id=1,diff-type=compliant]
|
||||||
----
|
----
|
||||||
class MyClass(object):
|
class MyClass(object):
|
||||||
def __init__(self):
|
def __init__(self):
|
||||||
self.message = 'Hello'
|
self.message = 'Hello'
|
||||||
----
|
----
|
||||||
|
|
||||||
|
== Resources
|
||||||
|
|
||||||
|
=== Documentation
|
||||||
|
|
||||||
|
* https://docs.python.org/3/reference/datamodel.html#object.++__init__++[The ``++__init__++`` method]
|
||||||
|
|
||||||
|
|
||||||
ifdef::env-github,rspecator-view[]
|
ifdef::env-github,rspecator-view[]
|
||||||
|
Loading…
x
Reference in New Issue
Block a user