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

Remove oauth2client dependency in Google Sheets #85637

Merged
merged 1 commit into from
Jan 12, 2023

Conversation

tkdrob
Copy link
Contributor

@tkdrob tkdrob commented Jan 10, 2023

Breaking change

Proposed change

oauth2client was needlessly being used and not listed as a dependency. This will result in an error if the user goes to set up Google Sheets without setting up Google Calendar first.

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:

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 added this to the 2023.1.4 milestone Jan 12, 2023
@MartinHjelmare MartinHjelmare merged commit ae9a57b into home-assistant:dev Jan 12, 2023
@tkdrob tkdrob deleted the google_sheets_oauth2 branch January 12, 2023 03:05
balloob pushed a commit that referenced this pull request Jan 12, 2023
@balloob balloob mentioned this pull request Jan 12, 2023
@epenet epenet mentioned this pull request Jan 12, 2023
19 tasks
@epenet
Copy link
Contributor

epenet commented Jan 13, 2023

Would this leave the tests deterministic in the unlikely event that the URLs were accidently changed?

If oauth2client is available in the full test suite, maybe it's worth adding a test checking that the constants match?

from homeassistant.components.google_sheets import GOOGLE_AUTH_URI, GOOGLE_TOKEN_URI

def test_constants() -> None:
    """Ensure that local constants match auth2client constants."""
    try:
        import auth2client
    except ImportError:
        return
    assert GOOGLE_AUTH_URI == oauth2client.GOOGLE_AUTH_URI
    assert GOOGLE_TOKEN_URI == oauth2client.GOOGLE_TOKEN_URI

@MartinHjelmare
Copy link
Member

I don't think we should do that. Each integration is responsible for connecting to the correct services and should require everything it needs to do that. It should not rely on resources outside its manifest that are not general resources.

@github-actions github-actions bot locked and limited conversation to collaborators Jan 14, 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.

4 participants