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

Code quality improvements in emoncms integration #118468

Merged

Conversation

alexandrecuer
Copy link
Contributor

type hints
remove unused var interval

Proposed change

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:

remove unused var interval
@home-assistant
Copy link

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

Code owner commands

Code owners of emoncms can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign emoncms Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

homeassistant/components/emoncms/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/emoncms/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/emoncms/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/emoncms/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/emoncms/sensor.py Show resolved Hide resolved
homeassistant/components/emoncms/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/emoncms/sensor.py Outdated Show resolved Hide resolved
@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@home-assistant home-assistant bot marked this pull request as draft May 30, 2024 09:05
@alexandrecuer alexandrecuer marked this pull request as ready for review May 30, 2024 11:28
@home-assistant home-assistant bot requested a review from epenet May 30, 2024 11:28
homeassistant/components/emoncms/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/emoncms/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/emoncms/sensor.py Outdated Show resolved Hide resolved
@epenet epenet changed the title code quality improvment in emoncms integration Code quality improvements in emoncms integration May 30, 2024
so that the extra parameters update correctly
@alexandrecuer alexandrecuer requested a review from epenet May 30, 2024 13:24
Copy link
Contributor

@epenet epenet left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@borpin
Copy link

borpin commented May 31, 2024

@alexandrecuer - while you are at it, this line causes an error when the returned value is NULL. #108828

ATTR_LASTUPDATETIMESTR: template.timestamp_local(float(self._elem["time"])),

I solved it locally by adding in a check on the Value, but don't know if that is the right way to handle it.

    @property
    def extra_state_attributes(self) -> dict[str, str]:
        """Return the attributes of the sensor."""
        if self._elem["value"] is None:
            return {
                ATTR_FEEDID: self._elem["id"],
                ATTR_TAG: self._elem["tag"],
                ATTR_FEEDNAME: self._elem["name"],
            }
        else:
            return {
                ATTR_FEEDID: self._elem["id"],
                ATTR_TAG: self._elem["tag"],
                ATTR_FEEDNAME: self._elem["name"],
                ATTR_SIZE: self._elem["size"],
                ATTR_USERID: self._elem["userid"],
                ATTR_LASTUPDATETIME: self._elem["time"],
                ATTR_LASTUPDATETIMESTR: template.timestamp_local(float(self._elem["time"])),
            }

@alexandrecuer
Copy link
Contributor Author

alexandrecuer commented May 31, 2024

@borpin: thanks, very nice, I keep this for next commit if you don't mind. This one is only code quality

@epenet epenet merged commit 8a3b494 into home-assistant:dev May 31, 2024
20 checks passed
@epenet
Copy link
Contributor

epenet commented May 31, 2024

Note: if you are planning further improvements, I suggest that you add yourself as a codeowner alongside burpin (you can always remove it later if it becomes too much of a burden).

@alexandrecuer alexandrecuer deleted the emoncms-integration-type-hints branch May 31, 2024 13:46
@github-actions github-actions bot locked and limited conversation to collaborators Jun 1, 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.

3 participants