You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "hussein-awala (via GitHub)" <gi...@apache.org> on 2026/06/15 09:48:55 UTC

[PR] Document apache-airflow-mypy package in core docs [airflow]

hussein-awala opened a new pull request, #68561:
URL: https://github.com/apache/airflow/pull/68561

   Adds user-facing documentation for the standalone `apache-airflow-mypy` distribution, which was previously only described in its release notes. A new "Static Type Checking for Dags" section under best practices points to the package and explains when a Dag author would want it.
   
   What it covers:
   - Links to the package on PyPI and to mypy.
   - When to use it: accurate `mypy` results for Airflow-specific patterns (typed decorators that inject keyword args, and operator/`@task` outputs resolved from `XComArg` to the runtime type).
   - Install and `[mypy] plugins` configuration.
   - Notes that it is optional, independently versioned (SemVer), and not required at runtime.
   
   ---
   
   ##### Was generative AI tooling used to co-author this PR?
   
   - [X] Yes — Cursor (Claude Opus 4.8)


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Document apache-airflow-mypy package in core docs [airflow]

Posted by "hussein-awala (via GitHub)" <gi...@apache.org>.
hussein-awala merged PR #68561:
URL: https://github.com/apache/airflow/pull/68561


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Document apache-airflow-mypy package in core docs [airflow]

Posted by "eladkal (via GitHub)" <gi...@apache.org>.
eladkal commented on code in PR #68561:
URL: https://github.com/apache/airflow/pull/68561#discussion_r3412625034


##########
airflow-core/docs/best-practices.rst:
##########
@@ -356,6 +356,54 @@ Running ``ruff`` will produce:
 
 By integrating ``ruff`` into your development workflow, you can proactively address deprecations and maintain code quality, facilitating smoother transitions between Airflow versions.
 
+.. _best_practices/static_type_checking:

Review Comment:
   Looks good but I am not sure we want it in best practices.
   Ideally, the length of this doc should be 0. We need to explain best practice only on things that are not self explained. so I think we should have a dedicated doc page for this and possibly just cross reference the doc from the best practices page



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Document apache-airflow-mypy package in core docs [airflow]

Posted by "hussein-awala (via GitHub)" <gi...@apache.org>.
hussein-awala commented on code in PR #68561:
URL: https://github.com/apache/airflow/pull/68561#discussion_r3413022168


##########
airflow-core/docs/best-practices.rst:
##########
@@ -356,6 +356,54 @@ Running ``ruff`` will produce:
 
 By integrating ``ruff`` into your development workflow, you can proactively address deprecations and maintain code quality, facilitating smoother transitions between Airflow versions.
 
+.. _best_practices/static_type_checking:

Review Comment:
   I moved it to howto and kept a reference in this page



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org