[Python] 值得參考的 Coding Style 整理筆記

# No
a = 1;
b = 1; c = a + b

# Yes
a = 1
b = 1
c = a + b

# No
return (x, y)
if (x and y): ...


# Yes
return x, y
if x and y

# No
id2value = {
    1: 10,
2: 20,
3: 30,
}


# Yes
id2value = {
    1: 10,
    2: 20,
    3: 30,
}

# No
def x():
    ...
def y():
    ...

# Yes
def x():
    ...


def y():
    ...

# No
class x:
    def __init__(self):
        ...


    def process(self):
        ...

# Yes
class x:
    def __init__(self):
        ...

    def process(self):
        ...

# No
a,b,c=1,2,3



# Yes
a, b, c = 1, 2, 3

def fetch_bigtable_rows(big_table, keys, other_silly_variable=None):
    """Fetches rows from a Bigtable.

    Retrieves rows pertaining to the given keys from the Table instance
    represented by big_table.  Silly things may happen if
    other_silly_variable is not None.

    Args:
        big_table: An open Bigtable Table instance.
        keys: A sequence of strings representing the key of each table row
            to fetch.
        other_silly_variable: Another optional variable, that has a much
            longer name than the other args, and which does nothing.

    Returns:
        A dict mapping keys to the corresponding table row data
        fetched. Each row is represented as a tuple of strings. For
        example:

        {'Serak': ('Rigel VII', 'Preparer'),
         'Zim': ('Irk', 'Invader'),
         'Lrrr': ('Omicron Persei 8', 'Emperor')}

        If a key from the keys argument is missing from the dictionary,
        then that row was not found in the table.

    Raises:
        IOError: An error occurred accessing the bigtable.Table object.
    """
    pass

# No
if i & (i-1) == 0:# true iff i is a power of 2


# Yes
if i & (i-1) == 0: # true iff i is a power of 2

# No
class SampleClass:
    pass


# Yes
class SampleClass(object):
    pass

# No
string = ''
for item in items:
    string += item


# Yes
string = []
for item in items:
    string.append(item)

string = ''.join(item)

# TODO([email protected]): Use a "*" here for string repetition.
# TODO(Zeke) Change this to use relations.

# No
import os, sys

# Yes
import os
import sys

import foo
from foo import bar
from foo.bar import baz
from foo.bar import Quux
from Foob import ar

# No
if foo: bar(foo)
else: baz(foo)

try: bar(foo)
except ValueError: baz(foo)

# Yes
if foo:
    bar(foo)
else:
    baz(foo)

try:
    bar(foo)
except ValueError:
    baz(foo)

# Yes
def main():
    ...

if __name__ == '__main__':
    main()