Skip to content

Cease using InventoryFileReader#45391

Merged
shahar1 merged 1 commit intoapache:mainfrom
AA-Turner:patch-1
Jan 10, 2025
Merged

Cease using InventoryFileReader#45391
shahar1 merged 1 commit intoapache:mainfrom
AA-Turner:patch-1

Conversation

@AA-Turner
Copy link
Contributor

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

@boring-cyborg
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: dev@airflow.apache.org
    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 :)

@AA-Turner
Copy link
Contributor Author

Was the deprecation discussed anywhere

The PR to move InventoryFileReader is here: sphinx-doc/sphinx#13215

This is preparatory work for a future v3 of the objects.inv file format.

A

@shahar1 shahar1 merged commit 57be063 into apache:main Jan 10, 2025
43 checks passed
@boring-cyborg
Copy link

boring-cyborg bot commented Jan 10, 2025

Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions.

github-actions bot pushed a commit that referenced this pull request Jan 10, 2025
(cherry picked from commit 57be063)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@github-actions
Copy link

Backport successfully created: v2-10-test

Status Branch Result
v2-10-test PR Link

shahar1 pushed a commit that referenced this pull request Jan 10, 2025
(cherry picked from commit 57be063)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
karenbraganz pushed a commit to karenbraganz/airflow that referenced this pull request Jan 13, 2025
HariGS-DB pushed a commit to HariGS-DB/airflow that referenced this pull request Jan 16, 2025
dauinh pushed a commit to dauinh/airflow that referenced this pull request Jan 24, 2025
got686-yandex pushed a commit to got686-yandex/airflow that referenced this pull request Jan 30, 2025
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.

3 participants