Skip to content

Return empty dictionary at first for attributes#41348

Merged
balloob merged 1 commit intohome-assistant:devfrom
springstan:return-empty-dict-first
Oct 6, 2020
Merged

Return empty dictionary at first for attributes#41348
balloob merged 1 commit intohome-assistant:devfrom
springstan:return-empty-dict-first

Conversation

@springstan
Copy link
Copy Markdown
Member

@springstan springstan commented Oct 6, 2020

Breaking change

Proposed change

Return empty dictionary at first for attribute properties. This makes the code easier to read because edge cases are handled first and foremost. After that the "default" behaviour is handled and then returned.

# Before
def attributes(self):
    if self._devices:
        return {"key": "value"}
    return {}

# After
def attributes(self):
    if not self._devices:
        return {}
    return {"key": "value"}

cc @balloob from #41271 (comment)

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)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Example entry for configuration.yaml:

# Example configuration.yaml
n/a

Additional information

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.
  • Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 🥈 Silver
  • 🥇 Gold
  • 🏆 Platinum

To help with the load of incoming pull requests:

@balloob balloob merged commit 61d9067 into home-assistant:dev Oct 6, 2020
@springstan springstan deleted the return-empty-dict-first branch October 6, 2020 16:10
@springstan
Copy link
Copy Markdown
Member Author

Thanks @balloob for looking over this PR so quickly 👍

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.

3 participants