Il s'agit de la commande pep257 qui peut être exécutée dans le fournisseur d'hébergement gratuit OnWorks en utilisant l'un de nos multiples postes de travail en ligne gratuits tels que Ubuntu Online, Fedora Online, l'émulateur en ligne Windows ou l'émulateur en ligne MAC OS
PROGRAMME:
Nom
pep257 - documentation pep257
pep257 est un outil d'analyse statique pour vérifier la conformité avec Python PEP 257.
Contenu:
UTILISATION
Command Gamme Interface
Utilisation
Utilisation : pep257 [options] [ ...]
Options:
--version affiche le numéro de version du programme et quitte
-h, --help affiche ce message d'aide et quitte
-e, --explain affiche l'explication de chaque erreur
-s, --source afficher la source pour chaque erreur
--select= choisissez la liste de base des erreurs vérifiées en spécifiant
quelles erreurs vérifier (avec une liste de virgules
codes d'erreur séparés). par exemple:
--select=D101,D202
--ignore= choisissez la liste de base des erreurs vérifiées en spécifiant
quelles erreurs ignorer (avec une liste d'erreurs séparées par des virgules
codes d'erreur). par exemple : --ignore=D101,D202
--convention= choisissez la liste de base des erreurs vérifiées en spécifiant
une convention existante. Conventions possibles : pep257
--add-select= modifier la liste des erreurs à vérifier en précisant
plus de codes d'erreur à vérifier.
--add-ignore= modifier la liste des erreurs à vérifier en précisant
plus de codes d'erreur à ignorer.
--match= vérifier uniquement les fichiers qui correspondent exactement ordinaire
expression; la valeur par défaut est --match='(?!test_).*\.py' qui
correspond aux fichiers qui ne commencent pas par 'test_' mais se terminent
avec '.py'
--match-dir=
rechercher uniquement les répertoires qui correspondent exactement ordinaire
expression; la valeur par défaut est --match-dir='[^\.].*', qui
correspond à tous les répertoires qui ne commencent pas par un point
-d, --debug affiche les informations de débogage
-v, --verbose affiche les informations d'état
--count affiche le nombre total d'erreurs vers la sortie standard
Retour Code
??
│0 │ Succès - aucune violation │
??
│1 │ Certaines violations de code ont été trouvées │
??
│2 │ Utilisation illégale - voir erreur │
│ message │
??
Configuration Documents officiels
pep257 supports ini-comme des fichiers de configuration. Afin de pep257 pour l'utiliser, il doit être
nommé configuration.cfg, tox.ini or .pep257 . Retenons donc les deux mots suivants [pep257] .
Lors de la recherche d'un fichier de configuration, pep257 recherche l'un des fichiers spécifiés ci-dessus
in qui exacte de commander. Si un fichier de configuration n'a pas été trouvé, il continue à en rechercher un
l'arborescence des répertoires jusqu'à ce qu'on en trouve un ou utilise la configuration par défaut.
Disponible Options
Toutes les options de configuration ne sont pas disponibles dans les fichiers de configuration. Options disponibles
sont:
· congrès
· Sélectionner
· ignorer
· add_select
· ajouter_ignorer
· rencontre
· rép_match
Voir le Utilisation section pour plus d'informations.
Droit des successions
Par défaut, lors de la recherche d'un fichier de configuration, pep257 essaie d'hériter du parent
configuration du répertoire et les fusionner avec les locaux.
Le processus de fusion est le suivant :
· Si l'un des Sélectionner, ignorer or congrès a été spécifié dans la configuration enfant -
Ignore la configuration parente et définit les nouveaux codes d'erreur à vérifier. Sinon, tout simplement
copie les codes d'erreur vérifiés par le parent.
· Si ajouter-ignorer or ajouter-sélectionner ont été spécifiés, ajoute ou supprime les codes d'erreur spécifiés
de la liste des codes d'erreur vérifiés.
· Si rencontre or répertoire-match ont été spécifiés - utilisez-les. Sinon, utilisez celui des parents.
Afin de désactiver cela (utile pour les fichiers de configuration situés à la racine de votre référentiel),
ajoutez simplement hériter=faux dans votre fichier de configuration.
NOTE:
Si l'un des Sélectionner, ignorer or congrès ont été spécifiés dans la CLI, la configuration
les fichiers ne participeront pas au choix des codes d'erreur à vérifier. rencontre et mes
répertoire-match prendra toujours effet.
Exemple
[pep257]
hériter = faux
ignorer = D100,D203,D405
correspondance = *.py
ERREUR CODES
regroupement
?? ??
│Manquant Docstrings │
?? ??
│D100 │ Chaîne de documentation manquante en public │
│ module │
?? ??
│D101 │ Chaîne de documentation manquante en public │
│ │ classe │
?? ??
│D102 │ Chaîne de documentation manquante en public │
│ méthode │
?? ??
│D103 │ Chaîne de documentation manquante en public │
│ fonction │
?? ??
│D104 │ Chaîne de documentation manquante en public │
│ paquet │
?? ??
│D105 │ Docstring manquant dans la magie │
│ méthode │
?? ??
│Espace blanc Questions │
?? ??
│D200 │ La docstring d'une ligne doit tenir
│ │ une ligne avec des guillemets │
?? ??
│D201 │ Aucune ligne vierge n'est autorisée avant │
│ │ fonction docstring │
?? ??
│D202 │ Aucune ligne vierge autorisée après │
│ │ fonction docstring │
?? ??
│D203 │ 1 ligne vierge obligatoire avant │
│ │ docstring de classe │
?? ??
│D204 │ 1 ligne vierge requise après │
│ │ docstring de classe │
?? ??
│D205 │ 1 ligne vide requise entre │
│ │ ligne récapitulative et description │
?? ??
│D206 │ La Docstring doit être indentée │
│ │ avec des espaces, pas des tabulations │
?? ??
│D207 │ Docstring est sous-indenté │
?? ??
│D208 │ La Docstring est trop indentée │
?? ??
│D209 │ Fermeture de la docstring multiligne │
│ │ les citations doivent être sur un séparé
│ ligne │
?? ??
│D210 │ Pas d'espaces autorisés │
│ │ texte docstring environnant │
?? ??
│D211 │ Aucune ligne vierge n'est autorisée avant │
│ │ docstring de classe │
?? ??
│ Devis Questions │
?? ??
│D300 │ Utilisez """guillemets triples""" │
?? ??
D301 │ Utilisez r""" s'il y a des barres obliques inverses dans un │
│ │ chaîne de documentation │
?? ??
│D302 │ Utilisez u""" pour les docstrings Unicode │
?? ??
│Docstring Contenu Questions │
?? ??
│D400 │ La première ligne doit se terminer par un │
│ période │
?? ??
│D401 │ La première ligne doit être en │
humeur impérative │
?? ??
│D402 │ La première ligne ne doit pas être le │
│ "signature" de la fonction │
?? ??
Réglage par défaut Contrôles
Tous les codes d'erreur ne sont pas vérifiés par défaut. Le comportement par défaut est de vérifier uniquement
codes d'erreur qui font partie du PEP257 congrès officiel.
Tous les codes d'erreur ci-dessus sont vérifiés par défaut, à l'exception de D203.
Créé par Vladimir Keleshev.
Maintenu par Amir Rachum.
Utilisez pep257 en ligne en utilisant les services onworks.net
