tweag/FawltyDeps

Imports protected by TYPE_CHECKING are treated as mandatory

Aperta

#390 aperta il 3 nov 2023

Vedi su GitHubGuida contributor
 (1 commento) (0 reazioni) (0 assegnatari)Python (18 fork)auto 404
P3good first issueparsing-imports

Metriche repository

Star
 (288 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

Describe the bug

Code which is protected by TYPE_CHECKING is listed as a required import. I'm not sure if to class this as a bug or a feature request but this template fits better.

For example:

from typing import TYPE_CHECKING
import foo
if TYPE_CHECKING:
    import bar

To Reproduce

bash-5.2$ echo $'from typing import TYPE_CHECKING\nimport foo\nif TYPE_CHECKING:\n    import bar' | fawltydeps --list-imports --code - --detailed
<stdin>:2: foo
<stdin>:4: bar

Expected behavior

Import protected by TYPE_CHECKING can be ignored.

Environment

  • Version of the code: 0.13.2

Additional context

Guida contributor

Direzione di ricerca
Indaga su come FawltyDeps analizza le importazioni dal codice sorgente Python. Concentrati sulla gestione delle importazioni all'interno di blocchi condizionali, specialmente quelli protetti da `TYPE CHECKING`. Il parser probabilmente attraversa l'AST e raccoglie tutti i nodi di importazione senza filtrare quelli all'interno di istruzioni if che controllano `TYPE CHECKING`. Modifica la logica di raccolta delle importazioni per saltare quelle all'interno dei blocchi `if TYPE CHECKING:`. Usa un controllo sulla costante `typing.TYPE CHECKING` nella condizione.
Tech stack
python
Dominio
backenddeveloper experiencetooling
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonAST parsing concepts
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65