Was ist der richtige Weg, um ein mehrzeiliges Diktat in Python zu formatieren?

In Python möchte ich ein mehrzeiliges Diktat in meinen Code schreiben. Es gibt verschiedene Möglichkeiten, wie man es formatieren kann. Hier sind einige, an die ich denken könnte:

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

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

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

Ich weiß, dass einer der oben genannten Punkte syntaktisch korrekt ist, aber ich gehe davon aus, dass es für Python-Diktate einen bevorzugten Einrückungs- und Zeilenumbruchstil gibt. Was ist es?

Hinweis: Dies ist kein Problem der Syntax. Alle oben genannten sind (soweit ich weiß) gültige Python-Anweisungen und entsprechen einander.

Ich benutze # 3. Gleiches gilt für lange Listen, Tupel usw. Es müssen keine zusätzlichen Leerzeichen über die Einrückungen hinaus hinzugefügt werden. Sei wie immer konsequent.

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

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

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

In ähnlicher Weise ist hier meine bevorzugte Methode, große Zeichenfolgen ohne Leerzeichen einzufügen (wie Sie es erhalten würden, wenn Sie mehrzeilige Zeichenfolgen mit dreifachen Anführungszeichen verwenden würden):

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

Zunächst sagte Steven Rumbalski, "PEP8 geht diese Frage nicht an", daher ist es eine Frage der persönlichen Präferenz.

Ich würde ein ähnliches, aber nicht identisches Format wie Ihr Format 3 verwenden. Hier ist meins und warum.

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

Da Ihre Schlüssel Zeichenfolgen sind und wir über Lesbarkeit sprechen, bevorzuge ich:

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

Wenn Sie große Python-Objekte haben, ist es normalerweise ziemlich schwierig, diese zu formatieren. Ich persönlich bevorzuge es, dafür einige Tools zu verwenden.

Hier ist Python-Verschönerer - www.cleancss.com/python-beautify , der Ihre Daten sofort in einen anpassbaren Stil verwandelt.

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

Aus meiner Erfahrung mit Tutorials und anderen Dingen scheint Nummer 2 immer bevorzugt zu sein, aber es ist mehr als alles andere eine persönliche Präferenzwahl.

Im Allgemeinen würden Sie das Komma nach dem endgültigen Eintrag nicht einfügen, aber Python korrigiert dies für Sie.