Fix completion/linting/type checking with VSCode/pyright #43899
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
Author
|
cc @JDarDagran |
JDarDagran
approved these changes
Nov 11, 2024
Contributor
JDarDagran
left a comment
JDarDagran
left a comment
There was a problem hiding this comment.
As for VSCode user with Pylance enabled - it fixed the issue. Thank you a lot @ashb 🚀
Member
Author
|
Okay sadly we can't do this. By creating this empty file pycharm thinks Okay, think I might have it fixed now. |
ashb
force-pushed
the
fix-vscode-ns-packages
branch
2 times, most recently
from
c3c9847 to
a8f5231
Compare
Pyright (the type engine powering VSCode's python extension) doesn't treat `airflow` as a namespace package because of the `airflow/__init__.py` and it doesn't want to/can't support detecting the `__path__ = ...` method of making it an explicit namespace package, so we are left with no option but to create Yet Another Stub File. Tested by pytting `reveal_type(FAB_VERSION); reveal_type(TaskSDKDag)` inside `_upgrade_outdated_dag_access_control` in `airflow/model/dag.py` -- before this change it was reporting both as Unknown. And to continue to keep Pycharm happy we have to have the `__path__` stanzas without future annotations in all the "empty" files. Ugly, but at least it works
ashb
force-pushed
the
fix-vscode-ns-packages
branch
from
a8f5231 to
73eb25b
Compare
ashb
commented
Nov 12, 2024
| # Similarly we need _a_ file for task_sdk too | ||
| mkdir -p ./task_sdk/src/airflow/sdk/ | ||
| touch ./task_sdk/src/airflow/__init__.py | ||
| touch ./task_sdk/src/airflow/sdk/__init__.py |
Member
Author
There was a problem hiding this comment.
This path was okay before, but since I added exclude = ["src/airflow/__init__.py"] in this PR this path now needs to change.
amoghrajesh
approved these changes
Nov 12, 2024
Contributor
amoghrajesh
left a comment
amoghrajesh
left a comment
There was a problem hiding this comment.
Pycharm test works as expected as discussed offline. LGTM
Member
Author
|
Static check failure unrelated and will be fixed by #43923 |
kaxil
approved these changes
Nov 12, 2024
potiuk
approved these changes
Nov 12, 2024
Member
potiuk
left a comment
potiuk
left a comment
There was a problem hiding this comment.
Cool. Getting it right with PyCharm, VSCode namespace packages and static checks and CLI seems like an interesting game :)
pierrejeambrun
approved these changes
Nov 12, 2024
sunank200
pushed a commit
to astronomer/airflow
that referenced
this pull request
Nov 12, 2024
Pyright (the type engine powering VSCode's python extension) doesn't treat `airflow` as a namespace package because of the `airflow/__init__.py` and it doesn't want to/can't support detecting the `__path__ = ...` method of making it an explicit namespace package, so we are left with no option but to create Yet Another Stub File. Tested by pytting `reveal_type(FAB_VERSION); reveal_type(TaskSDKDag)` inside `_upgrade_outdated_dag_access_control` in `airflow/model/dag.py` -- before this change it was reporting both as Unknown. And to continue to keep Pycharm happy we have to have the `__path__` stanzas without future annotations in all the "empty" files. Ugly, but at least it works
ellisms
pushed a commit
to ellisms/airflow
that referenced
this pull request
Nov 13, 2024
Pyright (the type engine powering VSCode's python extension) doesn't treat `airflow` as a namespace package because of the `airflow/__init__.py` and it doesn't want to/can't support detecting the `__path__ = ...` method of making it an explicit namespace package, so we are left with no option but to create Yet Another Stub File. Tested by pytting `reveal_type(FAB_VERSION); reveal_type(TaskSDKDag)` inside `_upgrade_outdated_dag_access_control` in `airflow/model/dag.py` -- before this change it was reporting both as Unknown. And to continue to keep Pycharm happy we have to have the `__path__` stanzas without future annotations in all the "empty" files. Ugly, but at least it works
kaxil
added a commit
to astronomer/airflow
that referenced
this pull request
Nov 15, 2024
same as Task SDK change in apache#43899 -- but for providers
kaxil
added a commit
that referenced
this pull request
Nov 15, 2024
same as Task SDK change in #43899 -- but for providers
kandharvishnu
pushed a commit
to kandharvishnu/airflow
that referenced
this pull request
Nov 19, 2024
same as Task SDK change in apache#43899 -- but for providers
kosteev
pushed a commit
to GoogleCloudPlatform/composer-airflow
that referenced
this pull request
May 27, 2025
same as Task SDK change in apache/airflow#43899 -- but for providers GitOrigin-RevId: eed59f1e96f590edcc95327b2874dd95bb8137ca
kosteev
pushed a commit
to GoogleCloudPlatform/composer-airflow
that referenced
this pull request
Sep 23, 2025
same as Task SDK change in apache/airflow#43899 -- but for providers GitOrigin-RevId: eed59f1e96f590edcc95327b2874dd95bb8137ca
kosteev
pushed a commit
to GoogleCloudPlatform/composer-airflow
that referenced
this pull request
Oct 20, 2025
same as Task SDK change in apache/airflow#43899 -- but for providers GitOrigin-RevId: eed59f1e96f590edcc95327b2874dd95bb8137ca
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pyright (the type engine powering VSCode's python extension) doesn't treat
airflowas a namespace package because of theairflow/__init__.pyand itdoesn't want to/can't support detecting the
__path__ = ...method of makingit an explicit namespace package, so we are left with no option but to create
Yet Another Stub File.
Tested by pytting
reveal_type(FAB_VERSION); reveal_type(TaskSDKDag)inside_upgrade_outdated_dag_access_controlinairflow/model/dag.py-- beforethis change it was reporting both as Unknown.