Proposed changes to pyflakes's traversal code.

Aperta
  • Qualcosa non va?
#816 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Refactoring
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
python
Ambito
tooling

Direzione di ricerca

Inizia leggendo il percorso di attraversamento tramite Checker.handleNode e Checker.getNodeHandler, quindi esamina le modifiche proposte a handleFields e visitor nella issue. Confronta il comportamento di attraversamento esistente con le PRs prototipo citate, in particolare l’ordine e la copertura di _unknown_handler. Il lavoro è completato quando il refactoring preserva il comportamento di attraversamento, rimuove i meccanismi elencati e include test per il comportamento modificato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

I have spent many happy hours studying pyflakes and its tree traversal methods. This issue proposes several possible simplifications. It's fine with me if you aren't interested.

Overview

All the simplifications follow from these changes:

  • Eliminate the omit and _fieldsOrder kwargs and the _FieldsOrder class.
  • Add/change visitors to specify required traversal order.
  • Rename the visitors so that the visitor's names are the same as the corresponding Ast nodes.

With these changes, Checker.getNodeHandler becomes:

handler = getattr(self, node.__class__.__name__, self.visit)
handler(node)

There is no need for the _nodeHandlers cache because the new code creates no strings.

Only Checker.handleNode calls getNodeHandler so the code above may as well appear in-line.

Other changes

  • Eliminate iter_child_nodes.
  • Add a handleFields method:
def handleFields(self, node, fields):
    """Visit only the *given* children of node in the given order."""
    for field in fields:
        child = getattr(node, field, None)
        if isinstance(child, list):
            for item in child:
                if isinstance(item, ast.AST):
                    self.handleNode(item, node)
        elif isinstance(child, ast.AST):
            self.handleNode(child, node)

def visit(self, node):
    self.visitFields(node._fields)  # Or duplicate the code above to eliminate the call.
  • Add or change visitors to specify the required traversal order. Examples:
def arguments(self, node):
    # Visit all fields except 'defaults' and 'kw_defaults'.
    fields = ('posonlyargs', 'args', 'var arg', 'kwonlyargs', 'kwarg')
    self.handleFields(node, fields)

def DictComp(self, node):
    with self.in_scope(GeneratorScope):
        # Order matters.
        self.handleFields(node, ('generators', 'key', 'value'))
  • Eliminate Checker._unknown_handler. A new unit test would cover its absence.

Summary

These changes are merely suggestions. You can find the prototype code in the five PRs at ekr-fork-pyflakes.
I'll happily make any changes you like in a real PR.

Eliminating kwargs invariably simplifies and generalizes code. For example, it would be straightforward to subclass the new traversal code. The new visitors increase the traversal's speed and make explicit the required traversal order of the visitor's children.

Edward

Lingua principale
Python
Stelle
1.5k
Fork
205
Merge medio
1g 2h
PR unite (30g)
5

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di PyCQA/pyflakes

Tutte le issue di PyCQA/pyflakes

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.