Який правильний спосіб відформатувати багаторядковий dict у 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. Що це?

Примітка. Це не проблема синтаксису. Все вищезазначене є (наскільки я знаю) дійсними твердженнями Python і рівнозначні один одному.

Я використовую №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=="
)

Перш за все, як сказав Стівен Румбальський, "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()

Оскільки ваші ключі - це рядки, і оскільки ми говоримо про читабельність, я віддаю перевагу:

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

Зазвичай, якщо у вас є великі об'єкти python, їх досить форматувати. Я особисто вважаю за краще використовувати для цього деякі інструменти.

Ось python-beautifier - www.cleancss.com/python-beautify, який миттєво перетворює ваші дані у налаштований стиль.

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

З мого досвіду роботи з навчальними посібниками та іншими речами номер 2 завжди здається кращим, але це особистий вибір переваг більше, ніж усе інше.

Як правило, ви не включаєте кому після остаточного запису, але Python це виправить для вас.