tweag/FawltyDeps

Imports protected by TYPE_CHECKING are treated as mandatory

Open

#390 opened on Nov 3, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (18 forks)auto 404
P3good first issueparsing-imports

Repository metrics

Stars
 (288 stars)
PR merge metrics
 (PR metrics pending)

Description

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

Contributor guide

Research direction
Investigate how FawltyDeps parses imports from Python source code. Focus on handling imports inside conditional blocks, especially those guarded by `TYPE CHECKING`. The parser likely traverses the AST and collects all import nodes without filtering out imports within if statements that check `TYPE CHECKING`. Modify the import collection logic to skip imports inside `if TYPE CHECKING:` blocks. Use the `typing.TYPE CHECKING` constant check on the condition.
Tech stack
python
Domain
backenddeveloper experiencetooling
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonAST parsing concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65