Lint Check for Indentation

Introduction

We would like to have a pylint check for indentation in Python code. This will likely require a custom lint check. Here are some of the cases we want to handle:

Indent By 4 Spaces

Good:

def func():
    pass

my_list = [
    'a',
    'b',
]

Bad:

def func():
  pass

my_list = ['a',
           'b',
]

Indent by 8 Spaces for Clarity

Sometimes indenting by 4 spaces is confusing:

if (
    some_var == 1):
    pass

In these cases, we should indent by 8 spaces instead:

if (
        some_var == 1):
    pass

Closing Braces/Brackets/Parentheses at End of Line or Same Indentation as Opening Brace/Bracket/Parenthesis

Good:

my_list = {
    'a': [
        1,
        2,
    ],
    'b': True,
}

my_list = {
    'a': [
        1,
        2],
    'b': True,
}

Bad:

my_list = {
    'a': [
        1,
        2,
        ],
}

my_list = {
    'a': [
        1,
        2,
],
}

Sometimes It’s Okay to Not Indent

In some cases, putting a pair of parentheses/braces/brackets on a new line and indenting is unnecessary:

some_function(
    {
        'a': True,
    }
)

This is fine instead:

some_function({
    'a': True,
})

Note that here we treat the ({ as a single opening character, so the 'a': True line is only indented by 4 spaces (not 8)

[U8NWXD]

All yours @FaazAbidi!

[U8NWXD]

my_function_with_a_really_long_name(
    'abc', 'def', None)

Are you referring to the above code from the style guide? It’s validly formatted, but this would also be valid:

my_function_with_a_really_long_name(
    'abc',
    'def',
    None,
)

Does that help?