airflow icon indicating copy to clipboard operation
airflow copied to clipboard

Add more proper typing to `StreamLogWriter`

Open Grub4K opened this issue 1 year ago • 3 comments

This PR makes the utils.log.logging_mixin.StreamLogWriter closer resemble the interface of sys.stdout/sys.stderr by implementing the following attributes properly:

  • encoding returns "utf-8"
  • mode returns "w"
  • name returns "<logger: {name}>"
  • write returns int
  • writable returns True
  • readable returns False
  • seekable returns False
  • fileno throws io.UnsupportedOperation

If different values are desired for these, feel free to let me know.

closes: #36992


^ 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.

Grub4K avatar Feb 11 '24 23:02 Grub4K

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

boring-cyborg[bot] avatar Feb 11 '24 23:02 boring-cyborg[bot]

I hope this is what you intended, otherwise let me know in more detail what would have to be changed

Grub4K avatar Feb 12 '24 20:02 Grub4K

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] avatar Apr 27 '24 00:04 github-actions[bot]

@Grub4K are you still working on this PR?

eladkal avatar Aug 04 '24 08:08 eladkal

I am waiting for https://github.com/apache/airflow/pull/37347#discussion_r1585335537 to be resolved. Once it is, i can commit the "undefined" and rebase it on master.

Grub4K avatar Aug 04 '24 09:08 Grub4K

I am waiting for #37347 (comment) to be resolved. Once it is, i can commit the "undefined" and rebase it on master.

If you believe it's handed then resolve it.

eladkal avatar Aug 04 '24 10:08 eladkal

@Grub4K test is failing. Can you look into it?

FAILED tests/utils/test_logging_mixin.py::TestStreamLogWriter::test_textio_compatibility - AttributeError: 'str' object has no attribute 'name'

eladkal avatar Aug 05 '24 09:08 eladkal

Sorry for the oversight. I couldn't figure out how to run tests locally with breeze and so pushed a faulty test

Grub4K avatar Aug 06 '24 20:08 Grub4K