rspec/rules/S3358/python/rule.adoc

59 lines
1.3 KiB
Plaintext
Raw Normal View History

== Why is this an issue?
Nested conditionals are hard to read and can make the order of operations complex to understand.
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
----
class Job:
@property
def readable_status(self):
return "Running" if job.is_running else "Failed" if job.errors else "Succeeded" # Noncompliant
2020-06-30 12:48:39 +02:00
----
Instead, use another line to express the nested operation in a separate statement.
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
----
class Job:
@property
def readable_status(self):
if job.is_running:
return "Running"
return "Failed" if job.errors else "Succeeded"
2020-06-30 12:48:39 +02:00
----
=== Exceptions
2020-06-30 12:48:39 +02:00
No issue is raised on conditional expressions in comprehensions.
[source,python]
----
job_statuses = ["Running" if job.is_running else "Failed" if job.errors else "Succeeded" for job in jobs] # Compliant by exception
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Extract this nested conditional expression into an independent statement.
=== Highlighting
* Primary: highlight the entire nested conditional expression
* Secondary: highlight the "if" and "else" of the parent conditional expression
message: 'Parent conditional expression.'
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]