Apa cara yang tepat untuk memformat dict multi-line dengan Python?

Dengan Python, saya ingin menulis dict multi-line dalam kode saya. Ada beberapa cara untuk memformatnya. Berikut adalah beberapa yang dapat saya pikirkan:

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

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

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

Saya tahu bahwa salah satu di atas secara sintaksis benar, tetapi saya berasumsi bahwa ada satu lekukan yang disukai dan gaya line-break untuk dicts Python. Apa itu?

Catatan: Ini bukan masalah sintaksis. Semua hal di atas adalah (sejauh yang saya tahu) pernyataan Python yang valid dan setara satu sama lain.

Saya menggunakan # 3. Sama untuk daftar panjang, tupel, dll. Tidak perlu menambahkan spasi tambahan di luar lekukan. Seperti biasa, konsistenlah.

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

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

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

Demikian pula, inilah cara yang saya sukai untuk memasukkan string besar tanpa memperkenalkan spasi kosong (seperti yang akan Anda dapatkan jika Anda menggunakan string multi-line tiga kutip):

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

Pertama-tama, seperti dikatakan Steven Rumbalski, "PEP8 tidak menjawab pertanyaan ini", jadi ini adalah masalah pilihan pribadi.

Saya akan menggunakan format yang serupa tetapi tidak identik dengan format Anda 3. Ini milik saya, dan mengapa.

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()

Karena kunci Anda adalah string dan karena kita berbicara tentang keterbacaan, saya lebih suka:

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

Biasanya, jika Anda memiliki objek python besar cukup sulit untuk memformatnya. Saya pribadi lebih suka menggunakan beberapa alat untuk itu.

Berikut ini adalah python-beautifier - www.cleancss.com/python-beautify yang secara instan mengubah data Anda menjadi gaya yang dapat disesuaikan.

dict(rank = int(lst[0]),
                grade = str(lst[1]),
                channel=str(lst[2])),
                videos = float(lst[3].replace(",", " ")),
                subscribers = float(lst[4].replace(",", "")),
                views = float(lst[5].replace(",", "")))

Dari pengalaman saya dengan tutorial, dan hal-hal lain nomor 2 sepertinya selalu lebih disukai, tetapi ini adalah pilihan preferensi pribadi lebih dari apa pun.

Secara umum, Anda tidak akan menyertakan koma setelah entri terakhir, tetapi Python akan memperbaikinya untuk Anda.