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

Improve type hints in saj #87183

Merged
merged 1 commit into from
Feb 2, 2023
Merged

Improve type hints in saj #87183

merged 1 commit into from
Feb 2, 2023

Conversation

epenet
Copy link
Contributor

@epenet epenet commented Feb 2, 2023

Proposed change

Linked to #87068

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
  • The code has been formatted using Black (black --fast 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:

@home-assistant
Copy link

home-assistant bot commented Feb 2, 2023

Hey there @fredericvl, mind taking a look at this pull request as it has been labeled with an integration (saj) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of saj can trigger bot actions by commenting:

  • @home-assistant close Closes the issue.
  • @home-assistant rename Awesome new title Change the title of the issue.
  • @home-assistant reopen Reopen the issue.
  • @home-assistant unassign saj Removes the current integration label and assignees on the issue, add the integration domain after the command.

"""Update all the SAJ sensors."""
values = await saj.read(sensor_def)
success = await saj.read(sensor_def)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

From what I can work out in the pysaj code, the read method returns True, False or raise an exception.
To make it clearer I have renamed the variable.

See https://github.com/fredericvl/pysaj/blob/b7f6a5021471fc32a89cd58067fd7871615547a8/pysaj/__init__.py#L225

The rest is just type hints.

@balloob balloob merged commit 11cb6b1 into home-assistant:dev Feb 2, 2023
@epenet epenet deleted the saj branch February 2, 2023 22:09
@github-actions github-actions bot locked and limited conversation to collaborators Feb 3, 2023
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.

2 participants