rspec/rules/S134/python/rule.adoc

52 lines
1.1 KiB
Plaintext
Raw Normal View History

== Why is this an issue?
2021-01-27 13:42:22 +01:00
Nested ``++if++``, ``++for++``, ``++while++``, ``++try++``, and ``++with++`` statements are key ingredients for making what's known as "Spaghetti code". Such code is hard to read, refactor and therefore maintain.
2020-06-30 12:47:33 +02:00
=== Noncompliant code example
2020-06-30 12:47:33 +02:00
The following code snippet illustrates this rule with the default threshold of 3.
2022-02-04 17:28:24 +01:00
[source,python]
2020-06-30 12:47:33 +02:00
----
if condition1: # Compliant - depth = 1
# ...
if condition2: # Compliant - depth = 2
# ...
for i in range(10): # Compliant - depth = 3, not exceeding the limit
# ...
if condition4: # Non-Compliant - depth = 4
if condition5: # Depth = 5, exceeding the limit, but issues are only reported on depth = 4
# ...
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
=== Parameters
.max
****
_Integer_
----
4
----
Maximum allowed control flow statement nesting depth.
****
include::../highlighting.adoc[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]