Proposed changes to pyflakes's traversal code.

Abierto
  • ¿Algo no está bien?
#816 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Refactorización
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
python
Área
tooling

Línea de trabajo

Empieza leyendo la ruta de recorrido a través de Checker.handleNode y Checker.getNodeHandler; después, revisa los cambios propuestos para handleFields y visitor en la issue. Compara el comportamiento de recorrido existente con los PRs de prototipo referenciados, especialmente el orden y la cobertura de _unknown_handler. Se considera terminado cuando el refactor conserva el comportamiento de recorrido, elimina los mecanismos indicados e incluye pruebas para el comportamiento modificado.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
Python
Estrellas
1.5k
Forks
205
Merge medio
1 d 2 h
PR fusionados (30 d)
5

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de PyCQA/pyflakes

Todos los issues de PyCQA/pyflakes

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.