Parser: a field declared under `if`/`else` in the class body is lost

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

@X6M-Work ya está trabajando en esto.

Desde el 14/11/2026.

  • #259 de @X6M-Work — abierto

Evaluación

Dificultad
3/5
Tiempo estimado
Medio día
Aptitud para principiantes
35/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
django, python
Área
databases, devtools

Línea de trabajo

Start in cli/orm_lens/parser.py: _build_body_regexes() near line 150 only matches class-body indent, and the body loop in _collect_defs() (around lines 606-700) is where block openers like if/else at class level would need handling. Reproduce with the docs/models.py example via orm-lens describe docs.Doc and add the test in cli/tests/test_conditional_models.py. Done means title_upper appears once, def bodies add nothing, and test_golden_snapshots.py is unchanged; a linked open PR (#259) already covers this, so check it before starting.

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

Descripción

bug help wanted python

Source: label-studio — label_studio/projects/models.py:1361 (Project.search_vector)

What happens

Some models pick a field depending on the database:

class Project(models.Model):
    ...
    if connection.vendor == "postgresql":
        search_vector = GeneratedField(...)
    else:
        search_vector = models.TextField(null=True, blank=True)

Body regexes are built for exactly the class-body indent (_build_body_regexes(indent)), so lines one level deeper never match. Both branches are skipped and the field is gone. On label-studio that's projects.Project.search_vector, reported by drift as "migrated but no longer declared".

Note: even with models.TextField in both branches the field is lost, so it isn't only about GeneratedField (that one is #6 above).

Repro

docs/models.py

from django.db import connection, models


class Doc(models.Model):
    title = models.CharField(max_length=200)

    if connection.vendor == "postgresql":
        title_upper = models.TextField(db_comment="pg")
    else:
        title_upper = models.TextField(null=True)

    body = models.TextField()

    class Meta:
        ordering = ["title"]

$ orm-lens describe docs.Doc
| `title` | CharField | `max_length=200` |
| `body` | TextField | `` |

Expected: title, title_upper, body.

Where

cli/orm_lens/parser.py

  • line 150, _build_body_regexes();
  • around lines 606–700, the body loop in _collect_defs().
Suggested fix

When a body line at class indent is a block opener (if ...:, elif ...:, else:, try:, except ...:, finally:), match the lines in that block with _build_body_regexes(indent + <block indent>) too. Keep the first definition of a name and ignore the rest, so the two branches don't give two title_upper fields. Methods (def) must stay out of this; only plain block statements count.

This touches the core loop, hence help wanted. src/parser.ts has the same loop, and test/fixtures/parity_input.py is the shared contract. A Python-only fix is fine, but leave a note in the PR so the TS side can follow.

How to test
  • A new test in cli/tests/test_conditional_models.py with the repro: three fields, title_upper once.
  • A method with an if inside (def save(self): if x: y = models.Q()) adds no field.
  • The golden snapshots don't change (test_golden_snapshots.py), or the PR explains why.
  • cd cli && python -m pytest -q, ruff and mypy pass.

Difficulty: help wanted, a few hours. Ask in the issue before you start if the approach is unclear.

Lenguaje dominante
Python
Estrellas
84
Forks
13
Sin PR fusionados en 30 d

Preparar el entorno

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 FROWNINGdev/django-orm-lens

Todos los issues de FROWNINGdev/django-orm-lens

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.