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

Add more proper typing to StreamLogWriter #37347

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

Grub4K
Copy link

@Grub4K Grub4K commented Feb 11, 2024

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 "undefined"
  • 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.

Copy link

boring-cyborg bot commented Feb 11, 2024

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

Copy link
Collaborator

@dirrao dirrao left a comment

Choose a reason for hiding this comment

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

Can you add the test case for where it is breaking?

@Grub4K
Copy link
Author

Grub4K commented Feb 12, 2024

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

airflow/utils/log/logging_mixin.py Outdated Show resolved Hide resolved
airflow/utils/log/logging_mixin.py Outdated Show resolved Hide resolved
airflow/utils/log/logging_mixin.py Show resolved Hide resolved
Copy link

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 github-actions bot added the stale Stale PRs per the .github/workflows/stale.yml policy file label Apr 27, 2024
Copy link
Author

@Grub4K Grub4K left a comment

Choose a reason for hiding this comment

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

Im sorry I took so long to get back to this

airflow/utils/log/logging_mixin.py Show resolved Hide resolved
airflow/utils/log/logging_mixin.py Outdated Show resolved Hide resolved
@github-actions github-actions bot removed the stale Stale PRs per the .github/workflows/stale.yml policy file label Aug 4, 2024
@eladkal
Copy link
Contributor

eladkal commented Aug 4, 2024

@Grub4K are you still working on this PR?

@Grub4K
Copy link
Author

Grub4K commented Aug 4, 2024

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

@eladkal
Copy link
Contributor

eladkal commented Aug 4, 2024

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
Copy link
Contributor

eladkal commented Aug 5, 2024

@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'

@Grub4K
Copy link
Author

Grub4K commented Aug 6, 2024

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

Copy link

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 github-actions bot added the stale Stale PRs per the .github/workflows/stale.yml policy file label Sep 23, 2024
@shahar1 shahar1 removed the stale Stale PRs per the .github/workflows/stale.yml policy file label Sep 25, 2024
@shahar1 shahar1 requested a review from dirrao September 25, 2024 18:28
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.

Missing properties on logger
7 participants