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

Make integration setup optional #48381

Merged
merged 3 commits into from
Mar 29, 2021
Merged

Make integration setup optional #48381

merged 3 commits into from
Mar 29, 2021

Conversation

frenck
Copy link
Member

@frenck frenck commented Mar 26, 2021

Proposed change

With the use of config entries, the integration setup and async_setup methods are often just empty methods returning True.

e.g.,

async def async_setup(hass, config):
    """Component setup, do nothing."""
    return True

Which is pretty useless. This PR adjusts the setup process by making those optional, only in case there is an async_setup_entry available.

Implementation commit: 1f0106d

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

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.
  • 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:

@Kane610
Copy link
Member

Kane610 commented Mar 26, 2021

Yes!! This is lovely ❤️

@frenck frenck force-pushed the frenck-2021-0978 branch from e1b8046 to d5418cc Compare March 26, 2021 20:26
@frenck frenck marked this pull request as ready for review March 26, 2021 21:10
Copy link
Member

@Kane610 Kane610 left a comment

Choose a reason for hiding this comment

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

Looks good, but a lot more integrations should be affected?

@frenck
Copy link
Member Author

frenck commented Mar 27, 2021

That would add a lot of file changes, doing a couple of separate PR for cleaning up.

@frenck frenck force-pushed the frenck-2021-0978 branch from d4d241a to 990f8bc Compare March 27, 2021 09:21
@frenck
Copy link
Member Author

frenck commented Mar 27, 2021

Rebased to deal with a merge conflict.

@frenck frenck force-pushed the frenck-2021-0978 branch from 990f8bc to 412395e Compare March 29, 2021 20:27
@frenck
Copy link
Member Author

frenck commented Mar 29, 2021

Rebased to deal with a merge conflict.

@balloob balloob merged commit 52475c1 into dev Mar 29, 2021
@balloob balloob deleted the frenck-2021-0978 branch March 29, 2021 20:53
@github-actions github-actions bot locked and limited conversation to collaborators Mar 30, 2021
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.

4 participants