web-dev-qa-db-ja.com

Pythonで複数行の辞書をフォーマットする適切な方法は何ですか？

Pythonでは、コードに複数行の辞書を記述します。フォーマットする方法はいくつかあります。私が考えることができるいくつかはここにあります：

  1. mydict = { "key1": 1,
           "key2": 2,
           "key3": 3, }

  2. mydict = { "key1": 1,
           "key2": 2,
           "key3": 3,
         }

  3. mydict = {
    "key1": 1,
    "key2": 2,
    "key3": 3,
}

上記のいずれかが構文的に正しいことは知っていますが、Python dictsには好ましいインデントと改行スタイルがあると思います。それは何ですか？

注：これは構文の問題ではありません。上記のすべては（私の知る限り）有効なPythonステートメントであり、互いに同等です。

pythonindentationcode-formattingmultiline
156
Ryan Thompson

＃3を使用します。長いリスト、タプルなどでも同じです。インデント以外のスペースを追加する必要はありません。いつものように、一貫性を保ってください。

mydict = {
    "key1": 1,
    "key2": 2,
    "key3": 3,
}

mylist = [
    (1, 'hello'),
    (2, 'world'),
]

nested = {
    a: [
        (1, 'a'),
        (2, 'b'),
    ],
    b: [
        (3, 'c'),
        (4, 'd'),
    ],
}

同様に、空白を挿入せずに大きな文字列を含めるための私の好ましい方法は次のとおりです（三重引用符で囲まれた複数行の文字列を使用した場合に得られます）。

data = (
    "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABG"
    "l0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAAEN"
    "xBRpFYmctaKCfwrBSCrRLuL3iEW6+EEUG8XvIVjYWNgJdhFjIX"
    "rz6pKtPB5e5rmq7tmxk+hqO34e1or0yXTGrj9sXGs1Ib73efh1"
    "AAAABJRU5ErkJggg=="
)
206
FogleBird

まず第一に、Steven Rumbalskiが言ったように、「PEP8はこの質問に対処していない」ので、個人的な好みの問題です。

私はあなたのフォーマット3と似ているが同一ではないフォーマットを使用します。これは私のもので、その理由です。

my_dictionary = { # Don't think dict(...) notation has more readability
    "key1": 1, # Indent by one press of TAB (i.e. 4 spaces)
    "key2": 2, # Same indentation scale as above
    "key3": 3, # Keep this final comma, so that future addition won't show up as 2-lines change in code diff
    } # My favorite: SAME indentation AS ABOVE, to emphasize this bracket is still part of the above code block!
the_next_line_of_code() # Otherwise the previous line would look like the begin of this part of code

bad_example = {
               "foo": "bar", # Don't do this. Unnecessary indentation wastes screen space
               "hello": "world" # Don't do this. Omitting the comma is not good.
} # You see? This line visually "joins" the next line when in a glance
the_next_line_of_code()

btw_this_is_a_function_with_long_name_or_with_lots_of_parameters(
    foo='hello world',  # So I put one parameter per line
    bar=123,  # And yeah, this extra comma here is harmless too;
              # I bet not many people knew/tried this.
              # Oh did I just show you how to write
              # multiple-line inline comment here?
              # Basically, same indentation forms a natural paragraph.
    ) # Indentation here. Same idea as the long dict case.
the_next_line_of_code()

# By the way, now you see how I prefer inline comment to document the very line.
# I think this inline style is more compact.
# Otherwise you will need extra blank line to split the comment and its code from others.

some_normal_code()

# hi this function is blah blah
some_code_need_extra_explanation()

some_normal_code()
24
RayLuo

あなたのキーは文字列であり、読みやすさについて話しているので、私は好む：

mydict = dict(
    key1 = 1,
    key2 = 2,
    key3 = 3,
)
9
dugres

通常、大きなpythonオブジェクトがある場合、それらをフォーマットするのは非常に困難です。個人的には、いくつかのツールを使用することを好みます。

python-beautifier-www.cleancss.com/python-beautify は、データを即座にカスタマイズ可能なスタイルに変換します。

1
Max