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

Enable ruff TRY401 #114395

Merged
merged 2 commits into from
Mar 29, 2024
Merged

Enable ruff TRY401 #114395

merged 2 commits into from
Mar 29, 2024

Conversation

autinerd
Copy link
Contributor

Proposed change

This enables the Ruff rule TRY401: Redundant exception object included in logging.exception call

logging.exception already logs the exception and traceback, so the exception is not needed in the log message.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@bdraco
Copy link
Member

bdraco commented Mar 28, 2024

I think this is going to change how the logging appears in the UI in /config/logs since I'm not sure the full trace is shown there. It might make it harder for users to see issues

@autinerd
Copy link
Contributor Author

The full trace is shown in the log details. The only difference is that the exception message is no longer shown in the log overview.

(The picture is an example to provoke an exception)

image

And it was not really wide-spread in the codebase as well (84 occurrences of TRY401 vs. 614 usages of logging.exception in the codebase)

@bdraco
Copy link
Member

bdraco commented Mar 28, 2024

I think this is fine, but I'd like to wait for other members to review before merging

Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Thanks!

@MartinHjelmare MartinHjelmare merged commit a5b609f into home-assistant:dev Mar 29, 2024
33 of 35 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Mar 30, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants