Wenn Sie die PEP8-Regeln nicht befolgen, bellt Ihr Hund !?

Python hat einen Styleguide und einen Codierungsstandard namens PEP8. Wenn ein Team den Code überprüft, um festzustellen, ob er der PEP8-Konvention entspricht, wird er in einem gemeinsamen Schreibstil ausgerichtet, wodurch er lesbarer und einfacher zu entwickeln ist. Sie können PEP8 überprüfen, wenn Sie auf Github usw. drücken oder wenn Sie eine Pull-Anfrage stellen. In dieser Phase werden CI-Tools verwendet, um Tests durchzuführen und Sie über Punkte zu informieren, die gegen die Regeln verstoßen. Ein solches Tool ist reviewdog. ファイル名

Wenn Sie gegen die PEP8-Regeln verstoßen, werden Sie von diesem Hund gebellt. .. ファイル名

Mir wurde gesagt, dass der Hund immer wieder über die Fehler H404 und H405 im Zusammenhang mit dem Docstring bellte, und ich versuchte mein Bestes, um den Code zu korrigieren und mich vom Hund verzeihen zu lassen.

Inhalt des Fehlercodes H4xx

Der Fehlercode der H4xx-Serie bezieht sich auf ** docstring **. Die Dokumentzeichenfolge ist der Ort, an dem Sie beim Erstellen über eine Funktion oder Klassenmethode schreiben. Übrigens sieht das gut aus, was Hunde zum Bellen bringt! !! (Nicht vollständig mit PEP8 kompatibel)

def docstring_sample(hoge1: str):
    """ 
Dies ist die Dokumentzeichenfolge.

Wenn es ein Argument gibt, wird es hier erklärt. (Es gibt einige Vorlagen, also schauen Sie sie sich bitte an.)
Diesmal im numpy Stil

    Parameters
    ----------
        hoge1 : str
Geben Sie die hier eingegebene Zeichenfolge aus"""
    print(hoge1)

Es gibt viele andere Fehlercodes hier -7fdbe163079d) ist gut organisiert!

Werfen wir einen Blick auf den Inhalt von 4xx!

[H401] Docstrings should not start with a space.
[H403] Multi line docstrings should end on a new line.
[H404] Multi line docstrings should start without a leading new line.
[H405] Multi line docstrings should start with a one line summary followed

Ich kann nicht gut Englisch, daher fiel es mir schwer, H404 und H405 zu verstehen ... Ich werde es übersetzen (es ist eine kostenlose Übersetzung)

[H401] Beginnen Sie die Beschreibung von Docstrings nicht mit einem Leerzeichen.
[H403] Wenn Sie eine mehrzeilige Dokumentzeichenfolge schreiben, brechen Sie die Zeile in der letzten Zeile und schließen Sie sie dann.
[H404] Wenn Sie eine mehrzeilige Dokumentzeichenfolge schreiben, lassen Sie zuerst eine Zeile und schreiben Sie dann.
[H405] Wenn Sie eine mehrzeilige Dokumentzeichenfolge schreiben, schreiben Sie vor dem Schreiben eine Zusammenfassung der Funktion in eine Zeile.

darüber.

Wenn ich das lese, ich "Ich verstehe, das bedeutet, dass im vorherigen Beispiel am Ende kein Zeilenumbruch und am Anfang kein Leerzeichen vorhanden war. Schreiben wir es also neu." Bedeutet das so etwas?

def docstring_sample(hoge1: str):
    """ 

Eine Funktion, die das Argument hoge1 ausgibt. (Weil mir zuerst gesagt wurde, ich solle eine Zusammenfassung schreiben)
Dies ist die Dokumentzeichenfolge.

Wenn es ein Argument gibt, wird es hier erklärt. (Es gibt einige Vorlagen, also schauen Sie sie sich bitte an.)
Diesmal im numpy Stil

    Parameters
    ----------
        hoge1 : str
Geben Sie die hier eingegebene Zeichenfolge aus
    """
    print(hoge1)

Damit bellt der Hund jedoch. Der Fehlercode lautet H405. Warum. .. Also habe ich es für ein paar Stunden geschmolzen. (Für mich ist es eine Regel, dass man nicht zum Meister verschmelzen kann, solange der Hund bellt ...)

Ansatz

Nach ein paar Stunden verschiedener Dinge wurde es endlich vom Hund erkannt! !! das ist

Schreiben Sie H405 ganz am Anfang des Docstrings!

Mit anderen Worten, schreiben Sie eine Zusammenfassung, bevor Sie eine Zeile unterbrechen-> eine Zeile unterbrechen.

Endlich haben wir einen Docstring, der der PEP8-Konvention entspricht!

def docstring_sample(hoge1: str):
    """Eine Funktion, die das Argument hoge1 ausgibt.
    
Dies ist die Dokumentzeichenfolge.
Wenn es ein Argument gibt, wird es hier erklärt. (Es gibt einige Vorlagen, also schauen Sie sie sich bitte an.)
Diesmal im numpy Stil

    Parameters
    ----------
        hoge1 : str
Geben Sie die hier eingegebene Zeichenfolge aus
    """
    print(hoge1)

Übrigens, wenn Sie nur eine Zeile docstring schreiben, müssen Sie das "" "" am Ende des Satzes nicht brechen.

def docstring_sample(hoge1:str):
    """Funktion, die das Argument hoge1 ausgibt"""
    print(hoge1)

Zusammenfassung

In PEP8 können Sie dies wie erwartet ignorieren, oder? Ich denke, es gibt mehrere. (Begrenzung der Anzahl der Zeichen in einer Zeile) Wenn Sie sich jedoch beherrschen und es auf rechtmäßige Weise schreiben, erhalten Sie ein Gefühl der Vollendung! Versuch es bitte!

Nachfolgend einige Referenzen! Ich beziehe mich auch auf den Numpy-Stil und benutze ihn immer! Danke, dass du so einfach zu verstehen bist!

Verweise

https://blog.sideci.com/about-style-guide-of-python-and-linter-tool-pep8-pyflakes-flake8-haking-pyling-7fdbe163079d

[Python] Erfahren Sie, wie Sie eine Dokumentzeichenfolge schreiben, um die Lesbarkeit zu verbessern (NumPy-Stil)