Si vous ne suivez pas les règles PEP8, votre chien aboyera!?

python a un guide de style et une norme de codage appelés PEP8. Dans le cas d'une équipe, en vérifiant le code pour voir s'il respecte la convention PEP8, il sera aligné dans un style d'écriture commun, le rendant plus lisible et plus facile à développer. Vous pouvez vérifier PEP8 lorsque vous poussez vers github, etc. ou lorsque vous effectuez une demande d'extraction. À ce stade, les outils CI sont utilisés pour effectuer des tests et vous informer de tout point qui enfreint les règles. Un de ces outils est reviewdog. ファイル名

Si vous agissez contrairement aux règles PEP8, vous serez aboyé par ce chien. .. ファイル名

On m'a dit que le chien n'arrêtait pas d'aboyer en raison des erreurs H404 et H405 liées à la docstring, et j'ai fait de mon mieux pour corriger le code et laisser le chien me pardonner.

Contenu du code d'erreur H4xx

Le code d'erreur de la série H4xx est lié à ** docstring **. La docstring est l'endroit où vous écrivez sur une fonction ou une méthode de classe lorsque vous la créez. Au fait, cela a l'air bien docstring, ce qui fait aboyer les chiens! !! (Pas entièrement conforme à PEP8)

def docstring_sample(hoge1: str):
    """ 
Ceci est le docstring.

S'il y a un argument, il sera expliqué ici. (Il existe des modèles, veuillez donc les consulter.)
Cette fois dans un style numpy

    Parameters
    ----------
        hoge1 : str
Sortie de la chaîne de caractères saisie ici"""
    print(hoge1)

Il existe de nombreux autres codes d'erreur [ici](https://blog.sideci.com/about-style-guide-of-python-and-linter-tool-pep8-pyflakes-flake8-haking-pyling -7fdbe163079d) est bien organisé!

Jetons un coup d'œil au contenu de 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

Je ne suis pas bon en anglais, j'ai donc eu du mal à comprendre H404 et H405 ... Je vais le traduire (c'est une traduction gratuite)

[H401] Ne commencez pas la description de Docstrings avec un espace.
[H403] Lors de l'écriture d'une docstring multiligne, coupez la ligne à la dernière ligne puis fermez-la.
[H404] Lors de l'écriture d'une docstring multiligne, laissez d'abord une ligne, puis écrivez.
[H405] Lors de l'écriture d'une docstring multiligne, écrivez un résumé de la fonction sur une ligne avant d'écrire.

à propos de ça.

Quand je lis ceci, je "Je vois, cela signifie que dans l'exemple précédent, il n'y avait pas de saut de ligne à la fin, et il n'y avait pas d'espace au début, alors réécrivons-le." Est-ce que ça veut dire quelque chose comme ça?

def docstring_sample(hoge1: str):
    """ 

Une fonction qui génère l'argument hoge1. (Parce qu'on m'a dit d'écrire un résumé au début)
Ceci est le docstring.

S'il y a un argument, il sera expliqué ici. (Il existe des modèles, veuillez donc les consulter.)
Cette fois dans un style numpy

    Parameters
    ----------
        hoge1 : str
Sortie de la chaîne de caractères saisie ici
    """
    print(hoge1)

Cependant, avec cela, ** le chien aboie **. Le code d'erreur est H405. Pourquoi. .. Alors je l'ai fait fondre pendant quelques heures. (Pour moi, c'est une règle que vous ne pouvez pas fusionner avec le maître tant que le chien aboie ...)

approche

Après quelques heures à faire diverses choses, il a finalement été reconnu par le chien! !! C'est

Écrivez H405 au tout début de la docstring!

En d'autres termes, rédigez un résumé avant de rompre une ligne-> rompre une ligne.

Enfin, nous avons une docstring conforme à la convention PEP8!

def docstring_sample(hoge1: str):
    """Une fonction qui génère l'argument hoge1.
    
Ceci est le docstring.
S'il y a un argument, il sera expliqué ici. (Il existe des modèles, veuillez donc les consulter.)
Cette fois dans un style numpy

    Parameters
    ----------
        hoge1 : str
Sortie de la chaîne de caractères saisie ici
    """
    print(hoge1)

Au fait, si vous n’écrivez qu’une seule ligne de docstring, vous n’avez pas besoin de casser le «» «» à la fin de la phrase.

def docstring_sample(hoge1:str):
    """Fonction qui génère l'argument hoge1"""
    print(hoge1)

Résumé

Dans PEP8, vous pouvez ignorer cela comme prévu, non? Je pense qu'il y en a plusieurs. (Limitation du nombre de caractères sur une ligne) Cependant, si vous vous disciplinez et que vous l'écrivez de manière légale, cela vous donnera un sentiment d'accomplissement! Essayez-le!

Voici quelques références! Je me réfère également au style numpy et je l'utilise toujours! Merci d'être si facile à comprendre!

Les références

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

[Python] Apprenez à écrire une docstring pour améliorer la lisibilité (style NumPy)