Python: éviter pylint avertissements sur trop d'arguments

Je veux refactoriser un gros Python fonction en petits. Considérons, par exemple, cet extrait de code suivant:

x = x1 + x2 + x3 + x4 + x5 + x6 + x7 + x8 + x9

De sûr, c'est un exemple trivial. Dans la pratique, le code est plus complexe. Mon point est qu'il contient beaucoup de locaux-portée des variables qui doivent être transmises à l'extrait de fonction, qui pourrait ressembler à:

def mysum(x1, x2, x3, x4, x5, x6, x7, x8, x9):
    x = x1 + x2 + x3 + x4 + x5 + x6 + x7 + x8 + x9
    return x

Le problème est que pylint pourrait déclencher un avertissement sur trop d'arguments.
J'ai pu éviter l'avertissement en faisant quelque chose comme:

def mysum(d):
    x1 = d['x1']
    x2 = d['x2']
    ...
    x9 = d['x9']
    x = x1 + x2 + x3 + x4 + x5 + x6 + x7 + x8 + x9
    return x

def mybigfunction():
    ...
    d = {}
    d['x1'] = x1
    ...
    d['x9'] = x9
    x = mysum(d)

mais cette approche loos laid pour moi, il nécessite d'écrire beaucoup de code qui est même superflu.

Est-il un meilleur moyen de le faire?

  • Je crois mysum() peut être simplifiée: 'return sum(d.les valeurs ()) "ou au moins" return sum([d[foo] pour les foo in ('x1', 'x2', ..., 'x9')])'. Suis-je trop liste-de la compréhension heureux?
  • Le mysum() n'est qu'une abstraction, dans des scénarios réels, le code qui doit être extraite est beaucoup plus complexe. Mon point, c'est avoir à passer beaucoup de variables à l'extrait de fonction et d'éviter la pylint avertissement si possible (sans explicitement pylint de simplement ignorer cet avertissement).
InformationsquelleAutor Anonymous | 2009-05-03
  1. 86

    Tout d'abord, l'un des Perlis de l'épigramme:

    "Si vous avez une procédure avec 10
    les paramètres, vous avez sans doute manqué quelques-uns."

    Les 10 arguments sont sans doute liés. Les regrouper dans un objet, et de passer à la place.

    Faire un exemple, parce qu'il n'y a pas assez d'informations dans la question directement:

    class PersonInfo(object):
  def __init__(self, name, age, iq):
    self.name = name
    self.age = age
    self.iq = iq

    Alors vos 10 argument de la fonction:

    def f(x1, x2, name, x3, iq, x4, age, x5, x6, x7):
  ...

    devient:

    def f(personinfo, x1, x2, x3, x4, x5, x6, x7):
  ...

    et l'appelant des modifications:

    personinfo = PersonInfo(name, age, iq)
