Skip to content

Conversation

@gopidesupavan
Copy link
Member


^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in newsfragments.

@gopidesupavan
Copy link
Member Author

To save few clicks from manually select each directory 😄

We can update this file as we restructure so that it will be easy to fixup all in one go

Copy link
Contributor

@bugraoz93 bugraoz93 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Thanks for adding!

@potiuk
Copy link
Member

potiuk commented Feb 28, 2025

Hmm. I thought about it, but there are two things:

  • we need to make sure this one gets updated (pre-commit?)
  • why don't we commit both modules.iml and corresponding airflow.iml and dev/breeze/breeze.iml directly to the repo?

They seem to be portable, with relative references - IntelliJ ultimate and Pycharm seem to have the same format and work similarly, I can't see why we should not be able remove those files from .gitignore and commit them.

@potiuk
Copy link
Member

potiuk commented Feb 28, 2025

We could also commit equivalent configuration from vscode if it is portable and separate from all other vscode configuration.

@potiuk
Copy link
Member

potiuk commented Feb 28, 2025

The only problem I see that in breeze we might want to have another venv:

    <orderEntry type="jdk" jdkName="Python 3.12 (breeze)" jdkType="Python SDK" />
    <orderEntry type="sourceFolder" forTests="false" />

(BTW. It's funny how you can see that IntelliJ is just twisted java environment... jdkName= "Python 3.12 (breeze)" 🤣

@potiuk
Copy link
Member

potiuk commented Feb 28, 2025

BTW. I am not super strong on the committing, copying the files will mostly work as well, and that "jdk" is potentially blocking, but might be worth seeing if that will work :).

It woudl be awesome if contributor just opens the airflow folder as project in PyCharm/IntelliJ and has everything set-up.

@gopidesupavan
Copy link
Member Author

BTW. I am not super strong on the committing, copying the files will mostly work as well, and that "jdk" is potentially blocking, but might be worth seeing if that will work :).

It woudl be awesome if contributor just opens the airflow folder as project in PyCharm/IntelliJ and has everything set-up.

For JdkName it actually auto populated when i created virtual environment, so when we change interpreter paths in Pycharm settings then that will update the airflow.iml file. i have tested changing multiple paths in pycharm interpreter its updating the airflow.impl file

ah not sure how to setup when airflow folder opens :)

@gopidesupavan
Copy link
Member Author

gopidesupavan commented Feb 28, 2025

I have another idea, can add python script, it generates airflow.iml, module.xml files and updates automatically something like this cli.

python setup_ide.py --venv_name {}

We can update this script whenever changes happens :) ?

So users has to run first time and when any new changes happens.

@potiuk
Copy link
Member

potiuk commented Feb 28, 2025

I have another idea, can add python script, it generates airflow.iml, module.xml files and updates automatically something like this cli.

That seems like a nice middle ground

@gopidesupavan gopidesupavan changed the title Alternative method to mark source roots in pycharm Alternative method to mark source roots in PyCharm/IntelliJ IDEA Mar 24, 2025
Copy link
Member

@potiuk potiuk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️

@potiuk
Copy link
Member

potiuk commented Mar 24, 2025

Constraint/static check failure is setuptools mayhem - being fixed in #48210

@potiuk potiuk merged commit 695c597 into apache:main Mar 24, 2025
40 of 42 checks passed
@gopidesupavan gopidesupavan deleted the update-pycharm-doc branch March 24, 2025 18:44
got686-yandex pushed a commit to got686-yandex/airflow that referenced this pull request Mar 24, 2025
…che#47184)

* add pycharm idea airflow impl file to mark source root and tests

* add pycharm idea airflow impl file to mark source root and tests

* Update contributing-docs/quick-start-ide/contributors_quick_start_pycharm.rst

Co-authored-by: Kalyan R <kalyan.ben10@live.com>

* Update setup_idea script to create source roots in PyCharm and IntelliJ

---------

Co-authored-by: Kalyan R <kalyan.ben10@live.com>
pankajkoti pushed a commit to astronomer/airflow that referenced this pull request Mar 28, 2025
…che#47184)

* add pycharm idea airflow impl file to mark source root and tests

* add pycharm idea airflow impl file to mark source root and tests

* Update contributing-docs/quick-start-ide/contributors_quick_start_pycharm.rst

Co-authored-by: Kalyan R <kalyan.ben10@live.com>

* Update setup_idea script to create source roots in PyCharm and IntelliJ

---------

Co-authored-by: Kalyan R <kalyan.ben10@live.com>
shubham-pyc pushed a commit to shubham-pyc/airflow that referenced this pull request Apr 2, 2025
…che#47184)

* add pycharm idea airflow impl file to mark source root and tests

* add pycharm idea airflow impl file to mark source root and tests

* Update contributing-docs/quick-start-ide/contributors_quick_start_pycharm.rst

Co-authored-by: Kalyan R <kalyan.ben10@live.com>

* Update setup_idea script to create source roots in PyCharm and IntelliJ

---------

Co-authored-by: Kalyan R <kalyan.ben10@live.com>
nailo2c pushed a commit to nailo2c/airflow that referenced this pull request Apr 4, 2025
…che#47184)

* add pycharm idea airflow impl file to mark source root and tests

* add pycharm idea airflow impl file to mark source root and tests

* Update contributing-docs/quick-start-ide/contributors_quick_start_pycharm.rst

Co-authored-by: Kalyan R <kalyan.ben10@live.com>

* Update setup_idea script to create source roots in PyCharm and IntelliJ

---------

Co-authored-by: Kalyan R <kalyan.ben10@live.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants