Skip to content

Latest commit

 

History

History
88 lines (53 loc) · 2.68 KB

creating-cleaner-code.md

File metadata and controls

88 lines (53 loc) · 2.68 KB
description
Simplify logic for readability, maintainability, and efficiency.

Creating cleaner code

Module overview

In this module, you'll learn how to simplify logic to create cleaner, more readable, and maintainable code. The video covers a range of techniques—from grouping logical conditions with parentheses to optimizing whitespace and using concise Boolean expressions—that not only make your code easier to understand but also enhance its efficiency.

Video (13:23 minutes)

{% embed url="https://youtu.be/0dxVsT161bQ" %}

Why it matters
  • Reduces time spent understanding and debugging code.
  • Minimizes errors and tech debt in automation workflows.
Structuring logical conditions
  • Grouping logic with parentheses: Ensures the correct execution order.Example: (is_admin and is_active) or is_super_admin clarifies priority.
  • Using in for multiple value checks:
    • Before: if role == "admin" or role == "super_admin"
    • After: if role in ["admin", "super_admin"]
Optimizing whitespace for clarity
  • Use line breaks and indentation for better readability.
  • Jinja ignores extra spaces when using {%- %} or {{- }}.
Simplifying Boolean expressions
  • Implicit vs. explicit conditions:
    • Explicit: if my_list | length > 0
    • Implicit: if my_list (shorter and cleaner).Truthy values (non-empty lists, strings, non-zero numbers) return True, while falsy values (empty lists, strings, None, 0) return False.
Using ternary operators for concise logic

  • Syntax: variable = value_if_true if condition else value_if_false

  • Example: status = "Active" if is_active else "Inactive"

  • Supports cascading conditions:

    {% code overflow="wrap" %}

    greeting = "Good morning" if time < 12 else "Good afternoon" if time < 18 else "Good evening"

    {% endcode %}

Short-circuit evaluation for efficiency

Place the most common condition first to avoid unnecessary checks.Example: if is_logged_in and is_admin: skips the is_admin check if is_logged_in is false.

The impact
  • More readable code: Easier to understand and maintain.
  • Fewer errors: Reduces unnecessary complexity.
  • More efficient workflows: Avoids redundant operations.

By integrating these strategies into your coding practice, you'll build a streamlined, error-resistant codebase that scales gracefully with your automation workflows.