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

Add voluptuous type aliases #120399

Merged
merged 1 commit into from
Jun 25, 2024
Merged

Conversation

cdce8p
Copy link
Member

@cdce8p cdce8p commented Jun 25, 2024

Proposed change

First step to resolve the voluptuous type errors. Ref #120268

This PR adds two new type aliases

  • VolSchemaType to replace vol.Schema in core functions. These should also except vol.All and vol.Any.
  • VolDictType as alias for dict[str | vol.Marker, Any]. Since dict is mutable, it's considered invariant. Thus the inferred type might not match VolDictType if a dict schema is passed to a function. The alias will make it easier to "force" the correct dict type.
SOME_SCHEMA: VolDictType = {...}

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:

@cdce8p cdce8p requested a review from a team as a code owner June 25, 2024 09:24
@cdce8p cdce8p merged commit b4eee16 into home-assistant:dev Jun 25, 2024
35 checks passed
@cdce8p cdce8p deleted the vol-type-aliases branch June 25, 2024 09:58
@github-actions github-actions bot locked and limited conversation to collaborators Jun 26, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants