Skip to content

Preserve httpx boolean behavior in REST integration after aiohttp conversion #147738

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

Merged
merged 1 commit into from
Jun 28, 2025

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Jun 28, 2025

Proposed change

This PR restores the httpx behavior for boolean query parameters in the REST integration after the migration from httpx to aiohttp.

When the REST integration was migrated from httpx to aiohttp, we lost httpx's automatic conversion of boolean values to lowercase strings in query parameters. This broke existing user configurations that relied on this behavior.

For example, this configuration that worked with httpx:

rest:
  - resource: https://api.example.com/data
    params:
      inclBtw: true  # Boolean value

Now fails with:

TypeError: Invalid variable type: value should be str, int or float, got True of type <class 'bool'>

This PR adds a compatibility layer that converts boolean values to lowercase strings (True"true", False"false") before passing them to aiohttp, matching httpx's behavior and restoring backward compatibility.

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

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.

To help with the load of incoming pull requests:

@Copilot Copilot AI review requested due to automatic review settings June 28, 2025 20:42
@bdraco bdraco added this to the 2025.7.0 milestone Jun 28, 2025
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR restores httpx’s behavior of converting boolean query parameters to lowercase strings after migrating the REST integration to aiohttp.

  • Adds a compatibility layer in data.py to lowercase-render boolean params.
  • Introduces a test in test_data.py to verify the conversion of True/False into "true"/"false".

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
homeassistant/components/rest/data.py Insert boolean-to-string conversion before request send.
tests/components/rest/test_data.py New test to assert lowercase string conversion of booleans.

@bdraco bdraco merged commit 6d28b99 into dev Jun 28, 2025
34 checks passed
@bdraco bdraco deleted the bool_compat_rest branch June 28, 2025 22:24
@github-actions github-actions bot locked and limited conversation to collaborators Jun 30, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
3 participants