Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cease using InventoryFileReader #45391

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

AA-Turner
Copy link

Hello,

In Sphinx we are looking to refactor handling of inventory reading, which might involve deprecating or removing InventoryFileReader. Airflow is one of four projects I have found in the wild that uses it, but your usage can be replaced with a single call to .readline().decode(), as you are only sanity-checking the first line of content.

A

Copy link

boring-cyborg bot commented Jan 4, 2025

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.rst)
Here are some useful points:

  • Pay attention to the quality of your code (ruff, mypy and type annotations). Our pre-commits will help you with that.
  • In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
  • Consider using Breeze environment for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
  • Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
  • Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
  • Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: [email protected]
    Slack: https://s.apache.org/airflow-slack

@shahar1 shahar1 requested a review from Taragolis January 4, 2025 12:24
Copy link
Contributor

@shahar1 shahar1 left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for your contribution!
Was the deprecation discussed anywhere on GitHub / sphinx dev list / anywhere else publicly?
If so, I'd be happy if you could share a link, so we'd be in the loop for the next times :)

@shahar1 shahar1 requested a review from potiuk January 4, 2025 12:34
@shahar1 shahar1 added the backport-to-v2-10-test Mark PR with this label to backport to v2-10-test branch label Jan 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-to-v2-10-test Mark PR with this label to backport to v2-10-test branch kind:documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants