Skip to content

Add typed helpers and improve type hints in util/json#88534

Merged
epenet merged 7 commits into
home-assistant:devfrom
epenet:load_json-typing
Feb 22, 2023
Merged

Add typed helpers and improve type hints in util/json#88534
epenet merged 7 commits into
home-assistant:devfrom
epenet:load_json-typing

Conversation

@epenet
Copy link
Copy Markdown
Contributor

@epenet epenet commented Feb 21, 2023

Proposed change

Add typed helpers and improve type hints to load_json_* (loading JSON data from a file)

  • load_json now returns JsonValueType
  • load_json_array added to ensure JsonArrayType is returned
  • load_json_object added to ensure JsonValueType is returned

This is a followup to json_loads typing (loading JSON data from a string)

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:

@epenet epenet marked this pull request as ready for review February 21, 2023 12:08
@emontnemery
Copy link
Copy Markdown
Contributor

The PR title and description is not matching the PR content, can you double check @epenet ?

@epenet epenet changed the title Add type hints to load_json Add typed overloads and improve type hints to load_json Feb 22, 2023
@epenet
Copy link
Copy Markdown
Contributor Author

epenet commented Feb 22, 2023

The PR title and description is not matching the PR content, can you double check @epenet ?

I have adjusted the title and description.

@epenet epenet changed the title Add typed overloads and improve type hints to load_json Add typed helpers and improve type hints to load_json Feb 22, 2023
@emontnemery emontnemery changed the title Add typed helpers and improve type hints to load_json Add typed helpers and improve type hints in util/json Feb 22, 2023
Copy link
Copy Markdown
Contributor

@emontnemery emontnemery left a comment

Choose a reason for hiding this comment

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

Nice, thanks @epenet 👍

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.

2 participants