result = f(personinfo, x1, x2, x3, x4, x5, x6, x7)
    • J'aime cette réponse, car elle montre comment penser le problème!
    • Notez qu'à partir de la version 2.6 de Python, vous pouvez utiliser des collections.namedtuple de faire exactement la même chose au lieu de la classe.
    InformationsquelleAutor
  2. 35

    Voulez-vous une meilleure façon de passer les arguments ou tout simplement un moyen d'arrêter pylint de vous donner un moment difficile? Dans ce dernier cas, il me semble que vous pourriez arrêter de le harceler en mettant pylintcontrôle des commentaires dans votre code, le long des lignes de:

    #pylint: disable-msg=R0913

    ou:

    #pylint: disable-msg=too-many-arguments

    souvenir pour les réactiver dès que possible.

    À mon avis, il n'y a rien intrinsèquement de mal avec le passage d'un grand nombre d'arguments et de préconiser des solutions d'emballage tout en haut dans certains conteneur argument n'est pas vraiment à résoudre tous les problèmes, autres que de s'arrêter pylint de vous tarauder :-).

    Si vous avez besoin de passer vingt arguments, puis de les transmettre. Il se peut que cela est nécessaire parce que votre fonction est d'en faire trop et d'une re-factoring pourrait aider, et c'est quelque chose que vous devriez regarder. Mais ce n'est pas une décision nous peut vraiment faire à moins que nous voir ce que le "vrai" code de l'est.

    • Cette réponse encourage vraiment mauvaises habitudes - lire maintenant en 2015. 1) désactiver les vérifications de leur nombre - moderne pylint prise en charge des versions symbolique descripteurs, beaucoup plus explicatif 2) désactiver quelque chose doit avoir aussi un commentaire avec une explication de la raison pour laquelle il est désactivé 3) il doit y avoir qu'une directive par ligne, équilibrée par une réactivation 4) Généralement pylint a un point. Code des affrontements avec ces limites, est probablement illisible/difficile à maintenir. 5) Plutôt que de passer à un déluge de paramètres, il est beaucoup mieux d'utiliser un dictionnaire, ou un nom de tuple.
    • Igor, c'est pourquoi j'ai dit "le long des lignes de". Par tous les moyens d'utiliser la symbolique plutôt que des nombres, ou un par ligne, ou un commentaire pourquoi, ou ré-activer (bien que vous devriez considérer ce qui signifie que si il avait été désactivé - mieux serait une méthode pour enregistrer/désactiver/rétablir). Aucun de ces changements, l'utilité de la réponse elle-même, qui est de dire pylint pour arrêter l'alerte sur un problème de l'utilisateur le sait ils ne veulent pas en entendre parler (et accepte les conséquences).
    • L'utilisateur le plus probable est souvent dans l'auto-contradiction: pylint n'est pas le plus explicite de l'outil dans ce sens, mais les avertissements donnés ont généralement beaucoup plus profond que ce que le message semble donner. De sorte que l'utilisateur peut pense de savoir quelles en sont les conséquences sont acceptés, mais il n'a pas d'apprécier pleinement les implications.
    • À compter de 2017 (pylint 1.6.5), disable-msg et enable-msg sont désormais obsolète. Vous êtes censé utiliser uniquement disable et enable (description symbolique qui fonctionne avec ces).
    InformationsquelleAutor paxdiablo
  3. 21

    Vous pouvez facilement changer le nombre maximal d'arguments dans pylint. Il suffit d'ouvrir votre pylintrc fichier (générer si vous n'avez pas déjà un) et le changement:

    max-args=5

    à:

    max-args = 6 #, ou toute valeur qui vous convient

    De pylint de manuel

    Spécifier toutes les options appropriées
    pour votre installation et les normes de codage
    peut être fastidieux, il est donc possible d'
    utiliser un fichier rc pour spécifier la valeur par défaut
    des valeurs. Pylint recherche /etc/pylintrc
    et ~/.pylintrc. L' --generate-rcfile
    option génère un commenta
    fichier de configuration selon l'
    configuration en cours sur la norme de
    de sortie et la sortie. Vous pouvez mettre d'autres
    les options avant de celui-ci pour utilisation dans
    la configuration, ou de commencer avec la
    les valeurs par défaut et de la main de régler le
    la configuration.

    • Cependant, si il ya d'autres personnes dans votre équipe, de réviser votre code dans leurs propres environnements, qu'ils seront toujours à ces avertissements.
    InformationsquelleAutor Nadia Alramli
  4. 12

    Vous pouvez essayer d'utiliser Python est variable d'arguments fonctionnalité:

    def myfunction(*args):
    for x in args:
        # Do stuff with specific argument here
    • C'est le même que l'aide d'une liste, voir ci-dessous.
    InformationsquelleAutor hbw
  5. 7

    Vous pourriez peut-être quelques uns des arguments dans les variables. Si vous avez besoin de beaucoup plus d'état d'une classe sonne comme une bonne idée pour moi.

    • Ne fonctionne pas si j'ai besoin de revoir une méthode de classe et transmis variables sont locales à la grande refonte de la méthode et ne sont pas utilisés dans l'ensemble de la classe.
    • Non, mais si vous extrayez un nouveau type, au lieu de vous peuvent être en mesure de transformer certains de l'état dans les variables.
    InformationsquelleAutor Brian Rasmussen
  6. 6

    De simplifier ou de séparer la fonction de sorte qu'il ne nécessite pas neuf arguments (ou ignorer pylint, mais esquive comme ceux que vous proposez à l'encontre du but de la charpie de l'outil).

    EDIT: si c'est une mesure temporaire, désactiver l'avertissement pour la fonction en question à l'aide d'un commentaire tel que décrit ici: http://lists.logilab.org/pipermail/python-projects/2006-April/000664.html

    Plus tard, vous pouvez grep pour toutes les personnes handicapées mises en garde.

    • Mon objectif est de briser la grande fonction première. Ensuite, j'ai pu procéder à la pause, les petites parties plus loin. Mais je veux éviter ce pylint attention pendant le processus de refactorisation, si cela est possible.
    InformationsquelleAutor Dave
  7. 4

    Je n'aime pas se référant à la le nombre, la sybolic nom est beaucoup plus expressive et éviter d'avoir à ajouter un commentaire qui pourrait devenir obsolètes au fil du temps.

    Donc je ferais plutôt:

    #pylint: disable-msg=too-many-arguments

    Et je recommande aussi de ne pas le laisser pendre là: il restera actif jusqu'à ce que le fichier se termine ou s'il est désactivé, selon la première éventualité.

    Afin de mieux faire:

    #pylint: disable-msg=too-many-arguments
code_which_would_trigger_the_msg
#pylint: enable-msg=too-many-arguments

    Je vous recommande également l'activation/la désactivation d'un seul avertissement/d'erreur par ligne.

    InformationsquelleAutor Igor Stoppa
  8. 0

    Python a quelques belles fonctionnelle des outils de programmation qui sont susceptibles de correspondre à vos besoins. Découvrez lambda fonctions et carte. Aussi, vous êtes à l'aide dicts quand il semble que vous seriez beaucoup mieux servi avec des listes. Pour la simple exemple fourni par vous, essayez de cet idiome. Notez que la carte serait mieux et plus vite, mais ne peuvent pas s'adapter à vos besoins:

    def mysum(d):
   s = 0  
   for x in d:
        s += x
   return s

def mybigfunction():
   d = (x1, x2, x3, x4, x5, x6, x7, x8, x9)
   return mysum(d)

    Vous avez mentionné le fait d'avoir beaucoup de variables locales, mais franchement, si vous faites affaire avec des listes (ou tuples), vous devez utiliser les listes et le facteur de tous ces variables locales dans le long terme.

    • Je ne peux pas utiliser une liste. Dans mon exemple trivial mon passé variables jouent le même rôle. Mais dans un scénario complexe les variables ont des significations différentes, afin de remplacer leurs noms (qui portent une logique du sens) avec les éléments de la liste accessible par l'indice de totalement détruire la lisibilité du code.
    • Vous devrez utiliser le dict ensuite. Cela dit, vous n'allez pas être en mesure de nettoyer des trucs beaucoup moins de changer certaines de vos exigences. Vous pouvez également définir une classe pour tous ces trucs et puis poussez la logique dans les différentes méthodes de la classe. probablement plus propre que le massif si-alors arbre basé sur un dict, au moins!
    InformationsquelleAutor easel
  9. -2

    Je suis tombé sur la même lancinante erreur, que j'ai réalisé a quelque chose à voir avec une fonction cool PyCharm détecte automatiquement...il suffit d'ajouter le @staticmethod décorateur, et il sera automatiquement supprimer cette erreur, où la méthode est utilisée

    InformationsquelleAutor Ants