rspec/rules/S1066/python/rule.adoc

66 lines
1.1 KiB
Plaintext
Raw Normal View History

== Why is this an issue?
2020-06-30 12:47:33 +02:00
include::../description.adoc[]
Code like
2020-06-30 12:47:33 +02:00
2022-02-04 17:28:24 +01:00
[source,python]
2020-06-30 12:47:33 +02:00
----
if condition1:
if condition2: # Noncompliant
2020-06-30 12:47:33 +02:00
# ...
----
Will be more readable as
2020-06-30 12:47:33 +02:00
2022-02-04 17:28:24 +01:00
[source,python]
2020-06-30 12:47:33 +02:00
----
if condition1 and condition2: # Compliant
2020-06-30 12:47:33 +02:00
# ...
----
== How to fix it
If merging the conditions seems to result in a more complex code, extracting the condition or part of it in a named function or variable is a better approach to fix readability.
=== Code examples
==== Noncompliant code example
[source,python]
----
if file.isValid():
if file.isfile() or file.isdir(): # Noncompliant
# ...
----
==== Compliant solution
[source,python]
----
def isFileOrDirectory(File file):
return file.isFile() or file.isDirectory()
if file.isValid() and isFileOrDirectory(file): # Compliant
# ...
----
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[]