Improve documentation and examples in example_asana.py #15959
Conversation
|
This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 5 days if no further activity occurs. Thank you for your contributions. |
github-actions
bot
added
the
stale
jmelot
force-pushed
the
improve-asana-example-dag-documentation
branch
from
fe9a8ca
to
2cea2d8
Compare
|
Hi @ephraimbuddy, thanks for your comment above and sorry it was so long before I was able to get back to this. I added a system test. Please let me know if you have other suggestions or I need to make other modifications! |
uranusjr
removed
the
stale
| ASANA_TASK_TO_UPDATE = os.environ.get("ASANA_TASK_TO_UPDATE") | ||
| ASANA_TASK_TO_DELETE = os.environ.get("ASANA_TASK_TO_DELETE") | ||
| ASANA_PROJECT_ID = os.environ.get("ASANA_PROJECT_ID") | ||
| CONN_ID = os.environ.get("ASANA_CONNECTION_ID") |
There was a problem hiding this comment.
Is None an acceptable value for any of these? If not, it’s better to use os.environ["ASANA_TASK_TO_UPDATE"] etc. instead.
There was a problem hiding this comment.
Oh good point -- done! (that also reminded me to add some comments describing how the connection should be set up as well)
There was a problem hiding this comment.
Actually, this leads to an import error when ci_prepare_provider_documentation.sh gets run -- switching back to os.environ.get for now, though will check around later and see if there's another way to resolve.
There was a problem hiding this comment.
Hmm. Strange. Should not do that :)
There was a problem hiding this comment.
can you point me to the error :) ?
There was a problem hiding this comment.
Hi @potiuk! This is the error I saw (tried to link to the relevant line but that doesn't seem to be working - it's line 449, I'll paste the stack trace below). I can revert my previous commit so this error will get triggered again, if that would be useful, or let me know anything else I can do to help.
Traceback (most recent call last):
File "/opt/airflow/dev/import_all_classes.py", line 77, in import_all_classes
_module = importlib.import_module(modinfo.name)
File "/usr/local/lib/python3.6/importlib/__init__.py", line 126, in
import_module
return _bootstrap._gcd_import(name, package, level)
File "<frozen importlib._bootstrap>", line 994, in _gcd_import
File "<frozen importlib._bootstrap>", line 971, in _find_and_load
File "<frozen importlib._bootstrap>", line 955, in _find_and_load_unlocked
File "<frozen importlib._bootstrap>", line 665, in _load_unlocked
File "<frozen importlib._bootstrap_external>", line 678, in exec_module
File "<frozen importlib._bootstrap>", line 219, in _call_with_frames_removed
File "/opt/airflow/airflow/providers/asana/example_dags/example_asana.py",
line 36, in <module>
ASANA_TASK_TO_UPDATE = os.environ["ASANA_TASK_TO_UPDATE"]
File "/usr/local/lib/python3.6/os.py", line 669, in __getitem__
raise KeyError(key) from None
KeyError: 'ASANA_TASK_TO_UPDATE'
----------------------------------------
########################################################################################################################
[IN CONTAINER] EXITING /opt/airflow/scripts/in_container/run_prepare_provider_documentation.sh WITH EXIT CODE 1
| @pytest.mark.system("asana") | ||
| class AsanaExampleDagsSystemTest(SystemTest): | ||
| def test_run_example_dag_asana(self): | ||
| self.run_dag("example_asana", DAG_FOLDER) |
There was a problem hiding this comment.
We should probably refactor this a bit to avoid duplicate code. That’s something for another PR though.
avoid import error in ci_prepare_provider_documentation.sh
|
Rebuilding... |
Clarifies how to override workspace or project values from the connection in the operator parameters.