rspec/rules/S3626/python/rule.adoc

58 lines
1.2 KiB
Plaintext
Raw Normal View History

== Why is this an issue?
2021-01-27 13:42:22 +01:00
Jump statements, such as ``++return++``, ``++break++`` and ``++continue++`` let you change the default flow of program execution, but jump statements that direct the control flow to the original direction are just a waste of keystrokes.
2020-06-30 12:48:39 +02:00
=== Noncompliant code example
2020-06-30 12:48:39 +02:00
2022-02-04 17:28:24 +01:00
[source,python]
2020-06-30 12:48:39 +02:00
----
def redundant_jump(x):
if x == 1:
print(True)
return # NonCompliant
----
=== Compliant solution
2020-06-30 12:48:39 +02:00
2022-02-04 17:28:24 +01:00
[source,python]
2020-06-30 12:48:39 +02:00
----
def redundant_jump(x):
if x == 1:
print(True)
----
=== Exceptions
2020-06-30 12:48:39 +02:00
* No issue is raised if the jump statement is the only statement of a statement suite:
[source,python]
2020-06-30 12:48:39 +02:00
----
def my_function(x):
if x > 5:
do_something()
elif x == 0:
return # ok even it could be changed to "pass"
else:
do_something_else()
----
2021-01-27 13:42:22 +01:00
* No issue is raised for ``++return None++`` because this was certainly done on purpose to be explicit that a function is really returning ``++None++``.
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
include::../highlighting.adoc[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]